Spherical Pose Reader | Unreal Engine 5.7 Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

Description

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

Information

Plugin	ControlRig
Category	Hierarchy
Tags	Pose Reader, SPR
Type	FRigUnit_SphericalPoseReader

IO

Name	Description	Permitted Types	Default Value
ExecutePin	This property is used to chain multiple mutable units together	Execute Context

Inputs

Name	Description	Permitted Types	Default Value
DriverItem	The bone that will drive the output parameter when rotated into the active regions of this pose reader.	Rig Element Key	(Type=Bone,Name="")
DriverAxis	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).	Vector	(X=1.000000,Y=0.000000,Z=0.000000)
RotationOffset	Rotate the entire falloff region to align with the desired area of effect.	Vector	(X=90.000000,Y=0.000000,Z=0.000000)
ActiveRegionSize	The size of the active region (green) that outputs the full value (1.0). Range is 0-1. Default is 0.1.	float	0.100000
ActiveRegionScaleFactors	The directional scaling parameters for the active region (green).	Region Scale Factors	(PositiveWidth=1.000000,NegativeWidth=1.000000,PositiveHeight=1.000000,NegativeHeight=1.000000)
FalloffSize	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.	float	0.200000
FalloffRegionScaleFactors	The directional scaling parameters for the falloff region (yellow).	Region Scale Factors	(PositiveWidth=1.000000,NegativeWidth=1.000000,PositiveHeight=1.000000,NegativeHeight=1.000000)
FlipWidthScaling	Flip the positive / negative directions of the width scale factors.	bool	False
FlipHeightScaling	Flip the positive / negative directions of the height scale factors.	bool	False
OptionalParentItem	An optional parent to use as a stable frame of reference for the active regions (defaults to DriverItem's parent if unset).	Rig Element Key	(Type=Bone,Name="")
Debug	The debug settings	Spherical Pose Reader Debug Settings	(bDrawDebug=True,bDraw2D=False,bDrawLocalAxes=False,DebugScale=25.000000,DebugSegments=20,DebugThickness=0.250000)

Outputs

Name	Description	Permitted Types	Default Value
OutputParam	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.	float