UGizmoUniformScaleParameterSource

[UGizmoUniformScaleParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoUniformSca-) is an [IGizmoVec2ParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoVec2ParameterSource) implementation that interprets the Vec2 parameter as the position in a 2D plane, and maps this parameter to a change in a uniform scale value.

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 UGizmoUniformScaleParameterSource : public UGizmoBaseVec2ParameterSource

Remarks

UGizmoUniformScaleParameterSource is an IGizmoVec2ParameterSource implementation that interprets the Vec2 parameter as the position in a 2D plane, and maps this parameter to a change in a uniform scale value. This scale is applied to an IGizmoTransformSource.

The X/Y plane parameter deltas are converted to a uniform scale delta simply by adding them. This assumpes that the 3D plane is oriented such that "positive" along the X and Y tangent axes corresponds to something semantically meaningful. It's up to the client to do this.

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

Variables

Name Description

Public variable

TScriptInterfac...

 

AxisSource

AxisSource provides the 3D plane (origin/normal/u/v) that is used to interpret the 2D parameters

Public variable

FVector

 

CurScaleAxisX

In-plane axis X for current parameter edit (only valid between BeginModify/EndModify)

Public variable

FVector

 

CurScaleAxisY

In-plane axis Y for current parameter edit (only valid between BeginModify/EndModify)

Public variable

FVector

 

CurScaleNormal

Plane normal for current parameter edit (only valid between BeginModify/EndModify)

Public variable

FVector

 

CurScaleOrigin

Plane 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

FGizmoVec2Param...

 

LastChange

Active parameter change (only valid between BeginModify/EndModify)

Public variable

FVector2D

 

Parameter

Parameter is the two line-equation parameters that this Vec2ParameterSource 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 translation

Functions

Name Description

Public function Static

UGizmoUnifor...

 

Construct

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

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

Overridden from IGizmoVec2ParameterSource

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

FVector2D

 

GetParameter()

Optional position constraint function.

Public function Virtual

void

 

SetParameter

(
    const FVector2D& NewValue
)

Set value of parameter