UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::TIntrusiveConstraintHandle< T_CONSTRAINT > Class Template Reference

Base class for constraints that are allocated at permanent memory addresses and inherit the handle. More...

#include <ConstraintHandle.h>

+ Inheritance diagram for Chaos::TIntrusiveConstraintHandle< T_CONSTRAINT >:

Public Types

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

Public Member Functions

 TIntrusiveConstraintHandle ()
 
void SetContainer (FPBDConstraintContainer *InContainer)
 
FConstraintGetConstraint ()
 
const FConstraintGetConstraint () const
 
- Public Member Functions inherited from Chaos::FIntrusiveConstraintHandle
 FIntrusiveConstraintHandle ()
 
void SetContainer (FPBDConstraintContainer *InContainer)
 
- Public Member Functions inherited from Chaos::FConstraintHandle
 FConstraintHandle ()
 
 FConstraintHandle (FPBDConstraintContainer *InContainer)
 
virtual ~FConstraintHandle ()
 
virtual bool IsValid () const
 
FPBDConstraintContainerGetContainer ()
 
const FPBDConstraintContainerGetContainer () const
 
bool IsInConstraintGraph () const
 
Private::FPBDIslandConstraintGetConstraintGraphEdge () 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 FConstraintHandleTypeIDGetType () const
 
 UE_DEPRECATED (5.3, "Use GetConstraintGraphEdge") int32 GetConstraintGraphIndex() const
 
 UE_DEPRECATED (5.3, "Not supported") void SetConstraintGraphIndex(const int32 InIndex) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Chaos::FIntrusiveConstraintHandle
static const FConstraintHandleTypeIDStaticType ()
 
- Static Public Member Functions inherited from Chaos::FConstraintHandle
static const FConstraintHandleTypeIDStaticType ()
 
static const FConstraintHandleTypeIDInvalidType ()
 
- Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainerConstraintContainer
 
Private::FPBDIslandConstraintGraphEdge
 

Detailed Description

template<typename T_CONSTRAINT>
class Chaos::TIntrusiveConstraintHandle< T_CONSTRAINT >

Base class for constraints that are allocated at permanent memory addresses and inherit the handle.

See also
FIntrusiveConstraintHandle
Template Parameters
T_CONSTRAINTThe constraint type

Member Typedef Documentation

◆ FConstraint

Constructor & Destructor Documentation

◆ TIntrusiveConstraintHandle()

template<typename T_CONSTRAINT >
Chaos::TIntrusiveConstraintHandle< T_CONSTRAINT >::TIntrusiveConstraintHandle ( )
inline

Member Function Documentation

◆ GetConstraint() [1/2]

◆ GetConstraint() [2/2]

template<typename T_CONSTRAINT >
const FConstraint * Chaos::TIntrusiveConstraintHandle< T_CONSTRAINT >::GetConstraint ( ) const
inline

◆ SetContainer()


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