Explorar el Código

Added some documentation pointing towards various internal debug drawing options

See #1804
Jorrit Rouwe hace 4 semanas
padre
commit
4f81b8d6f3
Se han modificado 1 ficheros con 10 adiciones y 0 borrados
  1. 10 0
      Jolt/Physics/Body/BodyManager.h

+ 10 - 0
Jolt/Physics/Body/BodyManager.h

@@ -230,6 +230,16 @@ public:
 	};
 
 	/// Draw settings
+	///
+	/// Note that there are several debug drawing features that are not exposed through this interface since they use information
+	/// that is only available deep inside the simulation update and are mostly there to facilitate debugging Jolt. These options
+	/// use DebugRenderer::sInstance to draw.
+	///
+	/// E.g.:
+	/// * To draw contact information, use ContactConstraintManager::sDrawContactManifolds.
+	/// * To draw when continuous collision detection is used, use PhysicsSystem::sDrawMotionQualityLinearCast.
+	/// * To draw what's going on in a CharacterVirtual update, use CharacterVirtual::sDrawConstraints, CharacterVirtual::sDrawWalkStairs and CharacterVirtual::sDrawStickToFloor.
+	/// * To draw the volume of water that interacts with a shape, use Shape::sDrawSubmergedVolumes.
 	struct DrawSettings
 	{
 		bool						mDrawGetSupportFunction = false;				///< Draw the GetSupport() function, used for convex collision detection