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::FIntrusiveConstraintHandle Class Reference

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

#include <ConstraintHandle.h>

+ Inheritance diagram for Chaos::FIntrusiveConstraintHandle:

Public Member Functions

 FIntrusiveConstraintHandle ()
 
void SetContainer (FPBDConstraintContainer *InContainer)
 
- Public Member Functions inherited from Chaos::FConstraintHandle
 FConstraintHandle ()
 
 FConstraintHandle (FPBDConstraintContainer *InContainer)
 
virtual ~FConstraintHandle ()
 
virtual bool IsValid () const
 
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 ()
 

Additional Inherited Members

- Public Types inherited from Chaos::FConstraintHandle
using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 
- Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainer * ConstraintContainer
 
Private::FPBDIslandConstraint * GraphEdge
 

Detailed Description

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

Intended for use by constraint types that are allocated on the heap or in a block allocator and therefore have a persistent address (as opposed to array-based containers where the array could relocate). The constraint class should inherit this handle class. This effectively eliminates the handle, reducing cache misses and allocations.

Constructor & Destructor Documentation

◆ FIntrusiveConstraintHandle()

Chaos::FIntrusiveConstraintHandle::FIntrusiveConstraintHandle ( )
inline

Member Function Documentation

◆ SetContainer()

void Chaos::FIntrusiveConstraintHandle::SetContainer ( FPBDConstraintContainer *  InContainer)
inline

◆ StaticType()

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