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

#include <IndexedConstraintContainer.h>

+ Inheritance diagram for Chaos::FIndexedConstraintHandle:

Public Types

using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 
- Public Types inherited from Chaos::FConstraintHandle
using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 

Public Member Functions

 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 TVec2< FGeometryParticleHandle * > GetConstrainedParticles () const =0
 
virtual void SetEnabled (bool InEnabled)=0
 
virtual bool IsEnabled () const =0
 
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 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::FConstraintHandle
static const FConstraintHandleTypeID & StaticType ()
 
static const FConstraintHandleTypeID & InvalidType ()
 

Protected Attributes

int32 ConstraintIndex
 
- Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainer * ConstraintContainer
 
Private::FPBDIslandConstraint * GraphEdge
 

Friends

class FPBDIndexedConstraintContainer
 

Detailed Description

Base class for handles to constraints in an index-based container (e.g., FJointConstraints)

Member Typedef Documentation

◆ FGeometryParticleHandle

using Chaos::FIndexedConstraintHandle::FGeometryParticleHandle = TGeometryParticleHandle<FReal, 3>

Constructor & Destructor Documentation

◆ FIndexedConstraintHandle() [1/2]

Chaos::FIndexedConstraintHandle::FIndexedConstraintHandle ( )
inline

◆ FIndexedConstraintHandle() [2/2]

Chaos::FIndexedConstraintHandle::FIndexedConstraintHandle ( FPBDConstraintContainer *  InContainer,
int32  InConstraintIndex 
)
inline

◆ ~FIndexedConstraintHandle()

virtual Chaos::FIndexedConstraintHandle::~FIndexedConstraintHandle ( )
inlinevirtual

Member Function Documentation

◆ GetConstraintIndex()

int32 Chaos::FIndexedConstraintHandle::GetConstraintIndex ( ) const
inline

◆ IsValid()

virtual bool Chaos::FIndexedConstraintHandle::IsValid ( ) const
inlineoverridevirtual

Reimplemented from Chaos::FConstraintHandle.

◆ SetConstraintIndex()

void Chaos::FIndexedConstraintHandle::SetConstraintIndex ( const int32  InConstraintIndex)
inline

◆ StaticType()

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

Friends And Related Symbol Documentation

◆ FPBDIndexedConstraintContainer

friend class FPBDIndexedConstraintContainer
friend

Member Data Documentation

◆ ConstraintIndex

int32 Chaos::FIndexedConstraintHandle::ConstraintIndex
protected
The documentation for this class was generated from the following file: