class SelectionSet
SelectionSet is a set of scene node GUIDs referencing scene nodes in a scene.
Methods
| Method | Description |
| AddHierarchy | Adds the ids of this node and its children from this selectionset recursively. |
| AddItem | Adds a node id to the set. |
| Clear | Clears the set. |
| GetClass | Get the name of the SelectionSet class. |
| GetItem | Returns the node id in the i:th place in the set. |
| GetItemCount | The number of items in the set. |
| IsA | Returns true if SelectionSet is a or is a descendant of the class named as the type parameter. |
| IsNull | Returns true if the SelectionSet object is invalid. |
| RemoveHierarchy | Removes the ids of this node and its children from this selectionset recursively. |
| RemoveItem | Removes an node id from the set. |
Static methods
| Method | Description |
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spSelectionSet, and if this is the case, returns the object cast into spSelectionSet. |
Methods details
AddHierarchy
Adds the ids of this node and its children from this selectionset recursively.
Syntax
Parameters
| Type | Name | Min | Max | Description |
SceneNode | node | | | The top node in the hierarchy to add. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
SceneNode | node | | | The top node in the hierarchy to add. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
| node | SceneNode | | | The top node in the hierarchy to add. |
AddItem
Adds a node id to the set.
Syntax
Parameters
| Type | Name | Min | Max | Description |
const char * | NodeId | | | The node id that is to be added to the set. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
string | NodeId | | | The node id that is to be added to the set. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
| NodeId | str | | | The node id that is to be added to the set. |
Clear
Clears the set.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetClass
Get the name of the SelectionSet class.
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetItem
Returns the node id in the i:th place in the set.
Syntax
Parameters
| Type | Name | Min | Max | Description |
unsigned int | index | | | The index of the node id to get from the set. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
uint | index | | | The index of the node id to get from the set. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
| index | int | | | The index of the node id to get from the set. |
Return value
Type: str
GetItemCount
The number of items in the set.
Syntax
Parameters
GetItemCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetItemCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetItemCount takes no parameters.
Return value
Type: int
IsA
Returns true if SelectionSet is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if SelectionSet is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if SelectionSet is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
| type | str | | | Name of the class to check if SelectionSet is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the SelectionSet object is invalid.
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
RemoveHierarchy
Removes the ids of this node and its children from this selectionset recursively.
Syntax
Parameters
| Type | Name | Min | Max | Description |
SceneNode | node | | | The top node in the hierarchy to remove. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
SceneNode | node | | | The top node in the hierarchy to remove. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
| node | SceneNode | | | The top node in the hierarchy to remove. |
RemoveItem
Removes an node id from the set.
Syntax
Parameters
| Type | Name | Min | Max | Description |
const char * | NodeId | | | The node id that is to be removed from to the set. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
string | NodeId | | | The node id that is to be removed from to the set. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
| NodeId | str | | | The node id that is to be removed from to the set. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spSelectionSet, and if this is the case, returns the object cast into spSelectionSet.
Syntax
Parameters
| Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: SelectionSet
Syntax
Parameters
| Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: SelectionSet
Syntax
Parameters
| Name | Type | Min | Max | Description |
| object | Object | | | Object to cast. |
Return value
Type: SelectionSet