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

Light Theme

Dark Theme

TPBDConstraintColorRule

Level- and Color-based constraint rule.

Windows

MacOS

Linux

Inheritance Hierarchy

FConstraintRule

FPBDConstraintGraphRule

TPBDConstraintGraphRuleImpl

TPBDConstraintColorRule

References

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

Syntax

template<typename T_CONSTRAINTS>
class TPBDConstraintColorRule : public Chaos::TPBDConstraintGraphRuleImpl< T_CONSTRAINTS >

Remarks

Level- and Color-based constraint rule. Constraints of the same color are non-interacting and can therefore be processed in parallel. The level is used to implement shock propagation: constraints of lower levels are frozen in place as far as higher-level constraints are concerned.

Constructors

	Name	Description
	TPBDConstraintColorRule ( FConstraints& InConstraints, int32 InPriority )

Functions

		Name	Description
	const FPBDCo...	GetGraphColor()
	void	RemoveConstraints ( const TSet< TGeometryParticleHandle... )
	void	VisitIslandConstraints ( const int32 Island, const TVisitor& Visitor )

Overridden from FPBDConstraintGraphRule

	Name	Description
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	InitializeAccelerationStructures()	Initialize and performance-acceleration structures from the contact graph.
void	ResetConstraints()	Remove all constraints
void	SetUseContactGraph ( const bool bInUseContactGraph )
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

Typedefs

Name	Description
Base
FConstraints

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

Take our survey

Dismiss