Gear constraint settings. More...

#include <GearConstraint.h>

Inheritance diagram for GearConstraintSettings:

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.

void	SetRatio (int inNumTeethGear1, int inNumTeethGear2)

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.

Vec3	mHingeAxis1 = Vec3::sAxisX()
	Body 1 constraint reference frame (space determined by mSpace).

Vec3	mHingeAxis2 = Vec3::sAxisX()
	Body 2 constraint reference frame (space determined by mSpace)

float	mRatio = 1.0f
	Ratio between both gears, see SetRatio.

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

Gear constraint settings.

Member Function Documentation

◆ Create()

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

overridevirtual

Create an instance of this constraint.

Implements TwoBodyConstraintSettings.

◆ RestoreBinaryState()

void GearConstraintSettings::RestoreBinaryState ( StreamIn & inStream )

overrideprotectedvirtual

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

Reimplemented from ConstraintSettings.

◆ SaveBinaryState()

void GearConstraintSettings::SaveBinaryState ( StreamOut & inStream ) const

overridevirtual

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

Reimplemented from ConstraintSettings.

◆ SetRatio()

void GearConstraintSettings::SetRatio	(	int	inNumTeethGear1,
		int	inNumTeethGear2 )

inline

Defines the ratio between the rotation of both gears The ratio is defined as: Gear1Rotation(t) = -ratio * Gear2Rotation(t)

Parameters

inNumTeethGear1	Number of teeth that body 1 has
inNumTeethGear2	Number of teeth that body 2 has

Member Data Documentation

◆ mHingeAxis1

Vec3 GearConstraintSettings::mHingeAxis1 = Vec3::sAxisX()

Body 1 constraint reference frame (space determined by mSpace).

◆ mHingeAxis2

Vec3 GearConstraintSettings::mHingeAxis2 = Vec3::sAxisX()

Body 2 constraint reference frame (space determined by mSpace)

◆ mRatio

float GearConstraintSettings::mRatio = 1.0f

Ratio between both gears, see SetRatio.

◆ mSpace

EConstraintSpace GearConstraintSettings::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/GearConstraint.h
Jolt/Physics/Constraints/GearConstraint.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members