1. Epic GamesDeveloper
  3. FIKRetargetFKChainsOp

FIKRetargetFKChainsOp

API > API/Plugins > API/Plugins/IKRig

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

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="FK Chains"))  
struct FIKRetargetFKChainsOp : public FIKRetargetOpBase

Inheritance Hierarchy

Constants

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllChainsDebugData TArray< FFKChainDebugData >   Retargeter/RetargetOps/FKChainsOp.h  
Settings FIKRetargetFKChainsOpSettings   Retargeter/RetargetOps/FKChainsOp.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ChainPairsFK TArray< FChainPairFK > The Source/Target pairs of Bone Chains retargeted using the FK algorithm Retargeter/RetargetOps/FKChainsOp.h  
ChildrenToUpdateLocalTransforms TArray< FTransform >   Retargeter/RetargetOps/FKChainsOp.h  
NonRetargetedChildrenToUpdate TArray< int32 > Children of the FK chains that need updated after the chains are retargeted Retargeter/RetargetOps/FKChainsOp.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SaveDebugData ( const TArray< FTransform >& OutTargetGlobalPose
)

   Retargeter/RetargetOps/FKChainsOp.h  

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

virtual void CollectRetargetedBones ( TSet< int32 >& OutRetargetedBones
) const

 (optional) override and add any bones that your op modifies to the output TSet of bone indices Add indices of any bone that this op modifies. Retargeter/RetargetOps/FKChainsOp.h  

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

 (optional) override to draw debug info into the editor viewport when the Op is selected Retargeter/RetargetOps/FKChainsOp.h  
(optional) ops can optionally store their own chain mapping, this allows outside systems to query/edit it. Retargeter/RetargetOps/FKChainsOp.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/FKChainsOp.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/FKChainsOp.h  

virtual const UScriptStruct * GetSettingsType()

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

virtual const UScriptStruct * GetType()

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

virtual bool HasDebugDrawing()

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

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

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

virtual void PostInitialize ( const FIKRetargetProcessor& InProcessor,
const FRetargetSkeleton& InSourceSkeleton,
const FTargetSkeleton& InTargetSkeleton,
FIKRigLogger& InLog
)

 (optional) a second pass of initialization that ops can use after Op::Initialize() is called on all ops. Retargeter/RetargetOps/FKChainsOp.h  

virtual void PostLoad ( const FIKRigObjectVersion::Type InVersion
)

 (optional) called during the PostLoad of the owning asset. Retargeter/RetargetOps/FKChainsOp.h  

virtual void ResetChainSettingsToDefault ( const FName& InChainName
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page