hkObjectInspector.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:4k
源码类别:

其他游戏

开发平台:

Visual C++

  1. /* 
  2.  * 
  3.  * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
  4.  * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
  5.  * 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.
  6.  * 
  7.  */
  8. #ifndef HK_OBJECT_INSPECTOR_H
  9. #define HK_OBJECT_INSPECTOR_H
  10. #include <Common/Base/Types/hkBaseTypes.h>
  11. /// Utility functions to inspect an object using metadata.
  12. namespace hkObjectInspector
  13. {
  14. /// Location of pointer and corresponding reflection information.
  15. struct Pointer
  16. {
  17. ///
  18. void** location;
  19. ///
  20. const hkClass* klass;
  21. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_SERIALIZE, Pointer );
  22. };
  23. /// Called when an object is found.
  24. class ObjectListener
  25. {
  26. public:
  27. virtual ~ObjectListener() {}
  28. /// Called when an object is found.
  29. /// The 'klass' contains reflection information that
  30. /// corresponds to the specified object in 'objP'.
  31. /// The 'containedPointers' provides array of locations
  32. /// of pointers (see Pointer structure) that referenced
  33. /// by 'object'.
  34. /// The implementation may modify this array.
  35. /// NOTE: The 'containedPointers' may contain items where
  36. /// pointers referenced by Pointer::location can be
  37. /// equal to HK_NULL (however, the location is never equal
  38. /// to HK_NULL).
  39. /// The Pointer::klass contains pointer correct structure
  40. /// for non-virtual objects and pointer to the base class
  41. /// for virtual object. However, in some cases where the base
  42. /// class for virtual object is unknown it contains HK_NULL.
  43. /// It is callback's responsibility to correct the Pointer::klass
  44. /// value in order to allow farther processing of the pointers.
  45. virtual hkResult objectCallback( const void* objP, const hkClass& klass, hkArray<Pointer>& containedPointers ) = 0;
  46. };
  47. /// Get list of pointers and classes (array of Pointer structs) from specified object.
  48. /// The 'klass' must contains reflection information that corresponds to the specified 'object'.
  49. /// Return array of pointers in 'outContainedPointers'.
  50. /// NOTE: The Pointer::klass contains pointer correct structure
  51. /// for non-virtual objects and pointer to the base class
  52. /// for virtual object. However, in some cases where the base
  53. /// class for virtual object is unknown it contains HK_NULL.
  54. hkResult HK_CALL getPointers(const void* object, const hkClass& klass, hkArray<Pointer>& outContainedPointers);
  55. /// Walk through an object and call listener providing list of all found pointers to other objects.
  56. /// The listener may hold and update the list of these pointers. The function does not trace/analyse
  57. /// duplicated pointers, the listener is responsible to process/ignore such pointers found in objects.
  58. /// The function recursively walks through each object referenced by pointer from the list when the
  59. /// listener callback is complete.
  60. hkResult HK_CALL walkPointers(const void* object, const hkClass& klass, ObjectListener* listener);
  61. }
  62. #endif // HK_OBJECT_INSPECTOR_H
  63. /*
  64. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  65. * Confidential Information of Havok.  (C) Copyright 1999-2009
  66. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  67. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  68. * rights, and intellectual property rights in the Havok software remain in
  69. * Havok and/or its suppliers.
  70. * Use of this software for evaluation purposes is subject to and indicates
  71. * acceptance of the End User licence Agreement for this product. A copy of
  72. * the license is included with this software and is also available at www.havok.com/tryhavok.
  73. */