SimplygonSDK::ISceneBoneTable Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ISceneBoneTable:

Public Member Functions
virtual rid	AddBone (ISceneBone *bone)=0
virtual CountedPointer< ISceneBone >	FindBone (const char *name)=0
virtual rid	FindBoneId (const char *name)=0
virtual CountedPointer< ISceneBone >	GetBone (rid id)=0
virtual unsigned int	GetBonesCount ()=0
virtual const char *	GetClass ()
virtual bool	IsA (const char *type) const
virtual void	RemoveBone (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 ISceneBoneTable *	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

ISceneBoneTable keeps information on bones used while rendering.

Definition at line 14899 of file SimplygonSDK.h.

Member Function Documentation

AddBone()

virtual rid SimplygonSDK::ISceneBoneTable::AddBone ( ISceneBone *  bone )

pure virtual

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

Parameters

bone	is the scenebone to be added

Returns

the id of the added bone within the table

FindBone()

virtual CountedPointer<ISceneBone> SimplygonSDK::ISceneBoneTable::FindBone ( const char *  name )

pure virtual

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

Parameters

name	is the string to be searched for

Returns

the first matching bone, or NULL if no matches are found

FindBoneId()

virtual rid SimplygonSDK::ISceneBoneTable::FindBoneId ( const char *  name )

pure virtual

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

Parameters

name	is the string to be searched for

Returns

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

GetBone()

virtual CountedPointer<ISceneBone> SimplygonSDK::ISceneBoneTable::GetBone ( rid  id )

pure virtual

Returns the i:th bone, using the id of the bone

Parameters

id	is the id of the wanted bone

Returns

the bone corresponding to the id

GetBonesCount()

virtual unsigned int SimplygonSDK::ISceneBoneTable::GetBonesCount ( )

pure virtual

Returns the number of bones in the table

Returns

the number of bones in the table

GetClass()

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

IsA()

virtual bool SimplygonSDK::ISceneBoneTable::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::ISceneBoneTable::IsClassA ( const char *  type )

inlinestatic

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

RemoveBone()

virtual void SimplygonSDK::ISceneBoneTable::RemoveBone ( rid  id )

pure virtual

Removes a bone. If GetBone is called with the bone id, the value returned will be NULL.

Parameters

id	is the id of the bone that is to be removed

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a ISceneBoneTable pointer

Returns

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

Definition at line 14933 of file SimplygonSDK.h.

---

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

• SimplygonSDK.h