Go to the source code of this file.
Creates a new group object.
The created group must be subsequently added to the Entities of a model, component definition or a group.
- Parameters
-
[out] | group | The group object created. |
- Returns
-
Converts from an SUDrawingElementRef to an SUGroupRef. This is essentially a downcast operation so the given element must be convertible to an SUGroupRef.
- Parameters
-
[in] | drawing_elem | The given element reference. |
- Returns
- The converted SUGroupRef if the downcast operation succeeds
- If not, the returned reference will be invalid
Converts from an SUEntityRef to an SUGroupRef. This is essentially a downcast operation so the given entity must be convertible to an SUGroupRef.
- Parameters
-
[in] | entity | The given entity reference. |
- Returns
- The converted SUGroupRef if the downcast operation succeeds
- If not, the returned reference will be invalid
Retrieves the entities of the group object.
- Parameters
-
[in] | group | The group object. |
[out] | entities | The entities retrieved. |
- Returns
-
Retrieves the name of a group object.
- Parameters
-
[in] | group | The group object. |
[out] | name | The name retrieved. |
- Returns
-
Retrieves the transform of a group object.
See description of SUGroupSetTransform for a discussion of group transforms.
- Parameters
-
[in] | group | The group object. |
[out] | transform | The transform retrieved. |
- Returns
-
SU_RESULT SUGroupSetName |
( |
SUGroupRef |
group, |
|
|
const char * |
name |
|
) |
| |
Sets the name of a group object.
- Parameters
-
[in] | group | The group object. |
[in] | name | The name string to set the group object. Assumed to be UTF-8 encoded. |
- Returns
-
Sets the transform of a group 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] | group | The group object. |
[in] | transform | The affine transform to set. |
- Returns
-
Converts from an SUGroupRef to an SUDrawingElementRef. This is essentially an upcast operation.
- Parameters
-
[in] | group | The given group reference. |
- Returns
- The converted SUEntityRef if group is a valid group
- If not, the returned reference will be invalid
Converts from an SUGroupRef to an SUEntityRef. This is essentially an upcast operation.
- Parameters
-
[in] | group | The given group reference. |
- Returns
- The converted SUEntityRef if group is a valid group
- If not, the returned reference will be invalid