llemote.h

Go to the documentation of this file.

#ifndef LL_LLEMOTE_H
#define LL_LLEMOTE_H

//-----------------------------------------------------------------------------
// Header files
//-----------------------------------------------------------------------------
#include "llmotion.h"
#include "lltimer.h"

#define MIN_REQUIRED_PIXEL_AREA_EMOTE 2000.f

#define EMOTE_MORPH_FADEIN_TIME 0.3f
#define EMOTE_MORPH_IN_TIME 1.1f
#define EMOTE_MORPH_FADEOUT_TIME 1.4f

class LLVisualParam;

//-----------------------------------------------------------------------------
// class LLEmote
//-----------------------------------------------------------------------------
class LLEmote :
        public LLMotion
{
public:
        // Constructor
        LLEmote(const LLUUID &id);

        // Destructor
        virtual ~LLEmote();

public:
        //-------------------------------------------------------------------------
        // functions to support MotionController and MotionRegistry
        //-------------------------------------------------------------------------

        // static constructor
        // all subclasses must implement such a function and register it
        static LLMotion *create(const LLUUID &id) { return new LLEmote(id); }

public:
        //-------------------------------------------------------------------------
        // animation callbacks to be implemented by subclasses
        //-------------------------------------------------------------------------

        // motions must specify whether or not they loop
        virtual BOOL getLoop() { return FALSE; }

        // motions must report their total duration
        virtual F32 getDuration() { return EMOTE_MORPH_FADEIN_TIME + EMOTE_MORPH_IN_TIME + EMOTE_MORPH_FADEOUT_TIME; }

        // motions must report their "ease in" duration
        virtual F32 getEaseInDuration() { return EMOTE_MORPH_FADEIN_TIME; }

        // motions must report their "ease out" duration.
        virtual F32 getEaseOutDuration() { return EMOTE_MORPH_FADEOUT_TIME; }

        // called to determine when a motion should be activated/deactivated based on avatar pixel coverage
        virtual F32 getMinPixelArea() { return MIN_REQUIRED_PIXEL_AREA_EMOTE; }

        // motions must report their priority
        virtual LLJoint::JointPriority getPriority() { return LLJoint::MEDIUM_PRIORITY; }

        virtual LLMotionBlendType getBlendType() { return NORMAL_BLEND; }

        // run-time (post constructor) initialization,
        // called after parameters have been set
        // must return true to indicate success and be available for activation
        virtual LLMotionInitStatus onInitialize(LLCharacter *character);

        // called when a motion is activated
        // must return TRUE to indicate success, or else
        // it will be deactivated 
        virtual BOOL onActivate();

        // called per time step
        // must return TRUE while it is active, and
        // must return FALSE when the motion is completed.
        virtual BOOL onUpdate(F32 time, U8* joint_mask);

        // called when a motion is deactivated
        virtual void onDeactivate();

        virtual BOOL canDeprecate() { return FALSE; }

        static BOOL      getIndexFromName( const char* name, U32* index );

protected:

        LLCharacter*            mCharacter;

        LLVisualParam*          mParam;
};



#endif // LL_LLEMOTE_H

---