An object group allows you to consolidate multiple Object into one group. All objects connected to an ObjectGroup can then be selected or deselected all at once; the same goes for their visibility. You can quickly show or hide all Object by a single call.

Optionally a color can also be assigned to the ObjectGroup allowing you to have visual feedback of all the Object connected to a group.

See Also

Scene, Object, ObjectGrid, ObjectCell

Static Variables

Name	Description
`scene`	The Scene where the active ObjectGroup is defined.
Declaration Scene *scene
`object_count`	Total amount of Object contained in the current ObjectGroup.
Declaration unsigned short object_count
`uid`	The internal uid of the ObjectGroup to identify it globally.
Declaration unsigned int uid

Variables

Name	Description
`name`	Unique name to identify the ObjectGroup within the Scene it is defined.
Declaration char *name
`color`	A color to visually identify all the Object contained in the current ObjectGroup.
Declaration vec4 color

Functions

Name	Description
`AddObject`	Add an existing Object to the current ObjectGroup.
Declaration void AddObject( Object object ) Parameters* `object`: Reference to an existing Object that resides in the same Scene the current ObjectGroup is defined. Return Value `true` if the Object have been added to the ObjectGroup; `false` if the `object` reference is invalid or if it is already part of the group, or if the ObjectGroup and Object Scene does not match. If the Object is part of another ObjectGroup it will be transfered to the active one automatically.
`GetObject`	Retrieve a specific Object from the current ObjectGroup using its name as key.
Declaration Object GetObject( const char name ) Parameters `name`: The name of the Object reference to retrieve. Return Value `nil` if the `name` does not match any Object contained in the active ObjectGroup; else return the reference to the Object that have a `name` match.
`GetObjectAt`	Retrieve a specific Object reference using its index within the ObjectGroup.
Declaration Object GetObjectAt( unsigned short index ) Parameters* `index`: Index of the Object to retrieve. Return Value Reference to the Object that matches the index received in parameter; else return `nil`.
`GetObjectIndex`	Retrieve the index of an Object connected to the active ObjectGroup.
Declaration int GetObjectIndex( const Object object ) Parameters* `object`: The Object reference to get the index from. Return Value `-1` if the `object` is not contained within the active ObjectGroup; else return its internal list index.
`RemoveObject`	Remove a specific Object from the current ObjectGroup.
Declaration bool RemoveObject( Object object ) Parameters* `object`: Reference to an Object that is part of the current ObjectGroup. Return Value `true` if the Object was removed successfully; else return `false` (in the event the `object` reference is invalid).
`RemoveObjectAt`	Remove an Object from the group using its index as key.
Declaration bool RemoveObjectAt( int index ) Parameters `index`: Index of the Object to remove. Return Value `true` if the index was valid and the Object is removed from the group; else return `false`.
`SelectAll`	Helper function that mark all Object from the group as selected.
Declaration void SelectAll( void )
`DeselectAll`	Deselect all Object contained in the active ObjectGroup.
Declaration void DeselectAll( void )
`IsSelected`	Test if all Object in the active ObjectGroup are selected or not.
Declaration bool IsSelected( void ) Return Value `true` if they are all marked as selected; else return `false`.
`ShowAll`	Toggle the visibility of all Object of the ObjectGroup to `true`.
Declaration void ShowAll( void )
`HideAll`	Toggle the visibility of all Object of the ObjectGroup to `false`.
Declaration void HideAll( void )
`IsVisible`	Test if all Object visibility are set to `true`.
Declaration bool IsVisible( void ) Return Value `true` if all the Object are visible; else return `false`.