UGizmoPlaneTranslationParameterSource

[UGizmoAxisRotationParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoAxisRotati-) is an [IGizmoVec2ParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoVec2ParameterSource) implementation that interprets the [FVector2D](API\Runtime\Core\Math\FVector2D) parameter as a position in a 2D plane, and maps this position to a 3D translation a plane with origin/normal given by an [IGizmoAxisSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoAxisSource).

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

Remarks

UGizmoAxisRotationParameterSource is an IGizmoVec2ParameterSource implementation that interprets the FVector2D parameter as a position in a 2D plane, and maps this position to a 3D translation a plane with origin/normal given by an IGizmoAxisSource. This translation is applied to an IGizmoTransformSource.

This ParameterSource is intended to be used to create 3D Plane Translation 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

 

CurTranslationAxisX

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

Public variable

FVector

 

CurTranslationAxisY

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

Public variable

FVector

 

CurTranslationNormal

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

Public variable

FVector

 

CurTranslationOrigin

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

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

UGizmoPlaneT...

 

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

Public function Virtual

void

 

SetParameter

(
    const FVector2D& 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