/* 
 * 
 * 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_UTILITIES2_PHANTOM_DISPLAY_VIEWER_H
#define HK_UTILITIES2_PHANTOM_DISPLAY_VIEWER_H

#include <Physics/Utilities/VisualDebugger/Viewer/Dynamics/hkpWorldViewerBase.h>
#include <Physics/Dynamics/World/Listener/hkpWorldPostSimulationListener.h>
#include <Physics/Dynamics/Phantom/hkpPhantomListener.h>
#include <Physics/Dynamics/Phantom/hkpPhantomType.h>
#include <Common/Visualize/Shape/hkDisplayAABB.h>

class hkDebugDisplayHandler;
class hkpWorld;
class hkpWorldObject;

	/// Displays all the entities in a world.
class hkpPhantomDisplayViewer :	public hkpWorldViewerBase, 
								protected hkpPhantomListener, protected hkpWorldPostSimulationListener
{
	public:

			/// Creates a hkpPhantomDisplayViewer.
		static hkProcess* HK_CALL create(const hkArray<hkProcessContext*>& contexts);

			/// Registers the hkpPhantomDisplayViewer with the hkViewerFactory.
		static void HK_CALL registerViewer();

			/// Gets the tag associated with this viewer type
		virtual int getProcessTag() { return m_tag; }

		virtual void init();

		static inline const char* HK_CALL getName() { return "Phantoms"; }

	protected:

		hkpPhantomDisplayViewer(const hkArray<hkProcessContext*>& contexts);
		virtual ~hkpPhantomDisplayViewer();

		virtual void phantomAddedCallback( hkpPhantom* entity );
		virtual void phantomRemovedCallback( hkpPhantom* entity );
		virtual void postSimulationCallback( hkpWorld* world );

		virtual void worldAddedCallback( hkpWorld* world );
		virtual void worldRemovedCallback( hkpWorld* world );

	protected:

		void removeAllGeometries();
		void addWorld( hkpWorld* world );
		void removeWorld( hkpWorld* world );

	protected:

		static int m_tag;
		hkArray<hkpWorldObject*> m_phantomShapesCreated;
};

/// This singleton allows you to register hkPhantomTypes user types
/// as being hkShapePhantoms and thus allowing the auto display of the shapes held.
class hkpUserShapePhantomTypeIdentifier : public hkReferencedObject, public hkSingleton<hkpUserShapePhantomTypeIdentifier>
{
	//+vtable(true)
	public:

		hkpUserShapePhantomTypeIdentifier() {}

		void registerShapePhantomType( hkpPhantomType t );

	public:

		hkArray< hkpPhantomType > m_shapePhantomTypes;
};

#endif	// HK_UTILITIES2_SHAPE_DISPLAY_VIEWER_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.
* 
*/
