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

#include <PBDRigidDynamicSpringConstraints.h>

+ Inheritance diagram for Chaos::FPBDRigidDynamicSpringConstraintHandle:

Public Types

using Base = TIndexedContainerConstraintHandle< FPBDRigidDynamicSpringConstraints >
 
using FConstraintContainer = FPBDRigidDynamicSpringConstraints
 
- Public Types inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidDynamicSpringConstraints >
using Base = FIndexedConstraintHandle
 
using FGeometryParticleHandle = typename Base::FGeometryParticleHandle
 
using FConstraintContainer = FPBDRigidDynamicSpringConstraints
 
- Public Types inherited from Chaos::FIndexedConstraintHandle
using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 
- Public Types inherited from Chaos::FConstraintHandle
using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 

Public Member Functions

 FPBDRigidDynamicSpringConstraintHandle ()
 
 FPBDRigidDynamicSpringConstraintHandle (FConstraintContainer *InConstraintContainer, int32 InConstraintIndex)
 
virtual CHAOS_API FParticlePair GetConstrainedParticles () const override final
 
- Public Member Functions inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidDynamicSpringConstraints >
 TIndexedContainerConstraintHandle ()
 
 TIndexedContainerConstraintHandle (FConstraintContainer *InConstraintContainer, int32 InConstraintIndex)
 
virtual void SetEnabled (bool bInEnabled) override
 
virtual bool IsEnabled () const override
 
void RemoveConstraint ()
 
- Public Member Functions inherited from Chaos::FIndexedConstraintHandle
 FIndexedConstraintHandle ()
 
 FIndexedConstraintHandle (FPBDConstraintContainer *InContainer, int32 InConstraintIndex)
 
virtual ~FIndexedConstraintHandle ()
 
virtual bool IsValid () const override
 
int32 GetConstraintIndex () const
 
void SetConstraintIndex (const int32 InConstraintIndex)
 
- Public Member Functions inherited from Chaos::FConstraintHandle
 FConstraintHandle ()
 
 FConstraintHandle (FPBDConstraintContainer *InContainer)
 
virtual ~FConstraintHandle ()
 
FPBDConstraintContainerGetContainer ()
 
const FPBDConstraintContainerGetContainer () const
 
bool IsInConstraintGraph () const
 
Private::FPBDIslandConstraintGetConstraintGraphEdge () const
 
void SetConstraintGraphEdge (Private::FPBDIslandConstraint *InEdge)
 
virtual bool IsProbe () const
 
virtual bool SupportsSleeping () const
 
virtual bool SupportsPartialIslandSleeping () const
 
virtual bool IsSleeping () const
 
virtual void SetIsSleeping (const bool bInIsSleeping)
 
virtual FVec3f GetNetLinearImpulse () const
 
virtual bool WasAwakened () const
 
virtual void SetWasAwakened (const bool bInWasAwakened)
 
int32 GetContainerId () const
 
template<typename T >
T * As ()
 
template<typename T >
const T * As () const
 
template<typename T >
T * AsUnsafe ()
 
template<typename T >
const T * AsUnsafe () const
 
const FConstraintHandleTypeIDGetType () const
 
 UE_DEPRECATED (5.3, "Use GetConstraintGraphEdge") int32 GetConstraintGraphIndex() const
 
 UE_DEPRECATED (5.3, "Not supported") void SetConstraintGraphIndex(const int32 InIndex) const
 

Static Public Member Functions

static const FConstraintHandleTypeIDStaticType ()
 
- Static Public Member Functions inherited from Chaos::FIndexedConstraintHandle
static const FConstraintHandleTypeIDStaticType ()
 
- Static Public Member Functions inherited from Chaos::FConstraintHandle
static const FConstraintHandleTypeIDStaticType ()
 
static const FConstraintHandleTypeIDInvalidType ()
 

Additional Inherited Members

- Protected Member Functions inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidDynamicSpringConstraints >
FConstraintContainerConcreteContainer ()
 
const FConstraintContainerConcreteContainer () const
 
- Protected Attributes inherited from Chaos::TIndexedContainerConstraintHandle< FPBDRigidDynamicSpringConstraints >
int32 ConstraintIndex
 
- Protected Attributes inherited from Chaos::FIndexedConstraintHandle
int32 ConstraintIndex
 
- Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainerConstraintContainer
 
Private::FPBDIslandConstraintGraphEdge
 

Member Typedef Documentation

◆ Base

◆ FConstraintContainer

Constructor & Destructor Documentation

◆ FPBDRigidDynamicSpringConstraintHandle() [1/2]

Chaos::FPBDRigidDynamicSpringConstraintHandle::FPBDRigidDynamicSpringConstraintHandle ( )
inline

◆ FPBDRigidDynamicSpringConstraintHandle() [2/2]

Chaos::FPBDRigidDynamicSpringConstraintHandle::FPBDRigidDynamicSpringConstraintHandle ( FConstraintContainer InConstraintContainer,
int32  InConstraintIndex 
)
inline

Member Function Documentation

◆ GetConstrainedParticles()

FParticlePair Chaos::FPBDRigidDynamicSpringConstraintHandle::GetConstrainedParticles ( ) const
finaloverridevirtual

◆ StaticType()

static const FConstraintHandleTypeID & Chaos::FPBDRigidDynamicSpringConstraintHandle::StaticType ( )
inlinestatic

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