Navigation
API > API/Plugins > API/Plugins/ControlRig
Aligns the rotation of a primary and secondary axis of a bone to a global target. Note: This node operates in global space!
| Name | FRigUnit_AimItem |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
| Include Path | #include "Units/Highlevel/Hierarchy/RigUnit_AimBone.h" |
Syntax
USTRUCT (Meta=(DisplayName="Aim", Category="Hierarchy", Keywords="Lookat"))
struct FRigUnit_AimItem : public FRigUnit_HighlevelBaseMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_HighlevelBaseMutable → FRigUnit_AimItem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_AimItem() |
Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInitialized | bool | Units/Highlevel/Hierarchy/RigUnit_AimBone.h | ||
| CachedItem | FCachedRigElement | Units/Highlevel/Hierarchy/RigUnit_AimBone.h | ||
| DebugSettings | FRigUnit_AimBone_DebugSettings | The debug setting for the node | Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
|
| Item | FRigElementKey | The name of the item to align | Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
|
| Primary | FRigUnit_AimItem_Target | The primary target for the aim | Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
|
| PrimaryCachedSpace | FCachedRigElement | Units/Highlevel/Hierarchy/RigUnit_AimBone.h | ||
| Secondary | FRigUnit_AimItem_Target | The secondary target for the aim - also referred to as PoleVector / UpVector | Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
|
| SecondaryCachedSpace | FCachedRigElement | Units/Highlevel/Hierarchy/RigUnit_AimBone.h | ||
| Weight | float | The weight of the change - how much the change should be applied | Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
|
Functions
Public
Overridden from FRigUnit
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetDirectManipulationTargets
(
const URigVMUnitNode* InNode, |
Returns the targets for viewport posing | Units/Highlevel/Hierarchy/RigUnit_AimBone.h | |
virtual TArray< const URigVMPin * > GetPinsForDirectManipulation
(
const URigVMUnitNode* InNode, |
Returns a list of pins affected by the viewport pose | Units/Highlevel/Hierarchy/RigUnit_AimBone.h | |
virtual bool UpdateDirectManipulationFromHierarchy
(
const URigVMUnitNode* InNode, |
Sets the values on this node based on a viewport pose | Units/Highlevel/Hierarchy/RigUnit_AimBone.h | |
virtual bool UpdateHierarchyForDirectManipulation
(
const URigVMUnitNode* InNode, |
Sets a control's pose to represent this viewport pose target | Units/Highlevel/Hierarchy/RigUnit_AimBone.h |
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Highlevel/Hierarchy/RigUnit_AimBone.h |