unreal.RigUnit_FitChainToCurve

class unreal.RigUnit_FitChainToCurve(execute_context: ControlRigExecuteContext = [], start_bone: Name = 'None', end_bone: Name = 'None', bezier: RigVMFourPointBezier = [], alignment: ControlRigCurveAlignment = Ellipsis, minimum: float = 0.0, maximum: float = 0.0, sampling_precision: int = 0, primary_axis: Vector = Ellipsis, secondary_axis: Vector = Ellipsis, pole_vector_position: Vector = Ellipsis, rotations: None = [], rotation_ease_type: RigVMAnimEasingType = Ellipsis, weight: float = 0.0, propagate_to_children: bool = False, debug_settings: RigUnit_FitChainToCurve_DebugSettings = Ellipsis)

Bases: RigUnit_HighlevelBaseMutable

Fits a given chain to a four point bezier curve. Additionally provides rotational control matching the features of the Distribute Rotation node.

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_FitChainToCurve.h

Editor Properties: (see get_editor_property/set_editor_property)

  • alignment (ControlRigCurveAlignment): [Read-Only] Specifies how to align the chain on the curve

  • bezier (RigVMFourPointBezier): [Read-Write] The curve to align to

  • debug_settings (RigUnit_FitChainToCurve_DebugSettings): [Read-Write]

  • end_bone (Name): [Read-Write] The name of the last bone to align

  • execute_context (ControlRigExecuteContext): [Read-Write] * This property is used to chain multiple mutable units together

  • maximum (float): [Read-Only] The maximum U value to use on the curve

  • minimum (float): [Read-Only] The minimum U value to use on the curve

  • pole_vector_position (Vector): [Read-Write] The the position of the pole vector used for aligning the secondary axis. Only has an effect if the secondary axis is set.

  • primary_axis (Vector): [Read-Write] The major axis being aligned - along the bone

  • propagate_to_children (bool): [Read-Only] If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. Note: This is computationally more expensive than turning it off.

  • rotation_ease_type (RigVMAnimEasingType): [Read-Only] The easing to use between to rotations.

  • rotations (Array[RigUnit_FitChainToCurve_Rotation]): [Read-Write] The list of rotations to be applied along the curve

  • sampling_precision (int32): [Read-Only] The number of samples to use on the curve. Clamped at 64.

  • secondary_axis (Vector): [Read-Write] The minor axis being aligned - towards the pole vector. You can use (0.0, 0.0, 0.0) to disable it.

  • start_bone (Name): [Read-Write] The name of the first bone to align

  • weight (float): [Read-Write] The weight of the solver - how much the rotation should be applied

property alignment: ControlRigCurveAlignment

[Read-Only] Specifies how to align the chain on the curve

Type:

(ControlRigCurveAlignment)

property bezier: RigVMFourPointBezier

[Read-Write] The curve to align to

Type:

(RigVMFourPointBezier)

property debug_settings: RigUnit_FitChainToCurve_DebugSettings

[Read-Write]

Type:

(RigUnit_FitChainToCurve_DebugSettings)

property end_bone: Name

[Read-Write] The name of the last bone to align

Type:

(Name)

property maximum: float

[Read-Only] The maximum U value to use on the curve

Type:

(float)

property minimum: float

[Read-Only] The minimum U value to use on the curve

Type:

(float)

property pole_vector_position: Vector

[Read-Write] The the position of the pole vector used for aligning the secondary axis. Only has an effect if the secondary axis is set.

Type:

(Vector)

property primary_axis: Vector

[Read-Write] The major axis being aligned - along the bone

Type:

(Vector)

property propagate_to_children: bool

[Read-Only] If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. Note: This is computationally more expensive than turning it off.

Type:

(bool)

property rotation_ease_type: RigVMAnimEasingType

[Read-Only] The easing to use between to rotations.

Type:

(RigVMAnimEasingType)

property rotations: None

[Read-Write] The list of rotations to be applied along the curve

Type:

(Array[RigUnit_FitChainToCurve_Rotation])

property sampling_precision: int

[Read-Only] The number of samples to use on the curve. Clamped at 64.

Type:

(int32)

property secondary_axis: Vector

[Read-Write] The minor axis being aligned - towards the pole vector. You can use (0.0, 0.0, 0.0) to disable it.

Type:

(Vector)

property start_bone: Name

[Read-Write] The name of the first bone to align

Type:

(Name)

property weight: float

[Read-Write] The weight of the solver - how much the rotation should be applied

Type:

(float)