Provides script language access to C++ objects of this type.
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | AddChild | Adds a child <Node> to a <Group>. |
| int32 | ChildCountByType | Returns the count of child <Node> objects of the specified type. |
| int32 | ChildrenAreAllType | Returns true if all child <Node> objects are the type specified. |
| int32 | ClearTransform | Resets to zero the position and orientation and resets to 1 the scale. |
| int32 | CloneChildrenToBuffer | Clones the child <Node> objects and transfers ownership of them to the specified <NodeBuffer>. |
| int32 | DeleteAllChildren | Deletes all child <Node> objects from a <Group>. After the function returns, any dependencies on child <Node> objects will have been cleared. |
| int32 | DeleteChild | Deletes a child <Node> from a <Group>. Clears any dependencies on the <Node> and then frees the memory allocated for the <Node>. |
| <Node> | FindChild | Finds a child by name and type. A <Node> object indicates success, nullptr indicates failure. |
| <Node> | FindChildByNameTraverse | Traverses the hierarchy below this <Group> and finds the first child that matches the name and type values submitted to this function. |
| <Node> | FindChildTraverse | Performs a breadth-first search using this <Group> as the search root, and returns the first child of the specified type. Returns a <Node> pointer that must be cast to the expected type. |
| <Node> | FirstChild | Returns a pointer to the first child, or nullptr if this <Node> has no children. |
| <Node> | FirstChildFromSetOfTypes | Returns a pointer to the first child <Node> that matches any of the types in the <TypeInfoArray> submitted to this function. |
| <Node> | GetChild | Returns a pointer to the first child whose name matches the string submitted to this function. Returns nullptr if no match exist. |
| <Node> | GetChildByType | Searches a <Group> node object's child list for a <Node> of the specified type. If there are more than one <Node> objects of the specified type, only the first <Node> is found. |
| int32 | GetChildIndex | Returns the index of a <Node> in its parent's child list. |
| <NodeList> | GetChildList | Returns a pointer to the <NodeList>> object that stores this <Group> node object's children. Please note that changes made to a <Node> via this direct accessor cannot be undone. |
| int32 | GetChildTraverse | Using the <Node> submitted to this function as the root, performs a breadth-first search and populates a <List> object with all the <Node> objects of the indicated type. Optionally, this function can clone the child <Node> objects and transfer ownership of them to the <List>. |
| int32 | GetDegreeByType | Returns the child count of the specified type. |
| <Node> | GetNodeByPath | Searches a <Group> and its child hierarchy for a <Node> using a specified path. |
| <Vec> | GetOrientation | Allocates a <Vec> object via new and returns a pointer to the object. This object contains the group's orientation. The caller is responsible for the allocation. |
| <Vec> | GetPosition | Allocates a <Vec> object via new and returns a pointer to the object. This object contains the group's position. The caller is responsible for the allocation. |
| <Vec> | GetScale | Allocates a <Vec> object via new and returns a pointer to the object. This object contains the group's scale. The caller is responsible for the allocation. |
| <Matrix> | GetTransform | Returns a pointer to a matrix object containing the <Group> node object's transformation parameters. |
| <Matrix> | GetTransformToGroup | Fills a matrix with the values required to transform a coordinate from the source <Group> to the destination <Group>. |
| <Node> | GetTypedNodeByPath | Searches a <Group> and its child hierarchy for a <Node> using a specified path. |
| <NodeBuffer> | GetViewOfDerivedType | Returns a pointer to a <NodeBuffer> object that contains all the child nodes that are derived from the specified type, or, optionally, any child nodes derived from the specified type, and that are reachable by traversing any hierarchy below the node. |
| <NodeBuffer> | GetViewOfType | Returns a pointer to a <NodeBuffer> object that contains all the child nodes that exactly match the specified type, or, optionally, any child nodes that exactly match the specified type, and that are reachable by traversing any hierarchy below the node. |
| int32 | InsertChild | Inserts a <Node> into a <Group> at the specified child index. |
| int32 | InvalidateExtent | Invalidates the extent data stored in the <Group>. The <Group> recalculates the extent on demand. |
| int32 | IsomorphicByType | Returns true if GroupB is isomorphic to this <Group> node with respect to child count and child type. |
| <Node> | LastChild | Returns a pointer to the last child of a <Group>, or nullptr if the <Group> node object's child list is empty. |
| int32 | PopulateBuffer | Populates a <NodeBuffer> with non-owning pointers to the <Group> node object's children of the specified type. |
| int32 | SetOrientation | Sets the <Group> node object's orientation to the values in the specified <Vec> object. |
| int32 | SetPOS | Sets the <Group> node object's position, orientation, and scale transformation. |
| int32 | SetPosition | Sets the <Group> node object's position to the values in the specified <Vec> object. |
| int32 | SetScale | Sets the <Group> node object's position to the values in the specified <Vec> object. |
| int32 | SetTransform | Sets the position, orientation, and scale for a <Group>. |
| int32 | SizeOf | Returns the size in bytes of this <Group>. |
| int32 | SortChildren | This option is undocumented at present. |
| <Node> | TransferFromList | Populates a <Group> with any <Node> objects resident in the <List> object. The <List> must be the sole owner of these <Node> objects or the application will crash. |
| <Matrix> | TransformPointToGroup | Transforms a coordinate from one <Group> to another. |
| int32 | TypeAtIndex | Returns true if the type at the specified index matches the specified type information. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| int32 | Billboard | Sets the Billboard flag for a <Group>. |
| int32 | BoundFrozen | Gets or sets the Freeze flag for a <Group>. |
| double[] | BoundMax[ index ] | Gets or sets the maximum values on X, Y, and Z for the bounding box extents. |
| double[] | BoundMin[ index ] | Gets or sets the minimum values on X, Y, and Z for the bounding box extents. |
| int32 | ChildCount | Returns the child count for a <Group>. |
| Node[] | Children[ index ] | This member is an array of the <Group> node object's children. Accessor syntax: <Group>.Children[ n ]. |
| int32 | Collisions | Gets or sets the Collisions flag for a <Group>. |
| int32 | Cull | Gets or sets the Cull flag for a <Group>. |
| int32 | Hidden | Gets or sets the Hidden flag for a <Group>. |
| int32 | Locked | Gets or sets the Locked flag for a <Group>. |
| <Node> | ParameterGroup | Gets or sets the <Group> node object's ParameterGroup, which can be any <Node> in the local document. This allows you to form relationships between a <Group> and any other <Node> in the document in a way that suits your purpose. |
| int32 | Visible | Gets or sets the Visible flag for a <Group>. |