unreal.RigUnit_SphericalPoseReader

class unreal.RigUnit_SphericalPoseReader(execute_context: ControlRigExecuteContext = [], output_param: float = 0.0, driver_item: RigElementKey = Ellipsis, driver_axis: Vector = Ellipsis, rotation_offset: Vector = Ellipsis, active_region_size: float = 0.0, active_region_scale_factors: RegionScaleFactors = Ellipsis, falloff_size: float = 0.0, falloff_region_scale_factors: RegionScaleFactors = Ellipsis, flip_width_scaling: bool = False, flip_height_scaling: bool = False, optional_parent_item: RigElementKey = Ellipsis, debug: SphericalPoseReaderDebugSettings = Ellipsis)

Bases: RigUnit_HighlevelBaseMutable

  • Outputs a float value between 0-1 based off of the driver item’s rotation in a specified region.

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_SphericalPoseReader.h

Editor Properties: (see get_editor_property/set_editor_property)

  • active_region_scale_factors (RegionScaleFactors): [Read-Write] The directional scaling parameters for the active region (green).

  • active_region_size (float): [Read-Write] The size of the active region (green) that outputs the full value (1.0). Range is 0-1. Default is 0.1.

  • debug (SphericalPoseReaderDebugSettings): [Read-Write]

  • driver_axis (Vector): [Read-Write] The axis of the driver transform that is compared against the falloff regions. Typically the axis that is pointing at the child; usually X by convention. Default is X-axis (1,0,0).

  • driver_item (RigElementKey): [Read-Write] The bone that will drive the output parameter when rotated into the active regions of this pose reader.

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

  • falloff_region_scale_factors (RegionScaleFactors): [Read-Write] The directional scaling parameters for the falloff region (yellow).

  • falloff_size (float): [Read-Write] The size of the falloff region (yellow) that defines the start of the output range. A value of 1 wraps the entire sphere with falloff. Range is 0-1. Default is 0.2.

  • flip_height_scaling (bool): [Read-Write] Flip the positive / negative directions of the height scale factors.

  • flip_width_scaling (bool): [Read-Write] Flip the positive / negative directions of the width scale factors.

  • optional_parent_item (RigElementKey): [Read-Write] An optional parent to use as a stable frame of reference for the active regions (defaults to DriverItem’s parent if unset).

  • output_param (float): [Read-Write] The normalized output parameter; ranges from 0 (when outside yellow region) to 1 (in the green region) and smoothly blends from 0-1 in the yellow region.

  • rotation_offset (Vector): [Read-Write] Rotate the entire falloff region to align with the desired area of effect.

property active_region_scale_factors: RegionScaleFactors

[Read-Write] The directional scaling parameters for the active region (green).

Type:

(RegionScaleFactors)

property active_region_size: float

[Read-Write] The size of the active region (green) that outputs the full value (1.0). Range is 0-1. Default is 0.1.

Type:

(float)

property debug: SphericalPoseReaderDebugSettings

[Read-Write]

Type:

(SphericalPoseReaderDebugSettings)

property driver_axis: Vector

[Read-Write] The axis of the driver transform that is compared against the falloff regions. Typically the axis that is pointing at the child; usually X by convention. Default is X-axis (1,0,0).

Type:

(Vector)

property driver_item: RigElementKey

[Read-Write] The bone that will drive the output parameter when rotated into the active regions of this pose reader.

Type:

(RigElementKey)

property falloff_region_scale_factors: RegionScaleFactors

[Read-Write] The directional scaling parameters for the falloff region (yellow).

Type:

(RegionScaleFactors)

property falloff_size: float

[Read-Write] The size of the falloff region (yellow) that defines the start of the output range. A value of 1 wraps the entire sphere with falloff. Range is 0-1. Default is 0.2.

Type:

(float)

property flip_height_scaling: bool

[Read-Write] Flip the positive / negative directions of the height scale factors.

Type:

(bool)

property flip_width_scaling: bool

[Read-Write] Flip the positive / negative directions of the width scale factors.

Type:

(bool)

property optional_parent_item: RigElementKey

[Read-Write] An optional parent to use as a stable frame of reference for the active regions (defaults to DriverItem’s parent if unset).

Type:

(RigElementKey)

property output_param: float

[Read-Only] The normalized output parameter; ranges from 0 (when outside yellow region) to 1 (in the green region) and smoothly blends from 0-1 in the yellow region.

Type:

(float)

property rotation_offset: Vector

[Read-Write] Rotate the entire falloff region to align with the desired area of effect.

Type:

(Vector)