/**
 * @file llphysicsmotion.h
 * @brief Implementation of LLPhysicsMotion class.
 *
 * $LicenseInfo:firstyear=2011&license=viewerlgpl$
 *
 * Copyright (C) 2011, Linden Research, Inc.
 *
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 *
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 *
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 *
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LL_LLPHYSICSMOTIONCONTROLLER_H
#define LL_LLPHYSICSMOTIONCONTROLLER_H

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

#define PHYSICS_MOTION_FADEIN_TIME 1.0f
#define PHYSICS_MOTION_FADEOUT_TIME 1.0f

class LLPhysicsMotion;

//-----------------------------------------------------------------------------
// class LLPhysicsMotion
//-----------------------------------------------------------------------------
class LLPhysicsMotionController : public LLMotion
{
protected:
	LOG_CLASS(LLPhysicsMotionController);

public:
	// Constructor
	LLPhysicsMotionController(const LLUUID& id);

	// Destructor
	virtual ~LLPhysicsMotionController();

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

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

	// motions must specify whether or not they loop
	LL_INLINE virtual bool getLoop()						{ return true; }

	// motions must report their total duration
	LL_INLINE virtual F32 getDuration()						{ return 0.f; }

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

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

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

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

	LL_INLINE virtual LLMotionBlendType getBlendType()		{ return ADDITIVE_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.
	LL_INLINE virtual bool onActivate()						{ return true; }

	// 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
	LL_INLINE virtual void onDeactivate()					{}

	LL_INLINE LLCharacter* getCharacter()					{ return mCharacter; }

protected:
	void addMotion(LLPhysicsMotion* motion);

private:
	LLCharacter*	mCharacter;

	typedef std::vector<LLPhysicsMotion*> motion_vec_t;
	motion_vec_t	mMotions;
};

#endif // LL_LLPHYSICSMOTION_H