Browse Source

Documented that the points supplied don't need to be the convex hull vertices

See #1432
Jorrit Rouwe 6 months ago
parent
commit
15561f8491
1 changed files with 1 additions and 1 deletions
  1. 1 1
      Jolt/Physics/Collision/Shape/ConvexHullShape.h

+ 1 - 1
Jolt/Physics/Collision/Shape/ConvexHullShape.h

@@ -30,7 +30,7 @@ public:
 	// See: ShapeSettings
 	virtual ShapeResult		Create() const override;
 
-	Array<Vec3>				mPoints;															///< Points to create the hull from
+	Array<Vec3>				mPoints;															///< Points to create the hull from. Note that these points don't need to be the vertices of the convex hull, they can contain interior points or points on faces/edges.
 	float					mMaxConvexRadius = 0.0f;											///< Convex radius as supplied by the constructor. Note that during hull creation the convex radius can be made smaller if the value is too big for the hull.
 	float					mMaxErrorConvexRadius = 0.05f;										///< Maximum distance between the shrunk hull + convex radius and the actual hull.
 	float					mHullTolerance = 1.0e-3f;											///< Points are allowed this far outside of the hull (increasing this yields a hull with less vertices). Note that the actual used value can be larger if the points of the hull are far apart.