Browse Source

bullet: document that sweep_test_closest is convex-only in API ref

Closes #356
rdb 7 years ago
parent
commit
b0bbc66f06
1 changed files with 3 additions and 1 deletions
  1. 3 1
      panda/src/bullet/bulletWorld.cxx

+ 3 - 1
panda/src/bullet/bulletWorld.cxx

@@ -947,7 +947,9 @@ ray_test_all(const LPoint3 &from_pos, const LPoint3 &to_pos, const CollideMask &
 }
 }
 
 
 /**
 /**
- *
+ * Performs a sweep test against all other shapes that match the given group
+ * mask.  The provided shape must be a convex shape; it is an error to invoke
+ * this method using a non-convex shape.
  */
  */
 BulletClosestHitSweepResult BulletWorld::
 BulletClosestHitSweepResult BulletWorld::
 sweep_test_closest(BulletShape *shape, const TransformState &from_ts, const TransformState &to_ts, const CollideMask &mask, PN_stdfloat penetration) const {
 sweep_test_closest(BulletShape *shape, const TransformState &from_ts, const TransformState &to_ts, const CollideMask &mask, PN_stdfloat penetration) const {