a.AnimNode.HandIKRetargeting.Enable

a.AnimNode.HandIKRetargeting.Enable

#Overview

name: a.AnimNode.HandIKRetargeting.Enable

This variable is created as a Console Variable (cvar).

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of a.AnimNode.HandIKRetargeting.Enable is to control the enabling or disabling of Hand IK retargeting in Unreal Engine’s animation system. This setting variable is specifically used for debugging purposes in the animation graph runtime.

This setting variable is relied upon by the AnimGraphRuntime module, particularly in the implementation of the Hand IK Retargeting feature. It’s used within the FAnimNode_HandIKRetargeting class, which is part of the bone controllers in the animation system.

The value of this variable is set through a console variable (CVar) named CVarAnimHandIKRetargetingEnable. It’s initialized with a default value of true, meaning Hand IK retargeting is enabled by default.

The associated variable CVarAnimHandIKRetargetingEnable directly interacts with a.AnimNode.HandIKRetargeting.Enable. They share the same value and purpose.

Developers must be aware that this variable is only active when ENABLE_ANIM_DEBUG is defined. It’s intended for debugging purposes and may not be available in shipping builds.

Best practices when using this variable include:

  1. Use it for debugging Hand IK retargeting issues in development builds.
  2. Be aware that disabling it may affect the quality of hand animations in your game.
  3. Remember to re-enable it after debugging to ensure proper hand IK retargeting.

Regarding the associated variable CVarAnimHandIKRetargetingEnable:

The purpose of CVarAnimHandIKRetargetingEnable is to provide runtime control over the Hand IK retargeting feature for debugging purposes.

This console variable is used in the AnimGraphRuntime module, specifically in the FAnimNode_HandIKRetargeting class.

The value of CVarAnimHandIKRetargetingEnable is set when the variable is initialized, but it can be changed at runtime through console commands.

It directly interacts with the a.AnimNode.HandIKRetargeting.Enable setting, as they represent the same functionality.

Developers should be aware that this variable is only available in debug builds (when ENABLE_ANIM_DEBUG is defined).

Best practices for using CVarAnimHandIKRetargetingEnable include:

  1. Use console commands to toggle Hand IK retargeting on and off during runtime for debugging.
  2. Remember that changes made through this console variable are temporary and won’t persist between sessions.
  3. Use it in conjunction with other animation debugging tools for comprehensive troubleshooting of hand animations.

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Runtime/AnimGraphRuntime/Private/BoneControllers/AnimNode_HandIKRetargeting.cpp:7

Scope: file

Source code excerpt:


#if ENABLE_ANIM_DEBUG
static TAutoConsoleVariable<bool> CVarAnimHandIKRetargetingEnable(TEXT("a.AnimNode.HandIKRetargeting.Enable"), true, TEXT("Enable / Disable Hand IK retargeting"));
#endif

/////////////////////////////////////////////////////
// FAnimNode_HandIKRetargeting

FAnimNode_HandIKRetargeting::FAnimNode_HandIKRetargeting()

#Associated Variable and Callsites

This variable is associated with another variable named CVarAnimHandIKRetargetingEnable. They share the same value. See the following C++ source code.

#Loc: <Workspace>/Engine/Source/Runtime/AnimGraphRuntime/Private/BoneControllers/AnimNode_HandIKRetargeting.cpp:7

Scope: file

Source code excerpt:


#if ENABLE_ANIM_DEBUG
static TAutoConsoleVariable<bool> CVarAnimHandIKRetargetingEnable(TEXT("a.AnimNode.HandIKRetargeting.Enable"), true, TEXT("Enable / Disable Hand IK retargeting"));
#endif

/////////////////////////////////////////////////////
// FAnimNode_HandIKRetargeting

FAnimNode_HandIKRetargeting::FAnimNode_HandIKRetargeting()

#Loc: <Workspace>/Engine/Source/Runtime/AnimGraphRuntime/Private/BoneControllers/AnimNode_HandIKRetargeting.cpp:43

Scope (from outer to inner):

file
function     void FAnimNode_HandIKRetargeting::EvaluateSkeletalControl_AnyThread

Source code excerpt:


#if ENABLE_ANIM_DEBUG
	if (!CVarAnimHandIKRetargetingEnable.GetValueOnAnyThread())
	{
		return;
	}
#endif 
	// Early exit if alpha is zero
	if (PerAxisAlpha.IsNearlyZero())