ATransformGizmoActor

[ATransformGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\ATransformGizmoActor) is an Actor type intended to be used with [UTransformGizmo](API\Runtime\InteractiveToolsFramework\BaseGizmos\UTransformGizmo), as the in-scene visual representation of the Gizmo.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseGizmos/TransformGizmo.h"

Syntax

class ATransformGizmoActor : public AGizmoActor

Remarks

ATransformGizmoActor is an Actor type intended to be used with UTransformGizmo, as the in-scene visual representation of the Gizmo.

FTransformGizmoActorFactory returns an instance of this Actor type (or a subclass), and based on which Translate and Rotate UProperties are initialized, will associate those Components with UInteractiveGizmo's that implement Axis Translation, Plane Translation, and Axis Rotation.

If a particular sub-Gizmo is not required, simply set that FProperty to null.

The static factory method ::ConstructDefault3AxisGizmo() creates and initializes an Actor suitable for use in a standard 3-axis Transformation Gizmo.

Variables

Name Description

Public variable

UPrimitiveCompo...

 

AxisScaleX

X Axis Scale Component

Public variable

UPrimitiveCompo...

 

AxisScaleY

Y Axis Scale Component

Public variable

UPrimitiveCompo...

 

AxisScaleZ

Z Axis Scale Component

Public variable

UPrimitiveCompo...

 

PlaneScaleXY

XY Plane Scale Component

Public variable

UPrimitiveCompo...

 

PlaneScaleXZ

XZ Plane Scale Component

Public variable

UPrimitiveCompo...

 

PlaneScaleYZ

YZ Plane Scale Component

Public variable

UPrimitiveCompo...

 

RotateX

Rotation ComponentsX Axis Rotation Component

Public variable

UPrimitiveCompo...

 

RotateY

Y Axis Rotation Component

Public variable

UPrimitiveCompo...

 

RotateZ

Z Axis Rotation Component

Public variable

UPrimitiveCompo...

 

TranslateX

Translation ComponentsX Axis Translation Component

Public variable

UPrimitiveCompo...

 

TranslateXY

XY Plane Translation Component

Public variable

UPrimitiveCompo...

 

TranslateXZ

XZ Plane Translation Component

Public variable

UPrimitiveCompo...

 

TranslateY

Y Axis Translation Component

Public variable

UPrimitiveCompo...

 

TranslateYZ

YZ Plane Translation Component

Public variable

UPrimitiveCompo...

 

TranslateZ

Z Axis Translation Component

Public variable

UPrimitiveCompo...

 

UniformScale

Scaling ComponentsUniform Scale Component

Constructors

Name Description

Public function

ATransformGizmoActor()

Functions

Name Description

Public function Static

ATransformGi...

 

ConstructCustom3AxisGizmo

(
    UWorld* World,
    ETransformGizmoSubElements Elements
)

Create a new instance of ATransformGizmoActor.

Public function Static

ATransformGi...

 

ConstructDefault3AxisGizmo

(
    UWorld* World
)

Create a new instance of ATransformGizmoActor and populate the various sub-components with standard GizmoXComponent instances suitable for a 3-axis transformer Gizmo

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