Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
TwoBodyConstraintSettings Class Referenceabstract

Base class for settings for all constraints that involve 2 bodies. More...

#include <TwoBodyConstraint.h>

Inheritance diagram for TwoBodyConstraintSettings:
ConstraintSettings SerializableObject RefTarget< ConstraintSettings > NonCopyable ConeConstraintSettings DistanceConstraintSettings FixedConstraintSettings GearConstraintSettings HingeConstraintSettings PathConstraintSettings PointConstraintSettings PulleyConstraintSettings RackAndPinionConstraintSettings SixDOFConstraintSettings SliderConstraintSettings SwingTwistConstraintSettings

Public Member Functions

virtual TwoBodyConstraintCreate (Body &inBody1, Body &inBody2) const =0
 
- Public Member Functions inherited from ConstraintSettings
virtual void SaveBinaryState (StreamOut &inStream) const
 Saves the contents of the constraint settings in binary form to inStream.
 
- Public Member Functions inherited from SerializableObject
virtual ~SerializableObject ()=default
 Constructor.
 
- Public Member Functions inherited from NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
void operator= (const NonCopyable &)=delete
 
- Public Member Functions inherited from RefTarget< ConstraintSettings >
 RefTarget ()=default
 Constructor.
 
 RefTarget (const RefTarget &)
 
 ~RefTarget ()
 assert no one is referencing us
 
void SetEmbedded () const
 
RefTargetoperator= (const RefTarget &)
 Assignment operator.
 
uint32 GetRefCount () const
 Get current refcount of this object.
 
void AddRef () const
 Add or release a reference to this object.
 
void Release () const
 

Additional Inherited Members

- Public Types inherited from ConstraintSettings
using ConstraintResult = Result< Ref< ConstraintSettings > >
 
- Static Public Member Functions inherited from ConstraintSettings
static ConstraintResult sRestoreFromBinaryState (StreamIn &inStream)
 Creates a constraint of the correct type and restores its contents from the binary stream inStream.
 
- Static Public Member Functions inherited from RefTarget< ConstraintSettings >
static int sInternalGetRefCountOffset ()
 INTERNAL HELPER FUNCTION USED BY SERIALIZATION.
 
- Public Attributes inherited from ConstraintSettings
bool mEnabled = true
 If this constraint is enabled initially. Use Constraint::SetEnabled to toggle after creation.
 
uint32 mConstraintPriority = 0
 
uint mNumVelocityStepsOverride = 0
 Used only when the constraint is active. Override for the number of solver velocity iterations to run, 0 means use the default in PhysicsSettings::mNumVelocitySteps. The number of iterations to use is the max of all contacts and constraints in the island.
 
uint mNumPositionStepsOverride = 0
 Used only when the constraint is active. Override for the number of solver position iterations to run, 0 means use the default in PhysicsSettings::mNumPositionSteps. The number of iterations to use is the max of all contacts and constraints in the island.
 
float mDrawConstraintSize = 1.0f
 Size of constraint when drawing it through the debug renderer.
 
uint64 mUserData = 0
 User data value (can be used by application)
 
- Protected Member Functions inherited from ConstraintSettings
virtual void RestoreBinaryState (StreamIn &inStream)
 This function should not be called directly, it is used by sRestoreFromBinaryState.
 
- Protected Attributes inherited from RefTarget< ConstraintSettings >
atomic< uint32mRefCount
 Current reference count.
 
- Static Protected Attributes inherited from RefTarget< ConstraintSettings >
static constexpr uint32 cEmbedded
 A large value that gets added to the refcount to mark the object as embedded.
 

Detailed Description

Base class for settings for all constraints that involve 2 bodies.

Member Function Documentation

◆ Create()

virtual TwoBodyConstraint * TwoBodyConstraintSettings::Create ( Body inBody1,
Body inBody2 
) const
pure virtual

The documentation for this class was generated from the following file: