1. Epic GamesDeveloper
  3. UIKRetargetProcessor

UIKRetargetProcessor

The runtime processor that converts an input pose from a source skeleton into an output pose on a target skeleton.

API > API/Plugins > API/Plugins/IKRig > API/Plugins/IKRig/Retargeter

Inheritance Hierarchy

References

   
Module IKRig
Header /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/IKRetargetProcessor.h
Include #include "Retargeter/IKRetargetProcessor.h"

Syntax

UCLASS ()  
class UIKRetargetProcessor : public UObject

Remarks

The runtime processor that converts an input pose from a source skeleton into an output pose on a target skeleton. To use:

Initialize a processor with a Source/Target skeletal mesh and a UIKRetargeter asset.

Call RunRetargeter and pass in a source pose as an array of global-space transforms

RunRetargeter returns an array of global space transforms for the target skeleton.

Variables

  Type Name Description
Public variable FRetargetDebugData DebugData Store data for debug drawing
Public variable FIKRigLogger Log Logging system

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Apply the settings stored in the IKRig asset.
Public function Const FName

GetBoneAtParam ( const FName InChainName,
const float InParam,
const ERetargetSourceOrTarget SourceOrTarget
)

 Get the bone in the chain at the given param.
Public function Const int32

GetBoneIndexFromName ( const FName BoneName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Returns index of the bone with the given name in either Source or Target skeleton.
Public function Const const FChainFK *

GetChain ( const FName InChainName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Get access to the internal chain on the given skeleton
Public function Const FName

GetChainNameForBone ( const FName BoneName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Returns name of the chain associated with this bone. Returns NAME_None if bone is not in a chain.
Public function Const const TArray< FRetargetChainPairFK > & Get read only access to the core FK retarget chains
Public function Const FTransform

GetGlobalRetargetPoseAtParam ( const FName InChainName,
const float Param,
const ERetargetSourceOrTarget SourceOrTarget
)

 Get a transform at a given param in a chain
Public function Const const FRetargetGlobalSettings & Get read only access to the current global settings.
Public function Const const TArray< FRetargetChainPairIK > & Get read only access to the core IK retarget chains
Public function FName

GetMappedChainName ( const FName InChainName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Get the chain mapped to this one.
Public function Const float

GetParamOfBoneInChain ( const FName InBoneName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Get the param of the bone in it's retarget chain. Ranges from 0 to NumBonesInChain.
Public function Const const TArray< TObjectPtr< URetargetOpBase > > & Get read only access to the retarget ops currently running in processor.
Public function Const FName Get name of the root bone of the given skeleton.
Public function Const const FRootRetargeter & Get read only access to the core root retargeter
Public function Const const FRetargetSkeleton & Get read-only access to either source or target skeleton.
Public function Const UIKRigProcessor * Get the currently running IK Rig processor for the target
Public function void

Initialize ( USkeletalMesh* SourceSkeleton,
USkeletalMesh* TargetSkeleton,
UIKRetargeter* InRetargeterAsset,
const FRetargetProfile& Settings,
const bool bSuppressWarnings
)

 Initialize the retargeter to enable running it.
Public function Const bool

IsBoneRetargeted ( const FName BoneName,
const ERetargetSourceOrTarget SourceOrTarget
)

 Returns true if the bone is part of a retarget chain or root bone, false otherwise.
Public function Const bool Get whether this processor is ready to call RunRetargeter() and generate new poses.
Public function FOnRetargeterInitialized & Attach a delegate to be notified whenever this processor is initialized.
Public function void Reset the IK planting state.
Public function TArray< FTransform > &

RunRetargeter ( const TArray< FTransform >& InSourceGlobalPose,
const TMap< FName, float >& SpeedValuesFromCurves,
const float DeltaTime,
const FRetargetProfile& Settings
)

 Run the retarget to generate a new pose.
Public function void Set that this processor needs to be reinitialized.
Public function void

UpdateRetargetPoseAtRuntime ( const FName NewRetargetPoseName,
ERetargetSourceOrTarget SourceOrTarget
)

 Does a partial reinitialization (at runtime) whenever the retarget pose is swapped to a different or if the pose has been modified.
Public function bool

WasInitializedWithTheseAssets ( const TObjectPtr< USkeletalMesh > InSourceMesh,
const TObjectPtr< USkeletalMesh > InTargetMesh,
const TObjectPtr< UIKRetargeter > InRetargetAsset
)

 Get whether this processor was initialized with these skeletal meshes and retarget asset

Typedefs

Name Description
FOnRetargeterInitialized  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page