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

Light Theme

Dark Theme

FPBDConstraintGraphRule

Base class for Constraint Rules that use the Contact Graph (which will be most optimized ones).

Windows

MacOS

Linux

Inheritance Hierarchy

FConstraintRule

FPBDConstraintGraphRule

TPBDConstraintGraphRuleImpl

	TPBDConstraintColorRule
	TPBDConstraintIslandRule

References

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

Syntax

class FPBDConstraintGraphRule : public Chaos::FConstraintRule

Remarks

Base class for Constraint Rules that use the Contact Graph (which will be most optimized ones). The graph is shared among many/all constraint rules and is held external to the Graph rule itself. Each edge in the graph can be mapped back to a constraint controlled by the rule. To support this, each rule is assigned an ID which is stored alongside the constraint index in the graph.

Constructors

	Name	Description
	FPBDConstraintGraphRule ( int32 InPriority )

Destructors

	Name	Description
	~FPBDConstraintGraphRule()

Functions

	Name	Description
void	AddToGraph()	Add all constraints to the connectivity graph
bool	ApplyConstraints ( const FReal Dt, int32 Island, const int32 It, const int32 NumIts )	Apply all corrections for constraints in the specified island.
bool	ApplyPushOut ( const FReal Dt, int32 Island, const int32 It, const int32 NumIts )	Apply push out for constraints in the specified island. Return true if more iterations are needed.
void	BindToGraph ( FPBDConstraintGraph& InContactGrap..., uint32 InContainerId )
void	InitializeAccelerationStructures()	Initialize and performance-acceleration structures from the contact graph.
int32	NumConstraints()	The number of constraints in the collection
void	RemoveConstraints ( const TSet< TGeometryParticleHandle... )	Remove all constraints associated with the specified particles
void	SetUseContactGraph ( const bool InUseContactGraph )
void	UpdateAccelerationStructures ( const int32 Island )	Set up the perf-acceleration structures for the specified island.
void	UpdatePositionBasedState ( const FReal Dt )	Called once per tick to allow constraint containers to create/alter their constraints based on particle position