FRigUnit_SphericalPoseReader | Unreal Engine 5.4 Documentation

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Highlevel > API/Plugins/ControlRig/Units/Highlevel/Hierarchy

Inheritance Hierarchy

References


Module	ControlRig
Header	/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
Include	#include "Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h"

Syntax

USTRUCT (  
        Meta=(DisplayName="Spherical Pose Reader", Category="Hierarchy", Keywords="Pose Reader, SPR"))  
struct FRigUnit_SphericalPoseReader : public FRigUnit_HighlevelBaseMutable

Remarks

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

Variables

Type	Name	Description
FRegionScaleFactors	ActiveRegionScaleFactors	The directional scaling parameters for the active region (green).
float	ActiveRegionSize	The size of the active region (green) that outputs the full value (1.0). Range is 0-1. Default is 0.1.
bool	bCachedInitTransforms
FVector	CachedRotationOffset
FSphericalPoseReaderDebugSettings	Debug
FVector	Driver2D
FVector	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).
FCachedRigElement	DriverCache
FRigElementKey	DriverItem	The bone that will drive the output parameter when rotated into the active regions of this pose reader.
FVector	DriverNormal
FRegionScaleFactors	FalloffRegionScaleFactors	The directional scaling parameters for the falloff region (yellow).
float	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.
bool	FlipHeightScaling	Flip the positive / negative directions of the height scale factors.
bool	FlipWidthScaling	Flip the positive / negative directions of the width scale factors.
FSphericalRegion	InnerRegion	Private work data
FTransform	LocalDriverTransformInit
FCachedRigElement	OptionalParentCache
FRigElementKey	OptionalParentItem	An optional parent to use as a stable frame of reference for the active regions (defaults to DriverItem's parent if unset).
FSphericalRegion	OuterRegion
float	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.
FVector	RotationOffset	Rotate the entire falloff region to align with the desired area of effect.

Constructors

	Type	Name	Description
		FRigUnit_SphericalPoseReader ()

Functions

	Type	Name	Description
	float	CalcOutputParam ( const FEllipseQuery& InnerEllipseResults, const FEllipseQuery& OuterEllipseResults )
	void	DistanceToEllipse ( const float InX, const float InY, const float SizeX, const float SizeY, FEllipseQuery& OutEllipseQuery )
	void	DrawDebug ( FRigUnit_SphericalPoseReader& PoseReader )
	void	EvaluateInterpolation ( FRigUnit_SphericalPoseReader& Node, const FTransform& DriverTransform )
	void	RemapAndConvertInputs ( FSphericalRegion& InnerRegion, FSphericalRegion& OuterRegion, const float ActiveRegionSize, const FRegionScaleFactors& ActiveRegionScaleFactors, const float FalloffSize, const FRegionScaleFactors& FalloffRegionScaleFactors, const bool FlipWidth, const bool FlipHeight )
	float	RemapRange ( const float T, const float AStart, const float AEnd, const float BStart, const float BEnd )