1. Epic GamesDeveloper
  3. FAnimNode_ControlRigBase

FAnimNode_ControlRigBase

Animation node that allows animation ControlRig output to be used in an animation graph

API > API/Plugins > API/Plugins/ControlRig

Inheritance Hierarchy

References

   
Module ControlRig
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/AnimNode_ControlRigBase.h
Include #include "AnimNode_ControlRigBase.h"

Syntax

USTRUCT ()  
struct FAnimNode_ControlRigBase : public FAnimNode_CustomProperty

Remarks

Animation node that allows animation ControlRig output to be used in an animation graph

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay TArray< TObjectPtr< UAssetUserData > > AssetUserData  
Protected variable bool bClearEventQueueRequired  
Protected variable bool bControlRigRequiresInitialization  
Protected variable UProperty Transient bool bExecute  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay bool bResetInputPoseToInitial If this is checked the rig's pose needs to be reset to its initial prior to evaluating the rig.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay bool bTransferInputCurves If this is checked the curves coming from the AnimBP will be transferred into the Control Rig.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay bool bTransferInputPose If this is checked the bone pose coming from the AnimBP will be transferred into the Control Rig.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay bool bTransferPoseInGlobalSpace Transferring the pose in global space guarantees a global pose match, while transferring in local space ensures a match of the local transforms.
Protected variable TArray< TPair< uint16, uint16 > > ControlRigBoneInputMappingByIndex Complete mapping from skeleton to control rig bone index
Protected variable TMap< FName, uint16 > ControlRigBoneInputMappingByName Rig Hierarchy bone name to required array index mapping
Protected variable TArray< TPair< uint16, uint16 > > ControlRigBoneOutputMappingByIndex  
Protected variable TMap< FName, uint16 > ControlRigBoneOutputMappingByName  
Protected variable TArray< TPair< uint16, FName > > ControlRigCurveMappingByIndex Complete mapping from skeleton to curve name
Protected variable TMap< FName, FName > ControlRigCurveMappingByName Rig Curve name to Curve mapping
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay TArray< FControlRigAnimNodeEventName > EventQueue The customized event queue to run.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay TArray< FBoneReference > InputBonesToTransfer An inclusive list of bones to transfer as part of the input pose transfer phase.
Protected variable UProperty Transient FControlRigIOSettings InputSettings  
Protected variable TMap< FName, int32 > InputToControlIndex  
Protected variable float InternalBlendAlpha The below is alpha value support for control rig.
Protected variable uint16 LastBonesSerialNumberForCacheBones  
Protected variable UProperty Transient TWeakObjectPtr< UNodeMappingContainer > NodeMappingContainer Node Mapping Container
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay TArray< FBoneReference > OutputBonesToTransfer An inclusive list of bones to transfer as part of the output pose transfer phase.
Protected variable UProperty Transient FControlRigIOSettings OutputSettings  
Protected variable UProperty Category, EditAnywhere FPoseLink Source  
Protected variable TWeakObjectPtr< const UAnimInstance > WeakAnimInstanceObject  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void

CacheBones_AnyThread ( const FAnimationCacheBonesContext& Context
)

  
Protected function Virtual bool  
Public function Virtual void

Evaluate_AnyThread ( FPoseContext& Output
)

  
Protected function void

ExecuteControlRig ( FPoseContext& InOutput
)

 Execute control rig on the input pose and outputs the result
Public function Virtual void

GatherDebugData ( FNodeDebugData& DebugData
)

  
Protected function Const TArray< TObjectPtr< UAssetUserData > >  
Public function Virtual Const UControlRig * Return Control Rig of current object
Public function Virtual Const TSubclassOf< UControlRig >  
Protected function Virtual Const UClass *  
Public function Virtual void

Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

  
Public function Virtual Const bool  
Public function Virtual void

OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy,
const UAnimInstance* InAnimInstance
)

  
Protected function Const void

QueueControlRigDrawInstructions ( UControlRig* ControlRig,
FAnimInstanceProxy* Proxy
)

  
Public function Virtual void

Update_AnyThread ( const FAnimationUpdateContext& Context
)

  
Protected function Const void  
Protected function Virtual void

UpdateInput ( UControlRig* ControlRig,
const FPoseContext& InOutput
)

 Update input/output to control rig
Protected function void

UpdateInputOutputMappingIfRequired ( UControlRig* InControlRig,
const FBoneContainer& RequiredBones
)

  
Protected function Virtual void

UpdateOutput ( UControlRig* ControlRig,
FPoseContext& InOutput
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page