Characters::CharacterInstance Class Reference
#include <characterinstance.h>
Inheritance diagram for Characters::CharacterInstance:
Detailed Description
Contains the per-instance data of a character.(C) 2008 Radon Labs GmbH
Public Member Functions | |
| CharacterInstance () | |
| constructor | |
| virtual | ~CharacterInstance () |
| destructor | |
| void | Setup (const Ptr< Character > &origCharacter, const Ptr< Models::ModelInstance > &modelInst) |
| setup the character instance from a character | |
| void | Discard () |
| discard the character instance | |
| bool | IsValid () const |
| return true if the object has been setup | |
| const Ptr< Jobs::JobPort > & | GetJobPort () const |
| get the character instance's job port | |
| CharacterSkeletonInstance & | Skeleton () |
| access to get the character's skeleton | |
| CharacterSkinSet & | SkinSet () |
| access to character's skin set | |
| CharacterAnimationController & | AnimController () |
| access to character's animation controller | |
| void | SetVariationSetName (const Util::StringAtom &variationSetName) |
| access to the character's variation | |
| void | RenderDebug (const Math::matrix44 &modelTransform) |
| render a debug visualization of the character | |
| void | WaitUpdateDone () const |
| wait for the character to become valid after StartUpdateAsync() | |
| bool | CheckUpdateDone () const |
| check whether asynchronous character update has finished | |
| bool | IsValidForRendering () const |
| return whether this object is valid for rendering (updated in StartUpdate()) | |
| IndexT | GetJointTextureRowIndex () const |
| get character joint texture row index (for GPUTextureSkinning) | |
| int | GetRefCount () const |
| get the current refcount | |
| void | AddRef () |
| increment refcount by one | |
| void | Release () |
| decrement refcount and destroy object if refcount is zero | |
| bool | IsInstanceOf (const Rtti &rtti) const |
| return true if this object is instance of given class | |
| bool | IsInstanceOf (const Util::String &className) const |
| return true if this object is instance of given class by string | |
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| return true if this object is instance of given class by fourcc | |
| bool | IsA (const Rtti &rtti) const |
| return true if this object is instance of given class, or a derived class | |
| bool | IsA (const Util::String &rttiName) const |
| return true if this object is instance of given class, or a derived class, by string | |
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| return true if this object is instance of given class, or a derived class, by fourcc | |
| const Util::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
Static Public Member Functions | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Member Function Documentation
| void Characters::CharacterInstance::RenderDebug | ( | const Math::matrix44 & | modelTransform | ) |
render a debug visualization of the character
Render a debug visualization of the character.
| void Characters::CharacterInstance::WaitUpdateDone | ( | ) | const |
wait for the character to become valid after StartUpdateAsync()
Wait until StartUpdate() is done for this character.
| bool Characters::CharacterInstance::CheckUpdateDone | ( | ) | const |
check whether asynchronous character update has finished
Check if StartUpdate() has finished, return immediately.
| int Core::RefCounted::GetRefCount | ( | ) | const [inline, inherited] |
get the current refcount
Return the current refcount of the object.
| void Core::RefCounted::AddRef | ( | ) | [inline, inherited] |
increment refcount by one
Increment the refcount of the object.
| void Core::RefCounted::Release | ( | ) | [inline, inherited] |
decrement refcount and destroy object if refcount is zero
Decrement the refcount and destroy object if refcount is zero.
| const Util::String & Core::RefCounted::GetClassName | ( | ) | const [inline, inherited] |
get the class name
Get the class name of the object.
| Util::FourCC Core::RefCounted::GetClassFourCC | ( | ) | const [inline, inherited] |
get the class FourCC code
Get the class FourCC of the object.
| void Core::RefCounted::DumpRefCountingLeaks | ( | ) | [static, inherited] |
dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)
This method should be called as the very last before an application exits.