The Nebula Device 3: Characters::Character Class Reference

The Nebula Device 3

Characters::Character Class Reference

#include <charactervariationlibrary.h>

Inheritance diagram for Characters::Character:

Core::RefCounted

Detailed Description

A Character resource object holds all shared data belonging to a skinned character.

(C) 2008 Radon Labs GmbH

Public Member Functions

 Character ()
 constructor
virtual ~Character ()
 destructor
void Setup ()
 setup the character object
void Discard ()
 discard the character object
bool IsValid () const
 return true if character object has been setup
CharacterSkeletonSkeleton ()
 access to the character's skeleton
CharacterSkinLibrarySkinLibrary ()
 access to the character's skin library
CharacterAnimationLibrary & AnimationLibrary ()
 access to the character's anim library
CharacterVariationLibrary & VariationLibrary ()
 access to the character's variation library
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::StringGetClassName () 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::Character::Setup (  ) 

setup the character object

NOTE: embedded objects must still be setup individually after this method has been called!

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.