unreal.IKRetargetPelvisMotionOpSettings¶
- class unreal.IKRetargetPelvisMotionOpSettings(lod_threshold: int = 0, source_crotch_offset: float = 0.0, target_crotch_offset: float = 0.0, rotation_alpha: float = 0.0, rotation_offset_local: Rotator = Ellipsis, rotation_offset_global: Rotator = Ellipsis, translation_alpha: float = 0.0, translation_offset_local: Vector = Ellipsis, translation_offset_global: Vector = Ellipsis, blend_to_source_translation: float = 0.0, blend_to_source_translation_weights: Vector = Ellipsis, scale_horizontal: float = 0.0, scale_vertical: float = 0.0, affect_ik_horizontal: float = 0.0, affect_ik_vertical: float = 0.0)¶
Bases:
IKRetargetOpSettingsBaseIKRetarget Pelvis Motion Op Settings
C++ Source:
Plugin: IKRig
Module: IKRig
File: PelvisMotionOp.h
Editor Properties: (see get_editor_property/set_editor_property)
affect_ik_horizontal(double): [Read-Write] Range 0 to 1. Default 1. Control whether modifications made to the pelvis will affect the horizontal component of IK positions. At 0 the IK positions are independent of the pelvis modifications. At 1 the IK positions are calculated relative to the modified pelvis location.affect_ik_vertical(double): [Read-Write] Range 0 to 1. Default 0. Control whether modifications made to the pelvis will affect the vertical component of IK positions. At 0 the IK positions are independent of the pelvis modifications. At 1 the IK positions are calculated relative to the modified pelvis location.blend_to_source_translation(double): [Read-Write] Range 0 to 1. Default 0. Blends the retarget pelvis’ translation to the exact source location. At 0 the pelvis is placed at the retargeted location. At 1 the pelvis is placed at the location of the source’s pelvis bone.blend_to_source_translation_weights(Vector): [Read-Write] Per-axis weights for the Blend to Source.debug_draw_size(double): [Read-Write] Adjust size of the debug drawingdebug_draw_thickness(double): [Read-Write] Adjust thickness of the debug drawingenable_debug_draw(bool): [Read-Write] deprecated: Property ‘bEnableDebugDraw’ is deprecated.floor_constraint_weight(double): [Read-Write] Range 0 to 1. Default is 0. Set to a value of 1 to turn the pelvis floor constraint ON. When ON, the floor constraint will adjust the vertical Pelvis motion separately according to the following rules: 1. When the source pelvis is LOWER than the ref pose, the target pelvis will be lowered proportional to their relative crotch heights. 2. When the source pelvis is HIGHER than the ref pose, the target pelvis will be raised an identical amount while maintaining any vertical offset in the ref pose.lod_threshold(int32): [Read-Write] The maximum LOD that this Op is allowed to run at. For example if you have LODThreshold of 2, the Op will run until LOD 2 (based on 0 index). When the component LOD becomes 3, it will stop running. A value of -1 forces the Op to execute at all LOD levels. Default is -1.rotation_alpha(double): [Read-Write] Range 0 to 1. Default 1. Blends the amount of retargeted pelvis rotation to apply. At 0 the pelvis is left at the rotation from the retarget pose. At 1 the pelvis is rotated fully to match the source pelvis rotation.rotation_offset(Rotator): [Read-Write] deprecated: Property ‘RotationOffset’ is deprecated.rotation_offset_global(Rotator): [Read-Write] Applies a static global-space rotation offset to the pelvis.rotation_offset_local(Rotator): [Read-Write] Applies a static local-space rotation offset to the pelvis.scale_horizontal(double): [Read-Write] Default 1. Scales the translation of the pelvis in the horizontal plane (X,Y).scale_vertical(double): [Read-Write] Default 1. Scales the translation of the pelvis in the vertical direction (Z).source_crotch_offset(double): [Read-Write] A negative vertical offset in cm relative to the Pelvis bone of the SOURCE. NOTE: Adjust this until the green dot is located roughly at the crotch of the character.source_pelvis_bone(BoneReference): [Read-Write] The Pelvis bone on the source skeleton to copy motion FROM.target_crotch_offset(double): [Read-Write] A negative vertical offset in cm relative to the Pelvis bone of the TARGET. NOTE: Adjust this until the green dot is located roughly at the crotch of the character.target_pelvis_bone(BoneReference): [Read-Write] The Pelvis bone on the target skeleton to copy motion TO.translation_alpha(double): [Read-Write] Range 0 to 1. Default 1. Blends the amount of retargeted pelvis translation to apply. At 0 the pelvis is left at the position from the retarget pose. At 1 the pelvis will follow the source motion according to the behavior defined in the subsequent settings.translation_offset(Vector): [Read-Write] deprecated: Property ‘TranslationOffset’ is deprecated.translation_offset_global(Vector): [Read-Write] Applies a static global-space translation offset to the pelvis.translation_offset_local(Vector): [Read-Write] Applies a static local-space translation offset to the pelvis.
- property affect_ik_horizontal: float¶
[Read-Write] Range 0 to 1. Default 1. Control whether modifications made to the pelvis will affect the horizontal component of IK positions. At 0 the IK positions are independent of the pelvis modifications. At 1 the IK positions are calculated relative to the modified pelvis location.
- Type:
(double)
- property affect_ik_vertical: float¶
[Read-Write] Range 0 to 1. Default 0. Control whether modifications made to the pelvis will affect the vertical component of IK positions. At 0 the IK positions are independent of the pelvis modifications. At 1 the IK positions are calculated relative to the modified pelvis location.
- Type:
(double)
- property blend_to_source_translation: float¶
[Read-Write] Range 0 to 1. Default 0. Blends the retarget pelvis’ translation to the exact source location. At 0 the pelvis is placed at the retargeted location. At 1 the pelvis is placed at the location of the source’s pelvis bone.
- Type:
(double)
- property blend_to_source_translation_weights: Vector¶
[Read-Write] Per-axis weights for the Blend to Source.
- Type:
(Vector)
- property enable_debug_draw: bool¶
[Read-Write] deprecated: Property ‘bEnableDebugDraw’ is deprecated.
- Type:
(bool)
- property rotation_alpha: float¶
[Read-Write] Range 0 to 1. Default 1. Blends the amount of retargeted pelvis rotation to apply. At 0 the pelvis is left at the rotation from the retarget pose. At 1 the pelvis is rotated fully to match the source pelvis rotation.
- Type:
(double)
- property rotation_offset: Rotator¶
[Read-Write] deprecated: Property ‘RotationOffset’ is deprecated.
- Type:
(Rotator)
- property rotation_offset_global: Rotator¶
[Read-Write] Applies a static global-space rotation offset to the pelvis.
- Type:
(Rotator)
- property rotation_offset_local: Rotator¶
[Read-Write] Applies a static local-space rotation offset to the pelvis.
- Type:
(Rotator)
- property scale_horizontal: float¶
[Read-Write] Default 1. Scales the translation of the pelvis in the horizontal plane (X,Y).
- Type:
(double)
- property scale_vertical: float¶
[Read-Write] Default 1. Scales the translation of the pelvis in the vertical direction (Z).
- Type:
(double)
- property source_crotch_offset: float¶
[Read-Write] A negative vertical offset in cm relative to the Pelvis bone of the SOURCE. NOTE: Adjust this until the green dot is located roughly at the crotch of the character.
- Type:
(double)
- property target_crotch_offset: float¶
[Read-Write] A negative vertical offset in cm relative to the Pelvis bone of the TARGET. NOTE: Adjust this until the green dot is located roughly at the crotch of the character.
- Type:
(double)
- property translation_alpha: float¶
[Read-Write] Range 0 to 1. Default 1. Blends the amount of retargeted pelvis translation to apply. At 0 the pelvis is left at the position from the retarget pose. At 1 the pelvis will follow the source motion according to the behavior defined in the subsequent settings.
- Type:
(double)
- property translation_offset: Vector¶
[Read-Write] deprecated: Property ‘TranslationOffset’ is deprecated.
- Type:
(Vector)