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

其他游戏

开发平台:

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_SERIALIZE_RESOURCE_H
  9. #define HK_SERIALIZE_RESOURCE_H
  10. #include <Common/Base/Reflection/hkClass.h>
  11. #include <Common/Serialize/Util/hkBuiltinTypeRegistry.h>
  12. class hkTypeInfoRegistry;
  13. /// Abstract base class for resources which require cleanup.
  14. class hkResource : public hkReferencedObject
  15. {
  16. public:
  17. /// Object which this resource provides.
  18. struct Export
  19. {
  20. /// Symbol of exported object.
  21. const char* name;
  22. /// Exported object pointer.
  23. void* data;
  24. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_SERIALIZE, hkResource::Export );
  25. };
  26. /// Object which this resource requires.
  27. struct Import
  28. {
  29. /// Symbol of imported object.
  30. const char* name;
  31. /// Location inside this resource which points to the Export with the same name.
  32. void** location;
  33. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_SERIALIZE, hkResource::Import );
  34. };
  35. public:
  36. /// Get the name of this resource.
  37. virtual const char* getName() const = 0;
  38. /// Destroy the resource data.
  39. /// All contained objects are first destroyed then any allocated
  40. /// memory is freed.  See also callDestructors().
  41. virtual ~hkResource() { }
  42. /// Destruct objects.
  43. /// This method is separate from ~hkResource() because if multiple
  44. /// resources reference each other, it will usually be necessary to perform
  45. /// two passes. e.g because otherwise the destructors could call removeReference
  46. /// on freed memory. The first pass calls all destructors. The second pass frees memory.
  47. virtual void callDestructors() { }
  48. /// Get a list of the imports/exports from this resource.
  49. virtual void getImportsExports( hkArray<Import>& impOut, hkArray<Export>& expOut ) const = 0;
  50. /// This function assumes that the packfile version matches the in-memory
  51. /// version. You may use hkVersionUtil if this is not the case. See the
  52. /// serialization section of the manual for more details.
  53. /// Usually you will use hkResource::getContents() instead of this function.
  54. /// If the packfile contents type do not match the expected class type
  55. /// this method will return HK_NULL. You may pass HK_NULL as the expected
  56. /// class to disable this check.
  57. /// Some objects will require a finishing step. i.e. to initialize
  58. /// members which have not been serialized or to initialize vtables.
  59. /// If "typeRegistry" is not HK_NULL, apply these finishing steps.
  60. /// If required hkTypeInfo is not found in "typeRegistry" while applying
  61. /// the finishing steps then this method will return HK_NULL.
  62. virtual void* getContentsPointer(const char* typeName, const hkTypeInfoRegistry* typeRegistry) const = 0;
  63. /// Return pointer to a top level object of specified type T.
  64. /// See hkResource::getContentsPointer(const char*, const hkTypeInfoRegistry*) method for details.
  65. template<typename T>
  66. T* getContentsWithRegistry(const hkTypeInfoRegistry* typeRegistry) const;
  67. /// Return pointer to a top level object of specified type T.
  68. /// The function finishes objects using type registry from hkBuiltinTypeRegistry.
  69. /// See hkResource::getContentsPointer(const char*, const hkTypeInfoRegistry*) method for details.
  70. template<typename T>
  71. T* getContents() const;
  72. /// Return the top level object type name.
  73. virtual const char* getContentsTypeName() const = 0;
  74. };
  75. #include<Common/Serialize/Resource/hkResource.inl>
  76. #endif // HK_SERIALIZE_RESOURCE_H
  77. /*
  78. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  79. * Confidential Information of Havok.  (C) Copyright 1999-2009
  80. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  81. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  82. * rights, and intellectual property rights in the Havok software remain in
  83. * Havok and/or its suppliers.
  84. * Use of this software for evaluation purposes is subject to and indicates
  85. * acceptance of the End User licence Agreement for this product. A copy of
  86. * the license is included with this software and is also available at www.havok.com/tryhavok.
  87. */