UGizmoAxisTranslationParameterSource

Various 1D and 2D ParameterSource converters intended to be used to create 3D transformation gizmos.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseGizmos/ParameterToTransformAdapters.h"

Syntax

class UGizmoAxisTranslationParameterSource : public UGizmoBaseFloatParameterSource

Remarks

Various 1D and 2D ParameterSource converters intended to be used to create 3D transformation gizmos. Based on base classes in ParameterSourcesFloat.h and ParameterSourcesVec2.hUGizmoAxisTranslationParameterSource is an IGizmoFloatParameterSource implementation that interprets the float value as the parameter of a line equation, and maps this parameter to a 3D translation along a line with origin/direction given by an IGizmoAxisSource. This translation is applied to an IGizmoTransformSource.

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

Variables

Name Description

Public variable

TScriptInterfac...

 

AxisSource

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

Public variable

FVector

 

CurTranslationAxis

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

Public variable

FVector

 

CurTranslationOrigin

Tranlsation 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

TUniqueFunction...

 

PositionConstraintFunction

Optional position constraint function.

Public variable

TScriptInterfac...

 

TransformSource

This TransformSource is updated by applying the constructed 3D translation

Functions

Name Description

Public function Static

UGizmoAxisTr...

 

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()

Public function Virtual

void

 

SetParameter

(
    float NewValue
)

Set value of parameter
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss