unreal.IKRetargetRunIKRigChainSettings¶
- class unreal.IKRetargetRunIKRigChainSettings(target_chain_name: Name = 'None', enable_ik: bool = False, chain_position_alpha: float = 0.0, chain_rotation_alpha: float = 0.0, override_goal_alpha: bool = False, final_position_alpha: float = 0.0, final_rotation_alpha: float = 0.0)¶
Bases:
StructBaseIKRetarget Run IKRig Chain Settings
C++ Source:
Plugin: IKRig
Module: IKRig
File: RunIKRigOp.h
Editor Properties: (see get_editor_property/set_editor_property)
chain_position_alpha(double): [Read-Write] Range 0 to 1. Default 1. Retargets the goal position based on the source chain length and direction. At 0, the goal is left at the input pose bone location. At 1, the goal is translated in the direction of the source chain, at a distance from the base of the chain proportional to how much it is compressed or stretched.chain_rotation_alpha(double): [Read-Write] Range 0 to 1. Default 1. Retargets the goal rotation based on the source chain end bone rotation. At 0, the goal is left at the input pose bone rotation. At 1, the goal is rotated by the same world space rotation applied to the source chain end bone. NOTE: if the target end bone rotation was already retargeted before this op, this setting may have no effect. It will not double-rotate the goal. This setting is useful if no FK retargeting is being performed on this chain before the IK op.enable_ik(bool): [Read-Write] Enable/disable IK on this chain. NOTE: This actually removes the goal from the internal IK Rig solve and triggers a reinitialization of the solver stack when toggled.final_position_alpha(double): [Read-Write] Range 0 to 1. Default 1. Blends all goal translation offsets on/off. At 0, the goal is left at the input pose bone location. At 1, the goal is moved to the location generated by the IK goal ops.final_rotation_alpha(double): [Read-Write] Range 0 to 1. Default 1. Blends all goal rotation offsets on/off. At 0, the goal is left at the input pose bone rotation. At 1, the goal is rotated to the orientation generated by the IK goal ops.override_goal_alpha(bool): [Read-Write] Default false. If true, the alpha values here will override the goal alpha settings from the IK Rig asset.target_chain_name(Name): [Read-Write] The name of the TARGET chain to run IK on.
- property chain_position_alpha: float¶
[Read-Write] Range 0 to 1. Default 1. Retargets the goal position based on the source chain length and direction. At 0, the goal is left at the input pose bone location. At 1, the goal is translated in the direction of the source chain, at a distance from the base of the chain proportional to how much it is compressed or stretched.
- Type:
(double)
- property chain_rotation_alpha: float¶
[Read-Write] Range 0 to 1. Default 1. Retargets the goal rotation based on the source chain end bone rotation. At 0, the goal is left at the input pose bone rotation. At 1, the goal is rotated by the same world space rotation applied to the source chain end bone. NOTE: if the target end bone rotation was already retargeted before this op, this setting may have no effect. It will not double-rotate the goal. This setting is useful if no FK retargeting is being performed on this chain before the IK op.
- Type:
(double)
- property enable_ik: bool¶
[Read-Write] Enable/disable IK on this chain. NOTE: This actually removes the goal from the internal IK Rig solve and triggers a reinitialization of the solver stack when toggled.
- Type:
(bool)
- property final_position_alpha: float¶
[Read-Write] Range 0 to 1. Default 1. Blends all goal translation offsets on/off. At 0, the goal is left at the input pose bone location. At 1, the goal is moved to the location generated by the IK goal ops.
- Type:
(double)
- property final_rotation_alpha: float¶
[Read-Write] Range 0 to 1. Default 1. Blends all goal rotation offsets on/off. At 0, the goal is left at the input pose bone rotation. At 1, the goal is rotated to the orientation generated by the IK goal ops.
- Type:
(double)