unreal.RigUnit_ChainInfo

class unreal.RigUnit_ChainInfo(items: None = [], param: float = 0.0, calculate_stretch: bool = False, initial: bool = False, debug: bool = False, debug_scale: float = 0.0, interpolated_transform: Transform = Ellipsis, chain_length: float = 0.0, param_length: float = 0.0, chain_stretch_factor: float = 0.0, segment_info: RigUnit_ChainInfo_SegmentInfo = [])

Bases: RigUnit_HighlevelBase

  • Retrieves various pieces of info about an interpolated transform hierarchy from an rig element item list

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_ChainInfo.h

Editor Properties: (see get_editor_property/set_editor_property)

  • calculate_stretch (bool): [Read-Write] * If True calculate stretch factors of chain and current segment

  • chain_length (float): [Read-Write] * The length of the interpolated chain

  • chain_stretch_factor (float): [Read-Write] * Stretch factor of chain

  • debug (bool): [Read-Write] * Enable debug draw for node

  • debug_scale (float): [Read-Write] * Debug draw scale

  • initial (bool): [Read-Write] * If True use initial transform values for chain

  • interpolated_transform (Transform): [Read-Write] * The interpolated transform at the chain’s input parameter

  • items (Array[RigElementKey]): [Read-Write] * The items to use to interpret the chain

  • param (float): [Read-Write] * The parameter value down the chain of items from 0 to 1

  • param_length (float): [Read-Write] * The length of the interpolated chain

  • segment_info (RigUnit_ChainInfo_SegmentInfo): [Read-Write] * Segment Info

property calculate_stretch: bool

[Read-Write] * If True calculate stretch factors of chain and current segment

Type:

(bool)

property chain_length: float

[Read-Only] * The length of the interpolated chain

Type:

(float)

property chain_stretch_factor: float

[Read-Only] * Stretch factor of chain

Type:

(float)

property debug: bool

[Read-Write] * Enable debug draw for node

Type:

(bool)

property debug_scale: float

[Read-Write] * Debug draw scale

Type:

(float)

property initial: bool

[Read-Write] * If True use initial transform values for chain

Type:

(bool)

property interpolated_transform: Transform

[Read-Only] * The interpolated transform at the chain’s input parameter

Type:

(Transform)

property items: None

[Read-Write] * The items to use to interpret the chain

Type:

(Array[RigElementKey])

property param: float

[Read-Write] * The parameter value down the chain of items from 0 to 1

Type:

(float)

property param_length: float

[Read-Only] * The length of the interpolated chain

Type:

(float)

property segment_info: RigUnit_ChainInfo_SegmentInfo

[Read-Only] * Segment Info

Type:

(RigUnit_ChainInfo_SegmentInfo)