Go to the source code of this file.
Converts from an SUDrawingElementRef to an SUComponentInstanceRef. This is essentially a downcast operation so the given element must be convertible to a component instance.
- Parameters
-
[in] | drawing_elem | The given drawing element reference. |
- Returns
- The converted SUComponentInstanceRef if the downcast operation succeeds
- If not, the returned reference will be invalid
Converts from an SUEntityRef to an SUComponentInstanceRef. This is essentially a downcast operation so the given entity must be convertible to a component instance.
- Parameters
-
[in] | entity | The given entity reference. |
- Returns
- The converted SUComponentInstanceRef if the downcast operation succeeds
- If not, the returned reference will be invalid
Retrieves the component definition of a component instance object.
- Parameters
-
[in] | instance | The component instance object. |
[out] | component | The component definition retrieved. |
- Returns
-
Retrieves the name of a component instance object.
- Parameters
-
[in] | instance | The component instance object. |
[out] | name | The name retrieved. |
- Returns
-
Retrieves the transform of a component instance object.
See description of SUComponentInstanceSetTransform for a discussion of component instance transforms.
- Parameters
-
[in] | instance | The component instance object. |
[out] | transform | The transform retrieved. |
- Returns
-
Deallocates a component instance object created with SUComponentDefinitionCreateInstance.
The instance object must not be associated with a parent object. That is, if SUEntitiesAddInstance is called with the instance object, then the instance object must not be released explicitly.
- Parameters
-
[in] | instance | The component instance object. |
- Returns
-
Sets the name of a component instance object.
- Parameters
-
[in] | instance | The component instance object. |
[in] | name | The name string to set the component instance object. Assumed to be UTF-8 encoded. |
- Returns
-
Sets the transform of a component instance object.
The transform is relative to the parent component. If the parent component is the root component of a model, then the transform is relative to absolute coordinates.
- Parameters
-
[in] | instance | The component instance object. |
[in] | transform | The affine transform to set. |
- Returns
-
Converts from an SUComponentInstanceRef to an SUDrawingElementRef. This is essentially an upcast operation.
- Parameters
-
[in] | instance | The given component instance reference. |
- Returns
- The converted SUEntityRef if instance is a valid component instance
- If not, the returned reference will be invalid
Converts from an SUComponentInstanceRef to an SUEntityRef. This is essentially an upcast operation.
- Parameters
-
[in] | instance | The given component instance reference. |
- Returns
- The converted SUEntityRef if instance is a valid component instance
- If not, the returned reference will be invalid