unreal.FloorConstraintChainSettings

class unreal.FloorConstraintChainSettings(target_chain_name: Name = 'None', enable_floor_constraint: bool = False, alpha: float = 0.0, maintain_height_offset: float = 0.0)

Bases: StructBase

Floor Constraint Chain Settings

C++ Source:

  • Plugin: IKRig

  • Module: IKRig

  • File: FloorConstraintOp.h

Editor Properties: (see get_editor_property/set_editor_property)

  • alpha (double): [Read-Write] Range 0 to 1. Default is 0. Blend the effect of the constraint on this goal on/off.

  • enable_floor_constraint (bool): [Read-Write] Whether to apply the floor constraint to the location of the IK goal on this chain. Default is false. When ON, the floor constraint will adjust the vertical position of the IK Goal according to the following rules. 1. When the source goal bone is LOWER than FloorHeightFalloffStart, the height of the goal is smoothly blended to the height of the source bone. 2. When the source goal bone is HIGHER than FloorHeightFalloffStart, the height of the goal is left at its normal retargeted location. NOTE: the floor is assumed to be the XY plane where Z = 0. NOTE: This only has an effect if the chain has an IK Goal assigned to it in the Target IK Rig asset.

  • maintain_height_offset (double): [Read-Write] Range 0 to 1. Default is 0. Maintain the height different between the source and target from the retarget pose.

  • target_chain_name (Name): [Read-Write] The name of the TARGET chain to transfer animation onto.

property alpha: float

[Read-Write] Range 0 to 1. Default is 0. Blend the effect of the constraint on this goal on/off.

Type:

(double)

property enable_floor_constraint: bool

[Read-Write] Whether to apply the floor constraint to the location of the IK goal on this chain. Default is false. When ON, the floor constraint will adjust the vertical position of the IK Goal according to the following rules. 1. When the source goal bone is LOWER than FloorHeightFalloffStart, the height of the goal is smoothly blended to the height of the source bone. 2. When the source goal bone is HIGHER than FloorHeightFalloffStart, the height of the goal is left at its normal retargeted location. NOTE: the floor is assumed to be the XY plane where Z = 0. NOTE: This only has an effect if the chain has an IK Goal assigned to it in the Target IK Rig asset.

Type:

(bool)

property maintain_height_offset: float

[Read-Write] Range 0 to 1. Default is 0. Maintain the height different between the source and target from the retarget pose.

Type:

(double)

property target_chain_name: Name

[Read-Write] The name of the TARGET chain to transfer animation onto.

Type:

(Name)