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

#include <CharacterGroundConstraintContainer.h>

+ Inheritance diagram for Chaos::FCharacterGroundConstraintHandle:

Public Types

using Base = TIntrusiveConstraintHandle< FCharacterGroundConstraintHandle >
 
using FConstraintContainer = FCharacterGroundConstraintContainer
 
- Public Types inherited from Chaos::TIntrusiveConstraintHandle< FCharacterGroundConstraintHandle >
using FConstraint = FCharacterGroundConstraintHandle
 
- Public Types inherited from Chaos::FConstraintHandle
using FGeometryParticleHandle = TGeometryParticleHandle< FReal, 3 >
 

Public Member Functions

 FCharacterGroundConstraintHandle ()
 
ESyncState GetSyncState () const
 
void SetSyncState (ESyncState InSyncState)
 
EResimType GetResimType () const
 
bool GetEnabledDuringResim () const
 
void SetEnabledDuringResim (bool bEnabled)
 
virtual void SetEnabled (bool InEnabled) override
 
virtual bool IsEnabled () const
 
const FCharacterGroundConstraintSettings & GetSettings () const
 
const FCharacterGroundConstraintDynamicData & GetData () const
 
void SetData (const FCharacterGroundConstraintDynamicData &InData)
 
void SetSettings (const FCharacterGroundConstraintSettings &InSettings)
 
FCharacterGroundConstraintSettings & GetSettings_Mutable ()
 
virtual FParticlePair GetConstrainedParticles () const override final
 
FGeometryParticleHandle * GetCharacterParticle () const
 
FGeometryParticleHandle * GetGroundParticle () const
 
void SetGroundParticle (FGeometryParticleHandle *InGroundParticle)
 
FVec3 GetSolverAppliedForce () const
 
FVec3 GetSolverAppliedTorque () const
 
bool HasGroundParticleChanged () const
 
bool HaveSettingsChanged () const
 
bool HasDataChanged () const
 
void ClearDirtyFlags ()
 
- Public Member Functions inherited from Chaos::TIntrusiveConstraintHandle< FCharacterGroundConstraintHandle >
 TIntrusiveConstraintHandle ()
 
void SetContainer (FPBDConstraintContainer *InContainer)
 
FConstraint * GetConstraint ()
 
const FConstraint * GetConstraint () 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
 
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 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::FIntrusiveConstraintHandle
static const FConstraintHandleTypeID & StaticType ()
 
- Static Public Member Functions inherited from Chaos::FConstraintHandle
static const FConstraintHandleTypeID & StaticType ()
 
static const FConstraintHandleTypeID & InvalidType ()
 

Friends

class FCharacterGroundConstraintContainer
 
class FCharacterGroundConstraintProxy
 
class Private::FCharacterGroundConstraintContainerSolver
 
class ChaosTest::CharacterGroundConstraintContainerTest
 

Additional Inherited Members

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

Detailed Description

Physics thread side representation of a character ground constraint Data accessed through this class is synced from the game thread representation FCharacterGroundConstraint

Member Typedef Documentation

◆ Base

using Chaos::FCharacterGroundConstraintHandle::Base = TIntrusiveConstraintHandle<FCharacterGroundConstraintHandle>

◆ FConstraintContainer

using Chaos::FCharacterGroundConstraintHandle::FConstraintContainer = FCharacterGroundConstraintContainer

Constructor & Destructor Documentation

◆ FCharacterGroundConstraintHandle()

Chaos::FCharacterGroundConstraintHandle::FCharacterGroundConstraintHandle ( )
inline

Member Function Documentation

◆ ClearDirtyFlags()

void Chaos::FCharacterGroundConstraintHandle::ClearDirtyFlags ( )
inline

◆ GetCharacterParticle()

FGeometryParticleHandle * Chaos::FCharacterGroundConstraintHandle::GetCharacterParticle ( ) const
inline

◆ GetConstrainedParticles()

virtual FParticlePair Chaos::FCharacterGroundConstraintHandle::GetConstrainedParticles ( ) const
inlinefinaloverridevirtual

Implements Chaos::FConstraintHandle.

◆ GetData()

const FCharacterGroundConstraintDynamicData & Chaos::FCharacterGroundConstraintHandle::GetData ( ) const
inline

◆ GetEnabledDuringResim()

bool Chaos::FCharacterGroundConstraintHandle::GetEnabledDuringResim ( ) const
inline

◆ GetGroundParticle()

FGeometryParticleHandle * Chaos::FCharacterGroundConstraintHandle::GetGroundParticle ( ) const
inline

◆ GetResimType()

EResimType Chaos::FCharacterGroundConstraintHandle::GetResimType ( ) const
inline

◆ GetSettings()

const FCharacterGroundConstraintSettings & Chaos::FCharacterGroundConstraintHandle::GetSettings ( ) const
inline

Settings is only modifiable on the game thread via FCharacterGroundConstraint but Data can be modified on the physics thread and is synced with the game thread

◆ GetSettings_Mutable()

FCharacterGroundConstraintSettings & Chaos::FCharacterGroundConstraintHandle::GetSettings_Mutable ( )
inline

◆ GetSolverAppliedForce()

FVec3 Chaos::FCharacterGroundConstraintHandle::GetSolverAppliedForce ( ) const
inline

◆ GetSolverAppliedTorque()

FVec3 Chaos::FCharacterGroundConstraintHandle::GetSolverAppliedTorque ( ) const
inline

◆ GetSyncState()

ESyncState Chaos::FCharacterGroundConstraintHandle::GetSyncState ( ) const
inline

◆ HasDataChanged()

bool Chaos::FCharacterGroundConstraintHandle::HasDataChanged ( ) const
inline

◆ HasGroundParticleChanged()

bool Chaos::FCharacterGroundConstraintHandle::HasGroundParticleChanged ( ) const
inline

◆ HaveSettingsChanged()

bool Chaos::FCharacterGroundConstraintHandle::HaveSettingsChanged ( ) const
inline

◆ IsEnabled()

virtual bool Chaos::FCharacterGroundConstraintHandle::IsEnabled ( ) const
inlinevirtual

Implements Chaos::FConstraintHandle.

◆ SetData()

void Chaos::FCharacterGroundConstraintHandle::SetData ( const FCharacterGroundConstraintDynamicData &  InData)
inline

◆ SetEnabled()

virtual void Chaos::FCharacterGroundConstraintHandle::SetEnabled ( bool  InEnabled)
inlineoverridevirtual

Implements Chaos::FConstraintHandle.

◆ SetEnabledDuringResim()

void Chaos::FCharacterGroundConstraintHandle::SetEnabledDuringResim ( bool  bEnabled)
inline

◆ SetGroundParticle()

void Chaos::FCharacterGroundConstraintHandle::SetGroundParticle ( FGeometryParticleHandle *  InGroundParticle)
inline

◆ SetSettings()

void Chaos::FCharacterGroundConstraintHandle::SetSettings ( const FCharacterGroundConstraintSettings &  InSettings)
inline

◆ SetSyncState()

void Chaos::FCharacterGroundConstraintHandle::SetSyncState ( ESyncState  InSyncState)
inline

◆ StaticType()

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

Friends And Related Symbol Documentation

◆ ChaosTest::CharacterGroundConstraintContainerTest

friend class ChaosTest::CharacterGroundConstraintContainerTest
friend

◆ FCharacterGroundConstraintContainer

friend class FCharacterGroundConstraintContainer
friend

◆ FCharacterGroundConstraintProxy

friend class FCharacterGroundConstraintProxy
friend

◆ Private::FCharacterGroundConstraintContainerSolver

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