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 > FPBDSuspensionConstraints

Light Theme

Dark Theme

FPBDSuspensionConstraints

Windows

MacOS

Linux

Inheritance Hierarchy

FPBDConstraintContainer

FPBDSuspensionConstraints

References

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

Syntax

class FPBDSuspensionConstraints : public Chaos::FPBDConstraintContainer

Constructors

	Name	Description
	FPBDSuspensionConstraints ( const FPBDSuspensionSolverSettings ... )
	FPBDSuspensionConstraints ( TArray< FVec3 >&& Locations, TArray< TGeometryParticleHandle< FR..., TArray< FVec3 >&& InLocalOffset, TArray< FPBDSuspensionSettings >&&... )

Destructors

	Name	Description
	~FPBDSuspensionConstraints()

Functions

	Name	Description
FConstraintC...	AddConstraint ( TGeometryParticleHandle< FReal, 3 >..., const FVec3& InConstraintFrame, const FPBDSuspensionSettings& InCo... )	Add a constraint.
bool	Apply ( const FReal Dt, const TArray< FConstraintContainerH..., const int32 It, const int32 NumIts )
bool	ApplyPushOut ( const FReal Dt, const TArray< FConstraintContainerH..., const int32 It, const int32 NumIts )
void	DisableConstraints ( const TSet< TGeometryParticleHandle... )	Disabled the specified constraint.
const FHandl...	GetConstConstraintHandles()
TVec2< TGeom...	GetConstrainedParticles ( int32 ConstraintIndex )	Get the particles that are affected by the specified constraint.
FConstraintC...	GetConstraintHandle ( int32 ConstraintIndex )
const FConst...	GetConstraintHandle ( int32 ConstraintIndex )
FHandles &	GetConstraintHandles()
const FVec3 ...	GetConstraintPosition ( int ConstraintIndex )	Get the world-space constraint positions for each body.
FPBDSuspensi...	GetSettings ( int32 ConstraintIndex )
const FPBDSu...	GetSettings ( int32 ConstraintIndex )	Constraint API
int32	NumConstraints()	Constraint Container API Get the number of constraints.
void	PrepareIteration ( FReal Dt )
void	PrepareTick()	Island Rule API
void	RemoveConstraint ( int ConstraintIndex )	Remove a constraint.
void	SetConstraintPosition ( const int32 ConstraintIndex, const FVec3& Position )
void	SetSettings ( int32 ConstraintIndex, const FPBDSuspensionSettings& Sett... )
void	UnprepareIteration ( FReal Dt )
void	UnprepareTick()
void	UpdatePositionBasedState ( const FReal Dt )

Typedefs

Name	Description
Base
FConstraintContainerHandle
FConstraintHandleAllocator
FHandles

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

Take our survey

Dismiss