CATDraftingGenUseItf Interface CATIDftGenGeomAccess
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftGenGeomAccess
Interface on the Generative View which allows to access generated Geometry (GenItems)
and to execute different query on it.
Method Index
- o
GetAllGeneratedItems(IID&,CATIUnknownList**)
- Returns all the generated geometry accordingly to the required interface.
- o
GetAllGeneratedShapes(IID&,CATIUnknownList**)
- Returns all the generated shapes accordingly to the required interface.
- o
GetGenGeomStatus(CATBoolean&)
- Returns the status of the GenItems generation.
- o
GetGeneratedItemForm3DFeature(IID&,CATBaseUnknown*,CATOmbObjectInContext*,CATIUnknownList**)
- Returns a list of GenItem which have been generated from a particular geometry in a specified product.
- o
GetGeneratedItemForm3DGeom(IID&,CATGeometry*,CATOmbObjectInContext*,CATIUnknownList**)
- Returns a list of GenItem which have been generated from a particular geometry in a specified product.
Methods
o GetAllGeneratedItems
| public virtual GetAllGeneratedItems( | const | iIID, |
| | oList) |
-
Returns all the generated geometry accordingly to the required interface.
- Parameters:
-
- const
- IID & iIID
[in] The IID of the required interface
- oList[out,
- CATBaseUnknown#Release] the list of returned pointers
- Returns:
- HRESULT
- S_OK
- Some geometry has been found
- E_FAIL
- No geometry found which implements the interface iIID
o GetAllGeneratedShapes
| public virtual GetAllGeneratedShapes( | const | iIID, |
| | oList) |
-
Returns all the generated shapes accordingly to the required interface.
- Parameters:
-
- const
- IID & iIID
[in] The IID of the required interface
- oList[out,
- CATBaseUnknown#Release] the list of returned pointers
- Returns:
- HRESULT
- S_OK
- Some Generative shapes has been found
- S_FALSE
- No generative shape has been found
- E_FAIL
- Abnormal behavior
o GetGenGeomStatus
| public virtual GetGenGeomStatus( | | obGenerationState) |
-
Returns the status of the GenItems generation.
This method indicates if GenItem elements are created in the view.
This status is available for all view projection modes (EXACT, CGR, APPROXIMATE, RASTER)
PreCondition<\b>: Only generated geometry are taken into account. Annotations, Ditto and Dress up are excluded.
- Parameters:
-
- obGenerationState
-
- TRUE : GenItems are created in the generative view.
- FALSE : No GenItem in the generative view.
- Returns:
- HRESULT
- S_OK
- Method correctly executed.
- E_FAIL
- If the operation failed.
o GetGeneratedItemForm3DFeature
| public virtual GetGeneratedItemForm3DFeature( | const | iIID, |
| | iFeature, |
| | iRepInstance, |
| | oList) |
-
Returns a list of GenItem which have been generated from a particular geometry in a specified product.
- Parameters:
-
- iIID
- the IID of the returned interface
- iFeature
- the "coming from" 3D feature
- iRepInstance
- the "coming from" representation instance in the assembly. If NULL not considered.
- oList[out,
- CATBaseUnknown#Release] the list of GenItem.
- Returns:
- HRESULT
- S_OK
- If found at least one GenItem.
- S_FALSE
- No GemItem found.
- E_INVALIDARG
- If NULL iGeom.
- E_FAIL
- If abnormal behavior.
o GetGeneratedItemForm3DGeom
| public virtual GetGeneratedItemForm3DGeom( | const | iIID, |
| | iGeom, |
| | iRepInstance, |
| | oList) |
-
Returns a list of GenItem which have been generated from a particular geometry in a specified product.
- Parameters:
-
- iIID
- the IID of the returned interface
- iGeom
- the "coming from" geometry
- iRepInstance
- the "coming from" representation instance in the assembly. If NULL not considered.
- oList[out,
- CATBaseUnknown#Release] the list of GenItem.
- Returns:
- HRESULT
- S_OK
- If found at least one GenItem.
- S_FALSE
- No GemItem found.
- E_INVALIDARG
- If NULL iGeom.
- E_FAIL
- If abnormal behavior.
This object is included in the file: CATIDftGenGeomAccess.h
If needed, your Imakefile.mk should include the module: CATDraftingGenUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.