Navigation
API > API/Runtime > API/Runtime/Chaos
Physics thread side representation of a character ground constraint Data accessed through this class is synced from the game thread representation FCharacterGroundConstraint
| Name | FCharacterGroundConstraintHandle |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Character/CharacterGroundConstraintContainer.h |
| Include Path | #include "Chaos/Character/CharacterGroundConstraintContainer.h" |
Syntax
class FCharacterGroundConstraintHandle : public Chaos::TIntrusiveConstraintHandle< FCharacterGroundConstraintHandle >
Inheritance Hierarchy
- FConstraintHandle → FIntrusiveConstraintHandle → TIntrusiveConstraintHandle → FCharacterGroundConstraintHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCharacterGroundConstraintHandle() |
Chaos/Character/CharacterGroundConstraintContainer.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Base | TIntrusiveConstraintHandle< FCharacterGroundConstraintHandle > | Chaos/Character/CharacterGroundConstraintContainer.h | |
| FConstraintContainer | FCharacterGroundConstraintContainer | Chaos/Character/CharacterGroundConstraintContainer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDisabled | bool | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| bEnabledDuringResim | bool | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| CharacterParticle | FGeometryParticleHandle * | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| Data | FCharacterGroundConstraintDynamicData | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| DirtyFlags | uint8 | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| GroundParticle | FGeometryParticleHandle * | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| LocalCharacterPosition | FVec3 | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| ResimType | EResimType | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| Settings | FCharacterGroundConstraintSettings | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| SolverAppliedForce | FVec3 | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| SolverAppliedTorque | FVec3 | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| SyncState | ESyncState | Chaos/Character/CharacterGroundConstraintContainer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearDirtyFlags() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
FGeometryParticleHandle * GetCharacterParticle() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
const FCharacterGroundConstraintDynamicData & GetData() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
bool GetEnabledDuringResim() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
FGeometryParticleHandle * GetGroundParticle() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
EResimType GetResimType() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
const FCharacterGroundConstraintSettings & GetSettings() |
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 | Chaos/Character/CharacterGroundConstraintContainer.h | |
FCharacterGroundConstraintSettings & GetSettings_Mutable() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
FVec3 GetSolverAppliedForce() |
Get the force applied by the solver due to this constraint. Units are ML/T^2. | Chaos/Character/CharacterGroundConstraintContainer.h | |
FVec3 GetSolverAppliedTorque() |
Get the torque applied by the solver due to this constraint. Units are ML^2/T^2. | Chaos/Character/CharacterGroundConstraintContainer.h | |
ESyncState GetSyncState() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
bool HasDataChanged() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
bool HasGroundParticleChanged() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
bool HaveSettingsChanged() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
void SetData
(
const FCharacterGroundConstraintDynamicData& InData |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
void SetEnabledDuringResim
(
bool bEnabled |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
void SetGroundParticle
(
FGeometryParticleHandle* InGroundParticle |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
void SetSettings
(
const FCharacterGroundConstraintSettings& InSettings |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
void SetSyncState
(
ESyncState InSyncState |
Chaos/Character/CharacterGroundConstraintContainer.h |
Overridden from FConstraintHandle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FParticlePair GetConstrainedParticles() |
Declared final so that TPBDConstraintGraphRuleImpl::AddToGraph() does not need to hit vtable. | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual bool IsEnabled() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
virtual void SetEnabled
(
bool InEnabled |
Chaos/Character/CharacterGroundConstraintContainer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FConstraintHandleTypeID & StaticType() |
Chaos/Character/CharacterGroundConstraintContainer.h |