llmotioncontroller.h

Go to the documentation of this file.

#ifndef LL_LLMOTIONCONTROLLER_H
#define LL_LLMOTIONCONTROLLER_H

//-----------------------------------------------------------------------------
// Header files
//-----------------------------------------------------------------------------
#include <string>
#include <map>
#include <deque>

#include "lluuidhashmap.h"
#include "llmotion.h"
#include "llpose.h"
#include "llframetimer.h"
#include "llstatemachine.h"
#include "llstring.h"

//-----------------------------------------------------------------------------
// Class predeclaration
// This is necessary because llcharacter.h includes this file.
//-----------------------------------------------------------------------------
class LLCharacter;

//-----------------------------------------------------------------------------
// LLMotionRegistry
//-----------------------------------------------------------------------------
typedef LLMotion*(*LLMotionConstructor)(const LLUUID &id);

class LLMotionTableEntry
{
public:
        LLMotionTableEntry();
        LLMotionTableEntry(LLMotionConstructor constructor, const LLUUID& id);
        ~LLMotionTableEntry(){};

        LLMotion* create(const LLUUID& id);
        static BOOL uuidEq(const LLUUID &uuid, const LLMotionTableEntry &id_pair)
        {
                if (uuid == id_pair.mID)
                {
                        return TRUE;
                }
                return FALSE;
        }

        const LLUUID& getID() { return mID; }

protected:
        LLMotionConstructor             mConstructor;
        LLUUID  mID;
};

class LLMotionRegistry
{
public:
        // Constructor
        LLMotionRegistry();

        // Destructor
        ~LLMotionRegistry();

        // adds motion classes to the registry
        // returns true if successfull
        BOOL addMotion( const LLUUID& id, LLMotionConstructor create);

        // creates a new instance of a named motion
        // returns NULL motion is not registered
        LLMotion *createMotion( const LLUUID &id );

        // initialization of motion failed, don't try to create this motion again
        void markBad( const LLUUID& id );


protected:
        LLUUIDHashMap<LLMotionTableEntry, 32>   mMotionTable;
};

//-----------------------------------------------------------------------------
// class LLMotionController
//-----------------------------------------------------------------------------
class LLMotionController
{
public:
        typedef std::list<LLMotion*> motion_list_t;
        typedef std::set<LLMotion*> motion_set_t;
        
public:
        // Constructor
        LLMotionController();

        // Destructor
        virtual ~LLMotionController();

        // set associated character
        // this must be called exactly once by the containing character class.
        // this is generally done in the Character constructor
        void setCharacter( LLCharacter *character );

        // registers a motion with the controller
        // (actually just forwards call to motion registry)
        // returns true if successfull
        BOOL addMotion( const LLUUID& id, LLMotionConstructor create );

        // creates a motion from the registry
        LLMotion *createMotion( const LLUUID &id );

        // unregisters a motion with the controller
        // (actually just forwards call to motion registry)
        // returns true if successfull
        void removeMotion( const LLUUID& id );

        // start motion
        // begins playing the specified motion
        // returns true if successful
        BOOL startMotion( const LLUUID &id, F32 start_offset );

        // stop motion
        // stops a playing motion
        // in reality, it begins the ease out transition phase
        // returns true if successful
        BOOL stopMotionLocally( const LLUUID &id, BOOL stop_immediate );

        // update motions
        // invokes the update handlers for each active motion
        // activates sequenced motions
        // deactivates terminated motions`
        void updateMotion();

        // flush motions
        // releases all motion instances
        void flushAllMotions();

        //Flush is a liar.
        void deactivateAllMotions();    

        // pause and continue all motions
        void pause();
        void unpause();
        BOOL isPaused() { return mPaused; }

        void setTimeStep(F32 step);

        void setTimeFactor(F32 time_factor);
        F32 getTimeFactor() { return mTimeFactor; }

        motion_list_t& getActiveMotions() { return mActiveMotions; }

//protected:
        bool isMotionActive( LLMotion *motion );
        bool isMotionLoading( LLMotion *motion );
        LLMotion *findMotion( const LLUUID& id );

protected:
        // internal operations act on motion instances directly
        // as there can be duplicate motions per id during blending overlap
        void deleteAllMotions();
        void addLoadedMotion(LLMotion *motion);
        BOOL activateMotionInstance(LLMotion *motion, F32 time);
        BOOL deactivateMotionInstance(LLMotion *motion);
        void deprecateMotionInstance(LLMotion* motion);
        BOOL stopMotionInstance(LLMotion *motion, BOOL stop_imemdiate);
        void removeMotionInstance(LLMotion* motion);
        void updateRegularMotions();
        void updateAdditiveMotions();
        void resetJointSignatures();
        void updateMotionsByType(LLMotion::LLMotionBlendType motion_type);

protected:
        F32                                     mTimeFactor;
        static LLMotionRegistry sRegistry;
        LLPoseBlender           mPoseBlender;

        LLCharacter                     *mCharacter;

//      Life cycle of an animation:
//
//      Animations are instantiated and immediately put in the mAllMotions map for their entire lifetime.
//      If the animations depend on any asset data, the appropriate data is fetched from the data server,
//      and the animation is put on the mLoadingMotions list.
//      Once an animations is loaded, it will be initialized and put on the mLoadedMotions deque.
//      Any animation that is currently playing also sits in the mActiveMotions list.

        typedef std::map<LLUUID, LLMotion*> motion_map_t;
        motion_map_t    mAllMotions;

        motion_set_t            mLoadingMotions;
        motion_list_t           mLoadedMotions;
        motion_list_t           mActiveMotions;
        motion_set_t            mDeprecatedMotions;
        
        LLFrameTimer            mTimer;
        F32                                     mTime;
        F32                                     mTimeOffset;
        F32                                     mLastTime;
        BOOL                            mHasRunOnce;
        BOOL                            mPaused;
        F32                                     mTimeStep;
        S32                                     mTimeStepCount;
        F32                                     mLastInterp;
        F32                                     mPauseTime;

        U8                                      mJointSignature[2][LL_CHARACTER_MAX_JOINTS];
};

//-----------------------------------------------------------------------------
// Class declaractions
//-----------------------------------------------------------------------------
#include "llcharacter.h"

#endif // LL_LLMOTIONCONTROLLER_H

---