Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | UIKRigEffectorGoal |
| Type | class |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/IKRigDefinition.h |
| Include Path | #include "Rig/IKRigDefinition.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UIKRigEffectorGoal : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UIKRigEffectorGoal
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExposePosition | bool | Should position data be exposed in Blueprint | Rig/IKRigDefinition.h |
|
| bExposeRotation | bool | Should rotation data be exposed in Blueprint | Rig/IKRigDefinition.h |
|
| BoneName | FName | The name of the bone that this Goal is located at. | Rig/IKRigDefinition.h |
|
| CurrentTransform | FTransform | The current transform of this Goal, in the Global Space of the character. | Rig/IKRigDefinition.h |
|
| GoalName | FName | The name used to refer to this goal from outside systems. | Rig/IKRigDefinition.h |
|
| InitialTransform | FTransform | The initial transform of this Goal, as defined by the initial transform of the Goal's bone in the retarget pose. | Rig/IKRigDefinition.h |
|
| PositionAlpha | float | Range 0-1, default is 1. | Rig/IKRigDefinition.h |
|
| PreviewMode | EIKRigGoalPreviewMode | Effects how this Goal transform is previewed in the IK Rig editor. | Rig/IKRigDefinition.h |
|
| RotationAlpha | float | Range 0-1, default is 1. | Rig/IKRigDefinition.h |
|
| SizeMultiplier | float | The size of the Goal gizmo drawing in the editor viewport. | Rig/IKRigDefinition.h |
|
| ThicknessMultiplier | float | The thickness of the Goal gizmo drawing in the editor viewport. | Rig/IKRigDefinition.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TOptional< FTransform::FReal > GetNumericValue
(
ESlateTransformComponent::Type Component, |
Rig/IKRigDefinition.h | ||
void OnCopyToClipboard
(
ESlateTransformComponent::Type Component, |
Rig/IKRigDefinition.h | ||
void OnPasteFromClipboard
(
ESlateTransformComponent::Type Component, |
Rig/IKRigDefinition.h | ||
TTuple< FTransform, FTransform > PrepareNumericValueChanged
(
ESlateTransformComponent::Type Component, |
Rig/IKRigDefinition.h | ||
void ResetTransformToDefault
(
ESlateTransformComponent::Type Component, |
Rig/IKRigDefinition.h | ||
void SetTransform
(
const FTransform& InTransform, |
Rig/IKRigDefinition.h | ||
bool TransformDiffersFromDefault
(
ESlateTransformComponent::Type Component, |
Rig/IKRigDefinition.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Rig/IKRigDefinition.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const UIKRigEffectorGoal& Other |
Rig/IKRigDefinition.h |