/** 
 * @file llpose.h
 * @brief Implementation of LLPose 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_LLPOSE_H
#define LL_LLPOSE_H

//-----------------------------------------------------------------------------
// Header Files
//-----------------------------------------------------------------------------

#include "lljointstate.h"
#include "lljoint.h"
#include "llpointer.h"

#include "boost/unordered/unordered_flat_map.hpp"

#include <map>
#include <string>

class LLMotion;
//-----------------------------------------------------------------------------
// class LLPose
//-----------------------------------------------------------------------------
class LLPose
{
	friend class LLPoseBlender;
protected:
	typedef std::map<std::string, LLPointer<LLJointState> > joint_map;
	typedef joint_map::iterator joint_map_iterator;
	typedef joint_map::value_type joint_map_value_type;
	
	joint_map					mJointMap;
	F32							mWeight;
	joint_map_iterator			mListIter;
public:
	// Iterate through jointStates
	LLJointState* getFirstJointState();
	LLJointState* getNextJointState();
	LLJointState* findJointState(LLJoint *joint);
	LLJointState* findJointState(const std::string &name);
public:
	// Constructor
	LLPose() : mWeight(0.f) {}
	// Destructor
	~LLPose() = default;
	// add a joint state in this pose
	BOOL addJointState(const LLPointer<LLJointState>& jointState);
	// remove a joint state from this pose
	BOOL removeJointState(const LLPointer<LLJointState>& jointState);
	// removes all joint states from this pose
	BOOL removeAllJointStates();
	// set weight for all joint states in this pose
	void setWeight(F32 weight);
	// get weight for this pose
	F32 getWeight() const;
	// returns number of joint states stored in this pose
	S32 getNumJointStates() const;
};

const S32 JSB_NUM_JOINT_STATES = 6;

LL_ALIGN_PREFIX(16)
class LLJointStateBlender
{
    LL_ALIGN_NEW
protected:
	LLPointer<LLJointState>	mJointStates[JSB_NUM_JOINT_STATES];
	S32				mPriorities[JSB_NUM_JOINT_STATES];
	BOOL			mAdditiveBlends[JSB_NUM_JOINT_STATES];
public:
	LLJointStateBlender();
	~LLJointStateBlender() = default;
	void blendJointStates(BOOL apply_now = TRUE);
	BOOL addJointState(const LLPointer<LLJointState>& joint_state, S32 priority, BOOL additive_blend);
	void interpolate(F32 u);
	void clear();
	void resetCachedJoint();

public:
	LL_ALIGN_16(LLJoint mJointCache);
} LL_ALIGN_POSTFIX(16);

class LLPoseBlender
{
protected:
	typedef std::list<LLJointStateBlender*> blender_list_t;
	typedef boost::unordered_flat_map<LLJoint*,LLJointStateBlender*> blender_map_t;
	blender_map_t mJointStateBlenderPool;
	blender_list_t mActiveBlenders;

	S32			mNextPoseSlot;
	LLPose		mBlendedPose;
public:
	// Constructor
	LLPoseBlender();
	// Destructor
	~LLPoseBlender();
	
	// request motion joint states to be added to pose blender joint state records
	BOOL addMotion(const std::shared_ptr<LLMotion> &motion);

	// blend all joint states and apply to skeleton
	void blendAndApply();

	// removes all joint state blenders from last time
	void clearBlenders();

	// blend all joint states and cache results
	void blendAndCache(BOOL reset_cached_joints);

	// interpolate all joints towards cached values
	void interpolate(F32 u);

	LLPose* getBlendedPose() { return &mBlendedPose; }
};

#endif // LL_LLPOSE_H

