Browse Source

Added documentation

Jorrit Rouwe 1 year ago
parent
commit
dc0f9c180f
1 changed files with 7 additions and 0 deletions
  1. 7 0
      Jolt/Physics/Constraints/PathConstraint.h

+ 7 - 0
Jolt/Physics/Constraints/PathConstraint.h

@@ -26,6 +26,13 @@ enum class EPathRotationConstraintType
 };
 
 /// Path constraint settings, used to constrain the degrees of freedom between two bodies to a path
+///
+/// The requirements of the path are that:
+/// * Tangent, normal and bi-normal form an orthonormal basis with: tangent cross bi-normal = normal
+/// * The path points along the tangent vector
+/// * The path is continuous so doesn't contain any sharp corners
+/// 
+/// The reason for all this is that the constraint acts like a slider constraint with the sliding axis being the tangent vector (the assumption here is that delta time will be small enough so that the path is linear for that delta time).
 class JPH_EXPORT PathConstraintSettings final : public TwoBodyConstraintSettings
 {
 public: