UGizmoAxisScaleParameterSource

[UGizmoAxisScaleParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoAxisScaleParameterSource) is an [IGizmoFloatParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoFloatParameterSource) implementation that interprets the float value as the parameter of a line equation, and maps this parameter to a scale factor along a line with origin/direction given by an [IGizmoAxisSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoAxisSource).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h

Include

#include "BaseGizmos/ParameterToTransformAdapters.h"

Syntax

class UGizmoAxisScaleParameterSource : public UGizmoBaseFloatParameterSource

Remarks

UGizmoAxisScaleParameterSource is an IGizmoFloatParameterSource implementation that interprets the float value as the parameter of a line equation, and maps this parameter to a scale factor along a line with origin/direction given by an IGizmoAxisSource. This scale is applied to an IGizmoTransformSource.

This ParameterSource is intended to be used to create 3D Axis Scale Gizmos.

Variables

Name Description

Public variable

TScriptInterfac...

 

AxisSource

The Parameter line-equation value is converted to a 3D Translation along this Axis

Public variable

bool

 

bClampToZero

If true, the minimal output scale will be zero.

Public variable

FVector

 

CurScaleAxis

Scale axis for current parameter edit (only valid between BeginModify/EndModify)

Public variable

FVector

 

CurScaleOrigin

Scale origin for current parameter edit (only valid between BeginModify/EndModify)

Public variable

FTransform

 

InitialTransform

Saved copy of Initial transform for current parameter edit (only valid between BeginModify/EndModify)

Public variable

FGizmoFloatPara...

 

LastChange

Active parameter change (only valid between BeginModify/EndModify)

Public variable

float

 

Parameter

Parameter is the line-equation parameter that this FloatParameterSource provides

Public variable

float

 

ScaleMultiplier

Coordinate delta is multiplied by this amount

Public variable

TScriptInterfac...

 

TransformSource

This TransformSource is updated by applying the constructed 3D rotation

Functions

Name Description

Public function Static

UGizmoAxisSc...

 

Construct

(
    IGizmoAxisSource* AxisSourceIn,
    IGizmoTransformSource* Transfo...,
    UObject* Outer
)

Create a standard instance of this ParameterSource, with the given AxisSource and TransformSource

Overridden from IGizmoFloatParameterSource

Name Description

Public function Virtual

void

 

BeginModify()

Notify ParameterSource that a parameter modification is about to begin

Public function Virtual

void

 

EndModify()

Notify ParameterSource that a parameter modification is complete

Public function Virtual Const

float

 

GetParameter()

Optional position constraint function.

Public function Virtual

void

 

SetParameter

(
    float NewValue
)

Set value of parameter