#include <ANamedAnimation.h>

Classes
struct	AAnimationBreakpointSortResult

Public Types
enum	FLAGS_ : FLAGS { FLAGS_NONE = 0 , FLAGS_FINISH_MANUAL = ( 1U << ( 0 ) ) , FLAGS_FINISH_ON_ANIM_END = ( 1U << ( 1 ) ) , FLAGS_OVERLAY = ( 1U << ( 2 ) ) , FLAGS_STATIC = ( 1U << ( 3 ) ) , FLAGS_NO_ANIM_REF = ( 1U << ( 4 ) ) , FLAGS_LOOP = ( 1U << ( 5 ) ) , FLAGS_REVERSE = ( 1U << ( 6 ) ) }

enum	FINISHTYPE_ : FINISHTYPE { FINISHTYPE_MANUAL , FINISHTYPE_AUTO }

using	FLAGS = TUINT16

using	FINISHTYPE = TINT

using	BreakpointList = Toshi::T2DynamicVector<AAnimationBreakpoint*>

using	SortedBreakpointList = Toshi::T2SortedVector<AAnimationBreakpoint*, BreakpointList, AAnimationBreakpointSortResult>

Public Member Functions
	ANamedAnimation (Toshi::T2Allocator *a_pAllocator)

	~ANamedAnimation ()

TBOOL	Create (const PBProperties a_pProperties, Toshi::TSkeleton a_pSkeleton)

void	Reset ()

void	AttachBreakpoint (AAnimationBreakpoint *a_pBreakpoint)

ANamedAnimationTransitionSet &	GetTransitionSet ()

TINT16	GetSequenceId () const

TBOOL	IsFinishManual () const

TBOOL	IsOverlay () const

TBOOL	IsReversed () const

TBOOL	IsLooped () const

TBOOL	IsStatic () const

FLAGS	GetFlags () const

TFLOAT	GetDefaultBlendOutTime () const

TFLOAT	GetDefaultBlendInTime () const

TFLOAT	GetDefaultWeight () const

TFLOAT	GetSpeed () const

TFLOAT	GetDuration () const

const Toshi::TPString8 &	GetName () const

const Toshi::TPString8 &	GetExportedName () const

SortedBreakpointList &	GetBreakpoints ()

Static Public Member Functions
static FINISHTYPE	GetFinishType (const Toshi::TPString8 &a_rcFinishType)

Detailed Description

Definition at line 77 of file ANamedAnimation.h.

Member Typedef Documentation

◆ BreakpointList

using ANamedAnimation::BreakpointList = Toshi::T2DynamicVector<AAnimationBreakpoint*>

Definition at line 118 of file ANamedAnimation.h.

◆ FINISHTYPE

using ANamedAnimation::FINISHTYPE = TINT

Definition at line 93 of file ANamedAnimation.h.

◆ FLAGS

using ANamedAnimation::FLAGS = TUINT16

Definition at line 80 of file ANamedAnimation.h.

◆ SortedBreakpointList

using ANamedAnimation::SortedBreakpointList = Toshi::T2SortedVector<AAnimationBreakpoint*, BreakpointList, AAnimationBreakpointSortResult>

Definition at line 119 of file ANamedAnimation.h.

Member Enumeration Documentation

◆ FINISHTYPE_

enum ANamedAnimation::FINISHTYPE_ : FINISHTYPE

Enumerator
FINISHTYPE_MANUAL
FINISHTYPE_AUTO

Definition at line 94 of file ANamedAnimation.h.

    {
        FINISHTYPE_MANUAL,
        FINISHTYPE_AUTO
    };

◆ FLAGS_

enum ANamedAnimation::FLAGS_ : FLAGS

Enumerator
FLAGS_NONE
FLAGS_FINISH_MANUAL
FLAGS_FINISH_ON_ANIM_END
FLAGS_OVERLAY
FLAGS_STATIC
FLAGS_NO_ANIM_REF
FLAGS_LOOP
FLAGS_REVERSE

Definition at line 81 of file ANamedAnimation.h.

    {
        FLAGS_NONE               = 0,
        FLAGS_FINISH_MANUAL      = BITFLAG( 0 ),
        FLAGS_FINISH_ON_ANIM_END = BITFLAG( 1 ),
        FLAGS_OVERLAY            = BITFLAG( 2 ),
        FLAGS_STATIC             = BITFLAG( 3 ),
        FLAGS_NO_ANIM_REF        = BITFLAG( 4 ),
        FLAGS_LOOP               = BITFLAG( 5 ),
        FLAGS_REVERSE            = BITFLAG( 6 ),
    };

Constructor & Destructor Documentation

◆ ANamedAnimation()

ANamedAnimation::ANamedAnimation ( Toshi::T2Allocator * a_pAllocator )

Definition at line 136 of file ANamedAnimation.cpp.

    : m_vecBreakpoints( a_pAllocator, 0, 0 )
    , m_oTransitionSet( this, a_pAllocator )
{
    m_iSequenceId          = -1;
    m_eFlags               = FLAGS_NONE;
    m_fDefaultBlendOutTime = 0.3f;
    m_fDefaultBlendInTime  = 0.3f;
    m_fDefaultWeight       = 1.0f;
    m_fSpeed               = 1.0f;
    m_pAllocator           = a_pAllocator;
 
    m_eFlags = FLAGS_NONE;
    m_eFlags = m_eFlags | FLAGS_LOOP;
}

◆ ~ANamedAnimation()

ANamedAnimation::~ANamedAnimation ( )

Definition at line 153 of file ANamedAnimation.cpp.

{
    // Delete breakpoints
    T2_FOREACH( m_vecBreakpoints, it )
    {
        delete ( *it );
    }
 
    m_vecBreakpoints.Clear();
}

Member Function Documentation

◆ AttachBreakpoint()

void ANamedAnimation::AttachBreakpoint ( AAnimationBreakpoint * a_pBreakpoint )

Definition at line 344 of file ANamedAnimation.cpp.

{
    m_vecBreakpoints.Push( a_pBreakpoint );
}

◆ Create()

TBOOL ANamedAnimation::Create	(	const PBProperties *	a_pProperties,
		Toshi::TSkeleton *	a_pSkeleton )

Definition at line 183 of file ANamedAnimation.cpp.

{
    m_eFlags &= ~FLAGS_LOOP;
    m_fDefaultBlendInTime  = 0.3f;
    m_fDefaultBlendOutTime = 0.3f;
    m_fDefaultWeight       = 1.0f;
 
    TINT      iNumBreakpoints = 0;
    TPString8 strDefaultFinishType;
 
    T2_FOREACH( ( *a_pProperties ), it )
    {
        const TCHAR* pchPropertyName = it->GetName().GetString();
 
        switch ( *pchPropertyName )
        {
            case 'B':
                // Breakpoint
                iNumBreakpoints += 1;
                break;
            case 'D':
                if ( !T2String8::Compare( pchPropertyName, "DefaultBlendInTime" ) )
                {
                    m_fDefaultBlendInTime = it->GetValue()->GetFloat();
                }
                else if ( !T2String8::Compare( pchPropertyName, "DefaultBlendOutTime" ) )
                {
                    m_fDefaultBlendOutTime = it->GetValue()->GetFloat();
                }
                else if ( !T2String8::Compare( pchPropertyName, "DefaultFinishType" ) )
                {
                    strDefaultFinishType = it->GetValue()->GetTPString8();
                }
                else if ( !T2String8::Compare( pchPropertyName, "DefaultWeight" ) )
                {
                    m_fDefaultWeight = it->GetValue()->GetFloat();
                }
                else if ( !T2String8::Compare( pchPropertyName, "DefaultSpeed" ) )
                {
                    m_fSpeed = it->GetValue()->GetFloat();
                }
 
                break;
            case 'E':
                // ExportedName
                m_strExportedName = it->GetValue()->GetTPString8();
                break;
            case 'L':
                // Loop
 
                if ( it->GetValue()->GetBoolean() )
                    m_eFlags |= FLAGS_LOOP;
                else
                    m_eFlags &= ~FLAGS_LOOP;
 
                break;
            case 'N':
                // Name
                m_strName = it->GetValue()->GetTPString8();
                break;
            case 'R':
                // Reverse
 
                if ( it->GetValue()->GetBoolean() )
                    m_eFlags |= FLAGS_REVERSE;
                else
                    m_eFlags &= ~FLAGS_REVERSE;
 
                break;
            case 'S':
                if ( !T2String8::Compare( pchPropertyName, "Static" ) )
                {
                    if ( it->GetValue()->GetBoolean() )
                        m_eFlags |= FLAGS_STATIC;
                    else
                        m_eFlags &= ~FLAGS_STATIC;
                }
                else if ( !T2String8::Compare( pchPropertyName, "Speed" ) )
                {
                    m_fSpeed = it->GetValue()->GetFloat();
                }
 
                break;
        }
    }
 
    TASSERT( !m_strName.IsEmpty() );
    TASSERT( !m_strExportedName.IsEmpty() );
 
    m_iSequenceId = a_pSkeleton->GetSequenceID( m_strExportedName, 0 );
    TASSERT( m_iSequenceId != -1 );
 
    if ( m_iSequenceId != -1 )
    {
        TSkeletonSequence* pSequence = a_pSkeleton->GetSequence( m_iSequenceId );
 
        if ( pSequence->IsOverlay() )
            m_eFlags |= FLAGS_OVERLAY;
        else
            m_eFlags &= ~FLAGS_OVERLAY;
 
        m_fDuration = pSequence->GetDuration();
 
        m_eFlags &= ~( FLAGS_FINISH_MANUAL | FLAGS_FINISH_ON_ANIM_END );
        m_eFlags |= ( GetFinishType( strDefaultFinishType ) == FINISHTYPE_AUTO ) ? FLAGS_FINISH_ON_ANIM_END : FLAGS_FINISH_MANUAL;
 
        TPString8 strModelName;
        a_pProperties->GetParentProperties()->GetParentProperties()->GetOptionalPropertyValue( strModelName, TPS8( Model ) );
 
        // Allocate space to store breakpoints
        TINT iNumSoundBreakpoints = AAnimatableObjectManager::GetSingleton()->FindNumAnimationSoundBreakpoints( strModelName, this );
        m_vecBreakpoints.AccessContainer()->Reserve( iNumBreakpoints + iNumSoundBreakpoints + 4 );
 
        // Read breakpoints stored in the properties
 
        T2_FOREACH( ( *a_pProperties ), it )
        {
            const TCHAR* pchPropertyName = it->GetName().GetString();
 
            if ( *pchPropertyName == 'B' )
            {
                // Breakpoint
                AAnimationBreakpoint* pBreakpoint = CreateBreakpointRuntime( it->GetValue()->GetProperties(), TTRUE );
 
                if ( pBreakpoint )
                {
                    m_vecBreakpoints.Push( pBreakpoint );
                }
            }
        }
 
        return TTRUE;
    }
    else
    {
        TERROR( "Couldn't get '%s' (Exported Name: '%s') animation from an animation set!", m_strName.GetString(), m_strExportedName.GetString() );
        return TFALSE;
    }
}

◆ GetBreakpoints()

SortedBreakpointList & ANamedAnimation::GetBreakpoints ( )

inline

Definition at line 147 of file ANamedAnimation.h.

147{ return m_vecBreakpoints; }

◆ GetDefaultBlendInTime()

TFLOAT ANamedAnimation::GetDefaultBlendInTime ( ) const

inline

Definition at line 141 of file ANamedAnimation.h.

141{ return m_fDefaultBlendInTime; }

◆ GetDefaultBlendOutTime()

TFLOAT ANamedAnimation::GetDefaultBlendOutTime ( ) const

inline

Definition at line 140 of file ANamedAnimation.h.

140{ return m_fDefaultBlendOutTime; }

◆ GetDefaultWeight()

TFLOAT ANamedAnimation::GetDefaultWeight ( ) const

inline

Definition at line 142 of file ANamedAnimation.h.

142{ return m_fDefaultWeight; }

◆ GetDuration()

TFLOAT ANamedAnimation::GetDuration ( ) const

inline

Definition at line 144 of file ANamedAnimation.h.

144{ return m_fDuration; }

◆ GetExportedName()

const Toshi::TPString8 & ANamedAnimation::GetExportedName ( ) const

inline

Definition at line 146 of file ANamedAnimation.h.

146{ return m_strExportedName; }

◆ GetFinishType()

ANamedAnimation::FINISHTYPE ANamedAnimation::GetFinishType ( const Toshi::TPString8 & a_rcFinishType )

static

Definition at line 167 of file ANamedAnimation.cpp.

{
    return ( !a_rcFinishType.GetString8().IsEmpty() && a_rcFinishType == TPS8( EndOfAnim ) ) ? FINISHTYPE_AUTO : FINISHTYPE_MANUAL;
}

◆ GetFlags()

FLAGS ANamedAnimation::GetFlags ( ) const

inline

Definition at line 139 of file ANamedAnimation.h.

139{ return m_eFlags; }

◆ GetName()

const Toshi::TPString8 & ANamedAnimation::GetName ( ) const

inline

Definition at line 145 of file ANamedAnimation.h.

145{ return m_strName; }

◆ GetSequenceId()

TINT16 ANamedAnimation::GetSequenceId ( ) const

inline

Definition at line 133 of file ANamedAnimation.h.

133{ return m_iSequenceId; }

◆ GetSpeed()

TFLOAT ANamedAnimation::GetSpeed ( ) const

inline

Definition at line 143 of file ANamedAnimation.h.

143{ return m_fSpeed; }

◆ GetTransitionSet()

ANamedAnimationTransitionSet & ANamedAnimation::GetTransitionSet ( )

inline

Definition at line 131 of file ANamedAnimation.h.

131{ return m_oTransitionSet; }

◆ IsFinishManual()

TBOOL ANamedAnimation::IsFinishManual ( ) const

inline

Definition at line 134 of file ANamedAnimation.h.

134{ return m_eFlags & FLAGS_FINISH_MANUAL; }

◆ IsLooped()

TBOOL ANamedAnimation::IsLooped ( ) const

inline

Definition at line 137 of file ANamedAnimation.h.

137{ return m_eFlags & FLAGS_LOOP; }

◆ IsOverlay()

TBOOL ANamedAnimation::IsOverlay ( ) const

inline

Definition at line 135 of file ANamedAnimation.h.

135{ return m_eFlags & FLAGS_OVERLAY; }

◆ IsReversed()

TBOOL ANamedAnimation::IsReversed ( ) const

inline

Definition at line 136 of file ANamedAnimation.h.

136{ return m_eFlags & FLAGS_REVERSE; }

◆ IsStatic()

TBOOL ANamedAnimation::IsStatic ( ) const

inline

Definition at line 138 of file ANamedAnimation.h.

138{ return m_eFlags & FLAGS_STATIC; }

◆ Reset()

void ANamedAnimation::Reset ( )

Definition at line 326 of file ANamedAnimation.cpp.

{
    m_strName         = TPS8( null );
    m_strExportedName = TPS8( null );
 
    m_eFlags &= ~FLAGS_LOOP;
    m_eFlags &= ~FLAGS_NO_ANIM_REF;
    m_fDefaultBlendOutTime = 0.3f;
    m_fDefaultBlendInTime  = 0.3f;
    m_fDefaultWeight       = 1.0f;
    m_fSpeed               = 1.0f;
    m_iSequenceId          = -1;
 
    m_eFlags &= ~( FLAGS_FINISH_MANUAL | FLAGS_FINISH_ON_ANIM_END );
    m_eFlags |= FLAGS_FINISH_MANUAL;
}

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

D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/Animation/ANamedAnimation.h
D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/Animation/ANamedAnimation.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ BreakpointList

◆ FINISHTYPE

◆ FLAGS

◆ SortedBreakpointList

Member Enumeration Documentation

◆ FINISHTYPE_

◆ FLAGS_

Constructor & Destructor Documentation

◆ ANamedAnimation()

◆ ~ANamedAnimation()

Member Function Documentation

◆ AttachBreakpoint()

◆ Create()

◆ GetBreakpoints()

◆ GetDefaultBlendInTime()

◆ GetDefaultBlendOutTime()

◆ GetDefaultWeight()

◆ GetDuration()

◆ GetExportedName()

◆ GetFinishType()

◆ GetFlags()

◆ GetName()

◆ GetSequenceId()

◆ GetSpeed()

◆ GetTransitionSet()

◆ IsFinishManual()

◆ IsLooped()

◆ IsOverlay()

◆ IsReversed()

◆ IsStatic()

◆ Reset()