FIKRetargetBlendToSourceOp

API > API/Plugins > API/Plugins/IKRig

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

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="Blend to Source"))  
struct FIKRetargetBlendToSourceOp : public FIKRetargetOpBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Settings FIKRetargetBlendToSourceOpSettings   Retargeter/RetargetOps/BlendToSourceOp.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ChainsToBlend TArray< FIKChainToBlend >   Retargeter/RetargetOps/BlendToSourceOp.h  
PelvisMotionOp const FIKRetargetPelvisMotionOp *   Retargeter/RetargetOps/BlendToSourceOp.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void RegenerateChainSettings ( const FIKRetargetOpBase* InParentOp
)

   Retargeter/RetargetOps/BlendToSourceOp.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/BlendToSourceOp.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/BlendToSourceOp.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/BlendToSourceOp.h  

virtual const UScriptStruct * GetParentOpType()

 (optional) ops can optionally behave as a 'child' where they can be parented to ops of the type returned by this function. Retargeter/RetargetOps/BlendToSourceOp.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/BlendToSourceOp.h  

virtual const UScriptStruct * GetSettingsType()

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

virtual const UScriptStruct * GetType()

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

virtual bool HasDebugDrawing()

 (required if using DebugDraw()) return true to display the debug draw toggle in the UI Retargeter/RetargetOps/BlendToSourceOp.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/BlendToSourceOp.h  

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

 (optional) override to automate initial setup after being added to the stack Retargeter/RetargetOps/BlendToSourceOp.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/BlendToSourceOp.h  

virtual void OnParentReinitPropertyEdited ( const FIKRetargetOpBase& InParentOp,
const FPropertyChangedEvent* InPropertyChangedEvent
)

 (optional) override to allow ops to react when a property marked "ReinitializeOnEdit" on the parent op is modified NOTE: InPropertyChangedEvent will be null at load time giving op a chance to clean based on parent state. Retargeter/RetargetOps/BlendToSourceOp.h  

virtual void OnTargetChainRenamed ( const FName InOldChainName,
const FName InNewChainName
)

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

virtual void ResetChainSettingsToDefault ( const FName& InChainName
)

 (optional) override to support resetting all settings for a given chain Retargeter/RetargetOps/BlendToSourceOp.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/BlendToSourceOp.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page