Related Scripting Object: Group | Supported Parameter List: Group
The Group class represents a collection of related objects. More...
#include <xsi_group.h>
Inheritance diagram for Group:
Public Member Functions |
|
| Group () | |
| ~Group () | |
| Group (const CRef &in_ref) | |
| Group (const Group &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| Group & | operator= (const Group &in_obj) |
| Group & | operator= (const CRef &in_ref) |
| bool | IsMember (const CRef &in_ref, bool in_branchmember=false) const |
| CRefArray | GetMembers () const |
| CRefArray | GetExpandedMembers () const |
| CStatus | AddMember (const CRef &in_ref, bool in_branchmember=false) |
| CStatus | AddMembers (const CRefArray &in_refs, bool in_branchmember=false) |
| CStatus | RemoveMember (const CRef &in_ref) |
| CStatus | RemoveMembers (const CRefArray &in_refs) |
| CStatus | RemoveAllMembers (void) |
| ~Group | ( | ) |
Destroys a Group object.
Constructs a Group object from a CRef object.
| in_ref | A reference to a group. |
Constructs a new Group object from an existing Group object.
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if this object supports the functionality of a specified class. For example, a Group is a type of SceneItem, so a Group object supports SceneItem functionality.
| in_ClassID | Test if this object supports this class. |
Reimplemented from SceneItem.
| siClassID GetClassID | ( | ) | const [virtual] |
Returns the class ID for this object.
Reimplemented from SceneItem.
Reimplemented in Layer, and Partition.
Assigns a Group object to an existing Group object.
| in_obj | A Group object to be copied into this object. |
Assigns a CRef to this Group object. The Group object is cleared if the CRef is not a reference to an object that supports the Group class.
| in_ref | A reference to an object that supports the Group class. |
Reimplemented from SceneItem.
Reimplemented in Layer, and Partition.
| bool IsMember | ( | const CRef & | in_ref, | |
| bool | in_branchmember = false |
|||
| ) | const |
Tests whether an object is a member of the group. For large numbers of objects, it is faster to enumerate the group members and use SIObject::IsEqualTo to find the object you're looking for and ProjectItem::GetBranchFlag to check whether the object was added as a branch member.
| in_ref | The object to find in the group. | |
| in_branchmember | If True, check if the object is a branch member. |
| CRefArray GetMembers | ( | ) | const |
Returns the SceneItem objects, such as X3DObject and Cluster, that represent the group members.
| CRefArray GetExpandedMembers | ( | ) | const |
Returns the SceneItem objects, such as X3DObject and Cluster, for the group members and the children of any branch members.
Adds a single member to the group.
| in_ref | The object to add to the group. | |
| in_branchmember | If set to true, the object is added as a branch member. All objects in a branch member's hierarchy inherit properties applied to the group. |
Adds the specified members to the group.
| in_refs | An array of objects to add to the group. | |
| in_branchmember | If set to true, the objects are added as branch members. All objects in a branch member's hierarchy inherit properties applied to the group. |
Removes a single member from the group.
| in_ref | The member to remove. |
Removes the specified members from the group.
| in_refs | An array of members to remove. |
| CStatus RemoveAllMembers | ( | void | ) |
Removes all members from the group.