formZ SDK | 5.0 API Reference | Project

# Group Manager

Description

The group data type and functions provides a hierarchical grouping tree used to organize data in a number of areas (eg. Objects, Layers, Lights). The referenced data is stored in a linear fashion which can be sequentially accessed through its own API functions. The linear access is more efficient and used for internal processing where the hierarchical grouping tree is designed for ease of use for the user.
The group tree follows a family model. Each entry in the tree can be a node or a leaf. A node is a branch which can can have siblings and children. The siblings are traced by accessing the next or previous sibling in a closed linked list. A leaf is a reference (tag) to a member of the referenced set of data.
Note, that in the corresponding palette, the leaf groups are not shown. Since there is always exactly one leaf group for each entity (such as a layer, light or object) in the palette, leafs are redundant from a user's standpoint and are therefore omitted in the palette. However, when getting the group from such an entity via the repective api call, the leaf group is always returned. To get to the group that shows in the palette, the parent of the leaf needs to be retrieved.
At the top of the group hierarchy is a root group, which is also not shown in the palette. It is a node group, from which all other groups can be traveresed as children of the root.

Function Sets

fz_grup_fset