1. Epic GamesDeveloper
  3. FRigUnit

FRigUnit

Base class for all rig units

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units

Inheritance Hierarchy

References

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

Syntax

USTRUCT (BlueprintType ,  
        Meta=(Abstract, NodeColor="0.1 0.1 0.1", ExecuteContext="FControlRigExecuteContext"))  
struct FRigUnit : public FRigVMStruct

Remarks

Base class for all rig units

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Virtual Const void Optionally configures a control's settings and value for a given target
Public function Virtual Const FTransform

DetermineOffsetTransformForPin ( const FString& InPinPath,
void* InUserContext
)

  
Public function Virtual Const FRigElementKey

DetermineSpaceForPin ( const FString& InPinPath,
void* InUserContext
)

  
Public function Virtual Const bool

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

 Returns the targets for viewport posing
Public function Static FName The name of the method used within each rig unit
Public function Virtual Const TArray< const URigVMPin * > Returns a list of pins affected by the viewport pose
Public function Virtual Const void Allows the node to draw debug drawing during a manipulation
Public function Virtual bool Sets the values on this node based on a viewport pose
Public function Virtual bool Sets a control's pose to represent this viewport pose target

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page