unreal.IKRetargeter

class unreal.IKRetargeter(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: IKRetargeter.h

Editor Properties: (see get_editor_property/set_editor_property)

  • chain_map (RetargetChainMapping): [Read-Write] BEGIN deprecated data from 5.6 refactor deprecated: Property ‘ChainMap’ is deprecated.

  • chain_settings (Array[RetargetChainSettings]): [Read-Write] Settings for how to map source chains to target chains. deprecated: Use FK Chain and IK Chain Op settings instead to affect chain settings.

  • current_retarget_pose (Name): [Read-Write] deprecated: Property ‘CurrentRetargetPose’ is deprecated.

  • debug_draw (bool): [Read-Write] Toggle debug drawing for retargeting in the viewport.

  • global_settings (IKRetargetGlobalSettings): [Read-Write] the retarget global settings deprecated: Toggled ‘phases’ is now done by enable/disabling ops. Warping now in Stride Warp Op.

  • ignore_root_lock_in_preview (bool): [Read-Write] When true, animation sequences with “Force Root Lock” turned On will act as though it is Off. This affects only the preview in the retarget editor. Use ExportRootLockMode to control exported animation behavior. This setting has no effect on runtime retargeting where root motion is copied from the source component.

  • op_stack (RetargetOpStack): [Read-Write] the stack of UObject-based ops deprecated: The pre 5.6 stack of UObject based solvers. Use RetargetOps instead.

  • override_source_skeleton_color (bool): [Read-Write] Override the source skeleton color in the editor viewport.

  • override_target_skeleton_color (bool): [Read-Write] Override the target skeleton color in the editor viewport.

  • profile_ops (bool): [Read-Write] Toggle performance profiling of the op stack.

  • retarget_fk (bool): [Read-Write] deprecated: Property ‘bRetargetFK’ is deprecated.

  • retarget_ik (bool): [Read-Write] deprecated: Property ‘bRetargetIK’ is deprecated.

  • retarget_poses (Map[Name, IKRetargetPose]): [Read-Write] (OLD VERSION) Before retarget poses were stored for target AND source. deprecated: Property ‘RetargetPoses’ is deprecated.

  • retarget_root (bool): [Read-Write] deprecated: Property ‘bRetargetRoot’ is deprecated.

  • root_settings (RetargetRootSettings): [Read-Write] the retarget root settings deprecated: Use Pelvis Op settings to affect the pelvis motion instead.

  • show_source_mesh (bool): [Read-Write] Show/hide the source skeletal mesh in the editor viewport.

  • show_source_skeleton (bool): [Read-Write] Show/hide the source skeleton in the editor viewport. Note: the viewport must be showing bones to see the skeleton.

  • show_target_mesh (bool): [Read-Write] Show/hide the target skeletal mesh in the editor viewport.

  • show_target_skeleton (bool): [Read-Write] Show/hide the target skeleton in the editor viewport. Note: the viewport must be showing bones to see the skeleton.

  • source_ik_rig_asset (IKRigDefinition): [Read-Write] The rig to copy animation FROM.

  • source_mesh_offset (Vector): [Read-Write] The offset applied to the source mesh in the editor viewport.

  • source_overide_color (LinearColor): [Read-Write] Override the source skeleton color in the editor viewport.

  • source_preview_mesh (SkeletalMesh): [Read-Write] Optional. Override the Skeletal Mesh to copy animation from. Uses the preview mesh from the Source IK Rig asset by default.

  • target_actor_offset (float): [Read-Write] deprecated: Property ‘TargetActorOffset’ is deprecated.

  • target_actor_scale (float): [Read-Write] deprecated: Property ‘TargetActorScale’ is deprecated.

  • target_ik_rig_asset (IKRigDefinition): [Read-Write] The rig to copy animation TO. Note that this is only the default target IK Rig and ops can be setup to use other IK Rigs as desired.

  • target_mesh_offset (Vector): [Read-Write] The offset applied to the target mesh in the editor viewport.

  • target_mesh_scale (float): [Read-Write] Scale the target mesh in the viewport for easier visualization next to the source.

  • target_overide_color (LinearColor): [Read-Write] Override the target skeleton color in the editor viewport.

  • target_preview_mesh (SkeletalMesh): [Read-Write] Optional. Override the Skeletal Mesh to preview the retarget on. Uses the preview mesh from the Target IK Rig asset by default.

property chain_map: RetargetChainMapping

[Read-Write] BEGIN deprecated data from 5.6 refactor deprecated: Property ‘ChainMap’ is deprecated.

Type:

(RetargetChainMapping)

property chain_settings: None

[Read-Write] Settings for how to map source chains to target chains. deprecated: Use FK Chain and IK Chain Op settings instead to affect chain settings.

Type:

(Array[RetargetChainSettings])

property current_retarget_pose: Name

[Read-Write] deprecated: Property ‘CurrentRetargetPose’ is deprecated.

Type:

(Name)

classmethod get_chain_settings_from_retarget_asset(retarget_asset, target_chain_name, optional_profile_name) → TargetChainSettings

Get Chain Settings from Retarget Asset deprecated: Use op profiles to get/set chain settings.

Parameters:
Return type:

TargetChainSettings

classmethod get_chain_settings_from_retarget_profile(retarget_profile, target_chain_name) -> (TargetChainSettings, retarget_profile=RetargetProfile)

Get Chain Settings from Retarget Profile deprecated: Use op profiles to get/set chain settings.

Parameters:
Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

classmethod get_chain_using_goal_from_retarget_asset(retarget_asset, ik_goal_name) → TargetChainSettings

Get Chain Using Goal from Retarget Asset deprecated: Use IK Chain Op controller to get chains with goals.

Parameters:
Return type:

TargetChainSettings

classmethod get_global_settings_from_retarget_asset(retarget_asset, optional_profile_name) → RetargetGlobalSettings

Get Global Settings from Retarget Asset deprecated: Use op profiles to get/set settings that previously used global settings.

Parameters:
Returns:

out_settings (RetargetGlobalSettings):

Return type:

RetargetGlobalSettings

classmethod get_global_settings_from_retarget_profile(retarget_profile) -> (RetargetGlobalSettings, retarget_profile=RetargetProfile)

Get Global Settings from Retarget Profile deprecated: Use op profiles to get/set settings that previously used global settings.

Parameters:

retarget_profile (RetargetProfile)

Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

classmethod get_root_settings_from_retarget_asset(retarget_asset, optional_profile_name) → TargetRootSettings

Get Root Settings from Retarget Asset deprecated: Use op profiles to get/set pelvis settings.

Parameters:
Returns:

out_settings (TargetRootSettings):

Return type:

TargetRootSettings

classmethod get_root_settings_from_retarget_profile(retarget_profile) -> (TargetRootSettings, retarget_profile=RetargetProfile)

Get Root Settings from Retarget Profile deprecated: Use op profiles to get/set pelvis settings.

Parameters:

retarget_profile (RetargetProfile)

Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

property global_settings: IKRetargetGlobalSettings

[Read-Write] the retarget global settings deprecated: Toggled ‘phases’ is now done by enable/disabling ops. Warping now in Stride Warp Op.

Type:

(IKRetargetGlobalSettings)

has_source_ik_rig() → bool

Returns true if the source IK Rig has been assigned

Return type:

bool

has_target_ik_rig() → bool

Returns true if the target IK Rig has been assigned

Return type:

bool

property op_stack: RetargetOpStack

[Read-Write] the stack of UObject-based ops deprecated: The pre 5.6 stack of UObject based solvers. Use RetargetOps instead.

Type:

(RetargetOpStack)

property retarget_fk: bool

[Read-Write] deprecated: Property ‘bRetargetFK’ is deprecated.

Type:

(bool)

property retarget_ik: bool

[Read-Write] deprecated: Property ‘bRetargetIK’ is deprecated.

Type:

(bool)

property retarget_poses: None

[Read-Write] (OLD VERSION) Before retarget poses were stored for target AND source. deprecated: Property ‘RetargetPoses’ is deprecated.

Type:

(Map[Name, IKRetargetPose])

property retarget_root: bool

[Read-Write] deprecated: Property ‘bRetargetRoot’ is deprecated.

Type:

(bool)

property root_settings: RetargetRootSettings

[Read-Write] the retarget root settings deprecated: Use Pelvis Op settings to affect the pelvis motion instead.

Type:

(RetargetRootSettings)

classmethod set_chain_fk_settings_in_retarget_profile(retarget_profile, fk_settings, target_chain_name) → RetargetProfile

Set Chain FKSettings in Retarget Profile deprecated: Use FK Chain Op profiles to get/set FK chain settings.

Parameters:
Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

classmethod set_chain_ik_settings_in_retarget_profile(retarget_profile, ik_settings, target_chain_name) → RetargetProfile

Set Chain IKSettings in Retarget Profile deprecated: Use IK Chain Op profiles to get/set IK chain settings.

Parameters:
Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

classmethod set_chain_settings_in_retarget_profile(retarget_profile, chain_settings, target_chain_name) → RetargetProfile

Set Chain Settings in Retarget Profile deprecated: Use op profiles to get/set chain settings.

Parameters:
Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

classmethod set_chain_speed_plant_settings_in_retarget_profile(retarget_profile, speed_plant_settings, target_chain_name) → RetargetProfile

Set Chain Speed Plant Settings in Retarget Profile deprecated: Use Speed Plant Op profiles to get/set speed plant settings.

Parameters:
Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

classmethod set_global_settings_in_retarget_profile(retarget_profile, global_settings) → RetargetProfile

Set the global settings in a retarget profile (will set bApplyGlobalSettings to true). deprecated: Use op profiles to get/set settings that previously used global settings.

Parameters:
Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

classmethod set_root_settings_in_retarget_profile(retarget_profile, root_settings) → RetargetProfile

Set Root Settings in Retarget Profile deprecated: Use op profiles to get/set settings that previously used root settings.

Parameters:
Returns:

retarget_profile (RetargetProfile):

Return type:

RetargetProfile

property target_actor_offset: float

[Read-Write] deprecated: Property ‘TargetActorOffset’ is deprecated.

Type:

(float)

property target_actor_scale: float

[Read-Write] deprecated: Property ‘TargetActorScale’ is deprecated.

Type:

(float)