TSkeleton Class Reference

#include <TSkeleton.h>

Public Types
enum	QUATINTERP_ { QUATINTERP_Default , QUATINTERP_Slerp , QUATINTERP_Nlerp }
using	t_fnQuatLerp = void ( * )( TQuaternion& a_rOut, const TQuaternion& a_rStart, const TQuaternion& a_rEnd, TFLOAT a_fProgress )
using	QUATINTERP = TUINT32

Public Member Functions
	TSkeleton ()
	~TSkeleton ()
TSkeletonInstance *	CreateInstance (TBOOL a_bSetBasePose)
t_fnQuatLerp	GetQInterpFn () const
void	SetQInterpFn (QUATINTERP a_eQuatInterp)
TSkeletonBone *	GetBone (const TCHAR *a_cBoneName, TUINT32 a_iLength=0)
TINT	GetBoneID (const TCHAR *a_cBoneName, TUINT32 a_iLength=0)
TKeyframeLibraryInstance &	GetKeyLibraryInstance ()
TINT	GetAnimationMaxCount ()
TSkeletonBone *	GetBone (TINT a_iBone)
TSkeletonBone *	GetBones ()
TINT	GetInstanceCount () const
TINT	GetBoneCount () const
TINT	GetAutoBoneCount () const
TINT	GetSequenceID (const TCHAR *a_sSequenceName, TUINT32 a_iLength=0)
TSkeletonSequence *	GetSequences ()
TSkeletonSequence *	GetSequence (TINT a_iSequence)
TSkeletonSequence *	GetSequence (const TCHAR *a_sSequenceName, TUINT32 a_iLength=0)
TINT16	GetSequenceCount ()
TSkeleton &	operator= (const TSkeleton &a_rSkeleton)

Public Attributes
friend	TSkeletonInstance
TINT16	m_iBoneCount
TINT16	m_iManualBoneCount
TINT16	m_iSequenceCount
TINT16	m_iAnimationMaxCount
TINT16	m_iInstanceCount
TKeyframeLibraryInstance	m_KeyLibraryInstance
TSkeletonBone *	m_pBones
TSkeletonSequence *	m_SkeletonSequences
union {
t_fnQuatLerp   m_fnQuatLerp
QUATINTERP   m_eQuatLerpType
};

Detailed Description

Definition at line 117 of file TSkeleton.h.

Member Typedef Documentation

QUATINTERP

using TSkeleton::QUATINTERP = TUINT32

Definition at line 122 of file TSkeleton.h.

t_fnQuatLerp

using TSkeleton::t_fnQuatLerp = void ( * )( TQuaternion& a_rOut, const TQuaternion& a_rStart, const TQuaternion& a_rEnd, TFLOAT a_fProgress )

Definition at line 120 of file TSkeleton.h.

Member Enumeration Documentation

QUATINTERP_

enum TSkeleton::QUATINTERP_

Enumerator
QUATINTERP_Default
QUATINTERP_Slerp
QUATINTERP_Nlerp

Definition at line 123 of file TSkeleton.h.

    {
        QUATINTERP_Default,
        QUATINTERP_Slerp,
        QUATINTERP_Nlerp
    };

Constructor & Destructor Documentation

TSkeleton()

TSkeleton::TSkeleton

(

)

Definition at line 12 of file TSkeleton.cpp.

{
    m_iBoneCount         = 0;
    m_iManualBoneCount   = 0;
    m_iSequenceCount     = 0;
    m_iAnimationMaxCount = 0;
    m_iInstanceCount     = 0;
    m_pBones             = TNULL;
    m_SkeletonSequences  = TNULL;
}

~TSkeleton()

TSkeleton::~TSkeleton

(

)

Definition at line 23 of file TSkeleton.cpp.

{
}

Member Function Documentation

CreateInstance()

TSkeletonInstance * TSkeleton::CreateInstance

(

TBOOL

a_bSetBasePose

)

Definition at line 28 of file TSkeleton.cpp.

{
    // Set quaternion interpolation method if it's not already set
    if ( m_eQuatLerpType <= QUATINTERP_Nlerp )
        SetQInterpFn( m_eQuatLerpType );
 
    auto               iAutoBoneCount = GetAutoBoneCount();
    TSIZE              iAnimationSize = TAlignNumUp( iAutoBoneCount * sizeof( TAnimationBone ) + sizeof( TAnimation ) );
    TSIZE              iInstanceSize  = sizeof( TSkeletonInstance ) + sizeof( TSkeletonInstanceBone ) * iAutoBoneCount + iAnimationSize * GetAnimationMaxCount();
    TSkeletonInstance* pInstance;
 
    pInstance = TSTATICCAST( TSkeletonInstance, TMalloc( iInstanceSize ) );
 
    new ( pInstance ) TSkeletonInstance();
    pInstance->m_pSkeleton              = this;
    pInstance->m_iSize                  = iInstanceSize;
    pInstance->m_iBaseAnimationCount    = 0;
    pInstance->m_iOverlayAnimationCount = 0;
    pInstance->m_eFlags                 = 0;
    pInstance->m_pBones                 = TREINTERPRETCAST( TSkeletonInstanceBone*, pInstance + 1 );
    pInstance->m_pAnimations            = TREINTERPRETCAST( TAnimation*, pInstance->m_pBones + iAutoBoneCount );
    pInstance->m_fTotalWeight           = 0.0f;
    pInstance->m_iLastUpdateStateFrame  = 0;
    pInstance->m_iLastUpdateTimeFrame   = 0;
 
    for ( TINT i = 0; i < GetAnimationMaxCount(); i++ )
    {
        TAnimation* pAnimation = TREINTERPRETCAST(
            TAnimation*,
            TREINTERPRETCAST( TUINTPTR, pInstance->m_pAnimations ) + i * iAnimationSize
        );
 
        new ( pAnimation ) TAnimation();
        pInstance->m_FreeAnimations.PushFront( pAnimation );
    }
 
    if ( a_bSetBasePose )
        pInstance->SetStateFromBasePose();
 
    m_iInstanceCount++;
    return pInstance;
}

GetAnimationMaxCount()

TINT TSkeleton::GetAnimationMaxCount ( )

inline

Definition at line 145 of file TSkeleton.h.

{ return m_iAnimationMaxCount; }

GetAutoBoneCount()

TINT TSkeleton::GetAutoBoneCount ( ) const

inline

Definition at line 150 of file TSkeleton.h.

{ return m_iBoneCount - m_iManualBoneCount; }

GetBone() [1/2]

TSkeletonBone * TSkeleton::GetBone ( const TCHAR * a_cBoneName, TUINT32 a_iLength = 0 )

inline

Definition at line 141 of file TSkeleton.h.

{ return GetBone( GetBoneID( a_cBoneName, a_iLength ) ); }

GetBone() [2/2]

TSkeletonBone * TSkeleton::GetBone ( TINT a_iBone )

inline

Definition at line 146 of file TSkeleton.h.

{ return &m_pBones[ a_iBone ]; }

GetBoneCount()

TINT TSkeleton::GetBoneCount ( ) const

inline

Definition at line 149 of file TSkeleton.h.

{ return m_iBoneCount; }

GetBoneID()

TINT TSkeleton::GetBoneID	(	const TCHAR *	a_cBoneName,
		TUINT32	a_iLength = 0 )

Definition at line 80 of file TSkeleton.cpp.

{
    if ( a_iLength == 0 )
        a_iLength = TStringManager::String8Length( a_szBoneName );
 
    for ( short i = 0; i < m_iBoneCount; i++ )
    {
        if ( m_pBones[ i ].GetNameLength() == a_iLength &&
             TStringManager::String8CompareNoCase( m_pBones[ i ].GetName(), a_szBoneName, a_iLength ) == 0 )
        {
            return i;
        }
    }
 
    return TBONE_INVALID;
}

GetBones()

TSkeletonBone * TSkeleton::GetBones ( )

inline

Definition at line 147 of file TSkeleton.h.

{ return m_pBones; }

GetInstanceCount()

TINT TSkeleton::GetInstanceCount ( ) const

inline

Definition at line 148 of file TSkeleton.h.

{ return m_iInstanceCount; }

GetKeyLibraryInstance()

TKeyframeLibraryInstance & TSkeleton::GetKeyLibraryInstance ( )

inline

Definition at line 144 of file TSkeleton.h.

{ return m_KeyLibraryInstance; }

GetQInterpFn()

t_fnQuatLerp TSkeleton::GetQInterpFn ( ) const

inline

Definition at line 138 of file TSkeleton.h.

{ return m_fnQuatLerp; }

GetSequence() [1/2]

TSkeletonSequence * TSkeleton::GetSequence ( const TCHAR * a_sSequenceName, TUINT32 a_iLength = 0 )

inline

Definition at line 155 of file TSkeleton.h.

{ return GetSequence( GetSequenceID( a_sSequenceName, a_iLength ) ); }

GetSequence() [2/2]

TSkeletonSequence * TSkeleton::GetSequence ( TINT a_iSequence )

inline

Definition at line 154 of file TSkeleton.h.

{ return &m_SkeletonSequences[ a_iSequence ]; }

GetSequenceCount()

TINT16 TSkeleton::GetSequenceCount ( )

inline

Definition at line 157 of file TSkeleton.h.

{ return m_iSequenceCount; }

GetSequenceID()

TINT TSkeleton::GetSequenceID	(	const TCHAR *	a_sSequenceName,
		TUINT32	a_iLength = 0 )

Definition at line 98 of file TSkeleton.cpp.

{
    if ( a_iLength == 0 )
        a_iLength = TStringManager::String8Length( a_szSequenceName );
 
    for ( short i = 0; i < m_iSequenceCount; i++ )
    {
        if ( m_SkeletonSequences[ i ].GetNameLength() == a_iLength &&
             TStringManager::String8CompareNoCase( m_SkeletonSequences[ i ].GetName(), a_szSequenceName, a_iLength ) == 0 )
        {
            return i;
        }
    }
 
    return TSEQ_INVALID;
}

GetSequences()

TSkeletonSequence * TSkeleton::GetSequences ( )

inline

Definition at line 153 of file TSkeleton.h.

{ return m_SkeletonSequences; }

operator=()

TSkeleton & TSkeleton::operator= ( const TSkeleton & a_rSkeleton )

inline

Definition at line 159 of file TSkeleton.h.

{ TIMPLEMENT(); }

SetQInterpFn()

void TSkeleton::SetQInterpFn

(

QUATINTERP

a_eQuatInterp

)

Definition at line 71 of file TSkeleton.cpp.

{
    if ( a_eQuatInterp == QUATINTERP_Slerp )
        m_fnQuatLerp = TQuaternion::Slerp;
    else
        m_fnQuatLerp = TQuaternion::Nlerp;
}

Member Data Documentation

[union]

union { ... } TSkeleton

m_eQuatLerpType

QUATINTERP TSkeleton::m_eQuatLerpType

Definition at line 174 of file TSkeleton.h.

m_fnQuatLerp

t_fnQuatLerp TSkeleton::m_fnQuatLerp

Definition at line 173 of file TSkeleton.h.

m_iAnimationMaxCount

TINT16 TSkeleton::m_iAnimationMaxCount

Definition at line 165 of file TSkeleton.h.

m_iBoneCount

TINT16 TSkeleton::m_iBoneCount

Definition at line 162 of file TSkeleton.h.

m_iInstanceCount

TINT16 TSkeleton::m_iInstanceCount

Definition at line 166 of file TSkeleton.h.

m_iManualBoneCount

TINT16 TSkeleton::m_iManualBoneCount

Definition at line 163 of file TSkeleton.h.

m_iSequenceCount

TINT16 TSkeleton::m_iSequenceCount

Definition at line 164 of file TSkeleton.h.

m_KeyLibraryInstance

TKeyframeLibraryInstance TSkeleton::m_KeyLibraryInstance

Definition at line 167 of file TSkeleton.h.

m_pBones

TSkeletonBone* TSkeleton::m_pBones

Definition at line 168 of file TSkeleton.h.

m_SkeletonSequences

TSkeletonSequence* TSkeleton::m_SkeletonSequences

Definition at line 169 of file TSkeleton.h.

TSkeletonInstance

friend TSkeleton::TSkeletonInstance

Definition at line 130 of file TSkeleton.h.

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Render/TSkeleton.h
• D:/_dev/OpenBarnyard/Source/Toshi/Source/Render/TSkeleton.cpp