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 TArray < FConstraintContainerH ...,
    const int32 It,
    const int32 NumIts
)

Island Rule API

Public function

bool

 

Apply

(
    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

bool

 

ApplyPushOut

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

Simple Rule API

Public function

void

 

ClearPostApplyCallback()

Public function

void

 

ClearPostProjectCallback()

Public function

void

 

ClearPreApplyCallback()

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

const FConst ...

 

GetConstraintHandle

(
    int32 ConstraintIndex
)

Public function

FConstraintC ...

 

GetConstraintHandle

(
    int32 ConstraintIndex
)

Public function

FHandles &

 

GetConstraintHandles()

Constraint API

Public function Const

int32

 

GetConstraintLevel

(
    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

 

PrepareConstraints

(
    FReal Dt
)

General Rule API

Public function

void

 

RemoveConstraint

(
    int ConstraintIndex
)

Remove the specified constraint.

Public function

void

 

RemoveConstraints

(
    const TSet < TGeometryParticleHandle ...
)

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

 

SetParticleLevels

(
    int32 ConstraintIndex,
    const TVector < int32 , 2 >& Particl...
)

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

 

UnprepareConstraints

(
    FReal Dt
)

Public function

void

 

UpdatePositionBasedState

(
    const FReal Dt
)

Typedefs

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