1. Epic GamesDeveloper
  3. FPBDRigidSpringConstraints

FPBDRigidSpringConstraints

Unreal Engine C++ API Reference > Runtime > Chaos > Chaos

Inheritance Hierarchy

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDRigidSpringConstraints.h
Include #include "Chaos/PBDRigidSpringConstraints.h"

Syntax

class FPBDRigidSpringConstraints : public Chaos::TPBDIndexedConstraintContainer< FPBDRigidSpringConstraints >

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddBodies ( const TArrayView< int32 >& ConstraintIndices,
FSolverBodyContainer& SolverBodyContainer
)

 TIndexedConstraintContainerSolver API - used by World solvers
Public function void

AddBodies ( FSolverBodyContainer& SolverBodyContainer
)

 TSimpleConstraintContainerSolver API - used by RBAN solvers
Public function FConstraintContainerHandle *

AddConstraint ( const FConstrainedParticlePair& InConstrainedParticles,
const TVector< FVec3, 2 >& InLocations,
FReal Stiffness,
FReal Damping,
FReal RestLength
)

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

ApplyPositionConstraints ( const TArrayView< int32 >& ConstraintIndices,
const FReal Dt,
const int32 It,
const int32 NumIts
)

  
Public function void

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

  
Public function void

ApplyProjectionConstraints ( const TArrayView< int32 >& ConstraintIndices,
const FReal Dt,
const int32 It,
const int32 NumIts
)

  
Public function void

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

  
Public function void

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

  
Public function void

ApplyVelocityConstraints ( const TArrayView< int32 >& ConstraintIndices,
const FReal Dt,
const int32 It,
const int32 NumIts
)

  
Public function void

DisableConstraints ( const TSet< TGeometryParticleHandle< FReal, 3 >* >& RemovedParticles
)

 Disabled the specified constraint.
Public function void

GatherInput ( const TArrayView< int32 >& ConstraintIndices,
const FReal Dt
)

  
Public function void

GatherInput ( const FReal Dt
)

  
Public function Const const FHandles &  
Public function Const const FConstrainedParticlePair &

GetConstrainedParticles ( int32 ConstraintIndex
)

 Get the particles that are affected by the specified constraint.
Public function FConstraintContainerHandle *

GetConstraintHandle ( int32 ConstraintIndex
)

  
Public function Const const FConstraintContainerHandle *

GetConstraintHandle ( int32 ConstraintIndex
)

  
Public function FHandles & Constraint API
Public function Const const TVector< FVec3, 2 > &

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 Constraint Container API Get the number of constraints.
Public function void

RemoveConstraint ( int ConstraintIndex
)

 Remove the specified constraint.
Public function void

ScatterOutput ( const TArrayView< int32 >& ConstraintIndices,
const FReal Dt
)

  
Public function void

ScatterOutput ( const FReal Dt
)

  
Public function void

SetConstraintPositions ( int ConstraintIndex,
const TVector< FVec3, 2 >& ConstraintPositions
)

 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

Overridden from FPBDConstraintContainer

  Type Name Description
Public function Virtual void Add all the constraints in the container to the graph
Public function Virtual Const int32 FConstraintContainer Implementation
Public function Virtual void Called oncer per tick to initialize buffers required for the rest of the tick
Public function Virtual void Empty the constraints (must be removed from the graph first, if required)
Public function Virtual void Should undo any allocations in PrepareTick

Typedefs

Name Description
Base  
FConstrainedParticlePair  
FConstraintContainerHandle  
FConstraintHandleAllocator  
FHandles  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page