/** 
 * @file llpathfindinglinkset.h
 * @author William Todd Stinson
 * @brief Definition of a pathfinding linkset that contains various properties required for havok pathfinding.
 *
 * $LicenseInfo:firstyear=2002&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_LLPATHFINDINGLINKSET_H
#define LL_LLPATHFINDINGLINKSET_H

#include "v3math.h"
#include "lluuid.h"

class LLSD;

class LLPathfindingLinkset
{
public:
	typedef enum
	{
		kUnknown,
		kWalkable,
		kStaticObstacle,
		kDynamicObstacle,
		kMaterialVolume,
		kExclusionVolume,
		kDynamicPhantom
	} ELinksetUse;

	LLPathfindingLinkset(const std::string &pUUID, const LLSD &pLinksetItem);
	LLPathfindingLinkset(const LLPathfindingLinkset& pOther);
	virtual ~LLPathfindingLinkset();

	LLPathfindingLinkset& operator = (const LLPathfindingLinkset& pOther);

	inline const LLUUID&      getUUID() const                        {return mUUID;};
	inline const std::string& getName() const                        {return mName;};
	inline const std::string& getDescription() const                 {return mDescription;};
	inline U32                getLandImpact() const                  {return mLandImpact;};
	inline const LLVector3&   getLocation() const                    {return mLocation;};

	inline ELinksetUse        getLinksetUse() const                  {return mLinksetUse;};
	inline void               setLinksetUse(ELinksetUse pLinksetUse) {mLinksetUse = pLinksetUse;};

	inline S32                getWalkabilityCoefficientA() const  {return mWalkabilityCoefficientA;};
	void                      setWalkabilityCoefficientA(S32 pA);

	inline S32                getWalkabilityCoefficientB() const  {return mWalkabilityCoefficientB;};
	void                      setWalkabilityCoefficientB(S32 pB);

	inline S32                getWalkabilityCoefficientC() const  {return mWalkabilityCoefficientC;};
	void                      setWalkabilityCoefficientC(S32 pC);

	inline S32                getWalkabilityCoefficientD() const  {return mWalkabilityCoefficientD;};
	void                      setWalkabilityCoefficientD(S32 pD);

	LLSD                      encodeAlteredFields(ELinksetUse pLinksetUse, S32 pA, S32 pB, S32 pC, S32 pD) const;

protected:

private:
	static ELinksetUse        getLinksetUse(bool pIsPhantom, bool pIsPermanent, bool pIsWalkable);
	static BOOL               isPhantom(ELinksetUse pLinksetUse);
	static BOOL               isPermanent(ELinksetUse pLinksetUse);
	static BOOL               isWalkable(ELinksetUse pLinksetUse);

	static const S32 MIN_WALKABILITY_VALUE;
	static const S32 MAX_WALKABILITY_VALUE;

	LLUUID       mUUID;
	std::string  mName;
	std::string  mDescription;
	U32          mLandImpact;
	LLVector3    mLocation;
	ELinksetUse  mLinksetUse;
	S32          mWalkabilityCoefficientA;
	S32          mWalkabilityCoefficientB;
	S32          mWalkabilityCoefficientC;
	S32          mWalkabilityCoefficientD;
};

#endif // LL_LLPATHFINDINGLINKSET_H