/* 
 * 
 * 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_CONTACT_COLLECTOR
#define HK_CONTACT_COLLECTOR

#include <Common/Base/hkBase.h>
#include <Physics/Dynamics/Collide/hkpCollisionListener.h>
#include <Physics/Dynamics/Entity/hkpEntityListener.h>

class hkpRigidBody;

/// This class collects all contact points for a specified entity.\n
/// For this class to work successfully, hkpEntity::m_processContactCallbackDelay (or
/// hkpRigidBodyCinfo::m_processContactCallbackDelay) should be set to 0.
class hkpEntityContactCollector : private hkpCollisionListener, private hkpEntityListener
{
public:
	/*
	** public classes
	*/
	struct ContactPoint
	{
		HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_UTILITIES, hkpEntityContactCollector::ContactPoint );

		hkContactPoint m_point;
		hkpRigidBody* m_bodyA;
		hkpRigidBody* m_bodyB;
	};

public:

	virtual ~hkpEntityContactCollector();

	/// Gets all contact points
	const hkArray<ContactPoint>& getContactPoints(){ return m_contactPoints; }

	/// Flips contact points (normal and bodies), so that bodyA is always refBody
	void flipContactPoints( hkpRigidBody* refBody );

	/// Resets all contact points
	void reset();

	/// Adds the contact collector as a listener to an entity. This also stores a reference to the entity
	/// to allow it to remove itself as a listener on destruction.
	void addToEntity( hkpEntity* entity );

	/// Removes the contact collector from the entity. 
	void removeFromEntity( hkpEntity* entity );

protected:
	// the hkpCollisionListener interface implementation
	virtual void contactPointAddedCallback(	  hkpContactPointAddedEvent& event);

	// the hkpCollisionListener interface implementation
	virtual void contactPointRemovedCallback( hkpContactPointRemovedEvent& event);

	// the hkpCollisionListener interface implementation
	virtual void contactPointConfirmedCallback( hkpContactPointConfirmedEvent& event);

	// the hkpCollisionListener interface implementation
	virtual void contactProcessCallback( hkpContactProcessEvent& event);

	// hkpEntityListener interface implementation
	virtual void entityDeletedCallback( hkpEntity* entity );



protected:

	hkArray<ContactPoint> m_contactPoints;

	hkInplaceArray<hkpEntity*, 1> m_entities;
};


#endif // HK_CONTACT_COLLECTOR

/*
* 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.
* 
*/
