VActorAnimationController.h

Engine/source/Verve/VActor/VActorAnimationController.h

More...

Classes:

Detailed Description

  1
  2//-----------------------------------------------------------------------------
  3// Verve
  4// Copyright (C) 2014 - Violent Tulip
  5//
  6// Permission is hereby granted, free of charge, to any person obtaining a copy
  7// of this software and associated documentation files (the "Software"), to
  8// deal in the Software without restriction, including without limitation the
  9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 10// sell copies of the Software, and to permit persons to whom the Software is
 11// furnished to do so, subject to the following conditions:
 12//
 13// The above copyright notice and this permission notice shall be included in
 14// all copies or substantial portions of the Software.
 15//
 16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 22// IN THE SOFTWARE.
 23//-----------------------------------------------------------------------------
 24#ifndef _VT_VACTORANIMATIONCONTROLLER_H_
 25#define _VT_VACTORANIMATIONCONTROLLER_H_
 26
 27#ifndef _VT_TYPES_H_
 28#include "Types/VTypes.h"
 29#endif
 30
 31#ifndef _VT_VACTORSTATETABLE_H_
 32#include "VActorStateTable.h"
 33#endif
 34
 35#ifndef _TSSHAPEINSTANCE_H_
 36#include "ts/tsShapeInstance.h"
 37#endif
 38
 39//-----------------------------------------------------------------------------
 40
 41class VActor;
 42class VActorStateTable;
 43
 44//-----------------------------------------------------------------------------
 45
 46class VActorAnimationController
 47{
 48public:
 49
 50    struct sAnimationRef
 51    {
 52        U32           Index;
 53        TSThread     *Thread;
 54
 55        sAnimationRef( void ) :
 56            Index( U32_MAX ),
 57            Thread( NULL )
 58        {
 59            // Void.
 60        }
 61    };
 62
 63protected:
 64
 65    VActor             *mObject;
 66
 67    VActorStateTable    mAnimationTable;
 68    sAnimationRef       mBaseAnimation;
 69
 70public:
 71
 72    VActorAnimationController( void );
 73    virtual ~VActorAnimationController( void );
 74
 75    // Initialisation Methods.
 76
 77    bool               initAnimationTable( void );
 78    bool               initAnimation( sAnimationRef &pAnimation, const U32 &pIndex, const F32 &pPosition, const F32 &pTimeScale );
 79    bool               initAnimationThread( TSThread *&pThread, const U32 &pIndex, const F32 &pPosition, const F32 &pTimeScale );
 80
 81    bool               initBaseAnimation( const U32 &pIndex, const F32 &pPosition, const F32 &pTimeScale );
 82
 83    // Accessor Methods.
 84
 85    bool               isValidObject( void );
 86    VActor            *getObject( void );
 87    void               setObject( VActor *pObject );
 88
 89    const TSShape     *getShape( void );
 90    TSShapeInstance   *getShapeInstance( void );
 91
 92    // Animation Methods.
 93
 94    virtual void       update( const F32 &pDelta );
 95
 96    bool               isAnimationSequence( const U32 &pIndex );
 97    S32                getAnimationSequence( const U32 &pIndex );
 98
 99    U32                getAnimation( void );
100    void               setAnimation( const U32 &pIndex );
101};
102
103#endif // _VT_VACTORANIMATIONCONTROLLER_H_
104