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

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)

   
Name FAnimNode_BoneDrivenController
Type struct
Header File /Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_BoneDrivenController.h
Include Path #include "BoneControllers/AnimNode_BoneDrivenController.h"

Syntax

USTRUCT ()  
struct FAnimNode_BoneDrivenController : public FAnimNode_SkeletalControlBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FAnimNode_BoneDrivenController()

   BoneControllers/AnimNode_BoneDrivenController.h  

Variables

Public

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ConvertTargetComponentToBits()

 Upgrade a node from the output enum to the output bits (change made in FAnimationCustomVersion::BoneDrivenControllerMatchingMaya) BoneControllers/AnimNode_BoneDrivenController.h  

Overridden from FAnimNode_SkeletalControlBase

Name Remarks Include Path Unreal Specifiers

virtual void EvaluateComponentSpaceInternal ( FComponentSpacePoseContext& Context
)

 Use this function to evaluate for skeletal control base BoneControllers/AnimNode_BoneDrivenController.h  

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

 Evaluate the new component-space transforms for the affected bones. BoneControllers/AnimNode_BoneDrivenController.h  

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

 Return true if it is valid to Evaluate BoneControllers/AnimNode_BoneDrivenController.h  

Overridden from FAnimNode_Base

Name Remarks Include Path Unreal Specifiers

virtual void GatherDebugData ( FNodeDebugData& DebugData
)

   BoneControllers/AnimNode_BoneDrivenController.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 Extracts the value used to drive the target bone or parameter BoneControllers/AnimNode_BoneDrivenController.h  

Overridden from FAnimNode_SkeletalControlBase

Name Remarks Include Path Unreal Specifiers

virtual void InitializeBoneReferences ( const FBoneContainer& RequiredBones
)

 Initialize any bone references you have BoneControllers/AnimNode_BoneDrivenController.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page