/**
 * @file llkeyframewalkmotion.h
 * @brief Implementation of LLKeframeWalkMotion class.
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLKEYFRAMEWALKMOTION_H
#define LL_LLKEYFRAMEWALKMOTION_H

//-----------------------------------------------------------------------------
// Header files
//-----------------------------------------------------------------------------
#include "llkeyframemotion.h"
#include "llcharacter.h"
#include "v3dmath.h"

#define MIN_REQUIRED_PIXEL_AREA_WALK_ADJUST (20.f)
#define MIN_REQUIRED_PIXEL_AREA_FLY_ADJUST (20.f)

//-----------------------------------------------------------------------------
// class LLKeyframeWalkMotion
//-----------------------------------------------------------------------------
class LLKeyframeWalkMotion :
    public LLKeyframeMotion
{
    friend class LLWalkAdjustMotion;
public:
    // Constructor
    LLKeyframeWalkMotion(const LLUUID &id);

    // Destructor
    virtual ~LLKeyframeWalkMotion();

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 LLKeyframeWalkMotion(id); }

public:
    //-------------------------------------------------------------------------
    // animation callbacks to be implemented by subclasses
    //-------------------------------------------------------------------------
    virtual LLMotionInitStatus onInitialize(LLCharacter *character);
    virtual bool onActivate();
    virtual void onDeactivate();
    virtual bool onUpdate(F32 time, U8* joint_mask);

public:
    //-------------------------------------------------------------------------
    // Member Data
    //-------------------------------------------------------------------------
    LLCharacter *mCharacter;
    F32         mCyclePhase;
    F32         mRealTimeLast;
    F32         mAdjTimeLast;
    S32         mDownFoot;
};

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

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 LLWalkAdjustMotion(id); }

public:
    //-------------------------------------------------------------------------
    // animation callbacks to be implemented by subclasses
    //-------------------------------------------------------------------------
    virtual LLMotionInitStatus onInitialize(LLCharacter *character);
    virtual bool onActivate();
    virtual void onDeactivate();
    virtual bool onUpdate(F32 time, U8* joint_mask);
    virtual LLJoint::JointPriority getPriority(){return LLJoint::HIGH_PRIORITY;}
    virtual bool getLoop() { return true; }
    virtual F32 getDuration() { return 0.f; }
    virtual F32 getEaseInDuration() { return 0.f; }
    virtual F32 getEaseOutDuration() { return 0.f; }
    virtual F32 getMinPixelArea() { return MIN_REQUIRED_PIXEL_AREA_WALK_ADJUST; }
    virtual LLMotionBlendType getBlendType() { return ADDITIVE_BLEND; }

public:
    //-------------------------------------------------------------------------
    // Member Data
    //-------------------------------------------------------------------------
    LLCharacter     *mCharacter;
    LLJoint*        mLeftAnkleJoint;
    LLJoint*        mRightAnkleJoint;
    LLPointer<LLJointState> mPelvisState;
    LLJoint*        mPelvisJoint;
    LLVector3d      mLastLeftFootGlobalPos;
    LLVector3d      mLastRightFootGlobalPos;
    F32             mLastTime;
    F32             mAdjustedSpeed;
    F32             mAnimSpeed;
    F32             mRelativeDir;
    LLVector3       mPelvisOffset;
    F32             mAnkleOffset;
};

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

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 LLFlyAdjustMotion(id); }

public:
    //-------------------------------------------------------------------------
    // animation callbacks to be implemented by subclasses
    //-------------------------------------------------------------------------
    virtual LLMotionInitStatus onInitialize(LLCharacter *character);
    virtual bool onActivate();
    virtual void onDeactivate() {};
    virtual bool onUpdate(F32 time, U8* joint_mask);
    virtual LLJoint::JointPriority getPriority(){return LLJoint::HIGHER_PRIORITY;}
    virtual bool getLoop() { return true; }
    virtual F32 getDuration() { return 0.f; }
    virtual F32 getEaseInDuration() { return 0.f; }
    virtual F32 getEaseOutDuration() { return 0.f; }
    virtual F32 getMinPixelArea() { return MIN_REQUIRED_PIXEL_AREA_FLY_ADJUST; }
    virtual LLMotionBlendType getBlendType() { return ADDITIVE_BLEND; }

protected:
    //-------------------------------------------------------------------------
    // Member Data
    //-------------------------------------------------------------------------
    LLCharacter     *mCharacter;
    LLPointer<LLJointState> mPelvisState;
    F32             mRoll;
};

#endif // LL_LLKeyframeWalkMotion_H