UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::Softs::FPBDSphericalBackstopConstraint Class Referencefinal

#include <PBDSphericalConstraint.h>

Public Member Functions

 FPBDSphericalBackstopConstraint (const int32 InParticleOffset, const int32 InParticleCount, const TArray< FSolverVec3 > &InAnimationPositions, const TArray< FSolverVec3 > &InAnimationNormals, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, FSolverReal MeshScale, bool bInUseGlobalIndexation=true)
 
 FPBDSphericalBackstopConstraint (const int32 InParticleOffset, const int32 InParticleCount, const TArray< FSolverVec3 > &InAnimationPositions, const TArray< FSolverVec3 > &InAnimationNormals, const TConstArrayView< FRealSingle > &InSphereRadii, const TConstArrayView< FRealSingle > &InSphereOffsetDistances, const bool bInUseLegacyBackstop, bool bInUseGlobalIndexation=true)
 
 ~FPBDSphericalBackstopConstraint ()
 
CHAOS_API void SetProperties (const FCollectionPropertyConstFacade &PropertyCollection, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, FSolverReal MeshScale)
 
void SetEnabled (bool bInEnabled)
 
bool IsEnabled () const
 
void Apply (FSolverParticles &Particles, const FSolverReal Dt) const
 
void Apply (FSolverParticlesRange &Particles, const FSolverReal Dt) const
 
void SetScale (FSolverReal InScale)
 
FSolverReal GetScale () const
 
bool UseLegacyBackstop () const
 
FSolverReal GetBackstopRadius (int32 ConstraintIndex) const
 
FSolverReal GetBackstopDistance (int32 ConstraintIndex) const
 
 UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (BackstopDistance, float)
 
 UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (BackstopRadius, float)
 
 UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (UseLegacyBackstop, bool)
 
 UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME (BackstopMeshName, bool)
 

Static Public Member Functions

static bool IsEnabled (const FCollectionPropertyConstFacade &PropertyCollection)
 

Constructor & Destructor Documentation

◆ FPBDSphericalBackstopConstraint() [1/2]

Chaos::Softs::FPBDSphericalBackstopConstraint::FPBDSphericalBackstopConstraint ( const int32  InParticleOffset,
const int32  InParticleCount,
const TArray< FSolverVec3 > &  InAnimationPositions,
const TArray< FSolverVec3 > &  InAnimationNormals,
const TMap< FString, TConstArrayView< FRealSingle > > &  WeightMaps,
const FCollectionPropertyConstFacade PropertyCollection,
FSolverReal  MeshScale,
bool  bInUseGlobalIndexation = true 
)
inline

◆ FPBDSphericalBackstopConstraint() [2/2]

Chaos::Softs::FPBDSphericalBackstopConstraint::FPBDSphericalBackstopConstraint ( const int32  InParticleOffset,
const int32  InParticleCount,
const TArray< FSolverVec3 > &  InAnimationPositions,
const TArray< FSolverVec3 > &  InAnimationNormals,
const TConstArrayView< FRealSingle > &  InSphereRadii,
const TConstArrayView< FRealSingle > &  InSphereOffsetDistances,
const bool  bInUseLegacyBackstop,
bool  bInUseGlobalIndexation = true 
)
inline

◆ ~FPBDSphericalBackstopConstraint()

Chaos::Softs::FPBDSphericalBackstopConstraint::~FPBDSphericalBackstopConstraint ( )
inline

Member Function Documentation

◆ Apply() [1/2]

void Chaos::Softs::FPBDSphericalBackstopConstraint::Apply ( FSolverParticles Particles,
const FSolverReal  Dt 
) const
inline

◆ Apply() [2/2]

void Chaos::Softs::FPBDSphericalBackstopConstraint::Apply ( FSolverParticlesRange Particles,
const FSolverReal  Dt 
) const
inline

◆ GetBackstopDistance()

FSolverReal Chaos::Softs::FPBDSphericalBackstopConstraint::GetBackstopDistance ( int32  ConstraintIndex) const
inline

◆ GetBackstopRadius()

FSolverReal Chaos::Softs::FPBDSphericalBackstopConstraint::GetBackstopRadius ( int32  ConstraintIndex) const
inline

◆ GetScale()

FSolverReal Chaos::Softs::FPBDSphericalBackstopConstraint::GetScale ( ) const
inline

◆ IsEnabled() [1/2]

bool Chaos::Softs::FPBDSphericalBackstopConstraint::IsEnabled ( ) const
inline

◆ IsEnabled() [2/2]

static bool Chaos::Softs::FPBDSphericalBackstopConstraint::IsEnabled ( const FCollectionPropertyConstFacade PropertyCollection)
inlinestatic

◆ SetEnabled()

void Chaos::Softs::FPBDSphericalBackstopConstraint::SetEnabled ( bool  bInEnabled)
inline

◆ SetProperties()

void Chaos::Softs::FPBDSphericalBackstopConstraint::SetProperties ( const FCollectionPropertyConstFacade PropertyCollection,
const TMap< FString, TConstArrayView< FRealSingle > > &  WeightMaps,
FSolverReal  MeshScale 
)

◆ SetScale()

void Chaos::Softs::FPBDSphericalBackstopConstraint::SetScale ( FSolverReal  InScale)
inline

◆ UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [1/4]

Chaos::Softs::FPBDSphericalBackstopConstraint::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME ( BackstopDistance  ,
float   
)

◆ UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [2/4]

Chaos::Softs::FPBDSphericalBackstopConstraint::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME ( BackstopMeshName  ,
bool   
)

◆ UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [3/4]

Chaos::Softs::FPBDSphericalBackstopConstraint::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME ( BackstopRadius  ,
float   
)

◆ UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME() [4/4]

Chaos::Softs::FPBDSphericalBackstopConstraint::UE_CHAOS_DECLARE_INDEXLESS_PROPERTYCOLLECTION_NAME ( UseLegacyBackstop  ,
bool   
)

◆ UseLegacyBackstop()

bool Chaos::Softs::FPBDSphericalBackstopConstraint::UseLegacyBackstop ( ) const
inline

The documentation for this class was generated from the following files: