1. Epic GamesDeveloper
  3. FPBDRigidSpringConstraints

FPBDRigidSpringConstraints

API > API/Runtime > API/Runtime/Chaos

   
Name FPBDRigidSpringConstraints
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDRigidSpringConstraints.h
Include Path #include "Chaos/PBDRigidSpringConstraints.h"

Syntax

class FPBDRigidSpringConstraints : public Chaos::TPBDIndexedConstraintContainer< FPBDRigidSpringConstraints >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FPBDRigidSpringConstraints()

   Chaos/PBDRigidSpringConstraints.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPBDRigidSpringConstraints()

   Chaos/PBDRigidSpringConstraints.h  

Structs

Name Remarks
FSpringSettings  

Typedefs

Name Type Remarks Include Path
Base TPBDIndexedConstraintContainer< FPBDRigidSpringConstraints >   Chaos/PBDRigidSpringConstraints.h
FConstrainedParticlePair TVector< TGeometryParticleHandle< FReal, 3 > *, 2 >   Chaos/PBDRigidSpringConstraints.h
FConstraintContainerHandle FPBDRigidSpringConstraintHandle   Chaos/PBDRigidSpringConstraints.h
FConstraintHandleAllocator TConstraintHandleAllocator< FPBDRigidSpringConstraints >   Chaos/PBDRigidSpringConstraints.h
FHandles TArray< FConstraintContainerHandle * >   Chaos/PBDRigidSpringConstraints.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Constraints TArray< FConstrainedParticlePair >   Chaos/PBDRigidSpringConstraints.h  
ConstraintSolverBodies TArray< FSolverBodyPtrPair >   Chaos/PBDRigidSpringConstraints.h  
Distances TArray< TVector< FVec3, 2 > >   Chaos/PBDRigidSpringConstraints.h  
HandleAllocator FConstraintHandleAllocator   Chaos/PBDRigidSpringConstraints.h  
Handles TArray< FConstraintContainerHandle * >   Chaos/PBDRigidSpringConstraints.h  
SpringSettings TArray< FSpringSettings >   Chaos/PBDRigidSpringConstraints.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 TIndexedConstraintContainerSolver API - used by World solvers Chaos/PBDRigidSpringConstraints.h  

void AddBodies ( FSolverBodyContainer& SolverBodyContainer
)

 TSimpleConstraintContainerSolver API - used by RBAN solvers Chaos/PBDRigidSpringConstraints.h  

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. Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

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

 Disabled the specified constraint. Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

void GatherInput ( const FReal Dt
)

   Chaos/PBDRigidSpringConstraints.h  

const FHandles & GetConstConstraintHandles()

   Chaos/PBDRigidSpringConstraints.h  

const FConstrainedParticlePair & GetConstrainedParticles ( int32 ConstraintIndex
) const

 Get the particles that are affected by the specified constraint. Chaos/PBDRigidSpringConstraints.h  

FConstraintContainerHandle * GetConstraintHandle ( int32 ConstraintIndex
)

   Chaos/PBDRigidSpringConstraints.h  

const FConstraintContainerHandle * GetConstraintHandle ( int32 ConstraintIndex
) const

   Chaos/PBDRigidSpringConstraints.h  

FHandles & GetConstraintHandles()

 Constraint API Chaos/PBDRigidSpringConstraints.h  

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

 Get the local-space constraint positions for each body. Chaos/PBDRigidSpringConstraints.h  

FReal GetRestLength ( int32 ConstraintIndex
) const

 Get the rest length of the spring Chaos/PBDRigidSpringConstraints.h  

int32 NumConstraints()

 Constraint Container API Get the number of constraints. Chaos/PBDRigidSpringConstraints.h  

void RemoveConstraint ( int ConstraintIndex
)

 Remove the specified constraint. Chaos/PBDRigidSpringConstraints.h  

void ScatterOutput ( const FReal Dt
)

   Chaos/PBDRigidSpringConstraints.h  

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

   Chaos/PBDRigidSpringConstraints.h  

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

 Set the local-space constraint positions for each body. Chaos/PBDRigidSpringConstraints.h  

void SetRestLength ( int32 ConstraintIndex,
const FReal SpringLength
)

 Set the rest length of the spring Chaos/PBDRigidSpringConstraints.h  

Overridden from FPBDConstraintContainer

Name Remarks Include Path Unreal Specifiers

virtual void AddConstraintsToGraph ( Private::FPBDIslandManager& IslandManager
)

 Add all the constraints in the container to the graph Chaos/PBDRigidSpringConstraints.h  

virtual int32 GetNumConstraints()

 FConstraintContainer Implementation Chaos/PBDRigidSpringConstraints.h  

virtual void PrepareTick()

 Called oncer per tick to initialize buffers required for the rest of the tick Chaos/PBDRigidSpringConstraints.h  

virtual void ResetConstraints()

 Empty the constraints (must be removed from the graph first, if required) Chaos/PBDRigidSpringConstraints.h  

virtual void UnprepareTick()

 Should undo any allocations in PrepareTick Chaos/PBDRigidSpringConstraints.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page