1. Epic GamesDeveloper
  3. FAnimNode_BoneDrivenController

FAnimNode_BoneDrivenController

This is the runtime version of a bone driven controller, which maps part of the state from one bone to another (e.g., 2 * source.x -> target.z)

API > API/Runtime > API/Runtime/AnimGraphRuntime > API/Runtime/AnimGraphRuntime/BoneControllers

Inheritance Hierarchy

References

   
Module AnimGraphRuntime
Header /Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_BoneDrivenController.h
Include #include "BoneControllers/AnimNode_BoneDrivenController.h"

Syntax

USTRUCT ()  
struct FAnimNode_BoneDrivenController : public FAnimNode_SkeletalControlBase

Remarks

This is the runtime version of a bone driven controller, which maps part of the state from one bone to another (e.g., 2 * source.x -> target.z)

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetRotationX Affect the X component of rotation on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetRotationY Affect the Y component of rotation on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetRotationZ Affect the Z component of rotation on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetScaleX Affect the X component of scale on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetScaleY Affect the Y component of scale on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetScaleZ Affect the Z component of scale on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetTranslationX Affect the X component of translation on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetTranslationY Affect the Y component of translation on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bAffectTargetTranslationZ Affect the Z component of translation on the target bone.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bUseRange Whether or not to clamp the driver value and remap it before scaling it.
Public variable UProperty Category, EditAnywhere EDrivenDestinationMode DestinationMode Type of destination to drive, currently either bone or morph target.
Public variable UProperty Category, EditAnywhere TObjectPtr< UCurveFloat > DrivingCurve Curve used to map from the source attribute to the driven attributes if present (otherwise the Multiplier will be used)
Public variable UProperty Category, EditAnywhere EDrivenBoneModificationMode ModificationMode The type of modification to make to the destination component(s)
Public variable UProperty Category, EditAnywhere float Multiplier Multiplier to apply to the input value (Note: Ignored when a curve is used)
Public variable UProperty Category, EditAnywhere FName ParameterName Name of Morph Target to drive using the source attribute
Public variable UProperty Category, EditAnywhere, Meta double RangeMax Maximum limit of the input value (mapped to RemappedMax, only used when limiting the source range) If this is rotation, the unit is radian
Public variable UProperty Category, EditAnywhere, Meta double RangeMin Minimum limit of the input value (mapped to RemappedMin, only used when limiting the source range) If this is rotation, the unit is radian
Public variable UProperty Category, EditAnywhere, Meta double RemappedMax Maximum value to apply to the destination (remapped from the input range) If this is rotation, the unit is radian
Public variable UProperty Category, EditAnywhere, Meta double RemappedMin Minimum value to apply to the destination (remapped from the input range) If this is rotation, the unit is radian
Public variable UProperty Category, EditAnywhere FBoneReference SourceBone Bone to use as controller input.
Public variable UProperty Category, EditAnywhere TEnumAsByte< EComponentType::Type > SourceComponent Transform component to use as input.
Public variable UProperty Category, EditAnywhere FBoneReference TargetBone Bone to drive using controller input.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Upgrade a node from the output enum to the output bits (change made in FAnimationCustomVersion::BoneDrivenControllerMatchingMaya)
Protected function const double

ExtractSourceValue ( const FTransform& InCurrentBoneTransform,
const FTransform& InRefPoseBoneTransform
)

 Extracts the value used to drive the target bone or parameter
Public function Virtual void

GatherDebugData ( FNodeDebugData& DebugData
)

  

Overridden from FAnimNode_SkeletalControlBase

  Type Name Description
Public function Virtual void

EvaluateComponentSpaceInternal ( FComponentSpacePoseContext& Context
)

 Use this function to evaluate for skeletal control base
Public function Virtual void

EvaluateSkeletalControl_AnyThread ( FComponentSpacePoseContext& Output,
TArray< FBoneTransform >& OutBoneTransforms
)

 Evaluate the new component-space transforms for the affected bones.
Protected function Virtual void

InitializeBoneReferences ( const FBoneContainer& RequiredBones
)

 Initialize any bone references you have
Public function Virtual bool

IsValidToEvaluate ( const USkeleton* Skeleton,
const FBoneContainer& RequiredBones
)

 Return true if it is valid to Evaluate

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page