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

其他游戏

开发平台:

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_COLLIDE2_CYLINDER_SHAPE_H
  9. #define HK_COLLIDE2_CYLINDER_SHAPE_H
  10. #include <Physics/Collide/Shape/Convex/hkpConvexShape.h>
  11. extern const hkClass hkpCylinderShapeClass;
  12. /// A cylinder defined by two points and a radius.
  13. /// The points define the centers of the circular ends of the cylinder.
  14. ///
  15. /// hkpCylinderShape is not modeled as an implicit geometry (hkpSphereShape and hkpCapsuleShape are implicitly modeled).
  16. /// hkpCylinderShape is represented by vertices generated on the cylinder's surface. Those vertices
  17. /// are efficiently generated on-the-fly, and do not take up extra memory.
  18. /// They are referred to as being virtual.
  19. ///
  20. /// This virtual tessellation causes instability in collision response. For that reason
  21. /// hkpCylinderShape uses a specialized collision agent, hkPredGskCylinderAgent3.
  22. /// hkPredGskCylinderAgent3 uses an implicit capsule representation
  23. /// when the cylinder lies on its side or rolls on a flat surface.
  24. /// There is a simple mechanism that checks the cylinder's axis angle with the contact normal,
  25. /// once the angle passes a specified threshold, the object's representation is altered.
  26. ///
  27. /// As hkPredGskCylinderAgent3 alters the geometrical representation of the cylinder, it reduces the contact information
  28. /// and this reduction may result in objects tunneling through each other. In a test where a 1cm-radius cylinder collided against
  29. /// a triangle, and the cylinder was constantly pushed towards the triangle's surface with very high impulses,
  30. /// the cylinder tunneled through after a few seconds of simulation. Generally, under 'normal' conditions, the hkPredGskCylinderAgent3
  31. /// yields stable results.
  32. ///
  33. /// hkPredGskCylinderAgent3 is not used when an hkpCylinderShape is enclosed in an hkpShapeCollection
  34. /// hierarchy e.g. when an hkpCylinderShape is part of an hkpListShape.
  35. ///
  36. /// A problem + work-around for such cases:
  37. ///
  38. /// hkpCylinderShape is tessellated, not implicit like hkpSphereShape or hkpCapsuleShape. This leads
  39. /// to an issue with cylinders rolling on their sides which may cause them to penetrate other
  40. /// objects or have incorrect momentum properties. To work around this problem, use a list
  41. /// shape consisting of an hkpCylinderShape and an hkpCapsuleShape. The hkpCylinderShape ensures
  42. /// that the list shape can stand on its ends. The hkpCapsuleShape ensures that the list
  43. /// shape rolls properly. You will want to use a minimally tessellated cylinder sub-shape.
  44. ///
  45. /// Note that this workaround does not work for cylinders that are flat e.g. coins. In these
  46. /// cases the capsule ends protrude from the faces of the coin.
  47. ///
  48. /// Remember to disable hkPredGskCylinderAgent3 if you want to use this workaround for all cases.
  49. ///
  50. /// You can vary the tessellation of cylinders by calling hkpCylinderShape::setNumberOfSideSegments().
  51. /// This indicates how many facets should make up the round side of the cylinder (see the function's description).
  52. ///
  53. /// N.B. Changing this parameter affects ALL hkCylinderShapes. It should only be changed
  54. /// before creating the world. Changing it with hkCylinderShapes in the world can cause an assert in the
  55. /// convex collision agent.
  56. class hkpCylinderShape : public hkpConvexShape
  57. {
  58. public:
  59. HK_DECLARE_REFLECTION();
  60. HK_DECLARE_GET_SIZE_FOR_SPU(hkpCylinderShape);
  61. /// Creates a new hkpCylinderShape using the specified points and radius
  62. hkpCylinderShape( const hkVector4& vertexA,
  63. const hkVector4& vertexB,
  64. hkReal cylinderRadius,
  65. hkReal paddingRadius = hkConvexShapeDefaultRadius );
  66. /// Gets the pointer to the first vertex. This casts the corresponding hkSphere (m_vertexA) to a hkVector4*.
  67. /// You can then index by 0 or 1, to get the first or second vertex respectively.
  68. inline const hkVector4* getVertices() const;
  69. /// Gets a vertex given an index "i". "i" can be 0 or 1. This casts the corresponding hkSphere to a hkVector4.
  70. HK_FORCE_INLINE const hkVector4& getVertex(int i) const;
  71. /// Sets a vertex given an index "i". "i" can be 0 or 1.
  72. HK_FORCE_INLINE void setVertex(int i, const hkVector4& position );
  73. /// Returns cylinder radius (don't use getRadius)
  74. hkReal getCylinderRadius() const;
  75. /// Returns cylinder radius (don't use setRadius)
  76. void setCylinderRadius(const hkReal radius);
  77. /// Tells by how much the spheres representing the circumference of each of the
  78. /// cylinder's basis are moved towards the cylinder's axis of symmetry.
  79. ///
  80. /// This is only used for collisions against heightfield.
  81. ///
  82. /// When colliding against a heightfield, the sphere representation of the shape is used.
  83. /// The cylinder shape is represented by 16 spheres distributed uniformly on the basis (8 spheres/per base)
  84. /// and two extra spheres -- one in the center of each base. They all have the radius of equal to the
  85. /// bounding m_radius of the shape.
  86. ///
  87. /// If the cylinder is long enough to fit a sphere with the radius equal to the radius of the cylinder
  88. /// (i.e. e.g. not in the case of a coin), than the two spheres in the centers of the bases are 'blown up'.
  89. /// Their radius is equal to the radius of the cylinder (i.e. equal to m_cylRadius + m_radius), and their centers
  90. /// are moved inwards just enough that they don't stick out of the cylinder.
  91. /// Those large spheres allow better rolling behavior.
  92. ///
  93. /// The cylinder-base-radius factor is useful when a cylinder rolls over an uneven landscape heightfield.
  94. /// In such cases, due to the landscape's curvature, the cylinder may easily rest on
  95. /// the edges of its basis. This will make it harder to roll (because the two large spheres
  96. /// used for rolling are not toughing the landscape, and the base edge's representation uses
  97. /// only 8 spheres).
  98. ///
  99. /// Meaning of the parameter's value:
  100. /// Factor of 1.0f means that the spheres are not moved.
  101. /// Factor of 0.0f means that all the spheres representing a base are moved
  102. /// onto the symmetry axis of the cylinder (effectively converting the cylinder
  103. /// The spheres are only shifted in the plane perpendicular to the cylinder's axis.
  104. hkReal getCylinderBaseRadiusFactorForHeightfieldCollisions(hkReal radiusFactor) { return m_cylBaseRadiusFactorForHeightFieldCollisions; }
  105. /// Tells by how much the spheres representing the circumference of each of the
  106. /// cylinder's basis are moved towards the axis.
  107. ///
  108. /// See hkReal getCylinderBaseRadiusFactorForSphereCollisionInfo(hkReal radiusFactor) for
  109. /// detailed info.
  110. inline void setCylinderBaseRadiusFactorForHeightfieldCollisions(hkReal radiusFactor) { m_cylBaseRadiusFactorForHeightFieldCollisions = radiusFactor; }
  111. //
  112. // hkpConvexShape implementation
  113. //
  114. // hkpConvexShape::getSupportingVertex() interface implementation.
  115. HKP_SHAPE_VIRTUAL void getSupportingVertexImpl( HKP_SHAPE_VIRTUAL_THIS hkVector4Parameter direction, hkpCdVertex& supportingVertexOut ) HKP_SHAPE_VIRTUAL_CONST;
  116. // hkpConvexShape interface implementation.
  117. HKP_SHAPE_VIRTUAL void convertVertexIdsToVerticesImpl( HKP_SHAPE_VIRTUAL_THIS const hkpVertexId* ids, int numIds, hkpCdVertex* verticesOut) HKP_SHAPE_VIRTUAL_CONST;
  118. // hkpConvexShape interface implementation.
  119. HKP_SHAPE_VIRTUAL void getCentreImpl( HKP_SHAPE_VIRTUAL_THIS hkVector4& centreOut ) HKP_SHAPE_VIRTUAL_CONST;
  120. //
  121. // hkpSphereRepShape implementation
  122. //
  123. // hkpSphereRepShape interface implementation.
  124. HKP_SHAPE_VIRTUAL int getNumCollisionSpheresImpl( HKP_SHAPE_VIRTUAL_THIS2 ) HKP_SHAPE_VIRTUAL_CONST;
  125. // hkpSphereRepShape interface implementation.
  126. HKP_SHAPE_VIRTUAL const hkSphere* getCollisionSpheresImpl( HKP_SHAPE_VIRTUAL_THIS hkSphere* sphereBuffer ) HKP_SHAPE_VIRTUAL_CONST;
  127. //
  128. // hkpShape implementation
  129. //
  130. // hkpShape interface implementation.
  131. HKP_SHAPE_VIRTUAL void getAabbImpl( HKP_SHAPE_VIRTUAL_THIS const hkTransform& localToWorld, hkReal tolerance, hkAabb& out ) HKP_SHAPE_VIRTUAL_CONST;
  132. // hkpShape interface implementation.
  133. HKP_SHAPE_VIRTUAL hkBool castRayImpl( HKP_SHAPE_VIRTUAL_THIS const hkpShapeRayCastInput& input, hkpShapeRayCastOutput& results) HKP_SHAPE_VIRTUAL_CONST;
  134. // hkpConvexShape interface implementation.
  135. /// Returns the first vertex of this shape. This is only used for initialization of collision detection data.
  136. virtual void getFirstVertex(hkVector4& v) const;
  137. //
  138. // hkpShape implementation
  139. //
  140. /// Returns a struct of function pointers needed by the SPU
  141. static void HK_CALL registerSimulationFunctions( ShapeFuncs& sf );
  142. /// Returns a struct of function pointers needed by the SPU
  143. static void HK_CALL registerCollideQueryFunctions( ShapeFuncs& sf );
  144. /// Returns a struct of function pointers needed by the SPU
  145. static void HK_CALL registerRayCastFunctions( ShapeFuncs& sf );
  146. /// Returns a struct of function pointers needed by the SPU
  147. static void HK_CALL registerGetAabbFunction( ShapeFuncs& sf );
  148.         virtual void calcContentStatistics( hkStatisticsCollector* collector, const hkClass* cls) const;
  149. /// Sets the number of side segments (facets) for the cylinder. This parameter is set globally for all cylinders.
  150. /// Note that virtual tessellation is not uniform.
  151. /// Input value is rounded down to a multiple of 8. Values between 8 and 128 are accepted.
  152. static void HK_CALL setNumberOfVirtualSideSegements(int numSegments);
  153. public:
  154. /// Returns a unit vector perpendicular to the axis of the cylinder.
  155. void presetPerpendicularVector();
  156. private:
  157. HK_FORCE_INLINE static void HK_CALL initRoundUpThreshold();
  158. HK_FORCE_INLINE // don't inline on an spu
  159. void decodeVertexId(hkpVertexId code, hkVector4& result) const;
  160. protected:
  161. // The cylinder's radius (as opposed to the bounding volume radius associated with hkpConvexShape
  162. hkReal    m_cylRadius;
  163. hkReal m_cylBaseRadiusFactorForHeightFieldCollisions; //+default(0.8f)
  164. // The line's first point.
  165. hkVector4 m_vertexA;
  166. // The line's second point.
  167. hkVector4 m_vertexB;
  168. // Arbitrary vector perpendicular to the axis
  169. hkVector4 m_perpendicular1;
  170. hkVector4 m_perpendicular2;
  171. public:
  172. hkpCylinderShape( hkFinishLoadedObjectFlag flag );
  173. enum VertexIdEncoding
  174. {
  175. VERTEX_ID_ENCODING_IS_BASE_A_SHIFT     = 7,
  176. VERTEX_ID_ENCODING_SIN_SIGN_SHIFT      = 6,
  177. VERTEX_ID_ENCODING_COS_SIGN_SHIFT      = 5,
  178. VERTEX_ID_ENCODING_IS_SIN_LESSER_SHIFT = 4,
  179. VERTEX_ID_ENCODING_VALUE_MASK          = 0x0f
  180. };
  181. private:
  182. static hkReal s_virtualTesselationParameter;
  183. static hkReal s_virtualTesselationParameterInv;
  184. static hkReal s_intRoundUpThreshold;
  185. };
  186. #include <Physics/Collide/Shape/Convex/Cylinder/hkpCylinderShape.inl>
  187. #endif // HK_COLLIDE2_CYLINDER_SHAPE_H
  188. /*
  189. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  190. * Confidential Information of Havok.  (C) Copyright 1999-2009
  191. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  192. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  193. * rights, and intellectual property rights in the Havok software remain in
  194. * Havok and/or its suppliers.
  195. * Use of this software for evaluation purposes is subject to and indicates
  196. * acceptance of the End User licence Agreement for this product. A copy of
  197. * the license is included with this software and is also available at www.havok.com/tryhavok.
  198. */