TPBDConstraintColorRule

Level- and Color-based constraint rule.

Windows
MacOS
Linux

Inheritance Hierarchy

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

Public function

TPBDConstraintColorRule

(
    FConstraints & InConstraints,
    int32 InPriority
)

Functions

Name Description

Public function Const

void

 

VisitIslandConstraints

(
    const int32 Island,
    const TVisitor& Visitor
)

Overridden from FPBDConstraintGraphRule

Name Description

Public function Virtual

bool

 

ApplyConstraints

(
    const FReal Dt,
    int32 Island,
    const int32 It,
    const int32 NumIts
)

Apply all corrections for constraints in the specified island.

Public function Virtual

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.

Public function Virtual

void

 

InitializeAccelerationStructures()

Initialize and performance-acceleration structures from the contact graph.

Public function Virtual

void

 

RemoveConstraints

(
    const TSet < TGeometryParticleHandle ...
)

Remove all constraints associated with the specified particles

Public function Virtual

void

 

SetUseContactGraph

(
    const bool bInUseContactGraph
)

Public function Virtual

void

 

UpdateAccelerationStructures

(
    const int32 Island
)

Set up the perf-acceleration structures for the specified island.

Public function Virtual

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback