1. Epic GamesDeveloper
  3. FRigUnit_ModifyTransforms

FRigUnit_ModifyTransforms

Modify Transforms is used to perform a change in the hierarchy by setting one or more bones' transforms

API > API/Plugins > API/Plugins/ControlRig

Modify Transforms is used to perform a change in the hierarchy by setting one or more bones' transforms

   
Name FRigUnit_ModifyTransforms
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h
Include Path #include "Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h"

Syntax

USTRUCT (  
        Meta=(DisplayName="Modify Transforms", Category="Transforms", DocumentationPolicy="Strict", Keywords="ModifyBone"))  
struct FRigUnit_ModifyTransforms : public FRigUnit_HighlevelBaseMutable

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigUnit_ModifyTransforms()

   Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ItemToModify TArray< FRigUnit_ModifyTransforms_PerItem > The items to modify. Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h
  • Meta=(Input, ExpandByDefault, DefaultArraySize=1)
Mode EControlRigModifyBoneMode Defines if the bone's transform should be set in local or global space, additive or override. Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h
  • Meta=(Input, Constant)
Weight float At 1 this sets the transform, between 0 and 1 the transform is blended with previous results. Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h
  • Meta=(Input, ClampMin=0.f, ClampMax=1.f, UIMin=0.f, UIMax=1.f)
WeightMaximum float The maximum of the weight - defaults to 1.0 Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h
  • Meta=(Input, Constant, ClampMin=0.f, ClampMax=1.f, UIMin=0.f, UIMax=1.f)
WeightMinimum float The minimum of the weight - defaults to 0.0 Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h
  • Meta=(Input, Constant, ClampMin=0.f, ClampMax=1.f, UIMin=0.f, UIMax=1.f)
WorkData FRigUnit_ModifyTransforms_WorkData Used to cache the internally used bone index. Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 GetIndexFromTarget ( const FString& InTarget
) const

   Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h  

Overridden from FRigUnit

Name Remarks Include Path Unreal Specifiers

virtual bool GetDirectManipulationTargets ( const URigVMUnitNode* InNode,
TSharedPtr< FStructOnScope > InInstance,
URigHierarchy* InHierarchy,
TArray< FRigDirectManipulationTarget >& InOutTargets,
FString* OutFailureReason
) const

 Returns the targets for viewport posing Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h  

virtual TArray< const URigVMPin * > GetPinsForDirectManipulation ( const URigVMUnitNode* InNode,
const FRigDirectManipulationTarget& InTarget
) const

 Returns a list of pins affected by the viewport pose Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h  

virtual bool UpdateDirectManipulationFromHierarchy ( const URigVMUnitNode* InNode,
TSharedPtr< FStructOnScope > InInstance,
FControlRigExecuteContext& InContext,
TSharedPtr< FRigDirectManipulationInfo > InInfo
)

 Sets the values on this node based on a viewport pose Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h  

virtual bool UpdateHierarchyForDirectManipulation ( const URigVMUnitNode* InNode,
TSharedPtr< FStructOnScope > InInstance,
FControlRigExecuteContext& InContext,
TSharedPtr< FRigDirectManipulationInfo > InInfo
)

 Sets a control's pose to represent this viewport pose target Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h  

Overridden from FRigVMStruct

Name Remarks Include Path Unreal Specifiers

virtual void Execute()

   Units/Highlevel/Hierarchy/RigUnit_ModifyTransforms.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page