Point constraint settings, used to create a point constraint. More...

#include <PointConstraint.h>

Inheritance diagram for PointConstraintSettings:

Public Member Functions
virtual void	SaveBinaryState (StreamOut &inStream) const override
	Saves the contents of the constraint settings in binary form to inStream.

virtual TwoBodyConstraint *	Create (Body &inBody1, Body &inBody2) const override
	Create an instance of this constraint.

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

RefTarget &	operator= (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

Public Attributes
EConstraintSpace	mSpace = EConstraintSpace::WorldSpace
	This determines in which space the constraint is setup, all properties below should be in the specified space.

RVec3	mPoint1 = RVec3::sZero()
	Body 1 constraint position (space determined by mSpace).

RVec3	mPoint2 = RVec3::sZero()

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
virtual void	RestoreBinaryState (StreamIn &inStream) override
	This function should not be called directly, it is used by sRestoreFromBinaryState.

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.

Protected Attributes inherited from RefTarget< ConstraintSettings >
atomic< uint32 >	mRefCount
	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

Point constraint settings, used to create a point constraint.

Member Function Documentation

◆ Create()

TwoBodyConstraint * PointConstraintSettings::Create	(	Body &	inBody1,
		Body &	inBody2 ) const

overridevirtual

Create an instance of this constraint.

Implements TwoBodyConstraintSettings.

◆ RestoreBinaryState()

void PointConstraintSettings::RestoreBinaryState ( StreamIn & inStream )

overrideprotectedvirtual

This function should not be called directly, it is used by sRestoreFromBinaryState.

Reimplemented from ConstraintSettings.

◆ SaveBinaryState()

void PointConstraintSettings::SaveBinaryState ( StreamOut & inStream ) const

overridevirtual

Saves the contents of the constraint settings in binary form to inStream.

Reimplemented from ConstraintSettings.

Member Data Documentation

◆ mPoint1

RVec3 PointConstraintSettings::mPoint1 = RVec3::sZero()

Body 1 constraint position (space determined by mSpace).

◆ mPoint2

RVec3 PointConstraintSettings::mPoint2 = RVec3::sZero()

Body 2 constraint position (space determined by mSpace). Note: Normally you would set mPoint1 = mPoint2 if the bodies are already placed how you want to constrain them (if mSpace = world space).

◆ mSpace

EConstraintSpace PointConstraintSettings::mSpace = EConstraintSpace::WorldSpace

This determines in which space the constraint is setup, all properties below should be in the specified space.

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

Jolt/Physics/Constraints/PointConstraint.h
Jolt/Physics/Constraints/PointConstraint.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members