FPBDJointConstraints

A joint restricting up to 6 degrees of freedom, with linear and angular limits.

Windows
MacOS
Linux

Inheritance Hierarchy

FPBDConstraintContainer

FPBDJointConstraints

References

Module

Chaos

Header

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

Include

#include "Chaos/PBDJointConstraints.h"

Syntax

class FPBDJointConstraints : public Chaos::FPBDConstraintContainer

Remarks

A joint restricting up to 6 degrees of freedom, with linear and angular limits.

Constructors

Name Description

Public function

FPBDJointConstraints

(
    const FPBDJointSolverSettings& InS...
)

Destructors

Name Description

Public function Virtual

~FPBDJointConstraints()

Functions

Name Description

Public function

FConstraintC...

 

AddConstraint

(
    const FParticlePair& InConstrained...,
    const FTransformPair& ConstraintFr...,
    const FPBDJointSettings& InConstra...
)

Add a constraint with particle-space constraint offsets.

Public function

FConstraintC...

 

AddConstraint

(
    const FParticlePair& InConstrained...,
    const FTransformPair& ConstraintFr...
)

Add a constraint with particle-space constraint offsets.

Public function

FConstraintC...

 

AddConstraint

(
    const FParticlePair& InConstrained...,
    const FRigidTransform3& WorldConst...
)

Add a constraint with particle-space constraint offsets.

Public function

bool

 

Apply

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

Simple Rule API

Public function

bool

 

Apply

(
    const FReal Dt,
    const TArray< FConstraintContainerH...,
    const int32 It,
    const int32 NumIts
)

Island Rule API

Public function

bool

 

ApplyPushOut

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

Simple Rule API

Public function

bool

 

ApplyPushOut

(
    const FReal Dt,
    const TArray< FConstraintContainerH...,
    const int32 It,
    const int32 NumIts
)

Simple Rule API

Public function

void

 

BreakConstraint

(
    int32 ConstraintIndex
)

Force a constraints to break

Public function

void

 

ClearBreakCallback()

Public function

void

 

ClearPostApplyCallback()

Public function

void

 

ClearPostProjectCallback()

Public function

void

 

ClearPreApplyCallback()

Public function

void

 

DisableConstraints

(
    const TSet< TGeometryParticleHandle...
)

Disable the constraints attached to the input particles.

Public function

void

 

FixConstraints

(
    int32 ConstraintIndex
)

Repair a broken constraints (does not adjust particle positions)

Public function Const

const FHandl...

 

GetConstConstraintHandles()

Public function Const

const FParti...

 

GetConstrainedParticles

(
    int32 ConstraintIndex
)

Get the particles that are affected by the specified constraint.

Public function Const

FVec3

 

GetConstraintAngularImpulse

(
    int32 ConstraintIndex
)

Public function Const

int32

 

GetConstraintBatch

(
    int32 ConstraintIndex
)

Public function Const

int32

 

GetConstraintColor

(
    int32 ConstraintIndex
)

Public function Const

const FConst...

 

GetConstraintHandle

(
    int32 ConstraintIndex
)

Public function

FConstraintC...

 

GetConstraintHandle

(
    int32 ConstraintIndex
)

Public function

FHandles &

 

GetConstraintHandles()

Constraint API

Public function Const

int32

 

GetConstraintIsland

(
    int32 ConstraintIndex
)

Public function Const

int32

 

GetConstraintLevel

(
    int32 ConstraintIndex
)

Public function Const

FVec3

 

GetConstraintLinearImpulse

(
    int32 ConstraintIndex
)

Public function Const

const FPBDJo...

 

GetConstraintSettings

(
    int32 ConstraintIndex
)

Public function Const

const FPBDJo...

 

GetSettings()

Public function Const

int32

 

NumConstraints()

Constraint Container API Get the number of constraints.

Public function

void

 

PrepareIteration

(
    FReal Dt
)

Public function

void

 

PrepareTick()

General Rule API

Public function

void

 

RemoveConstraint

(
    int ConstraintIndex
)

Remove the specified constraint.

Public function

void

 

RemoveConstraints

(
    const TSet< TGeometryParticleHandle...
)

Public function

void

 

SetBreakCallback

(
    const FJointBreakCallback& Callbac...
)

Public function

void

 

SetConstraintSettings

(
    int32 ConstraintIndex,
    const FPBDJointSettings& InConstra...
)

Public function

void

 

SetNumPairIterations

(
    const int32 NumPairIterationss
)

Public function

void

 

SetNumPushOutPairIterations

(
    const int32 NumPairIterationss
)

Public function

void

 

SetPostApplyCallback

(
    const FJointPostApplyCallback& Cal...
)

Public function

void

 

SetPostProjectCallback

(
    const FJointPostApplyCallback& Cal...
)

Public function

void

 

SetPreApplyCallback

(
    const FJointPostApplyCallback& Cal...
)

Public function

void

 

SetSettings

(
    const FPBDJointSolverSettings& InS...
)

Public function

void

 

SetUpdateVelocityInApplyConstraints

(
    bool bEnabled
)

Enable or disable velocity update in apply constraints

Public function

void

 

UnprepareIteration

(
    FReal Dt
)

Public function

void

 

UnprepareTick()

Public function

void

 

UpdatePositionBasedState

(
    const FReal Dt
)

Overridden from FPBDConstraintContainer

Name Description

Public function Virtual Const

bool

 

IsConstraintEnabled

(
    int32 ConstraintIndex
)

Whether the constraint is enabled

Public function Virtual

void

 

SetConstraintEnabled

(
    int32 ConstraintIndex,
    bool bEnabled
)

Enable or disable a constraints

Typedefs

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