FIKRetargetRunIKRigOp

API > API/Plugins > API/Plugins/IKRig

   
Name FIKRetargetRunIKRigOp
Type struct
Header File /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/RetargetOps/RunIKRigOp.h
Include Path #include "Retargeter/RetargetOps/RunIKRigOp.h"

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="Run IK Rig"))  
struct FIKRetargetRunIKRigOp : public FIKRetargetOpBase

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
DebugDataMutex FCriticalSection   Retargeter/RetargetOps/RunIKRigOp.h

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/RunIKRigOp.h  
GoalDebugData TArray< FRunIKRigOpGoalDebugData >   Retargeter/RetargetOps/RunIKRigOp.h  
Settings FIKRetargetRunIKRigOpSettings   Retargeter/RetargetOps/RunIKRigOp.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Chains TArray< FRunIKRigChain >   Retargeter/RetargetOps/RunIKRigOp.h  
GoalBoneIndicesMap TMap< FName, int32 >   Retargeter/RetargetOps/RunIKRigOp.h  
IKRigProcessor FIKRigProcessor The IK Rig processor for running IK on the target Retargeter/RetargetOps/RunIKRigOp.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArray< FName > GetRequiredTargetChains()

   Retargeter/RetargetOps/RunIKRigOp.h  

void RegenerateChainSettings()

   Retargeter/RetargetOps/RunIKRigOp.h  

void SaveCurrentGoalTransformsIntoDebugData()

   Retargeter/RetargetOps/RunIKRigOp.h  

void SaveInitialGoalTransformsIntoDebugData ( const FIKRetargetProcessor& InProcessor,
const TArray< FTransform >& InTargetGlobalPose
)

   Retargeter/RetargetOps/RunIKRigOp.h  

Public Virtual

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/RunIKRigOp.h  

virtual bool CanHaveChildOps()

 (optional) ops can optionally behave as a 'parent' where child ops must be executed first. Retargeter/RetargetOps/RunIKRigOp.h  

virtual void DebugDraw ( FPrimitiveDrawInterface* InPDI,
const FTransform& InSourceTransform,
const FTransform& InTargetTransform,
const double InComponentScale,
const FIKRetargetDebugDrawState& InEditorState
) const

 (optional) override to draw debug info into the editor viewport when the Op is selected Retargeter/RetargetOps/RunIKRigOp.h  
(optional) ops can optionally store their own chain mapping, this allows outside systems to query/edit it. Retargeter/RetargetOps/RunIKRigOp.h  

virtual uint8 * GetChainSettingsMemory ( const FName InChainName
)

 (required for any op that stores settings per-chain) return the memory for the settings struct associated with a particular chain NOTE: implementing this can automate some boilerplate UI setup, allows systems to display chain settings and get/set them. Retargeter/RetargetOps/RunIKRigOp.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/RunIKRigOp.h  
(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/RunIKRigOp.h  

virtual const UScriptStruct * GetSettingsType()

 (required) override and return the type used to house the settings for this operation Retargeter/RetargetOps/RunIKRigOp.h  

virtual const UScriptStruct * GetType()

 (required) override and return the type of this op (the derived subclass) Retargeter/RetargetOps/RunIKRigOp.h  

virtual bool HasDebugDrawing()

 (required if using DebugDraw()) return true to display the debug draw toggle in the UI Retargeter/RetargetOps/RunIKRigOp.h  

virtual bool Initialize ( const FIKRetargetProcessor& InProcessor,
const FRetargetSkeleton& InSourceSkeleton,
const FTargetSkeleton& InTargetSkeleton,
const FIKRetargetOpBase* InParentOp,
FIKRigLogger& Log
)

 (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/RunIKRigOp.h  

virtual void InitializeBeforeChildren ( FIKRetargetProcessor& InProcessor,
const FRetargetSkeleton& InSourceSkeleton,
const FTargetSkeleton& InTargetSkeleton,
FIKRigLogger& Log
)

 (optional) override to give this op a chance to initialize before it's children are initialized This is executed right after the previous op in the stack and right before the first child op Initialize() is called NOTE: unless this is a parent op, this will have no effect Retargeter/RetargetOps/RunIKRigOp.h  

virtual void OnAddedToStack ( const UIKRetargeter* InRetargetAsset,
const FIKRetargetOpBase* InParentOp
)

 (optional) override to automate initial setup after being added to the stack Retargeter/RetargetOps/RunIKRigOp.h  

virtual void OnAssignIKRig ( const ERetargetSourceOrTarget SourceOrTarget,
const UIKRigDefinition* InIKRig,
const FIKRetargetOpBase* InParentOp
)

 (optional) override to react after user assigns a new IK Rig to all ops Retargeter/RetargetOps/RunIKRigOp.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/RunIKRigOp.h  

virtual void ResetChainSettingsToDefault ( const FName& InChainName
)

 (optional) override to support resetting all settings for a given chain Retargeter/RetargetOps/RunIKRigOp.h  

virtual void Run ( FIKRetargetProcessor& InProcessor,
const double InDeltaTime,
const TArray< FTransform >& InSourceGlobalPose,
TArray< FTransform >& OutTargetGlobalPose
)

 (optional) override to evaluate this operation and modify the output pose Retargeter/RetargetOps/RunIKRigOp.h  

virtual void RunBeforeChildren ( FIKRetargetProcessor& InProcessor,
const double InDeltaTime,
const TArray< FTransform >& InSourceGlobalPose,
TArray< FTransform >& OutTargetGlobalPose
)

 (optional) override to give this op a chance to do work before it's children are run This is executed right after the previous op in the stack and right before the first child op Run() is called NOTE: unless this is a parent op, this will have no effect Retargeter/RetargetOps/RunIKRigOp.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ValidateIKChain ( const FName& InChainToValidate,
const FIKRigGoalContainer& InGoalContainer,
const FRetargeterBoneChains& InBoneChains,
const FIKRetargetOpBase* InOp,
const FIKRetargetOpBase* InParentOp,
FIKRigLogger& InLog,
const FResolvedBoneChain*& OutSourceBoneChain,
const FResolvedBoneChain*& OutTargetBoneChain
)

 A helper function that sub-ops can use to validate IK chains before use Retargeter/RetargetOps/RunIKRigOp.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page