Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | FIKRetargetAlignPoleVectorOp |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/RetargetOps/AlignPoleVectorOp.h |
| Include Path | #include "Retargeter/RetargetOps/AlignPoleVectorOp.h" |
Syntax
USTRUCT (BlueprintType , Meta=(DisplayName="Pole Vector Alignment"))
struct FIKRetargetAlignPoleVectorOp : public FIKRetargetOpBase
Inheritance Hierarchy
- FIKRetargetOpBase → FIKRetargetAlignPoleVectorOp
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChainMapping | FRetargetChainMapping | This op maintains its own chain mapping table to allow per-op mapping | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
| Settings | FIKRetargetAlignPoleVectorOpSettings | Retargeter/RetargetOps/AlignPoleVectorOp.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PoleVectorMatchers | TArray< FPoleVectorMatcher > | Retargeter/RetargetOps/AlignPoleVectorOp.h |
Functions
Public
Overridden from FIKRetargetOpBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AreChainSettingsAtDefault
(
const FName& InChainName |
(optional) override to support "Reset to Default" UI for chains | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual FRetargetChainMapping * GetChainMapping () |
(optional) ops can optionally store their own chain mapping, this allows outside systems to query/edit it. | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual const UIKRigDefinition * GetCustomTargetIKRig() |
(optional) override and supply the target IK Rig this op references NOTE: The retarget processor will resolve the bone chains in the rig so that they can be queried by the op. | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual FIKRetargetOpSettingsBase * GetSettings () |
(required) override and return a pointer to the settings struct used by this operation NOTE: it is not permitted to modify the settings from inside this getter. | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual const UScriptStruct * GetSettingsType() |
(required) override and return the type used to house the settings for this operation | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual const UScriptStruct * GetType() |
(required) override and return the type of this op (the derived subclass) | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual FText GetWarningMessage() |
(optional) override to display a warning message in the op stack | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual bool Initialize
(
const FIKRetargetProcessor& InProcessor, |
(optional) override to cache internal data when initializing the processor NOTE: you must set bIsInitialized to true to inform the retargeter that this op is ok to execute. | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual void OnAddedToStack
(
const UIKRetargeter* InRetargetAsset, |
(optional) override to automate initial setup after being added to the stack | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual void OnAssignIKRig
(
const ERetargetSourceOrTarget SourceOrTarget, |
(optional) override to react after user assigns a new IK Rig to all ops | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual void OnReinitPropertyEdited
(
const FPropertyChangedEvent* InPropertyChangedEvent |
(optional) override to allow ops to react when a property marked "ReinitializeOnEdit" is modified NOTE: this is called before Initialize() is called again to give op a chance to auto-configure itself based on its new state NOTE: this is called in several places where InPropertyChangedEvent may be null | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual void OnTargetChainRenamed
(
const FName InOldChainName, |
(optional) implement this if the op stores chain settings by name to allow the settings to be maintained after a chain is renamed NOTE: this is only called when the target IK Rig this op references has a chain that is renamed. | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual void ResetChainSettingsToDefault
(
const FName& InChainName |
(optional) override to support resetting all settings for a given chain | Retargeter/RetargetOps/AlignPoleVectorOp.h | |
virtual void Run
(
FIKRetargetProcessor& InProcessor, |
(optional) override to evaluate this operation and modify the output pose | Retargeter/RetargetOps/AlignPoleVectorOp.h |