FConstraintRule

Constraint Rules bind constraint collections to the evolution and provide their update algorithm.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Chaos

Header

/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDConstraintRule.h

Include

#include "Chaos/PBDConstraintRule.h"

Syntax

class FConstraintRule

Remarks

Constraint Rules bind constraint collections to the evolution and provide their update algorithm.

Variables

Name Description

Protected variable

int32

 

Priority

Constructors

Name Description

Public function

FConstraintRule

(
    int32 InPriority
)

Destructors

Name Description

Public function Virtual

~FConstraintRule()

Functions

Name Description

Public function Const

int32

 

GetPriority()

Determines the order in which constraints are resolved.

Public function Virtual

void

 

PrepareIteration

(
    FReal Dt
)

Called once per iteration before Apply. Can be used to prepare caches etc.

Public function Virtual

void

 

PrepareTick()

Called once per frame. Can be used to prepare caches etc.

Public function

void

 

SetPriority

(
    const int32 InPriority
)

Set the constraint resolution priority. Higher priority constraints override lower priority ones.

Public function Virtual

void

 

UnprepareIteration

(
    FReal Dt
)

Called once per iteration after Apply.

Public function Virtual

void

 

UnprepareTick()

Called once per frame.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss