SimplygonSDK::ISelectionSet Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ISelectionSet:

Public Member Functions
virtual void	AddItem (const char *NodeId)=0
virtual void	Clear ()=0
virtual const char *	GetClass ()
virtual rstring	GetItem (unsigned int index)=0
virtual unsigned int	GetItemCount ()=0
virtual bool	IsA (const char *type) const
virtual void	RemoveItem (const char *NodeId)=0
Public Member Functions inherited from SimplygonSDK::IObject
virtual rid	AddObserver (robserver *Observer, rid EventId)=0
virtual void	AddRef ()=0
virtual rstring	GetName ()=0
virtual void *	GetUserComponentArea (rid userid)=0
virtual void	PrintInfo ()=0
virtual void	Release ()=0
virtual void	RemoveObserver (rid ObserverId)=0
virtual void	SetName (const char *Name)=0

Static Public Member Functions
static bool	IsClassA (const char *type)
static ISelectionSet *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

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

Definition at line 15269 of file SimplygonSDK.h.

Member Function Documentation

AddItem()

virtual void SimplygonSDK::ISelectionSet::AddItem ( const char *  NodeId )

pure virtual

Adds a node id to the set.

Parameters

NodeId

is the node id that is to be added to the set.

Clear()

virtual void SimplygonSDK::ISelectionSet::Clear ( )

pure virtual

Clears the set.

GetClass()

virtual const char* SimplygonSDK::ISelectionSet::GetClass ( )

virtual

GetClass returns the name of the class of the object.

Returns

the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::IObject.

GetItem()

virtual rstring SimplygonSDK::ISelectionSet::GetItem ( unsigned int  index )

pure virtual

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

Parameters

index

is the index of the node id to get from the set.

Returns

the node id at the specified index.

GetItemCount()

virtual unsigned int SimplygonSDK::ISelectionSet::GetItemCount ( )

pure virtual

Get the number of items in the set.

Returns

the number of items in the set.

IsA()

virtual bool SimplygonSDK::ISelectionSet::IsA ( const char *  type ) const

virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the object is, or is a descendant of

Returns

true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::IObject.

IsClassA()

static bool SimplygonSDK::ISelectionSet::IsClassA ( const char *  type )

inlinestatic

The IsClassA function returns true if ISelectionSet is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the class is, or is a descendant of

Returns

true if the class is of the specified class, false if not

Definition at line 15290 of file SimplygonSDK.h.

RemoveItem()

virtual void SimplygonSDK::ISelectionSet::RemoveItem ( const char *  NodeId )

pure virtual

Removes an node id from the set.

Parameters

NodeId

is the node id that is to be removed from to the set.

SafeCast()

static ISelectionSet* SimplygonSDK::ISelectionSet::SafeCast ( IObject *  ptr )

inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a ISelectionSet pointer, and if this is possible, returns the cast pointer.

Parameters

ptr	is the pointer to be cast into a ISelectionSet pointer

Returns

a pointer to the ISelectionSet object, if the cast can be made, and a NULL pointer otherwise

Definition at line 15303 of file SimplygonSDK.h.

---

The documentation for this class was generated from the following file:

• SimplygonSDK.h