1. Epic GamesDeveloper
  3. FPBDSuspensionConstraints

FPBDSuspensionConstraints

API > API/Runtime > API/Runtime/Chaos

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

Syntax

class FPBDSuspensionConstraints : public Chaos::TPBDIndexedConstraintContainer< FPBDSuspensionConstraints >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

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

   Chaos/PBDSuspensionConstraints.h  
  Chaos/PBDSuspensionConstraints.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPBDSuspensionConstraints()

   Chaos/PBDSuspensionConstraints.h  

Typedefs

Name Type Remarks Include Path
Base TPBDIndexedConstraintContainer< FPBDSuspensionConstraints >   Chaos/PBDSuspensionConstraints.h
FConstraintContainerHandle FPBDSuspensionConstraintHandle   Chaos/PBDSuspensionConstraints.h
FConstraintHandleAllocator TConstraintHandleAllocator< FPBDSuspensionConstraints >   Chaos/PBDSuspensionConstraints.h
FHandles TArray< FConstraintContainerHandle * >   Chaos/PBDSuspensionConstraints.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CollisionSolverManifoldPoints TArray< Private::FPBDCollisionSolverManifoldPoint >   Chaos/PBDSuspensionConstraints.h  
CollisionSolvers TArray< Private::FPBDCollisionSolver >   Chaos/PBDSuspensionConstraints.h  
ConstrainedParticles TArray< FGeometryParticleHandle * >   Chaos/PBDSuspensionConstraints.h  
ConstraintEnabledStates TArray< bool >   Chaos/PBDSuspensionConstraints.h  
ConstraintResults TArray< FPBDSuspensionResults >   Chaos/PBDSuspensionConstraints.h  
ConstraintSettings TArray< FPBDSuspensionSettings >   Chaos/PBDSuspensionConstraints.h  
ConstraintSolverBodies TArray< FSolverBody * >   Chaos/PBDSuspensionConstraints.h  
HandleAllocator FConstraintHandleAllocator   Chaos/PBDSuspensionConstraints.h  
Handles FHandles   Chaos/PBDSuspensionConstraints.h  
SolverSettings FPBDSuspensionSolverSettings   Chaos/PBDSuspensionConstraints.h  
StaticCollisionBodies TArray< FSolverBody >   Chaos/PBDSuspensionConstraints.h  
SuspensionLocalOffset TArray< FVec3 >   Chaos/PBDSuspensionConstraints.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

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

void AddBodies ( FSolverBodyContainer& SolverBodyContainer
)

 TSimpleConstraintContainerSolver API - used by RBAN Chaos/PBDSuspensionConstraints.h  

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

 Add a constraint. Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

void GatherInput ( const FReal Dt
)

   Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

const FHandles & GetConstConstraintHandles()

   Chaos/PBDSuspensionConstraints.h  

TVec2< TGeometryParticleHandle< FReal, 3 > * > GetConstrainedParticles ( int32 ConstraintIndex
) const

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

FConstraintContainerHandle * GetConstraintHandle ( int32 ConstraintIndex
)

   Chaos/PBDSuspensionConstraints.h  

const FConstraintContainerHandle * GetConstraintHandle ( int32 ConstraintIndex
) const

   Chaos/PBDSuspensionConstraints.h  

FHandles & GetConstraintHandles()

   Chaos/PBDSuspensionConstraints.h  

const FVec3 & GetConstraintPosition ( int ConstraintIndex
) const

 Get the world-space constraint positions for each body. Chaos/PBDSuspensionConstraints.h  

const FPBDSuspensionResults & GetResults ( int32 ConstraintIndex
) const

   Chaos/PBDSuspensionConstraints.h  

const FPBDSuspensionSettings & GetSettings ( int32 ConstraintIndex
) const

 Constraint API Chaos/PBDSuspensionConstraints.h  

FPBDSuspensionSettings & GetSettings ( int32 ConstraintIndex
)

   Chaos/PBDSuspensionConstraints.h  

int32 NumConstraints()

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

void RemoveConstraint ( int ConstraintIndex
)

 Remove a constraint. Chaos/PBDSuspensionConstraints.h  

void ScatterOutput ( const FReal Dt
)

   Chaos/PBDSuspensionConstraints.h  

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

   Chaos/PBDSuspensionConstraints.h  

void SetConstraintPosition ( const int32 ConstraintIndex,
const FVec3& Position
)

   Chaos/PBDSuspensionConstraints.h  

void SetSettings ( int32 ConstraintIndex,
const FPBDSuspensionSettings& Settings
)

   Chaos/PBDSuspensionConstraints.h  

void SetTarget ( int32 ConstraintIndex,
const FVector& TargetPos
)

   Chaos/PBDSuspensionConstraints.h  

Overridden from FPBDIndexedConstraintContainer

Name Remarks Include Path Unreal Specifiers

virtual bool IsConstraintEnabled ( int32 ConstraintIndex
) const

   Chaos/PBDSuspensionConstraints.h  

virtual void SetConstraintEnabled ( int32 ConstraintIndex,
bool bEnabled
)

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

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

 Disconnect the constraints from the attached input particles. Chaos/PBDSuspensionConstraints.h  

virtual int32 GetNumConstraints()

 FConstraintContainer Implementation Chaos/PBDSuspensionConstraints.h  

virtual void PrepareTick()

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

virtual void ResetConstraints()

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

virtual void UnprepareTick()

 Should undo any allocations in PrepareTick Chaos/PBDSuspensionConstraints.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page