AnimNode_AnimDynamics.cpp File Reference

#include "BoneControllers/AnimNode_AnimDynamics.h"
#include "Animation/AnimInstance.h"
#include "Components/SkeletalMeshComponent.h"
#include "GameFramework/WorldSettings.h"
#include "Animation/AnimInstanceProxy.h"
#include "PhysicsEngine/PhysicsSettings.h"
#include "SceneInterface.h"
#include "CommonAnimationLibrary.h"
#include "ProfilingDebugging/CsvProfiler.h"

Classes
struct	FSimBodiesScratch

Functions
	DEFINE_STAT (STAT_AnimDynamicsOverall)
	DEFINE_STAT (STAT_AnimDynamicsWindData)
	DEFINE_STAT (STAT_AnimDynamicsBoneEval)
	DEFINE_STAT (STAT_AnimDynamicsSubSteps)
	CSV_DECLARE_CATEGORY_MODULE_EXTERN (ENGINE_API, Animation)
FAutoConsoleVariableRef	CVarAnimDynamicsSpaceAngularAlpha (TEXT("p.AnimDynamics.Space.SimSpaceAngularAlpha"), AnimDynamics_SimSpaceOverride.SimSpaceAngularAlpha, TEXT("AnimDynamics SimSpaceSettings overrides"), ECVF_Default)
FAutoConsoleVariableRef	CVarAnimDynamicsSpaceMaxCompAngVel (TEXT("p.AnimDynamics.Space.MaxAngularVelocity"), AnimDynamics_SimSpaceOverride.MaxAngularVelocity, TEXT("AnimDynamics SimSpaceSettings overrides"), ECVF_Default)
FAutoConsoleVariableRef	CVarAnimDynamicsSpaceMaxCompAngAcc (TEXT("p.AnimDynamics.Space.MaxAngularAcceleration"), AnimDynamics_SimSpaceOverride.MaxAngularAcceleration, TEXT("AnimDynamics SimSpaceSettings overrides"), ECVF_Default)
void	FindChainBones (const FName BeginBoneName, const FName EndBoneName, TFunctionRef< FName(const FName) > GetParentBoneName, TArray< FName > &OutChainBoneNames)

Variables
TAutoConsoleVariable< int32 >	CVarRestrictLod (TEXT("p.AnimDynamicsRestrictLOD"), -1, TEXT("Forces anim dynamics to be enabled for only a specified LOD, -1 to enable on all LODs."))
TAutoConsoleVariable< int32 >	CVarLODThreshold (TEXT("p.AnimDynamicsLODThreshold"), -1, TEXT("Max LOD that anim dynamics is allowed to run on. Provides a global threshold that overrides per-node the LODThreshold property. -1 means no override."), ECVF_Scalability)
TAutoConsoleVariable< int32 >	CVarEnableDynamics (TEXT("p.AnimDynamics"), 1, TEXT("Enables/Disables anim dynamics node updates."), ECVF_Scalability)
TAutoConsoleVariable< int32 >	CVarEnableScaling (TEXT("p.AnimDynamics.ScaleSupport"), 1, TEXT("Enables/Disables scaling support for anim dynamics nodes."))
TAutoConsoleVariable< int32 >	CVarEnableAdaptiveSubstep (TEXT("p.AnimDynamicsAdaptiveSubstep"), 0, TEXT("Enables/disables adaptive substepping. Adaptive substepping will substep the simulation when it is necessary and maintain a debt buffer for time, always trying to utilise as much time as possible."))
TAutoConsoleVariable< int32 >	CVarAdaptiveSubstepNumDebtFrames (TEXT("p.AnimDynamicsNumDebtFrames"), 5, TEXT("Number of frames to maintain as time debt when using adaptive substepping, this should be at least 1 or the time debt will never be cleared."))
TAutoConsoleVariable< int32 >	CVarEnableWind (TEXT("p.AnimDynamicsWind"), 1, TEXT("Enables/Disables anim dynamics wind forces globally."), ECVF_Scalability)
TAutoConsoleVariable< float >	CVarComponentAppliedLinearAccClampOverride (TEXT("p.AnimDynamics.ComponentAppliedLinearAccClampOverride"), -1.0f, TEXT("Override the per asset setting for all axis (X,Y & Z) of ComponentAppliedLinearAccClamp for all Anim Dynamics Nodes. Negative values are ignored."))
TAutoConsoleVariable< float >	CVarGravityScale (TEXT("p.AnimDynamics.GravityScale"), 1.0f, TEXT("Multiplies the default gravity and the gravity override on all Anim Dynamics Nodes."))
TAutoConsoleVariable< bool >	CVarDisableWorldSpace (TEXT("p.AnimDynamics.DisableWorldSpace"), false, TEXT("Disable World Sapce transform and override it to component space on all Anim Dynamics Nodes."))
bool	bAnimDynamics_SimSpace_EnableOverride = false
FAnimPhysSimSpaceSettings	AnimDynamics_SimSpaceOverride
FAutoConsoleVariableRef	CVarAnimDynamicsSpaceOverride (TEXT("p.AnimDynamics.Space.Override"), bAnimDynamics_SimSpace_EnableOverride, TEXT("Force-enable the advanced simulation space movement forces"), ECVF_Default)

Function Documentation

CSV_DECLARE_CATEGORY_MODULE_EXTERN()

CSV_DECLARE_CATEGORY_MODULE_EXTERN	(	ENGINE_API	,
		Animation
	)

CVarAnimDynamicsSpaceAngularAlpha()

FAutoConsoleVariableRef CVarAnimDynamicsSpaceAngularAlpha	(	TEXT("p.AnimDynamics.Space.SimSpaceAngularAlpha")	,
		AnimDynamics_SimSpaceOverride.	SimSpaceAngularAlpha,
		TEXT("AnimDynamics SimSpaceSettings overrides")	,
		ECVF_Default
	)

CVarAnimDynamicsSpaceMaxCompAngAcc()

FAutoConsoleVariableRef CVarAnimDynamicsSpaceMaxCompAngAcc	(	TEXT("p.AnimDynamics.Space.MaxAngularAcceleration")	,
		AnimDynamics_SimSpaceOverride.	MaxAngularAcceleration,
		TEXT("AnimDynamics SimSpaceSettings overrides")	,
		ECVF_Default
	)

CVarAnimDynamicsSpaceMaxCompAngVel()

FAutoConsoleVariableRef CVarAnimDynamicsSpaceMaxCompAngVel	(	TEXT("p.AnimDynamics.Space.MaxAngularVelocity")	,
		AnimDynamics_SimSpaceOverride.	MaxAngularVelocity,
		TEXT("AnimDynamics SimSpaceSettings overrides")	,
		ECVF_Default
	)

DEFINE_STAT() [1/4]

DEFINE_STAT

(

STAT_AnimDynamicsBoneEval

)

DEFINE_STAT() [2/4]

DEFINE_STAT

(

STAT_AnimDynamicsOverall

)

DEFINE_STAT() [3/4]

DEFINE_STAT

(

STAT_AnimDynamicsSubSteps

)

DEFINE_STAT() [4/4]

DEFINE_STAT

(

STAT_AnimDynamicsWindData

)

FindChainBones()

void FindChainBones	(	const FName	BeginBoneName,
		const FName	EndBoneName,
		TFunctionRef< FName(const FName) >	GetParentBoneName,
		TArray< FName > &	OutChainBoneNames
	)

Variable Documentation

AnimDynamics_SimSpaceOverride

FAnimPhysSimSpaceSettings AnimDynamics_SimSpaceOverride

bAnimDynamics_SimSpace_EnableOverride

bool bAnimDynamics_SimSpace_EnableOverride = false

CVarAdaptiveSubstepNumDebtFrames

TAutoConsoleVariable< int32 > CVarAdaptiveSubstepNumDebtFrames(TEXT("p.AnimDynamicsNumDebtFrames"), 5, TEXT("Number of frames to maintain as time debt when using adaptive substepping, this should be at least 1 or the time debt will never be cleared."))	(	TEXT("p.AnimDynamicsNumDebtFrames")	,
		5	,
		TEXT("Number of frames to maintain as time debt when using adaptive substepping, this should be at least 1 or the time debt will never be cleared.")
	)

CVarAnimDynamicsSpaceOverride

FAutoConsoleVariableRef CVarAnimDynamicsSpaceOverride(TEXT("p.AnimDynamics.Space.Override"), bAnimDynamics_SimSpace_EnableOverride, TEXT("Force-enable the advanced simulation space movement forces"), ECVF_Default)	(	TEXT("p.AnimDynamics.Space.Override")	,
		bAnimDynamics_SimSpace_EnableOverride	,
		TEXT("Force-enable the advanced simulation space movement forces")	,
		ECVF_Default
	)

CVarComponentAppliedLinearAccClampOverride

TAutoConsoleVariable< float > CVarComponentAppliedLinearAccClampOverride(TEXT("p.AnimDynamics.ComponentAppliedLinearAccClampOverride"), -1.0f, TEXT("Override the per asset setting for all axis (X,Y & Z) of ComponentAppliedLinearAccClamp for all Anim Dynamics Nodes. Negative values are ignored."))	(	TEXT("p.AnimDynamics.ComponentAppliedLinearAccClampOverride")	,
		-1.	0f,
		TEXT("Override the per asset setting for all axis (X,Y & Z) of ComponentAppliedLinearAccClamp for all Anim Dynamics Nodes. Negative values are ignored.")
	)

CVarDisableWorldSpace

TAutoConsoleVariable< bool > CVarDisableWorldSpace(TEXT("p.AnimDynamics.DisableWorldSpace"), false, TEXT("Disable World Sapce transform and override it to component space on all Anim Dynamics Nodes."))	(	TEXT("p.AnimDynamics.DisableWorldSpace")	,
		false	,
		TEXT("Disable World Sapce transform and override it to component space on all Anim Dynamics Nodes.")
	)

CVarEnableAdaptiveSubstep

TAutoConsoleVariable< int32 > CVarEnableAdaptiveSubstep(TEXT("p.AnimDynamicsAdaptiveSubstep"), 0, TEXT("Enables/disables adaptive substepping. Adaptive substepping will substep the simulation when it is necessary and maintain a debt buffer for time, always trying to utilise as much time as possible."))	(	TEXT("p.AnimDynamicsAdaptiveSubstep")	,
		0	,
		TEXT("Enables/disables adaptive substepping. Adaptive substepping will substep the simulation when it is necessary and maintain a debt buffer for time, always trying to utilise as much time as possible.")
	)

CVarEnableDynamics

TAutoConsoleVariable< int32 > CVarEnableDynamics(TEXT("p.AnimDynamics"), 1, TEXT("Enables/Disables anim dynamics node updates."), ECVF_Scalability)	(	TEXT("p.AnimDynamics")	,
		1	,
		TEXT("Enables/Disables anim dynamics node updates.")	,
		ECVF_Scalability
	)

CVarEnableScaling

TAutoConsoleVariable< int32 > CVarEnableScaling(TEXT("p.AnimDynamics.ScaleSupport"), 1, TEXT("Enables/Disables scaling support for anim dynamics nodes."))	(	TEXT("p.AnimDynamics.ScaleSupport")	,
		1	,
		TEXT("Enables/Disables scaling support for anim dynamics nodes.")
	)

CVarEnableWind

TAutoConsoleVariable< int32 > CVarEnableWind(TEXT("p.AnimDynamicsWind"), 1, TEXT("Enables/Disables anim dynamics wind forces globally."), ECVF_Scalability)	(	TEXT("p.AnimDynamicsWind")	,
		1	,
		TEXT("Enables/Disables anim dynamics wind forces globally.")	,
		ECVF_Scalability
	)

CVarGravityScale

TAutoConsoleVariable< float > CVarGravityScale(TEXT("p.AnimDynamics.GravityScale"), 1.0f, TEXT("Multiplies the default gravity and the gravity override on all Anim Dynamics Nodes."))	(	TEXT("p.AnimDynamics.GravityScale")	,
		1.	0f,
		TEXT("Multiplies the default gravity and the gravity override on all Anim Dynamics Nodes.")
	)

CVarLODThreshold

TAutoConsoleVariable< int32 > CVarLODThreshold(TEXT("p.AnimDynamicsLODThreshold"), -1, TEXT("Max LOD that anim dynamics is allowed to run on. Provides a global threshold that overrides per-node the LODThreshold property. -1 means no override."), ECVF_Scalability)	(	TEXT("p.AnimDynamicsLODThreshold")	,
		-	1,
		TEXT("Max LOD that anim dynamics is allowed to run on. Provides a global threshold that overrides per-node the LODThreshold property. -1 means no override.")	,
		ECVF_Scalability
	)

CVarRestrictLod

TAutoConsoleVariable< int32 > CVarRestrictLod(TEXT("p.AnimDynamicsRestrictLOD"), -1, TEXT("Forces anim dynamics to be enabled for only a specified LOD, -1 to enable on all LODs."))	(	TEXT("p.AnimDynamicsRestrictLOD")	,
		-	1,
		TEXT("Forces anim dynamics to be enabled for only a specified LOD, -1 to enable on all LODs.")
	)