Home Explore Help
Sign In
cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Explicitly marking some classes as internal to avoid confusion

See e.g. #1759
Jorrit Rouwe 1 week ago
parent
585532501d
commit
b1e5153f78
10 changed files with 35 additions and 4 deletions
Split View Show Diff Stats
  1. 6 2
      Jolt/Physics/Body/BodyManager.cpp
  2. 3 0
      Jolt/Physics/Body/BodyManager.h
  3. 5 1
      Jolt/Physics/Constraints/CalculateSolverSteps.h
  4. 3 0
      Jolt/Physics/Constraints/ConstraintManager.h
  5. 3 0
      Jolt/Physics/Constraints/ContactConstraintManager.h
  6. 2 0
      Jolt/Physics/IslandBuilder.h
  7. 2 0
      Jolt/Physics/LargeIslandSplitter.h
  8. 2 0
      Jolt/Physics/PhysicsUpdateContext.cpp
  9. 5 1
      Jolt/Physics/PhysicsUpdateContext.h
  10. 4 0
      Jolt/Physics/SoftBody/SoftBodyUpdateContext.h

+ 6 - 2
Jolt/Physics/Body/BodyManager.cpp
View File 

@@ -47,7 +47,8 @@ JPH_NAMESPACE_BEGIN
 
 	}
 
 #endif
 
 
-// Helper class that combines a body and its motion properties
 
+/// @cond INTERNAL
 
+/// Helper class that combines a body and its motion properties
 
 class BodyWithMotionProperties : public Body
 
 {
 
 public:
 
@@ -55,8 +56,10 @@ public:
 
 
 	MotionProperties			mMotionProperties;
 
 };
 
+/// @endcond
 
 
-// Helper class that combines a soft body its motion properties and shape
 
+/// @cond INTERNAL
 
+/// Helper class that combines a soft body its motion properties and shape
 
 class SoftBodyWithMotionPropertiesAndShape : public Body
 
 {
 
 public:
 
@@ -68,6 +71,7 @@ public:
 
 	SoftBodyMotionProperties	mMotionProperties;
 
 	SoftBodyShape				mShape;
 
 };
 
+/// @endcond
 
 
 inline void BodyManager::sDeleteBody(Body *inBody)
 
 {

+ 3 - 0
Jolt/Physics/Body/BodyManager.h
View File 

@@ -40,6 +40,9 @@ using BodyVector = Array<Body *>;
 
 using BodyIDVector = Array<BodyID>;
 
 
 /// Class that contains all bodies
 
+///
 
+/// WARNING: This class is an internal part of PhysicsSystem, it has no functions that can be called by users of the library.
 
+/// Its functionality is exposed through PhysicsSystem, BodyInterface, BodyLockRead and BodyLockWrite.
 
 class JPH_EXPORT BodyManager : public NonCopyable
 
 {
 
 public:

+ 5 - 1
Jolt/Physics/Constraints/CalculateSolverSteps.h
View File 

@@ -8,7 +8,8 @@
 
 
 JPH_NAMESPACE_BEGIN
 
 
-/// Class used to calculate the total number of velocity and position steps
 
+/// @cond INTERNAL
 
+/// Internal class used to calculate the total number of velocity and position steps
 
 class CalculateSolverSteps
 
 {
 
 public:
 
@@ -51,7 +52,9 @@ private:
 
 	bool						mApplyDefaultVelocity = false;
 
 	bool						mApplyDefaultPosition = false;
 
 };
 
+/// @endcond
 
 
+/// @cond INTERNAL
 
 /// Dummy class to replace the steps calculator when we don't need the result
 
 class DummyCalculateSolverSteps
 
 {
 
@@ -62,5 +65,6 @@ public:
 
 		/* Nothing to do */
 
 	}
 
 };
 
+/// @endcond
 
 
 JPH_NAMESPACE_END

+ 3 - 0
Jolt/Physics/Constraints/ConstraintManager.h
View File 

@@ -21,6 +21,9 @@ class DebugRenderer;
 
 using Constraints = Array<Ref<Constraint>>;
 
 
 /// A constraint manager manages all constraints of the same type
 
+///
 
+/// WARNING: This class is an internal part of PhysicsSystem, it has no functions that can be called by users of the library.
 
+/// Its functionality is exposed through PhysicsSystem and BodyInterface.
 
 class JPH_EXPORT ConstraintManager : public NonCopyable
 
 {
 
 public:

+ 3 - 0
Jolt/Physics/Constraints/ContactConstraintManager.h
View File 

@@ -24,6 +24,9 @@ JPH_NAMESPACE_BEGIN
 
 struct PhysicsSettings;
 
 class PhysicsUpdateContext;
 
 
+/// A contact constraint manager manages all contacts between two bodies
 
+///
 
+/// WARNING: This class is an internal part of PhysicsSystem, it has no functions that can be called by users of the library.
 
 class JPH_EXPORT ContactConstraintManager : public NonCopyable
 
 {
 
 public:

+ 2 - 0
Jolt/Physics/IslandBuilder.h
View File 

@@ -15,6 +15,8 @@ class TempAllocator;
 
 //#define JPH_VALIDATE_ISLAND_BUILDER
 
 
 /// Keeps track of connected bodies and builds islands for multithreaded velocity/position update
 
+///
 
+/// WARNING: This class is an internal part of PhysicsSystem, it has no functions that can be called by users of the library.
 
 class IslandBuilder : public NonCopyable
 
 {
 
 public:

+ 2 - 0
Jolt/Physics/LargeIslandSplitter.h
View File 

@@ -21,6 +21,8 @@ class CalculateSolverSteps;
 
 ///
 
 /// This basically implements what is described in: High-Performance Physical Simulations on Next-Generation Architecture with Many Cores by Chen et al.
 
 /// See: http://web.eecs.umich.edu/~msmelyan/papers/physsim_onmanycore_itj.pdf section "PARALLELIZATION METHODOLOGY"
 
+///
 
+/// WARNING: This class is an internal part of PhysicsSystem, it has no functions that can be called by users of the library.
 
 class LargeIslandSplitter : public NonCopyable
 
 {
 
 private:

+ 2 - 0
Jolt/Physics/PhysicsUpdateContext.cpp
View File 

@@ -8,6 +8,7 @@
 
 
 JPH_NAMESPACE_BEGIN
 
 
+/// @cond INTERNAL
 
 PhysicsUpdateContext::PhysicsUpdateContext(TempAllocator &inTempAllocator) :
 
 	mTempAllocator(&inTempAllocator),
 
 	mSteps(inTempAllocator)
 
@@ -19,5 +20,6 @@ PhysicsUpdateContext::~PhysicsUpdateContext()
 
 	JPH_ASSERT(mBodyPairs == nullptr);
 
 	JPH_ASSERT(mActiveConstraints == nullptr);
 
 }
 
+/// @endcond
 
 
 JPH_NAMESPACE_END

+ 5 - 1
Jolt/Physics/PhysicsUpdateContext.h
View File 

@@ -19,7 +19,10 @@ class Constraint;
 
 class TempAllocator;
 
 class SoftBodyUpdateContext;
 
 
-/// Information used during the Update call
 
+/// @cond INTERNAL
 
+/// Internal information used during the PhysicsSystem::Update call
 
+///
 
+/// WARNING: This class is an internal part of PhysicsSystem, it has no functions that can be called by users of the library.
 
 class PhysicsUpdateContext : public NonCopyable
 
 {
 
 public:
 
@@ -168,5 +171,6 @@ public:
 
 	SoftBodyUpdateContext *	mSoftBodyUpdateContexts = nullptr;						///< Contexts for updating soft bodies
 
 	atomic<uint>			mSoftBodyToCollide { 0 };								///< Next soft body to take when running SoftBodyCollide jobs
 
 };
 
+/// @endcond
 
 
 JPH_NAMESPACE_END

+ 4 - 0
Jolt/Physics/SoftBody/SoftBodyUpdateContext.h
View File 

@@ -14,7 +14,10 @@ class SoftBodyMotionProperties;
 
 class SoftBodyContactListener;
 
 class SimShapeFilter;
 
 
+/// @cond INTERNAL
 
 /// Temporary data used by the update of a soft body
 
+///
 
+/// WARNING: This class is an internal part of PhysicsSystem, it has no functions that can be called by users of the library.
 
 class SoftBodyUpdateContext : public NonCopyable
 
 {
 
 public:
 
@@ -55,5 +58,6 @@ public:
 
 	Vec3								mDeltaPosition;								///< Delta position of the body in the current time step, should be applied after the update
 
 	ECanSleep							mCanSleep;									///< Can the body sleep? Should be applied after the update
 
 };
 
+/// @endcond
 
 
 JPH_NAMESPACE_END