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

#include <IndexedConstraintContainer.h>

+ Inheritance diagram for Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >:

Public Types

using Base = FIndexedConstraintHandle
 
using FGeometryParticleHandle = typename Base::FGeometryParticleHandle
 
using FConstraintContainer = T_CONTAINER
 
- 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

 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 TVec2< FGeometryParticleHandle * > GetConstrainedParticles () 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
 

Protected Member Functions

FConstraintContainerConcreteContainer ()
 
const FConstraintContainerConcreteContainer () const
 

Protected Attributes

int32 ConstraintIndex
 
- Protected Attributes inherited from Chaos::FIndexedConstraintHandle
int32 ConstraintIndex
 
- Protected Attributes inherited from Chaos::FConstraintHandle
FPBDConstraintContainerConstraintContainer
 
Private::FPBDIslandConstraintGraphEdge
 

Additional Inherited Members

- 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 ()
 

Detailed Description

template<typename T_CONTAINER>
class Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >

Utility base class for FIndexedConstraintHandles

Member Typedef Documentation

◆ Base

◆ FConstraintContainer

◆ FGeometryParticleHandle

Constructor & Destructor Documentation

◆ TIndexedContainerConstraintHandle() [1/2]

template<typename T_CONTAINER >
Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >::TIndexedContainerConstraintHandle ( )
inline

◆ TIndexedContainerConstraintHandle() [2/2]

template<typename T_CONTAINER >
Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >::TIndexedContainerConstraintHandle ( FConstraintContainer InConstraintContainer,
int32  InConstraintIndex 
)
inline

Member Function Documentation

◆ ConcreteContainer() [1/2]

template<typename T_CONTAINER >
FConstraintContainer * Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >::ConcreteContainer ( )
inlineprotected

◆ ConcreteContainer() [2/2]

template<typename T_CONTAINER >
const FConstraintContainer * Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >::ConcreteContainer ( ) const
inlineprotected

◆ IsEnabled()

template<typename T_CONTAINER >
virtual bool Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >::IsEnabled ( ) const
inlineoverridevirtual

◆ RemoveConstraint()

◆ SetEnabled()

template<typename T_CONTAINER >
virtual void Chaos::TIndexedContainerConstraintHandle< T_CONTAINER >::SetEnabled ( bool  bInEnabled)
inlineoverridevirtual

Member Data Documentation

◆ ConstraintIndex

template<typename T_CONTAINER >
int32 Chaos::FIndexedConstraintHandle::ConstraintIndex
protected

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