DirectShape.CreateGeometryInstance
Method
Description:
Creates a copy of a definition shape that was created earlier.
Creates a copy of a definition shape that was created earlier.
Remarks:
Use DirectShapeLibrary class to store definitions prior to using them here. How the definitions are stored will determine whether an instance or a copy of the shape will be created. Use the output of this function as input to CreateElement to make the created shape persistent. This is intended to support a definition/instance pattern common in CAD formats - DWG blocks, STEP MAPPED_ITEM, IFC IfcMappedItem.
Use DirectShapeLibrary class to store definitions prior to using them here. How the definitions are stored will determine whether an instance or a copy of the shape will be created. Use the output of this function as input to CreateElement to make the created shape persistent. This is intended to support a definition/instance pattern common in CAD formats - DWG blocks, STEP MAPPED_ITEM, IFC IfcMappedItem.
Syntax
public static IList<GeometryObject> CreateGeometryInstance(
Document document,
string definition_id,
Transform trf
)
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | Document to which the created element will be added |
definition_id | String | ID of the shape definition that was created earlier and stored via DirectShapeLibrary |
trf | Transform | Transform to be applied to the definition |
Return Value
Type | Description |
---|---|
IList | A collection of GeometryObjects representing a placed instance of the pre-defined shape The caller function takes ownership |
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | A non-optional argument was null |