1. Epic GamesDeveloper
  3. UIKRetargeter

UIKRetargeter

API > API/Plugins > API/Plugins/IKRig

   
Name UIKRetargeter
Type class
Header File /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/IKRetargeter.h
Include Path #include "Retargeter/IKRetargeter.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UIKRetargeter : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UIKRetargeter ( const FObjectInitializer& ObjectInitializer
)

   Retargeter/IKRetargeter.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDebugDraw bool Toggle debug drawing for retargeting in the viewport. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=DebugSettings
bIgnoreRootLockInPreview bool When true, animation sequences with "Force Root Lock" turned On will act as though it is Off. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=RootLockSettings
BoneDrawSize float The visual size of the bones in the viewport (saved between sessions). This is set from the viewport Character>Bones menu. Retargeter/IKRetargeter.h  
Controller TObjectPtr< UObject > The controller responsible for managing this asset's data (all editor mutation goes through this) Retargeter/IKRetargeter.h
  • Transient
  • DuplicateTransient
  • NonTransactional
SourceMeshOffset FVector The offset applied to the source mesh in the editor viewport. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=PreviewSettings
TargetMeshOffset FVector The offset applied to the target mesh in the editor viewport. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=PreviewSettings
TargetMeshScale float Scale the target mesh in the viewport for easier visualization next to the source. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=PreviewSettings
  • Meta=(UIMin="0.01", UIMax="10.0")

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentProfile FName   Retargeter/IKRetargeter.h  
CurrentRetargetPose FName   Retargeter/IKRetargeter.h
  • Meta=(DeprecatedProperty)
CurrentSourceRetargetPose FName The current retarget pose to use for the SOURCE. Retargeter/IKRetargeter.h  
CurrentTargetRetargetPose FName The current retarget pose to use for the TARGET. Retargeter/IKRetargeter.h  
MeshesAskedToFixRootHeightFor TSet< TObjectPtr< USkeletalMesh > > Only ask to fix the root height once, then warn thereafter (don't nag) Retargeter/IKRetargeter.h  
Profiles TMap< FName, FRetargetProfile > Settings profiles stored in this asset Retargeter/IKRetargeter.h  
RetargetOps TArray< FInstancedStruct > Polymorphic stack of retargeting operations executed in serial fashion where output of prior operation is input to the next Retargeter/IKRetargeter.h
  • Meta=(ExcludeBaseStruct, BaseStruct="/Script/IKRig.RetargetOpBase")
RetargetPoses TMap< FName, FIKRetargetPose > (OLD VERSION) Before retarget poses were stored for target AND source. Retargeter/IKRetargeter.h
  • Meta=(DeprecatedProperty)
SourceIKRigAsset TObjectPtr< UIKRigDefinition > The rig to copy animation FROM. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=Source
SourcePreviewMesh TSoftObjectPtr< USkeletalMesh > Optional. Override the Skeletal Mesh to copy animation from. Uses the preview mesh from the Source IK Rig asset by default. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=Source
SourceRetargetPoses TMap< FName, FIKRetargetPose > The set of retarget poses for the SOURCE skeleton. Retargeter/IKRetargeter.h  
TargetIKRigAsset TObjectPtr< UIKRigDefinition > The rig to copy animation TO. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=Target
  • DisplayName="Default Target IK Rig"
TargetPreviewMesh TSoftObjectPtr< USkeletalMesh > Optional. Override the Skeletal Mesh to preview the retarget on. Uses the preview mesh from the Target IK Rig asset by default. Retargeter/IKRetargeter.h
  • EditAnywhere
  • Category=Target
TargetRetargetPoses TMap< FName, FIKRetargetPose > The set of retarget poses for the TARGET skeleton. Retargeter/IKRetargeter.h  
Version int32 Incremented by any edits that require re-initialization Retargeter/IKRetargeter.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< TObjectPtr< URetargetChainSettings > > & GetAllChainSettings()

 Get read-only access to the per-chain settings Retargeter/IKRetargeter.h  

TArray< T * > GetAllRetargetOpsOfType()

 Get all ops in the stack of the given type Retargeter/IKRetargeter.h  

const TObjectPtr< URetargetChainSettings > GetChainMapByName ( const FName& TargetChainName
) const

 Get read-only access to the chain map for a given chain (null if chain not in retargeter) Retargeter/IKRetargeter.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSFRetargetChainMapping & GetChainMapping ()

 BEGIN DEPRECATED API. Retargeter/IKRetargeter.h  
Get read-only access to the chain mapping Retargeter/IKRetargeter.h  

const FTargetChainSettings * GetChainSettingsByName ( const FName& TargetChainName
) const

 Get read-only access to the chain settings for a given chain (null if chain not in retargeter) Retargeter/IKRetargeter.h  

const FRetargetProfile * GetCurrentProfile()

 Get the current retarget profile (may be null) Retargeter/IKRetargeter.h  

const FIKRetargetPose * GetCurrentRetargetPose ( const ERetargetSourceOrTarget& SourceOrTarget
) const

 Get read-only access to a retarget pose. Retargeter/IKRetargeter.h  

FName GetCurrentRetargetPoseName ( const ERetargetSourceOrTarget& SourceOrTarget
) const

 Get name of the current retarget pose. Retargeter/IKRetargeter.h  

T * GetFirstRetargetOpOfType()

 Get the first op in the stack of the given type Retargeter/IKRetargeter.h  

const FRetargetGlobalSettings & GetGlobalSettings()

 Get access to the global settings itself Retargeter/IKRetargeter.h  

UIKRetargetGlobalSettings * GetGlobalSettingsUObject()

 Get access to the global settings uobject Retargeter/IKRetargeter.h  

const UIKRigDefinition * GetIKRig ( ERetargetSourceOrTarget SourceOrTarget
) const

 Get read-only access to the source or target IK Rig asset. Retargeter/IKRetargeter.h  
Get read-write access to the source IK Rig asset. Retargeter/IKRetargeter.h  

USkeletalMesh * GetPreviewMesh ( ERetargetSourceOrTarget SourceOrTarget
) const

 Get read-only access to preview meshes. Retargeter/IKRetargeter.h  

const FRetargetProfile * GetProfileByName ( const FName& ProfileName
) const

 Get the retarget profile by name (may be null) Retargeter/IKRetargeter.h  

const FIKRetargetOpBase * GetRetargetOpByName ( const FName& InOpName
) const

 Get a retarget op by name. Retargeter/IKRetargeter.h  

const TArray< FInstancedStruct > & GetRetargetOps()

 Get access to the stack of retargeting operations. Retargeter/IKRetargeter.h  

const FIKRetargetPose * GetRetargetPoseByName ( const ERetargetSourceOrTarget& SourceOrTarget,
const FName PoseName
) const

 Get read-only access to a retarget pose. Retargeter/IKRetargeter.h  

URetargetRootSettings * GetRootSettingsUObject()

 Get access to the root settings Retargeter/IKRetargeter.h  

int32 GetVersion()

 Get current version of the data (to compare against running processor instances) Retargeter/IKRetargeter.h  

bool HasSourceIKRig()

 Returns true if the source IK Rig has been assigned. Retargeter/IKRetargeter.h
  • BlueprintPure
  • Category=RetargetProfile

bool HasTargetIKRig()

 Returns true if the target IK Rig has been assigned. Retargeter/IKRetargeter.h
  • BlueprintPure
  • Category=RetargetProfile

void IncrementVersion()

 Do this after any edit that would require running instance to reinitialize Retargeter/IKRetargeter.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( bool bDuplicateForPIE
)

 UObject. Retargeter/IKRetargeter.h  

virtual void PostLoad()

   Retargeter/IKRetargeter.h  

virtual void Serialize ( FArchive& Ar
)

   Retargeter/IKRetargeter.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

 END UObject. Retargeter/IKRetargeter.h  

static FTargetChainSettings GetChainSettingsFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
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) Retargeter/IKRetargeter.h
  • BlueprintCallable
  • BlueprintPure
  • Category=RetargetAsset
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set chain settings.")

static FTargetChainSettings GetChainSettingsFromRetargetProfile ( FRetargetProfile& RetargetProfile,
const FName TargetChainName
)

 Returns the chain settings associated with a given target chain in the supplied Retarget Profile. Retargeter/IKRetargeter.h
  • BlueprintCallable
  • BlueprintPure
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set chain settings.")

static FTargetChainSettings GetChainUsingGoalFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
const FName IKGoalName
)

 Returns the chain settings associated with a given Goal in an IK Retargeter Asset using the given profile name (optional) Retargeter/IKRetargeter.h
  • BlueprintCallable
  • BlueprintPure
  • Category=RetargetAsset
  • Meta=(DeprecatedFunction, DeprecationMessage="Use IK Chain Op controller to get chains with goals.")

static const FName GetDefaultPoseName()

 Get name of default pose. Retargeter/IKRetargeter.h  

static void GetGlobalSettingsFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
const FName OptionalProfileName,
FRetargetGlobalSettings& OutSettings
)

 Returns the global settings in an IK Retargeter Asset using the given profile name (optional) Retargeter/IKRetargeter.h
  • BlueprintCallable
  • BlueprintPure
  • Category=RetargetAsset
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set settings that previously used global settings.")

static FRetargetGlobalSettings GetGlobalSettingsFromRetargetProfile ( FRetargetProfile& RetargetProfile
)

 Returns the global settings in the supplied Retarget Profile. Retargeter/IKRetargeter.h
  • BlueprintCallable
  • BlueprintPure
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set settings that previously used global settings.")

static void GetRootSettingsFromRetargetAsset ( const UIKRetargeter* RetargetAsset,
const FName OptionalProfileName,
FTargetRootSettings& OutSettings
)

 Returns the root settings in an IK Retargeter Asset using the given profile name (optional) Retargeter/IKRetargeter.h
  • BlueprintCallable
  • BlueprintPure
  • Category=RetargetAsset
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set pelvis settings.")

static FTargetRootSettings GetRootSettingsFromRetargetProfile ( FRetargetProfile& RetargetProfile
)

 Returns the root settings in the supplied Retarget Profile. Retargeter/IKRetargeter.h
  • BlueprintCallable
  • BlueprintPure
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set pelvis settings.")

static const FName GetSourceIKRigPropertyName()

 Get name of Source IK Rig property. Retargeter/IKRetargeter.h  

static const FName GetSourcePreviewMeshPropertyName()

 Get name of Source Preview Mesh property. Retargeter/IKRetargeter.h  

static const FName GetTargetIKRigPropertyName()

 Get name of Target IK Rig property. Retargeter/IKRetargeter.h  

static const FName GetTargetPreviewMeshPropertyName()

 Get name of Target Preview Mesh property. Retargeter/IKRetargeter.h  

static void SetChainFKSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainFKSettings& FKSettings,
const FName TargetChainName
)

 Set the chain FK settings in a retarget profile (will set bApplyChainSettings to true). Retargeter/IKRetargeter.h
  • BlueprintCallable
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use FK Chain Op profiles to get/set FK chain settings.")

static void SetChainIKSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainIKSettings& IKSettings,
const FName TargetChainName
)

 Set the chain IK settings in a retarget profile (will set bApplyChainSettings to true). Retargeter/IKRetargeter.h
  • BlueprintCallable
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use IK Chain Op profiles to get/set IK chain settings.")

static void SetChainSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainSettings& ChainSettings,
const FName TargetChainName
)

 Set the chain settings in a retarget profile (will set bApplyChainSettings to true). Retargeter/IKRetargeter.h
  • BlueprintCallable
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set chain settings.")

static void SetChainSpeedPlantSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetChainSpeedPlantSettings& SpeedPlantSettings,
const FName TargetChainName
)

 Set the chain Speed Plant settings in a retarget profile (will set bApplyChainSettings to true). Retargeter/IKRetargeter.h
  • BlueprintCallable
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use Speed Plant Op profiles to get/set speed plant settings.")

static void SetGlobalSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FRetargetGlobalSettings& GlobalSettings
)

 Set the global settings in a retarget profile (will set bApplyGlobalSettings to true). Retargeter/IKRetargeter.h
  • BlueprintCallable
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set settings that previously used global settings.")

static void SetRootSettingsInRetargetProfile ( FRetargetProfile& RetargetProfile,
const FTargetRootSettings& RootSettings
)

 Set the root settings in a retarget profile (will set bApplyRootSettings to true). Retargeter/IKRetargeter.h
  • BlueprintCallable
  • Category=RetargetProfile
  • Meta=(DeprecatedFunction, DeprecationMessage="Use op profiles to get/set settings that previously used root settings.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page