Navigation
API > API/Plugins > API/Plugins/ControlRig
Base class for all rig units
| Name | FRigUnit |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/RigUnit.h |
| Include Path | #include "Units/RigUnit.h" |
Syntax
USTRUCT (BlueprintType ,
Meta=(Abstract, NodeColor="0.1 0.1 0.1", ExecuteContext="FControlRigExecuteContext"))
struct FRigUnit : public FRigVMStruct
Inheritance Hierarchy
- FRigVMStruct → FRigUnit
Derived Classes
FRigUnit derived class hierarchy
- FRigUnit_BeginExecution
- FRigUnit_BinaryFloatOp
- FRigUnit_BinaryQuaternionOp
- FRigUnit_BinaryTransformOp
- FRigUnit_BinaryVectorOp
- FRigUnit_BlendTransform
- FRigUnit_BoneName
- FRigUnit_Clamp_Float
- FRigUnit_CollectionBase
- FRigUnit_ConnectorExecution
- FRigUnit_Control
- FRigUnit_ControlName
- FRigUnit_ControlRigSplineBase
- FRigUnit_ConvertEulerTransform
- FRigUnit_ConvertQuaternion
- FRigUnit_ConvertQuaternionToVector
- FRigUnit_ConvertRotation
- FRigUnit_ConvertRotationToVector
- FRigUnit_ConvertTransform
- FRigUnit_ConvertVectorToQuaternion
- FRigUnit_ConvertVectorToRotation
- FRigUnit_CurveExists
- FRigUnit_DebugBase
- FRigUnit_Distance_VectorVector
- FRigUnit_DrawContainerGetInstruction
- FRigUnit_DynamicHierarchyBase
- FRigUnit_FilterItemsByMetadataTags
- FRigUnit_FindItemsWithMetadata
- FRigUnit_FindItemsWithMetadataTag
- FRigUnit_FindItemsWithMetadataTagArray
- FRigUnit_GetAnimationChannelBase
- FRigUnit_GetAnimationChannelFromItemBase
- FRigUnit_GetBoneTransform
- FRigUnit_GetCandidates
- FRigUnit_GetControlBool
- FRigUnit_GetControlColor
- FRigUnit_GetControlDrivenList
- FRigUnit_GetControlFloat
- FRigUnit_GetControlInitialTransform
- FRigUnit_GetControlInteger
- FRigUnit_GetControlOffset
- FRigUnit_GetControlRotator
- FRigUnit_GetControlTransform
- FRigUnit_GetControlVector
- FRigUnit_GetControlVector2D
- FRigUnit_GetControlVisibility
- FRigUnit_GetCurveValue
- FRigUnit_GetInitialBoneTransform
- FRigUnit_GetLengthAtParamControlRigSpline
- FRigUnit_GetLengthControlRigSpline
- FRigUnit_GetMetadataTags
- FRigUnit_GetRelativeBoneTransform
- FRigUnit_GetRelativeTransformForItem
- FRigUnit_GetShapeTransform
- FRigUnit_GetSpaceTransform
- FRigUnit_GetTransform
- FRigUnit_GetTransformArray
- FRigUnit_GetTransformItemArray
- FRigUnit_HasMetadata
- FRigUnit_HasMetadataTag
- FRigUnit_HasMetadataTagArray
- FRigUnit_HierarchyBase
- FRigUnit_HighlevelBase
- FRigUnit_InteractionExecution
- FRigUnit_InverseExecution
- FRigUnit_IsInteracting
- FRigUnit_Item
- FRigUnit_ItemArray
- FRigUnit_ItemBase
- FRigUnit_LineTraceByObjectTypes
- FRigUnit_LineTraceByTraceChannel
- FRigUnit_MapRange_Float
- FRigUnit_PostBeginExecution
- FRigUnit_PostPrepareForExecution
- FRigUnit_PreBeginExecution
- FRigUnit_PrepareForExecution
- FRigUnit_ProjectTransformToNewParent
- FRigUnit_QuaternionFromAxisAndAngle
- FRigUnit_QuaternionToAngle
- FRigUnit_QuaternionToAxisAndAngle
- FRigUnit_RigModulesBase
- FRigUnit_SequenceExecution
- FRigUnit_ShapeExists
- FRigUnit_SpaceName
- FRigUnit_SphereTraceByObjectTypes
- FRigUnit_SphereTraceByTraceChannel
- FRigUnit_SphereTraceWorld
- FRigUnit_ToRigSpace_Location
- FRigUnit_ToRigSpace_Rotation
- FRigUnit_ToRigSpace_Transform
- FRigUnit_ToSwingAndTwist
- FRigUnit_ToWorldSpace_Location
- FRigUnit_ToWorldSpace_Rotation
- FRigUnit_ToWorldSpace_Transform
- FRigUnit_UnaryQuaternionOp
- FRigUnitMutable
- FRigUnit_PhysicsBase
- FRigUnit_LiveLinkBase
- FRigUnit_LiveLinkEvaluateInputDeviceValue
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit() |
Units/RigUnit.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRigUnit() |
Virtual destructor | Units/RigUnit.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ConfigureDirectManipulationControl
(
const URigVMUnitNode* InNode, |
Optionally configures a control's settings and value for a given target | Units/RigUnit.h | |
virtual FTransform DetermineOffsetTransformForPin
(
const FString& InPinPath, |
Units/RigUnit.h | ||
virtual FRigElementKey DetermineSpaceForPin
(
const FString& InPinPath, |
Units/RigUnit.h | ||
virtual bool GetDirectManipulationTargets
(
const URigVMUnitNode* InNode, |
Returns the targets for viewport posing | Units/RigUnit.h | |
virtual TArray< const URigVMPin * > GetPinsForDirectManipulation
(
const URigVMUnitNode* InNode, |
Returns a list of pins affected by the viewport pose | Units/RigUnit.h | |
virtual void PerformDebugDrawingForDirectManipulation
(
const URigVMUnitNode* InNode, |
Allows the node to draw debug drawing during a manipulation | Units/RigUnit.h | |
virtual bool UpdateDirectManipulationFromHierarchy
(
const URigVMUnitNode* InNode, |
Sets the values on this node based on a viewport pose | Units/RigUnit.h | |
virtual bool UpdateHierarchyForDirectManipulation
(
const URigVMUnitNode* InNode, |
Sets a control's pose to represent this viewport pose target | Units/RigUnit.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool AddDirectManipulationTarget_Internal
(
TArray< FRigDirectManipulationTarget >& InOutTargets, |
Units/RigUnit.h | ||
static TTuple< const FStructProperty *, uint8 * > FindStructPropertyAndTargetMemory
(
TSharedPtr< FStructOnScope > InInstance, |
Units/RigUnit.h | ||
static FName GetMethodName() |
The name of the method used within each rig unit | Units/RigUnit.h |