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

Light Theme

Dark Theme

TPBDRigidDynamicSpringConstraints

Windows

MacOS

Linux

Inheritance Hierarchy

FPBDConstraintContainer

TPBDRigidDynamicSpringConstraints

References

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

Syntax

template<class T, int d>
class TPBDRigidDynamicSpringConstraints : public Chaos::FPBDConstraintContainer

Constructors

	Name	Description
	TPBDRigidDynamicSpringConstraints ( const T InStiffness )
	TPBDRigidDynamicSpringConstraints ( TArray< FConstrainedParticlePair > ..., const T InCreationThreshold, const int32 InMaxSprings, const T InStiffness )

Destructors

	Name	Description
	~TPBDRigidDynamicSpringConstraints()

Functions

	Name	Description
FConstraintC...	AddConstraint ( const FConstrainedParticlePair& In... )	Add a constraint initialized from current world-space particle positions.
bool	Apply ( const T Dt, const TArray< FConstraintContainerH..., const int32 It, const int32 NumIts )
bool	ApplyPushOut ( const T Dt, const TArray< FConstraintContainerH..., const int32 It, const int32 NumIts )
const FHandl...	GetConstConstraintHandles()
const FConst...	GetConstrainedParticles ( int32 ConstraintIndex )	Get the particles that are affected by the specified constraint.
FConstraintC...	GetConstraintHandle ( int32 ConstraintIndex )
const FConst...	GetConstraintHandle ( int32 ConstraintIndex )
FHandles &	GetConstraintHandles()	Constraint API
int32	NumConstraints()	Constraint Container API Get the number of constraints.
void	PrepareConstraints ( FReal Dt )	Island Rule API
void	RemoveConstraint ( int ConstraintIndex )	Remove the specified constraint.
void	RemoveConstraints ( const TSet< TGeometryParticleHandle... )
void	SetCreationThreshold ( const T InCreationThreshold )	Set the distance threshold below which springs get created between particles.
void	SetMaxSprings ( const T InMaxSprings )	Set the maximum number of springs
void	UnprepareConstraints ( FReal Dt )
void	UpdatePositionBasedState ( const T Dt )

Typedefs

Name	Description
Base
FConstrainedParticlePair
FConstraintContainerHandle
FConstraintHandleAllocator
FHandles
FReal

Constants

Name	Description
Dimensions

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

Take our survey

Dismiss