UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
Chaos::FPBDNullConstraintHandle Class Referencefinal

#include <PBDNullConstraints.h>

+ Inheritance diagram for Chaos::FPBDNullConstraintHandle:

Public Member Functions

 FPBDNullConstraintHandle (FPBDNullConstraints *InConstraintContainer, int32 ConstraintIndex)
 
virtual void SetEnabled (bool bInEnabled) override
 
virtual bool IsEnabled () const override
 
virtual void SetIsSleeping (bool bInIsSleeping) override
 
virtual bool IsSleeping () const override
 
virtual FParticlePair GetConstrainedParticles () const override
 
- Public Member Functions inherited from Chaos::TIndexedContainerConstraintHandle< FPBDNullConstraints >
 TIndexedContainerConstraintHandle ()
 
 TIndexedContainerConstraintHandle (FConstraintContainer *InConstraintContainer, int32 InConstraintIndex)
 
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 ()
 
FPBDConstraintContainer * GetContainer ()
 
const FPBDConstraintContainer * GetContainer () const
 
bool IsInConstraintGraph () const
 
Private::FPBDIslandConstraint * GetConstraintGraphEdge () const
 
void SetConstraintGraphEdge (Private::FPBDIslandConstraint *InEdge)
 
virtual bool IsProbe () const
 
virtual bool SupportsSleeping () const
 
virtual bool SupportsPartialIslandSleeping () const
 
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 FConstraintHandleTypeID & GetType () 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 FConstraintHandleTypeID & StaticType ()
 
- Static Public Member Functions inherited from Chaos::FIndexedConstraintHandle
static const FConstraintHandleTypeID & StaticType ()
 
- Static Public Member Functions inherited from Chaos::FConstraintHandle
static const FConstraintHandleTypeID & StaticType ()
 
static const FConstraintHandleTypeID & InvalidType ()
 

Additional Inherited Members

- Public Types inherited from Chaos::TIndexedContainerConstraintHandle< FPBDNullConstraints >
using Base = FIndexedConstraintHandle
 
using FGeometryParticleHandle = typename Base::FGeometryParticleHandle
 
using FConstraintContainer = FPBDNullConstraints
 
- Public Types inherited from Chaos::FIndexedConstraintHandle
using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 
- Public Types inherited from Chaos::FConstraintHandle
using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 
- Protected Member Functions inherited from Chaos::TIndexedContainerConstraintHandle< FPBDNullConstraints >
FConstraintContainer * ConcreteContainer ()
 
const FConstraintContainer * ConcreteContainer () const
 
- Protected Attributes inherited from Chaos::TIndexedContainerConstraintHandle< FPBDNullConstraints >
int32 ConstraintIndex
 
- Protected Attributes inherited from Chaos::FIndexedConstraintHandle
int32 ConstraintIndex
 
- Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainer * ConstraintContainer
 
Private::FPBDIslandConstraint * GraphEdge
 

Constructor & Destructor Documentation

◆ FPBDNullConstraintHandle()

Chaos::FPBDNullConstraintHandle::FPBDNullConstraintHandle ( FPBDNullConstraints *  InConstraintContainer,
int32  ConstraintIndex 
)
inline

Member Function Documentation

◆ GetConstrainedParticles()

virtual FParticlePair Chaos::FPBDNullConstraintHandle::GetConstrainedParticles ( ) const
inlineoverridevirtual

Implements Chaos::FConstraintHandle.

◆ IsEnabled()

virtual bool Chaos::FPBDNullConstraintHandle::IsEnabled ( ) const
inlineoverridevirtual

Reimplemented from Chaos::TIndexedContainerConstraintHandle< FPBDNullConstraints >.

◆ IsSleeping()

virtual bool Chaos::FPBDNullConstraintHandle::IsSleeping ( ) const
inlineoverridevirtual

Reimplemented from Chaos::FConstraintHandle.

◆ SetEnabled()

virtual void Chaos::FPBDNullConstraintHandle::SetEnabled ( bool  bInEnabled)
inlineoverridevirtual

Reimplemented from Chaos::TIndexedContainerConstraintHandle< FPBDNullConstraints >.

◆ SetIsSleeping()

virtual void Chaos::FPBDNullConstraintHandle::SetIsSleeping ( bool  bInIsSleeping)
inlineoverridevirtual

Reimplemented from Chaos::FConstraintHandle.

◆ StaticType()

static const FConstraintHandleTypeID & Chaos::FPBDNullConstraintHandle::StaticType ( )
inlinestatic
The documentation for this class was generated from the following file: