1. Epic GamesDeveloper
  3. FPBDSuspensionConstraints

FPBDSuspensionConstraints

API > API/Runtime > API/Runtime/Chaos > API/Runtime/Chaos/Chaos

Inheritance Hierarchy

References

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

Syntax

class FPBDSuspensionConstraints : public Chaos::TPBDIndexedConstraintContainer< FPBDSuspensionConstraints >

Constructors

  Type Name Description
Public function    
Public function  

FPBDSuspensionConstraints ( TArray< FVec3 >&& Locations,
TArray< TGeometryParticleHandle< FReal, 3 >* >&& InConstrainedParticles,
TArray< FVec3 >&& InLocalOffset,
TArray< FPBDSuspensionSettings >&& InConstraintSettings
)

  

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
Public function FConstraintContainerHandle *

AddConstraint ( TGeometryParticleHandle< FReal, 3 >* Particle,
const FVec3& InConstraintFrame,
const FPBDSuspensionSettings& InConstraintSettings
)

 Add a constraint.
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 TArrayView< int32 >& ConstraintIndices,
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

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

  
Public function void

GatherInput ( const FReal Dt
)

  
Public function Const const FHandles &  
Public function Const TVec2< TGeometryParticleHandle< FReal, 3 > * >

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 &  
Public function Const const FVec3 &

GetConstraintPosition ( int ConstraintIndex
)

 Get the world-space constraint positions for each body.
Public function Const const FPBDSuspensionResults &

GetResults ( int32 ConstraintIndex
)

  
Public function Const const FPBDSuspensionSettings &

GetSettings ( int32 ConstraintIndex
)

 Constraint API
Public function FPBDSuspensionSettings &

GetSettings ( int32 ConstraintIndex
)

  
Public function Const int32 Constraint Container API Get the number of constraints.
Public function void

RemoveConstraint ( int ConstraintIndex
)

 Remove a constraint.
Public function void

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

  
Public function void

ScatterOutput ( const FReal Dt
)

  
Public function void

SetConstraintPosition ( const int32 ConstraintIndex,
const FVec3& Position
)

  
Public function void

SetSettings ( int32 ConstraintIndex,
const FPBDSuspensionSettings& Settings
)

  
Public function void

SetTarget ( int32 ConstraintIndex,
const FVector& TargetPos
)

  

Overridden from FPBDIndexedConstraintContainer

  Type Name Description
Public function Virtual Const bool

IsConstraintEnabled ( int32 ConstraintIndex
)

  
Public function Virtual void

SetConstraintEnabled ( int32 ConstraintIndex,
bool bEnabled
)

  

Overridden from FPBDConstraintContainer

  Type Name Description
Public function Virtual void Add all the constraints in the container to the graph
Public function Virtual void

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

 Disconnect the constraints from the attached input particles.
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  
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