UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Public Attributes | List of all members
Chaos::FPBDNullConstraints Class Reference

#include <PBDNullConstraints.h>

+ Inheritance diagram for Chaos::FPBDNullConstraints:

Public Types

using FConstraintContainerHandle = FPBDNullConstraintHandle
 
- Public Types inherited from Chaos::TPBDIndexedConstraintContainer< FPBDNullConstraints >
using FConstaintContainerType = FPBDNullConstraints
 

Public Member Functions

 FPBDNullConstraints ()
 
int32 NumConstraints () const
 
FPBDNullConstraint & GetConstraint (const int32 ConstraintIndex)
 
const FPBDNullConstraint & GetConstraint (const int32 ConstraintIndex) const
 
FPBDNullConstraintHandle * AddConstraint (const TVec2< FGeometryParticleHandle * > &InConstraintedParticles)
 
FParticlePair GetConstrainedParticles (int32 ConstraintIndex) const
 
TArray< FPBDNullConstraintHandle * > & GetConstraintHandles ()
 
const TArray< FPBDNullConstraintHandle * > & GetConstraintHandles () const
 
virtual int32 GetNumConstraints () const override final
 
virtual void ResetConstraints () override final
 
virtual void AddConstraintsToGraph (Private::FPBDIslandManager &IslandManager) override final
 
virtual void PrepareTick () override final
 
virtual void UnprepareTick () override final
 
void AddBodies (FSolverBodyContainer &SolverBodyContainer)
 
void GatherInput (const FReal Dt)
 
void ScatterOutput (const FReal Dt)
 
void ApplyPositionConstraints (const FReal Dt, const int32 It, const int32 NumIts)
 
void ApplyVelocityConstraints (const FReal Dt, const int32 It, const int32 NumIts)
 
void ApplyProjectionConstraints (const FReal Dt, const int32 It, const int32 NumIts)
 
void AddBodies (const TArrayView< int32 > &ConstraintIndices, FSolverBodyContainer &SolverBodyContainer)
 
void GatherInput (const TArrayView< int32 > &ConstraintIndices, const FReal Dt)
 
void ScatterOutput (const TArrayView< int32 > &ConstraintIndices, const FReal Dt)
 
void ApplyPositionConstraints (const TArrayView< int32 > &ConstraintIndices, const FReal Dt, const int32 It, const int32 NumIts)
 
void ApplyVelocityConstraints (const TArrayView< int32 > &ConstraintIndices, const FReal Dt, const int32 It, const int32 NumIts)
 
void ApplyProjectionConstraints (const TArrayView< int32 > &ConstraintIndices, const FReal Dt, const int32 It, const int32 NumIts)
 
- Public Member Functions inherited from Chaos::TPBDIndexedConstraintContainer< FPBDNullConstraints >
 TPBDIndexedConstraintContainer (FConstraintHandleTypeID InType)
 
virtual TUniquePtr< FConstraintContainerSolver > CreateSceneSolver (const int32 Priority) override final
 
virtual TUniquePtr< FConstraintContainerSolver > CreateGroupSolver (const int32 Priority) override final
 
- Public Member Functions inherited from Chaos::FPBDIndexedConstraintContainer
 FPBDIndexedConstraintContainer (FConstraintHandleTypeID InType)
 
virtual void SetConstraintEnabled (int32 ConstraintIndex, bool bEnabled)
 
virtual bool IsConstraintEnabled (int32 ConstraintIndex) const
 
- Public Member Functions inherited from Chaos::FPBDConstraintContainer
CHAOS_API FPBDConstraintContainer (FConstraintHandleTypeID InConstraintHandleType)
 
virtual CHAOS_API ~FPBDConstraintContainer ()
 
int32 GetContainerId () const
 
void SetContainerId (int32 InContainerId)
 
const FConstraintHandleTypeID & GetConstraintHandleType () const
 
virtual void UpdatePositionBasedState (const FReal Dt)
 
virtual void DisconnectConstraints (const TSet< TGeometryParticleHandle< FReal, 3 > * > &)
 
virtual void OnDisableParticle (FGeometryParticleHandle *DisabledParticle)
 
virtual void OnEnableParticle (FGeometryParticleHandle *EnabledParticle)
 

Public Attributes

TArray< FPBDNullConstraint > Constraints
 
TArray< FPBDNullConstraintHandle * > Handles
 
TConstraintHandleAllocator< FPBDNullConstraints > HandleAllocator
 

Additional Inherited Members

- Protected Member Functions inherited from Chaos::FPBDIndexedConstraintContainer
int32 GetConstraintIndex (const FIndexedConstraintHandle *ConstraintHandle) const
 
void SetConstraintIndex (FIndexedConstraintHandle *ConstraintHandle, int32 ConstraintIndex) const
 
- Protected Attributes inherited from Chaos::FPBDConstraintContainer
FConstraintHandleTypeID ConstraintHandleType
 
int32 ContainerId
 

Detailed Description

Constraint Container with minimal API required to test the Graph.

Member Typedef Documentation

◆ FConstraintContainerHandle

using Chaos::FPBDNullConstraints::FConstraintContainerHandle = FPBDNullConstraintHandle

Constructor & Destructor Documentation

◆ FPBDNullConstraints()

Chaos::FPBDNullConstraints::FPBDNullConstraints ( )

Member Function Documentation

◆ AddBodies() [1/2]

void Chaos::FPBDNullConstraints::AddBodies ( const TArrayView< int32 > &  ConstraintIndices,
FSolverBodyContainer &  SolverBodyContainer 
)
inline

◆ AddBodies() [2/2]

void Chaos::FPBDNullConstraints::AddBodies ( FSolverBodyContainer &  SolverBodyContainer)
inline

◆ AddConstraint()

FPBDNullConstraintHandle * Chaos::FPBDNullConstraints::AddConstraint ( const TVec2< FGeometryParticleHandle * > &  InConstraintedParticles)

◆ AddConstraintsToGraph()

void Chaos::FPBDNullConstraints::AddConstraintsToGraph ( Private::FPBDIslandManager &  IslandManager)
finaloverridevirtual

Add all the constraints in the container to the graph

Implements Chaos::FPBDConstraintContainer.

◆ ApplyPositionConstraints() [1/2]

void Chaos::FPBDNullConstraints::ApplyPositionConstraints ( const FReal  Dt,
const int32  It,
const int32  NumIts 
)
inline

◆ ApplyPositionConstraints() [2/2]

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

◆ ApplyProjectionConstraints() [1/2]

void Chaos::FPBDNullConstraints::ApplyProjectionConstraints ( const FReal  Dt,
const int32  It,
const int32  NumIts 
)
inline

◆ ApplyProjectionConstraints() [2/2]

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

◆ ApplyVelocityConstraints() [1/2]

void Chaos::FPBDNullConstraints::ApplyVelocityConstraints ( const FReal  Dt,
const int32  It,
const int32  NumIts 
)
inline

◆ ApplyVelocityConstraints() [2/2]

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

◆ GatherInput() [1/2]

void Chaos::FPBDNullConstraints::GatherInput ( const FReal  Dt)
inline

◆ GatherInput() [2/2]

void Chaos::FPBDNullConstraints::GatherInput ( const TArrayView< int32 > &  ConstraintIndices,
const FReal  Dt 
)
inline

◆ GetConstrainedParticles()

FParticlePair Chaos::FPBDNullConstraints::GetConstrainedParticles ( int32  ConstraintIndex) const
inline

◆ GetConstraint() [1/2]

FPBDNullConstraint & Chaos::FPBDNullConstraints::GetConstraint ( const int32  ConstraintIndex)
inline

◆ GetConstraint() [2/2]

const FPBDNullConstraint & Chaos::FPBDNullConstraints::GetConstraint ( const int32  ConstraintIndex) const
inline

◆ GetConstraintHandles() [1/2]

TArray< FPBDNullConstraintHandle * > & Chaos::FPBDNullConstraints::GetConstraintHandles ( )
inline

◆ GetConstraintHandles() [2/2]

const TArray< FPBDNullConstraintHandle * > & Chaos::FPBDNullConstraints::GetConstraintHandles ( ) const
inline

◆ GetNumConstraints()

virtual int32 Chaos::FPBDNullConstraints::GetNumConstraints ( ) const
inlinefinaloverridevirtual

Get the number of constraints in this container (includes inactive and disabled)

Implements Chaos::FPBDConstraintContainer.

◆ NumConstraints()

int32 Chaos::FPBDNullConstraints::NumConstraints ( ) const
inline

◆ PrepareTick()

virtual void Chaos::FPBDNullConstraints::PrepareTick ( )
inlinefinaloverridevirtual

Called oncer per tick to initialize buffers required for the rest of the tick

Implements Chaos::FPBDConstraintContainer.

◆ ResetConstraints()

virtual void Chaos::FPBDNullConstraints::ResetConstraints ( )
inlinefinaloverridevirtual

Empty the constraints (must be removed from the graph first, if required)

Implements Chaos::FPBDConstraintContainer.

◆ ScatterOutput() [1/2]

void Chaos::FPBDNullConstraints::ScatterOutput ( const FReal  Dt)
inline

◆ ScatterOutput() [2/2]

void Chaos::FPBDNullConstraints::ScatterOutput ( const TArrayView< int32 > &  ConstraintIndices,
const FReal  Dt 
)
inline

◆ UnprepareTick()

virtual void Chaos::FPBDNullConstraints::UnprepareTick ( )
inlinefinaloverridevirtual

Should undo any allocations in PrepareTick

Implements Chaos::FPBDConstraintContainer.

Member Data Documentation

◆ Constraints

TArray<FPBDNullConstraint> Chaos::FPBDNullConstraints::Constraints

◆ HandleAllocator

TConstraintHandleAllocator<FPBDNullConstraints> Chaos::FPBDNullConstraints::HandleAllocator

◆ Handles

TArray<FPBDNullConstraintHandle*> Chaos::FPBDNullConstraints::Handles
The documentation for this class was generated from the following files: