FPBDRigidSpringConstraints

Windows
MacOS
Linux

Inheritance Hierarchy

FPBDConstraintContainer

FPBDRigidSpringConstraints

References

Module

Chaos

Header

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

Include

#include "Chaos/PBDRigidSpringConstraints.h"

Syntax

class FPBDRigidSpringConstraints : public Chaos::FPBDConstraintContainer

Constructors

Name Description

Public function

FPBDRigidSpringConstraints()

Destructors

Functions

Name Description

Public function

FConstraintC ...

 

AddConstraint

(
    const FConstrainedParticlePair & In...,
    const TVector < FVec3 , 2 >& InLocat...,
    FReal Stiffness,
    FReal Damping,
    FReal RestLength
)

Add a constraint initialized from current world-space particle positions.

Public function

bool

 

Apply

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

Public function

bool

 

Apply

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

Public function

bool

 

ApplyPushOut

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

Public function

bool

 

ApplyPushOut

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

Public function Const

const FHandl ...

 

GetConstConstraintHandles()

Public function Const

const FConst ...

 

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

const TVecto ...

 

GetConstraintPositions

(
    int ConstraintIndex
)

Get the local-space constraint positions for each body.

Public function Const

FReal

 

GetRestLength

(
    int32 ConstraintIndex
)

Get the rest length of the spring

Public function Const

int32

 

NumConstraints()

Constraint Container API Get the number of constraints.

Public function

void

 

PrepareConstraints

(
    FReal Dt
)

Island Rule API

Public function

void

 

RemoveConstraint

(
    int ConstraintIndex
)

Remove the specified constraint.

Public function

void

 

RemoveConstraints

(
    const TSet < TGeometryParticleHandle ...
)

Public function

void

 

SetConstraintPositions

(
    int ConstraintIndex,
    const TVector < FVec3 , 2 >& Constra...
)

Set the local-space constraint positions for each body.

Public function

void

 

SetRestLength

(
    int32 ConstraintIndex,
    const FReal SpringLength
)

Set the rest length of the spring

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