1. Epic GamesDeveloper
  3. FAnimNode_ControlRigBase

FAnimNode_ControlRigBase

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

Unreal Engine C++ API Reference > 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&40;&41;  
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 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  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Virtual bool  
Protected function void Execute control rig on the input pose and outputs the result
Public function Virtual Const UControlRig * Return Control Rig of current object
Public function Virtual Const TSubclassOf< UControlRig >  
Protected function Const void  
Protected function Virtual void

UpdateInput ( UControlRig* ControlRig,
const FPoseContext& InOutput
)

 Update input/output to control rig
Protected function Virtual void

UpdateOutput ( UControlRig* ControlRig,
FPoseContext& InOutput
)

  

Overridden from FAnimNode_CustomProperty

  Type Name Description
Protected function Virtual Const UClass * Get Target Class

Overridden from FAnimNode_Base

  Type Name Description
Public function Virtual void Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
Public function Virtual void Called to evaluate local-space bones transforms according to the weights set up in Update().
Public function Virtual void Called to gather on-screen debug data. This is called on the game thread.
Public function Virtual void Called when the node first runs.
Public function Virtual Const bool For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficient or inefficient to use Initialize_AnyThread), return true here.
Public function Virtual void

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

 We only subscribe to the OnInitializeAnimInstance path because we need to cache our source object, so we only override these methods in editor at the moment
Public function Virtual void Called to update the state of the graph relative to this node.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page