/* 
 * 
 * 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_WORLD_SNAPSHOT_VIEWER_H
#define HK_UTILITIES2_WORLD_SNAPSHOT_VIEWER_H

#include <Physics/Utilities/VisualDebugger/Viewer/Dynamics/hkpWorldViewerBase.h>
#include <Common/Base/DebugUtil/StatisticsCollector/Stream/hkStreamStatisticsCollector.h>

class hkDebugDisplayHandler;
class hkpWorld;
class hkListener;

	/// Sends the memory used by the Worlds to the VDB clients to inspect
class hkpWorldSnapshotViewer : public hkpWorldViewerBase
{
	public:

		enum Command // for serialization
		{
			HK_SNAPSHOT = 0xD0,
		};

		HK_DECLARE_CLASS_ALLOCATOR(HK_MEMORY_CLASS_VDB);

			/// Creates a hkpWorldSnapshotViewer.
		static hkProcess* HK_CALL createNative(const hkArray<hkProcessContext*>& contexts);
		static hkProcess* HK_CALL createPC(const hkArray<hkProcessContext*>& contexts);

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

			/// Gets the tag associated with this viewer type
		virtual int getProcessTag() { return m_convert? m_tagPC : m_tagNative; }

		virtual void init();

		virtual void step( hkReal frameTimeInMs );

		static inline const char* HK_CALL getNameNative() { return "* Grab World Snapshot Native"; }
		static inline const char* HK_CALL getNamePC() { return "* Grab World Snapshot PC"; }

	protected:

		hkpWorldSnapshotViewer(const hkArray<hkProcessContext*>& contexts, bool convertToPC );
		virtual ~hkpWorldSnapshotViewer();

	protected:
			
		bool m_convert;
		static int m_tagPC;
		static int m_tagNative;
};

#endif	// HK_UTILITIES2_WORLD_SNAPSHOT_VIEWER_H

/*
* Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20091222)
* 
* 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.
* 
*/
