SimplygonSDK::ISelectionSetTable Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ISelectionSetTable:

Public Member Functions
virtual rid	AddSelectionSet (ISelectionSet *selectionSet)=0
virtual CountedPointer< ISelectionSet >	FindSelectionSet (const char *name)=0
virtual rid	FindSelectionSetId (const char *name)=0
virtual const char *	GetClass ()
virtual CountedPointer< ISelectionSet >	GetSelectionSet (rid id)=0
virtual unsigned int	GetSelectionSetCount ()=0
virtual bool	IsA (const char *type) const
virtual void	RemoveSelectionSet (rid id)=0
Public Member Functions inherited from SimplygonSDK::ITable
virtual rid	AddItem (IObject *item)=0
virtual void	Clear ()=0
virtual void	Copy (ITable *src)=0
virtual CountedPointer< IObject >	FindItem (const char *name)=0
virtual rid	FindItemId (const char *name)=0
virtual CountedPointer< IObject >	GetItem (rid id)=0
virtual unsigned int	GetItemsCount ()=0
virtual void	RemoveItem (rid id)=0
virtual void	SetItem (rid id, IObject *item)=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 ISelectionSetTable *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::ITable
static bool	IsClassA (const char *type)
static ITable *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

ISelectionSetTable keeps a table of ISelectionSet.

Definition at line 15355 of file SimplygonSDK.h.

Member Function Documentation

AddSelectionSet()

virtual rid SimplygonSDK::ISelectionSetTable::AddSelectionSet ( ISelectionSet *  selectionSet )

pure virtual

Adds a selection set to the table. The returned value is the id of the selection set within the table.

Parameters

selectionSet

is the selection set to be added

Returns

the id of the added selection set within the table

FindSelectionSet()

virtual CountedPointer<ISelectionSet> SimplygonSDK::ISelectionSetTable::FindSelectionSet ( const char *  name )

pure virtual

Finds a selection set in the table, using the name. If multiple selection sets have the same name, the first will be returned. If the selection set was not found, the return will be NULL.

Parameters

name	is the string to be searched for

Returns

the first matching selection set, or NULL if no matches are found

FindSelectionSetId()

virtual rid SimplygonSDK::ISelectionSetTable::FindSelectionSetId ( const char *  name )

pure virtual

Finds the id of a selection set in the table, using the name. If multiple selection sets have the same name, the first will be returned. If the selection set was not found, the return will be -1.

Parameters

name	is the string to be searched for

Returns

the id of the first matching selection set, or -1 if no matches are found

GetClass()

virtual const char* SimplygonSDK::ISelectionSetTable::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::ITable.

GetSelectionSet()

virtual CountedPointer<ISelectionSet> SimplygonSDK::ISelectionSetTable::GetSelectionSet ( rid  id )

pure virtual

Returns the i:th selection set, using the id of the selection set.

Parameters

id	is the id of the selection set in the table

Returns

the selection set corresponding to the id

GetSelectionSetCount()

virtual unsigned int SimplygonSDK::ISelectionSetTable::GetSelectionSetCount ( )

pure virtual

Returns the number of selection sets in the table

Returns

the number of selection sets in the table

IsA()

virtual bool SimplygonSDK::ISelectionSetTable::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::ITable.

IsClassA()

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

inlinestatic

The IsClassA function returns true if ISelectionSetTable 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 15376 of file SimplygonSDK.h.

RemoveSelectionSet()

virtual void SimplygonSDK::ISelectionSetTable::RemoveSelectionSet ( rid  id )

pure virtual

Removes a selection set. If GetSelectionSet is called with the selection set id, the value returned will be NULL.

Parameters

id	is the id of the selection set that is to be removed

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a ISelectionSetTable pointer

Returns

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

Definition at line 15389 of file SimplygonSDK.h.

---

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

• SimplygonSDK.h