hkpAction.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_DYNAMICS2_ACTION_H
  9. #define HK_DYNAMICS2_ACTION_H
  10. #include <Common/Base/hkBase.h>
  11. #include <Physics/Dynamics/Entity/hkpEntityListener.h>
  12. class hkpEntity;
  13. class hkpPhantom;
  14. class hkpSimulationIsland;
  15. class hkStepInfo;
  16. class hkpWorld;
  17. extern const hkClass hkpActionClass;
  18. /// This is the base class from which user actions (or controllers) are derived. Actions 
  19. /// are the interface between user controllable behavior of the physical simulation and the Havok core. 
  20. class hkpAction : public hkReferencedObject
  21. {
  22. public:
  23. // +hk.ModelerNodeType("LOCATOR")
  24. HK_DECLARE_REFLECTION();
  25. HK_DECLARE_CLASS_ALLOCATOR(HK_MEMORY_CLASS_ACTION);
  26. /// Default constructor
  27. inline hkpAction(hkUlong userData);
  28. /// Virtual Destructor.
  29. virtual ~hkpAction() { }
  30. /// The applyAction() method does the actual work of the action, and is called at every simulation step.
  31. virtual void applyAction( const hkStepInfo& stepInfo ) = 0;
  32. /// This method is used to maintain simulation islands.
  33. /// An action that requires that the entities it operates on are simulated together
  34. /// must return these entities in this function call. See the hkpBinaryAction 
  35. /// implementation for an example.
  36. virtual void getEntities( hkArray<hkpEntity*>& entitiesOut ) = 0;
  37. /// Get referenced phantoms. This is used in order to generically clone hkpAction objects
  38. /// that reference phantoms. This has a default implementation that returns no phantoms.
  39. virtual void getPhantoms( hkArray<hkpPhantom*>& phantomsOut ) {}
  40. /// Returns the hkpWorld that owns this action.
  41. inline hkpWorld* getWorld();
  42. // hkpEntityListener-like interface implementation
  43. virtual void entityRemovedCallback(hkpEntity* entity) = 0;
  44. /// Get the user data for the action
  45. inline hkUlong getUserData() const;
  46. /// Set the user data of the action.
  47. inline void setUserData( hkUlong data );
  48. /// Get the name of this action.
  49. inline const char* getName() const;
  50. /// Set the name of this action.
  51. /// IMPORTANT: This data will not be cleaned up by the hkpAction destructor. You are required to track it yourself.
  52. inline void setName( const char* name );
  53. /// In order to clone an action, with a varying number of dependant rigid bodies
  54. /// that you would like to repoint the clone at (and null the world ptr etc)
  55. /// we provide a list of entities, in the same order as given by getEntities()
  56. /// that are the new cloned bodies to use in the process.
  57. /// We also provide a list of phantoms. Actions do not generally reference phantoms,
  58. /// but there are exceptions, as in the case of hkpVehicleInstance.
  59. virtual hkpAction* clone( const hkArray<hkpEntity*>& newEntities, const hkArray<hkpPhantom*>& newPhantoms ) const = 0;
  60. private:
  61. hkpWorld* m_world; //+nosave
  62. hkpSimulationIsland* m_island; //+nosave
  63. protected:
  64. hkUlong m_userData; // +default(0)
  65. const char* m_name;
  66. friend class hkpWorld;
  67. friend class hkpWorldOperationUtil;
  68. friend class hkpSimulationIsland;
  69. //
  70. // Internal methods
  71. //
  72. public:
  73. // Gets the simulation island to which the action belongs.
  74. inline hkpSimulationIsland* getSimulationIsland();
  75. public:
  76. // Sets the simulation island.
  77. inline void setSimulationIsland(hkpSimulationIsland* island);
  78. // Sets the hkpWorld that owns this action.
  79. inline void setWorld( hkpWorld* owner );
  80. public:
  81. hkpAction( class hkFinishLoadedObjectFlag flag ) : hkReferencedObject(flag) {}
  82. };
  83. #include <Physics/Dynamics/Action/hkpAction.inl>
  84. #endif // HK_DYNAMICS2_ACTION_H
  85. /*
  86. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  87. * Confidential Information of Havok.  (C) Copyright 1999-2009
  88. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  89. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  90. * rights, and intellectual property rights in the Havok software remain in
  91. * Havok and/or its suppliers.
  92. * Use of this software for evaluation purposes is subject to and indicates
  93. * acceptance of the End User licence Agreement for this product. A copy of
  94. * the license is included with this software and is also available at www.havok.com/tryhavok.
  95. */