Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | FIKRigGoalContainer |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/IKRigDataTypes.h |
| Include Path | #include "Rig/IKRigDataTypes.h" |
Syntax
USTRUCT ()
struct FIKRigGoalContainer
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bRigNeedsInitialized | bool | Set to true when: |
a new goal is added
a goal has it's enabled flag toggled | Rig/IKRigDataTypes.h | |
| FIKRigProcessor | friend | Rig/IKRigDataTypes.h | ||
| Goals | TArray< FIKRigGoal > | Array of Goals. Cannot contain duplicates (name is key). | Rig/IKRigDataTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Empty() |
Clear out all Goals in container. | Rig/IKRigDataTypes.h | |
const void FillWithGoalArray
(
const TArray< UIKRigEffectorGoal* >& InGoals |
Fill this contain with all the goals in the input array | Rig/IKRigDataTypes.h | |
const FIKRigGoal * FindGoalByName
(
const FName& GoalName |
Get an IK goal with the given name. | Rig/IKRigDataTypes.h | |
FIKRigGoal * FindGoalByName
(
const FName& GoalName |
Get an IK goal with the given name. | Rig/IKRigDataTypes.h | |
const TArray< FIKRigGoal > & GetGoalArray () |
Get read-only access to array of Goals. | Rig/IKRigDataTypes.h | |
TArray< FIKRigGoal > & GetGoalArray () |
Rig/IKRigDataTypes.h | ||
bool IsEmpty() |
Returns true if there are no goals in the container | Rig/IKRigDataTypes.h | |
bool NeedsInitialized() |
Returns true if the container has a goal in it that triggered a reinitialization | Rig/IKRigDataTypes.h | |
void SetIKGoal
(
const FIKRigGoal& InGoal |
Set an IK goal to go to a specific location and rotation (in the specified space) blended by alpha. | Rig/IKRigDataTypes.h | |
void SetIKGoal
(
const UIKRigEffectorGoal* InEffectorGoal |
Set an IK goal to go to a specific location and rotation (in the specified space) blended by alpha. | Rig/IKRigDataTypes.h |