1. Epic GamesDeveloper
  3. UIKRetargeterController

UIKRetargeterController

A stateless singleton (1-per-asset) class used to make modifications to a [UIKRetargeter](API\Plugins\IKRig\Retargeter\UIKRetargeter) asset.

API > API/Plugins > API/Plugins/IKRigEditor > API/Plugins/IKRigEditor/RetargetEditor

Inheritance Hierarchy

References

   
Module IKRigEditor
Header /Engine/Plugins/Animation/IKRig/Source/IKRigEditor/Public/RetargetEditor/IKRetargeterController.h
Include #include "RetargetEditor/IKRetargeterController.h"

Syntax

UCLASS (Config=Engine, HideCategories=UObject)  
class UIKRetargeterController : public UObject

Remarks

A stateless singleton (1-per-asset) class used to make modifications to a UIKRetargeter asset. Use UIKRetargeter.GetController() to get the controller for the asset you want to modify.

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, BlueprintPure, Category int32 Add a new retarget op of the given type to the bottom of the stack. Returns the stack index.
Public function Const UFunction BlueprintCallable, Category void Automatically align all bones in mapped chains and store in the current retarget pose.
Public function Const UFunction BlueprintCallable, Category void

AutoAlignBones ( const TArray< FName >& BonesToAlign,
const ERetargetAutoAlignMethod Method,
ERetargetSourceOrTarget SourceOrTarget
)

 Automatically align an array of bones and store in the current retarget pose. Bones not in a mapped chain will be ignored.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

AutoMapChains ( const EAutoMapChainType AutoMapType,
const bool bForceRemap
)

 Use fuzzy string search to find "best" Source chain to map to each Target chain.
Public function Const void GENERAL C++ ONLY API Ensures all internal data is compatible with assigned meshes and ready to edit.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta FName

CreateRetargetPose ( const FName& NewPoseName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Add new retarget pose. Returns the name of the new retarget pose.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta FName

DuplicateRetargetPose ( const FName PoseToDuplicate,
const FName NewName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Duplicate a retarget pose. Returns the name of the new, duplicate pose (or NAME_None if PoseToDuplicate is not found).
Public function Const UFunction BlueprintCallable, Category, Meta const TArray< URetargetChainSettings * > & Get read-only access to the list of settings for each target chain.
Public function Const bool Get if we've already asked to fix the root height for the given skeletal mesh.
Public function Const UIKRetargeter * Get access to the retargeter asset.
Public function TObjectPtr< UIKRetargeter > &  
Public function Const FName

GetChainGoal ( const TObjectPtr< URetargetChainSettings > ChainSettings
)

 Get the name of the goal assigned to a chain.
Public function Static UFunction BlueprintCallable, Category, Meta UIKRetargeterController *

GetController ( const UIKRetargeter* InRetargeterAsset
)

 GENERAL PUBLIC/SCRIPTING API Use this to get the controller for the given retargeter asset
Public function Const UFunction BlueprintCallable, Category, Meta FIKRetargetPose & Get the current retarget pose.
Public function Const UFunction BlueprintCallable, Category, Meta FName Get the current retarget pose.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta FRetargetGlobalSettings Get a copy of the global settings for this asset.
Public function Const UFunction BlueprintCallable, Category, Meta const UIKRigDefinition *

GetIKRig ( const ERetargetSourceOrTarget SourceOrTarget
)

 Get either source or target IK Rig.
Public function Const UIKRigDefinition *

GetIKRigWriteable ( const ERetargetSourceOrTarget SourceOrTarget
)

 Get either source or target IK Rig.
Public function Const UFunction BlueprintCallable, Category int32 Get access to the given retarget operation.
Public function Const UFunction BlueprintCallable, Category int32 Get the number of Ops in the stack.
Public function Const UFunction BlueprintCallable, Category, Meta USkeletalMesh *

GetPreviewMesh ( const ERetargetSourceOrTarget SourceOrTarget
)

 Get the preview skeletal mesh.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta FTargetChainSettings

GetRetargetChainSettings ( const FName& TargetChainName
)

 Get a copy of the settings for the target chain by name.
Public function Const UFunction BlueprintCallable, Category URetargetOpBase * Get access to the given retarget operation.
Public function Const UFunction BlueprintCallable, Category bool

GetRetargetOpEnabled ( int32 RetargetOpIndex
)

 Get enabled status of the given Op.
Public function Const UFunction BlueprintCallable, Category, Meta TMap< FName, FIKRetargetPose > &

GetRetargetPoses ( const ERetargetSourceOrTarget SourceOrTarget
)

 Get access to array of retarget poses.
Public function Const FName

GetRetargetRootBone ( const ERetargetSourceOrTarget SourceOrTarget
)

 Get name of the Root bone used for retargeting.
Public function Const UFunction BlueprintCallable, Category, Meta FVector Get the translation offset on the retarget root bone for the current retarget pose.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta FTargetRootSettings Get a copy of the retarget root settings for this asset.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta FQuat

GetRotationOffsetForRetargetPoseBone ( const FName& BoneName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Get a delta rotation for a given bone for the current retarget pose.
Public function Const UFunction BlueprintCallable, Category, Meta FName

GetSourceChain ( const FName& TargetChainName
)

 Get the name of the source chain mapped to a given target chain (the chain animation is copied FROM).
Public function Const void Call this when IK Rig chain is added or removed.
Public function Const void

HandleRetargetChainRemoved ( UIKRigDefinition* IKRig,
const FName& InChainRemoved
)

 Call this when IK Rig chain is removed.
Public function Const void

HandleRetargetChainRenamed ( UIKRigDefinition* IKRig,
FName OldChainName,
FName NewChainName
)

 Call this when IK Rig chain is renamed. Retains existing mappings using the new name.
Public function Const bool

IsChainGoalConnectedToASolver ( const FName& GoalName
)

 Get whether the given chain's IK goal is connected to a solver.
Public function Const FName

MakePoseNameUnique ( const FString& PoseName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Add a numbered suffix to the given pose name to make it unique.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

MoveRetargetOpInStack ( int32 OpToMoveIndex,
int32 TargetIndex
)

 Move the retarget op at the given index to the target index.
Public function FOnIKRigReplaced & Attach a delegate to be notified whenever either the source or target IK Rig asset's are swapped out.
Public function FOnPreviewMeshReplaced & Attach a delegate to be notified whenever either the source or target Preview Mesh asset's are swapped out.
Public function FOnRetargeterNeedsInitialized & Attach a delegate to be notified whenever the retargeter is modified in such a way that would require re-initialization of the processor.
Public function Const UFunction BlueprintCallable, Category bool Remove all ops in the stack.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

RemoveRetargetOp ( const int32 OpIndex
)

 Remove the retarget op at the given stack index.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

RemoveRetargetPose ( const FName& PoseToRemove,
const ERetargetSourceOrTarget SourceOrTarget
)

 Remove a retarget pose. Returns true if the pose was found and removed.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

RenameRetargetPose ( const FName OldPoseName,
const FName NewPoseName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Rename current retarget pose. Returns true if a pose was renamed.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

ResetRetargetPose ( const FName& PoseToReset,
const TArray< FName >& BonesToReset,
const ERetargetSourceOrTarget SourceOrTarget
)

 Reset a retarget pose for the specified bones.
Public function Const void Set if we've asked to fix the root height for the given skeletal mesh.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

SetCurrentRetargetPose ( FName CurrentPose,
const ERetargetSourceOrTarget SourceOrTarget
)

 Change which retarget pose is used by the retargeter at runtime.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

SetGlobalSettings ( const FRetargetGlobalSettings& GlobalSettings
)

 Get a copy of the global settings for this asset.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

SetIKRig ( const ERetargetSourceOrTarget SourceOrTarget,
UIKRigDefinition* IKRig
)

 Set the IK Rig to use as the source or target (to copy animation FROM/TO)
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

SetPreviewMesh ( const ERetargetSourceOrTarget SourceOrTarget,
USkeletalMesh* InPreviewMesh
)

 Set the preview skeletal mesh for either source or target.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

SetRetargetChainSettings ( const FName& TargetChainName,
const FTargetChainSettings& Settings
)

 Set the settings for the target chain by name. Returns true if the chain settings were applied, false otherwise.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

SetRetargetOpEnabled ( int32 RetargetOpIndex,
bool bIsEnabled
)

 Set enabled/disabled status of the given retarget operation.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

SetRootOffsetInRetargetPose ( const FVector& TranslationOffset,
const ERetargetSourceOrTarget SourceOrTarget
)

 Set the translation offset on the retarget root bone for the current retarget pose.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

SetRootSettings ( const FTargetRootSettings& RootSettings
)

 Set the retarget root settings for this asset.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

SetRotationOffsetForRetargetPoseBone ( const FName& BoneName,
const FQuat& RotationOffset,
const ERetargetSourceOrTarget SkeletonMode
)

 Set a delta rotation for a given bone for the current retarget pose.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

SetSourceChain ( FName SourceChainName,
FName TargetChainName
)

 Assign a source chain to the given target chain. Animation will be copied from the source to the target.
Public function UFunction BlueprintCallable, Category void

SnapBoneToGround ( FName ReferenceBone,
ERetargetSourceOrTarget SourceOrTarget
)

 Moves the entire skeleton vertically until the specified bone is the same height off the ground as in the reference pose.

Overridden from UObject

  Type Name Description
Public function Virtual void UObject.

Typedefs

Name Description
FOnIKRigReplaced  
FOnPreviewMeshReplaced  
FOnRetargeterNeedsInitialized DELEGATE CALLBACKS FOR OUTSIDE SYSTEMS

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page