Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > IKRig > Retargeter > UIKRetargeter

Light Theme

Dark Theme

UIKRetargeter

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UIKRetargeter

References

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

Syntax

UCLASS(BlueprintType)
class UIKRetargeter : public UObject

Variables

	Name	Description
bool	bDebugDraw	Toggle debug drawing for retargeting in the viewport.
bool	bDrawFinalGoals	Draw final IK goal locations.
bool	bDrawSourceLocations	Draw goal locations from source skeleton.
float	BoneDrawSize	The visual size of the bones in the viewport (saved between sessions). This is set from the viewport Character>Bones menu.
float	ChainDrawSize	The visual size of the IK goals in the viewport.
float	ChainDrawThickness	The thickness of lines on the IK goals in the viewport.
TObjectPtr< UOb...	Controller	The controller responsible for managing this asset's data (all editor mutation goes through this)
FVector	SourceMeshOffset	The offset applied to the source mesh in the editor viewport.
FVector	TargetMeshOffset	The offset applied to the target mesh in the editor viewport.
float	TargetMeshScale	Scale the target mesh in the viewport for easier visualization next to the source.

Constructors

	Name	Description
	UIKRetargeter ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutC..., const UClass* SpecificSubclass )	END UObject.
const TArray...	GetAllChainSettings()	Get read-only access to the chain mapping.
const TObjec...	GetChainMapByName ( const FName& TargetChainName )	Get read-only access to the chain map for a given chain (null if chain not in retargeter)
const FTarge...	GetChainSettingsByName ( const FName& TargetChainName )	Get read-only access to the chain settings for a given chain (null if chain not in retargeter)
FTargetChain...	GetChainSettingsFromRetargetAsset ( const UIKRetargeter* RetargetA..., const FName TargetChainName, const FName OptionalProfileName )	Returns the chain settings associated with a given target chain in an IK Retargeter Asset using the given profile name (optional)
FTargetChain...	GetChainSettingsFromRetargetProfile ( FRetargetProfile& RetargetProfile, const FName TargetChainName )	Returns the chain settings associated with a given target chain in the supplied Retarget Profile.
FTargetChain...	GetChainUsingGoalFromRetargetAsset ( const UIKRetargeter* RetargetA..., const FName IKGoalName )	Returns the chain settings associated with a given Goal in an IK Retargeter Asset using the given profile name (optional)
const FRetar...	GetCurrentProfile()	Get the current retarget profile (may be null)
const FIKRet...	GetCurrentRetargetPose ( const ERetargetSourceOrTarget& Sou... )	Get read-only access to a retarget pose.
FName	GetCurrentRetargetPoseName ( const ERetargetSourceOrTarget& Sou... )	Get name of the current retarget pose.
const FName	GetDefaultPoseName()	Get name of default pose.
const FRetar...	GetGlobalSettings()	Get access to the global settings itself.
void	GetGlobalSettingsFromRetargetAsset ( const UIKRetargeter* RetargetA..., const FName OptionalProfileName, FRetargetGlobalSettings& OutSettin... )	Returns the global settings in an IK Retargeter Asset using the given profile name (optional)
FRetargetGlo...	GetGlobalSettingsFromRetargetProfile ( FRetargetProfile& RetargetProfile )	Returns the global settings in the supplied Retarget Profile.
UIKRetargetG...	GetGlobalSettingsUObject()	Get access to the global settings uobject.
const FRetar...	GetProfileByName ( const FName& ProfileName )	Get the retarget profile by name (may be null)
const FIKRet...	GetRetargetPoseByName ( const ERetargetSourceOrTarget& Sou..., const FName PoseName )	Get read-only access to a retarget pose.
void	GetRootSettingsFromRetargetAsset ( const UIKRetargeter* RetargetA..., const FName OptionalProfileName, FTargetRootSettings& OutSettings )	Returns the root settings in an IK Retargeter Asset using the given profile name (optional)
FTargetRootS...	GetRootSettingsFromRetargetProfile ( FRetargetProfile& RetargetProfile )	Returns the root settings in the supplied Retarget Profile.
URetargetRoo...	GetRootSettingsUObject()	Get access to the root settings.
const UIKRig...	GetSourceIKRig()	Get read-only access to the source IK Rig asset.
const FName	GetSourceIKRigPropertyName()	Get name of Source IK Rig property.
UIKRigDefini...	GetSourceIKRigWriteable()	Get read-write access to the source IK Rig asset.
const FName	GetSourcePreviewMeshPropertyName()	Get name of Source Preview Mesh property.
void	GetSpeedCurveNames ( TArray< FName >& OutSpeedCurveName... )	Get the names of the all the speed curves the retargeter will be looking for.
const UIKRig...	GetTargetIKRig()	Get read-only access to the target IK Rig asset.
const FName	GetTargetIKRigPropertyName()	Get name of Target IK Rig property.
UIKRigDefini...	GetTargetIKRigWriteable()	Get read-write access to the target IK Rig asset.
const FName	GetTargetPreviewMeshPropertyName()	Get name of Target Preview Mesh property.
void	SetChainFKSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile, const FTargetChainFKSettings& FKSe..., const FName TargetChainName )	Set the chain FK settings in a retarget profile (will set bApplyChainSettings to true).
void	SetChainIKSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile, const FTargetChainIKSettings& IKSe..., const FName TargetChainName )	Set the chain IK settings in a retarget profile (will set bApplyChainSettings to true).
void	SetChainSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile, const FTargetChainSettings& ChainS..., const FName TargetChainName )	Set the chain settings in a retarget profile (will set bApplyChainSettings to true).
void	SetChainSpeedPlantSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile, const FTargetChainSpeedPlantSetting..., const FName TargetChainName )	Set the chain Speed Plant settings in a retarget profile (will set bApplyChainSettings to true).
void	SetGlobalSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile, const FRetargetGlobalSettings& Glo... )	Set the global settings in a retarget profile (will set bApplyGlobalSettings to true).
void	SetRootSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile, const FTargetRootSettings& RootSet... )	Set the root settings in a retarget profile (will set bApplyRootSettings to true).

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
	void	Serialize ( FArchive& Ar )	UObject.

Deprecated Variables

		Name	Description
	bool	bRetargetFK_DEPRECATED
	bool	bRetargetIK_DEPRECATED
	bool	bRetargetRoot_DEPRECATED
	float	TargetActorOffset_DEPRECATED
	float	TargetActorScale_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel