class SelectionSet

SelectionSet is a set of scene node GUIDs referencing scene nodes in a scene.

Properties

Property	Description
Name	The name of the SelectionSet object. (Inherited from Object)

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.
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Clear	Clears the set.
GetClass	Get the name of the SelectionSet class. (Inherited from Object)
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. (Inherited from Object)
IsNull	Returns true if the SelectionSet object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the SelectionSet object is valid. (Inherited from Object)
NonNull	Returns true if the SelectionSet object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the SelectionSet object to the log. (Inherited from Object)
RemoveHierarchy	Removes the ids of this node and its children from this selectionset recursively.
RemoveItem	Removes an node id from the set.
RemoveObserver	Removes a previously added observer object. (Inherited from Object)

Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
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. (Inherited from Object)

Properties details

Name

The name of the SelectionSet object. (Inherited from Object)

Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

SetName parameters

Type	Name	Min	Max	Description
const char *	name			New name of the object.

GetName return value

Type: spString

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

Methods details

AddHierarchy

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

Syntax

void AddHierarchy( const spSceneNode & node ) const;

Parameters

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

Syntax

void AddHierarchy(spSceneNode node);

Parameters

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

Syntax

None AddHierarchy(node: spSceneNode)

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

void AddItem( const char * NodeId ) const;

Parameters

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

Syntax

void AddItem(string NodeId);

Parameters

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

Syntax

None AddItem(NodeId: str)

Parameters

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

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Syntax

rid AddObserver( const spObserver & observer ) const;

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: rid

Syntax

int AddObserver(spObserver observer);

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

Name	Type	Min	Max	Description
observer	Observer			Observer is the object that will receive events.

Return value

Type: int

Clear

Clears the set.

Syntax

void Clear() const;

Parameters

Clear takes no parameters.

Syntax

void Clear();

Parameters

Clear takes no parameters.

Syntax

None Clear()

Parameters

Clear takes no parameters.

GetClass

Get the name of the SelectionSet class. (Inherited from Object)

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetItem

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

Syntax

spString GetItem( unsigned int index ) const;

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

string GetItem(uint index);

Parameters

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

Return value

Type: string

Syntax

str GetItem(index: int)

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

unsigned int GetItemCount() const;

Parameters

GetItemCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetItemCount();

Parameters

GetItemCount takes no parameters.

Return value

Type: uint

Syntax

int GetItemCount()

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. (Inherited from Object)

Syntax

bool IsA( const char * type ) const;

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

bool IsA(string type);

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

bool IsA(type: str)

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. (Inherited from Object)

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

Returns true if the SelectionSet object is valid. (Inherited from Object)

Syntax

bool IsSameObjectAs( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to compare with.

Return value

Type: bool

NonNull

Returns true if the SelectionSet object is valid. (Inherited from Object)

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

Prints the content/info of the SelectionSet object to the log. (Inherited from Object)

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

Parameters

PrintInfo takes no parameters.

RemoveHierarchy

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

Syntax

void RemoveHierarchy( const spSceneNode & node ) const;

Parameters

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

Syntax

void RemoveHierarchy(spSceneNode node);

Parameters

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

Syntax

None RemoveHierarchy(node: spSceneNode)

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

void RemoveItem( const char * NodeId ) const;

Parameters

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

Syntax

void RemoveItem(string NodeId);

Parameters

Type	Name	Min	Max	Description
string	NodeId			The node id that is to be removed from to the set.

Syntax

None RemoveItem(NodeId: str)

Parameters

Name	Type	Min	Max	Description
NodeId	str			The node id that is to be removed from to the set.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Syntax

void RemoveObserver( rid observerId ) const;

Parameters

Type	Name	Min	Max	Description
rid	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

void RemoveObserver(int observerId);

Parameters

Type	Name	Min	Max	Description
int	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

None RemoveObserver(observerId: int)

Parameters

Name	Type	Min	Max	Description
observerId	int			ObserverId is the id returned by AddObserver when the observer was added.

Static methods details

IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

static bool IsClassA( const char * type ) const;

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

static bool IsClassA(string type);

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

@staticmethod
bool IsClassA(type: str)

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. (Inherited from Object)

Syntax

static spSelectionSet SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: SelectionSet

Syntax

static spSelectionSet SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: SelectionSet

Syntax

@staticmethod
spSelectionSet SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: SelectionSet