# 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

void AddHierarchy( spSceneNode node );

# Parameters

Type Name Min Max Description
SceneNode node The top node in the hierarchy to add.

# AddItem

Adds a node id to the set.

# Syntax

void AddItem( const char * NodeId );

# Parameters

Type Name Min Max Description
const char * NodeId The node id that is to be added to the set.

# Clear

Clears the set.

# Syntax

void Clear();

# Parameters

Clear takes no parameters.

# GetClass

Get the name of the SelectionSet class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetItem

Returns the node id in the i:th place in the set.

# Syntax

spString GetItem( unsigned int index );

# Parameters

Type Name Min Max Description
unsigned int index The index of the node id to get from the set.

# Return value

Type: spString

# GetItemCount

The number of items in the set.

# Syntax

unsigned int GetItemCount();

# Parameters

GetItemCount takes no parameters.

# Return value

Type: unsigned int

# IsA

Returns true if SelectionSet is a or is a descendant of the class named as the type parameter.

# Syntax

bool IsA( const char * type );

# 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

# IsNull

Returns true if the SelectionSet object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# RemoveHierarchy

Removes the ids of this node and its children from this selectionset recursively.

# Syntax

void RemoveHierarchy( spSceneNode node );

# Parameters

Type Name Min Max Description
SceneNode node The top node in the hierarchy to remove.

# RemoveItem

Removes an node id from the set.

# Syntax

void RemoveItem( const char * NodeId );

# Parameters

Type Name Min Max Description
const char * NodeId 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

static bool IsClassA( const char * type );

# 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

# 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

static spSelectionSet SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: SelectionSet