UGizmoAxisRotationParameterSource

[UGizmoAxisRotationParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoAxisRotati-) is an [IGizmoFloatParameterSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoFloatParameterSource) implementation that interprets the float parameter as an angle, and maps this angle to a 3D rotation around an [IGizmoAxisSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoAxisSource) (ie 3D axis).

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 UGizmoAxisRotationParameterSource : public UGizmoBaseFloatParameterSource

Remarks

UGizmoAxisRotationParameterSource is an IGizmoFloatParameterSource implementation that interprets the float parameter as an angle, and maps this angle to a 3D rotation around an IGizmoAxisSource (ie 3D axis). This rotation is applied to an IGizmoTransformSource. This ParameterSource is intended to be used to create 3D Rotation Gizmos.

Variables

Name Description

Public variable

float

 

Angle

Angle is the parameter that this FloatParameterSource provides

Public variable

TScriptInterfac...

 

AxisSource

Float-parameter Angle is mapped to a 3D Rotation around this Axis

Public variable

FVector

 

CurRotationAxis

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

Public variable

FVector

 

CurRotationOrigin

Rotation 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

TUniqueFunction...

 

RotationConstraintFunction

Optional rotation constraint function.

Public variable

TScriptInterfac...

 

TransformSource

This TransformSource is updated by applying the constructed 3D rotation

Functions

Name Description

Public function Static

UGizmoAxisRo...

 

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