UIKRetargetProcessor | Unreal Engine 5.2 Documentation

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

Inheritance Hierarchy

UObjectBase
UObjectBaseUtility
UObject
UIKRetargetProcessor

References


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

Syntax

UCLASS&40;&41;  
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
	FRetargetDebugData	DebugData	Store data for debug drawing
	FIKRigLogger	Log	Logging system

Constructors

	Type	Name	Description
		UIKRetargetProcessor ()

Functions

Type	Name	Description
void	ApplySettingsFromAsset ()	Apply the settings stored in the retargeter asset.
void	ApplySettingsFromProfile ( const FRetargetProfile& Profile )	Apply the settings stored in a retarget profile.
FName	GetChainNameForBone ( const int32& BoneIndex, const int8& SkeletonToCheck )	Returns name of the chain associated with this bone. Returns NAME_None if bone is not in a chain.
const TArray< FRetargetChainPairFK > &	GetFKChainPairs ()	Get read only access to the core FK retarget chains for debug purposes
const TArray< FRetargetChainPairIK > &	GetIKChainPairs ()	Get read only access to the core IK retarget chains for debug purposes
const FRootRetargeter &	GetRootRetargeter ()	Get read only access to the core root retargeter for debug purposes
const int32	GetSourceRetargetRoot ()	Get index of the root bone of the source skeleton.
const FRetargetSkeleton &	GetSourceSkeleton ()	Get read-only access to the source skeleton.
UIKRigProcessor *	GetTargetIKRigProcessor ()	Get the currently running IK Rig processor for the target
const int32	GetTargetRetargetRoot ()	Get index of the root bone of the target skeleton.
const FTargetSkeleton &	GetTargetSkeleton ()	Get read-only access to the target skeleton.
void	Initialize ( USkeletalMesh* SourceSkeleton, USkeletalMesh* TargetSkeleton, UIKRetargeter* InRetargeterAsset, const bool bSuppressWarnings )	Initialize the retargeter to enable running it.
bool	IsBoneRetargeted ( const int32& BoneIndex, const int8& SkeletonToCheck )	Returns true if the bone is part of a retarget chain or root bone, false otherwise.
bool	IsInitialized ()	Get whether this processor is ready to call RunRetargeter() and generate new poses.
void	ResetPlanting ()	Reset the IK planting state.
TArray< FTransform > &	RunRetargeter ( const TArray< FTransform >& InSourceGlobalPose, const TMap< FName, float >& SpeedValuesFromCurves, const float DeltaTime )	Run the retarget to generate a new pose.
void	SetNeedsInitialized ()	Set that this processor needs to be reinitialized.
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

Navigation