/* 
 * 
 * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
 * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
 * Level 2 and Level 3 source code contains trade secrets of Havok. Havok Software (C) Copyright 1999-2009 Telekinesys Research Limited t/a Havok. All Rights Reserved. Use of this software is subject to the terms of an end user license agreement.
 * 
 */

#ifndef HK_COLLIDE_COMPRESSED_SAMPLED_HEIGHTFIELD_SHAPE_H
#define HK_COLLIDE_COMPRESSED_SAMPLED_HEIGHTFIELD_SHAPE_H

#include <Physics/Collide/Shape/HeightField/SampledHeightField/hkpSampledHeightFieldShape.h>
#include <Physics/Collide/Shape/HeightField/SampledHeightField/hkpSampledHeightFieldBaseCinfo.h>

extern const hkClass hkpCompressedSampledHeightFieldShapeClass;

/// A heightfield shape which stores the heights in a simple compressed format.
/// hkpCompressedSampledHeightFieldShape is also used as a simple heightfield implementation on the SPU
class hkpCompressedSampledHeightFieldShape : public hkpSampledHeightFieldShape
{
	public:

		HK_DECLARE_REFLECTION();

		hkpCompressedSampledHeightFieldShape( const hkpSampledHeightFieldShape* hf );

		hkpCompressedSampledHeightFieldShape( const hkpSampledHeightFieldBaseCinfo& info, hkArray<hkUint16>& samples,  hkReal quantizationOffset, hkReal quantizationScale );

		HK_FORCE_INLINE HKP_SHAPE_VIRTUAL hkReal getHeightAtImpl( HKP_SHAPE_VIRTUAL_THIS int x, int z ) HKP_SHAPE_VIRTUAL_CONST;

		HK_FORCE_INLINE HKP_SHAPE_VIRTUAL hkBool getTriangleFlipImpl(HKP_SHAPE_VIRTUAL_THIS2) HKP_SHAPE_VIRTUAL_CONST;

		virtual void collideSpheres( const CollideSpheresInput& input, SphereCollisionOutput* outputArray) const;

			/// hkpShape Interface
		virtual int calcSizeForSpu(const CalcSizeForSpuInput& input, int spuBufferSizeLeft) const;


	public:

		hkArray<hkUint16> m_storage;
		hkBool m_triangleFlip;
		
		// Quantization information: the uncompressed (real) value is computed by 
		//		Uncompressed = scale*compressed + offset
		// Scale has a factor of 2^16 - 1 baked in
		hkReal m_offset;
		hkReal m_scale; 

	public:

		hkpCompressedSampledHeightFieldShape( const hkFinishLoadedObjectFlag f )
			: hkpSampledHeightFieldShape(f), m_storage(f)
		{
			if( f.m_finishing )
			{
				m_heightfieldType = hkpSampledHeightFieldShape::HEIGHTFIELD_COMPRESSED;
			}
		}

	protected:
		HK_FORCE_INLINE hkReal		_decompress(hkUint16 comp) const;
		HK_FORCE_INLINE hkUint16	_compress(hkReal uncomp) const;
};

#include <Physics/Collide/Shape/HeightField/CompressedSampledHeightField/hkpCompressedSampledHeightFieldShape.inl>

#endif // HK_COLLIDE_COMPRESSED_SAMPLED_HEIGHTFIELD_SHAPE_H

/*
* Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
* 
* Confidential Information of Havok.  (C) Copyright 1999-2009
* Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
* Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
* rights, and intellectual property rights in the Havok software remain in
* Havok and/or its suppliers.
* 
* Use of this software for evaluation purposes is subject to and indicates
* acceptance of the End User licence Agreement for this product. A copy of
* the license is included with this software and is also available at www.havok.com/tryhavok.
* 
*/
