1. Epic GamesDeveloper
  3. FRigUnit_SphericalPoseReader

FRigUnit_SphericalPoseReader

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

API > API/Plugins > API/Plugins/ControlRig

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

   
Name FRigUnit_SphericalPoseReader
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
Include Path #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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigUnit_SphericalPoseReader()

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActiveRegionScaleFactors FRegionScaleFactors The directional scaling parameters for the active region (green). Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)
ActiveRegionSize float The size of the active region (green) that outputs the full value (1.0). Range is 0-1. Default is 0.1. Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input, ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
bCachedInitTransforms bool   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  
CachedRotationOffset FVector   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  
Debug FSphericalPoseReaderDebugSettings   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)
Driver2D FVector   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Transient
DriverAxis FVector 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). Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)
DriverCache FCachedRigElement   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  
DriverItem FRigElementKey The bone that will drive the output parameter when rotated into the active regions of this pose reader. Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input, ExpandByDefault)
DriverNormal FVector   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Transient
FalloffRegionScaleFactors FRegionScaleFactors The directional scaling parameters for the falloff region (yellow). Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)
FalloffSize float 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. Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input, ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
FlipHeightScaling bool Flip the positive / negative directions of the height scale factors. Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)
FlipWidthScaling bool Flip the positive / negative directions of the width scale factors. Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)
InnerRegion FSphericalRegion Private work data Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Transient
LocalDriverTransformInit FTransform   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  
OptionalParentCache FCachedRigElement   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  
OptionalParentItem FRigElementKey An optional parent to use as a stable frame of reference for the active regions (defaults to DriverItem's parent if unset). Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)
OuterRegion FSphericalRegion   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Transient
OutputParam float 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. Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Output)
RotationOffset FVector Rotate the entire falloff region to align with the desired area of effect. Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h
  • Meta=(Input)

Functions

Public

Overridden from FRigVMStruct

Name Remarks Include Path Unreal Specifiers

virtual void Execute()

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

Static

Name Remarks Include Path Unreal Specifiers

static float CalcOutputParam ( const FEllipseQuery& InnerEllipseResults,
const FEllipseQuery& OuterEllipseResults
)

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

static void DistanceToEllipse ( const float InX,
const float InY,
const float SizeX,
const float SizeY,
FEllipseQuery& OutEllipseQuery
)

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

static void DrawDebug ( FRigUnit_SphericalPoseReader& PoseReader
)

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

static void EvaluateInterpolation ( FRigUnit_SphericalPoseReader& Node,
const FTransform& DriverTransform
)

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

static void RemapAndConvertInputs ( FSphericalRegion& InnerRegion,
FSphericalRegion& OuterRegion,
const float ActiveRegionSize,
const FRegionScaleFactors& ActiveRegionScaleFactors,
const float FalloffSize,
const FRegionScaleFactors& FalloffRegionScaleFactors,
const bool FlipWidth,
const bool FlipHeight
)

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

static float RemapRange ( const float T,
const float AStart,
const float AEnd,
const float BStart,
const float BEnd
)

   Units/Highlevel/Hierarchy/RigUnit_SphericalPoseReader.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page