Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Chaos > Chaos > FPBDJointConstraints

Light Theme

Dark Theme

FPBDJointConstraints

A joint restricting up to 6 degrees of freedom, with linear and angular limits.

Windows

MacOS

Linux

Inheritance Hierarchy

FPBDConstraintContainer

FPBDJointConstraints

References

Module	Chaos
Header	/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDJointConstraints.h
Include	#include "Chaos/PBDJointConstraints.h"

Syntax

class FPBDJointConstraints : public Chaos::FPBDConstraintContainer

Remarks

A joint restricting up to 6 degrees of freedom, with linear and angular limits.

Constructors

	Name	Description
	FPBDJointConstraints ( const FPBDJointSolverSettings& InS... )

Destructors

	Name	Description
	~FPBDJointConstraints()

Functions

	Name	Description
FConstraintC...	AddConstraint ( const FParticlePair& InConstrained..., const FTransformPair& ConstraintFr..., const FPBDJointSettings& InConstra... )	Add a constraint with particle-space constraint offsets.
FConstraintC...	AddConstraint ( const FParticlePair& InConstrained..., const FTransformPair& ConstraintFr... )	Add a constraint with particle-space constraint offsets.
FConstraintC...	AddConstraint ( const FParticlePair& InConstrained..., const FRigidTransform3& WorldConst... )	Add a constraint with particle-space constraint offsets.
bool	Apply ( const FReal Dt, const TArray< FConstraintContainerH..., const int32 It, const int32 NumIts )	Island Rule API
bool	Apply ( const FReal Dt, const int32 It, const int32 NumIts )	Simple Rule API
bool	ApplyPushOut ( const FReal Dt, const TArray< FConstraintContainerH..., const int32 It, const int32 NumIts )	Simple Rule API
bool	ApplyPushOut ( const FReal Dt, const int32 It, const int32 NumIts )	Simple Rule API
void	ClearPostApplyCallback()
void	ClearPostProjectCallback()
void	ClearPreApplyCallback()
const FHandl...	GetConstConstraintHandles()
const FParti...	GetConstrainedParticles ( int32 ConstraintIndex )	Get the particles that are affected by the specified constraint.
const FConst...	GetConstraintHandle ( int32 ConstraintIndex )
FConstraintC...	GetConstraintHandle ( int32 ConstraintIndex )
FHandles &	GetConstraintHandles()	Constraint API
int32	GetConstraintLevel ( int32 ConstraintIndex )
const FPBDJo...	GetConstraintSettings ( int32 ConstraintIndex )
const FPBDJo...	GetSettings()
int32	NumConstraints()	Constraint Container API Get the number of constraints.
void	PrepareConstraints ( FReal Dt )	General Rule API
void	RemoveConstraint ( int ConstraintIndex )	Remove the specified constraint.
void	RemoveConstraints ( const TSet< TGeometryParticleHandle... )
void	SetConstraintSettings ( int32 ConstraintIndex, const FPBDJointSettings& InConstra... )
void	SetNumPairIterations ( const int32 NumPairIterationss )
void	SetNumPushOutPairIterations ( const int32 NumPairIterationss )
void	SetParticleLevels ( int32 ConstraintIndex, const TVector< int32, 2 >& Particl... )
void	SetPostApplyCallback ( const FJointPostApplyCallback& Cal... )
void	SetPostProjectCallback ( const FJointPostApplyCallback& Cal... )
void	SetPreApplyCallback ( const FJointPostApplyCallback& Cal... )
void	SetSettings ( const FPBDJointSolverSettings& InS... )
void	UnprepareConstraints ( FReal Dt )
void	UpdatePositionBasedState ( const FReal Dt )

Typedefs

Name	Description
Base
FConstraintContainerHandle
FConstraintHandleAllocator
FHandles
FParticlePair
FTransformPair
FVectorPair

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss