SimplygonSDK::ISceneNodeCollection Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ISceneNodeCollection:

Public Member Functions
virtual rhandle	AddSceneNode (ISceneNode *obj)=0
virtual CountedPointer< ISceneNode >	FindSceneNode (const char *name)=0
virtual const char *	GetClass ()
virtual CountedPointer< ISceneNode >	GetNextItemAsSceneNode (rhandle *phandle_rhandleInputDataPtr)=0
virtual CountedPointer< ISceneNode >	GetSceneNode (rhandle objhandle)=0
virtual bool	IsA (const char *type) const
virtual bool	IsSceneNodeInCollection (ISceneNode *pobj)=0
virtual void	RemoveSceneNode (ISceneNode *pobj)=0
Public Member Functions inherited from SimplygonSDK::IObjectCollection
virtual rhandle	AddObject (IObject *obj)=0
virtual rhandle	AddObjectSorted (IObject *obj, bool ascending)=0
virtual CountedPointer< IObject >	FindObject (const char *name)=0
virtual rhandle	GetFirstItem ()=0
virtual rhandle	GetItem (unsigned int index)=0
virtual CountedPointer< IObject >	GetItemAsObject (unsigned int index)=0
virtual unsigned int	GetItemCount ()=0
virtual CountedPointer< IObject >	GetItemsObject (rhandle objhandle)=0
virtual rhandle	GetNextItem (rhandle objhandle)=0
virtual bool	IsItemInCollection (rhandle objhandle)=0
virtual bool	IsObjectInCollection (IObject *pobj)=0
virtual void	RemoveAllItems ()=0
virtual rhandle	RemoveItem (rhandle objhandle)=0
virtual void	RemoveObject (IObject *pobj)=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 ISceneNodeCollection *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObjectCollection
static bool	IsClassA (const char *type)
static IObjectCollection *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

ISceneNodeCollection holds a number of ISceneNode objects. The objects can be looked up by their names (if they have been named through IObject::SetName() ).

Definition at line 14583 of file SimplygonSDK.h.

Member Function Documentation

AddSceneNode()

virtual rhandle SimplygonSDK::ISceneNodeCollection::AddSceneNode ( ISceneNode *  obj )

pure virtual

Adds an object object to the collection. The handle refers to the object until it is removed from the collection again.

Parameters

obj	is the node that is to be added to the collection

Returns

the handle of the added node in the collection

FindSceneNode()

virtual CountedPointer<ISceneNode> SimplygonSDK::ISceneNodeCollection::FindSceneNode ( const char *  name )

pure virtual

Finds a named object.

Parameters

name	is the name of the searched for object

Returns

the found node, or NULL if no mathing node is found

GetClass()

virtual const char* SimplygonSDK::ISceneNodeCollection::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::IObjectCollection.

GetNextItemAsSceneNode()

virtual CountedPointer<ISceneNode> SimplygonSDK::ISceneNodeCollection::GetNextItemAsSceneNode ( rhandle *  phandle_rhandleInputDataPtr )

pure virtual

Returns the object of the next item.

Parameters

phandle_rhandleInputDataPtr

is the handle of a node in the collection

Returns

the node after phandle

GetSceneNode()

virtual CountedPointer<ISceneNode> SimplygonSDK::ISceneNodeCollection::GetSceneNode ( rhandle  objhandle )

pure virtual

Gets the object the handle is referring to.

Parameters

objhandle

is the handle of the node

Returns

the node associated with the handle

IsA()

virtual bool SimplygonSDK::ISceneNodeCollection::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::IObjectCollection.

IsClassA()

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

inlinestatic

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

IsSceneNodeInCollection()

virtual bool SimplygonSDK::ISceneNodeCollection::IsSceneNodeInCollection ( ISceneNode *  pobj )

pure virtual

Returns true if the object is in the collection

Parameters

pobj	is an arbitrary node

Returns

true if pobj is in the current collection, false otherwise

RemoveSceneNode()

virtual void SimplygonSDK::ISceneNodeCollection::RemoveSceneNode ( ISceneNode *  pobj )

pure virtual

Removes an object from the collection. Only the first occurrence of the object is removed.

Parameters

pobj	is the node to be be removed

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a ISceneNodeCollection pointer

Returns

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

Definition at line 14617 of file SimplygonSDK.h.

---

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

• SimplygonSDK.h