UCombinedTransformGizmoContextObject

[UCombinedTransformGizmoContextObject](API\Runtime\InteractiveToolsFramework\BaseGizmos\UCombinedTransfo-) is a utility object that registers a set of Gizmo Builders for [UCombinedTransformGizmo](API\Runtime\InteractiveToolsFramework\BaseGizmos\UCombinedTransformGizmo) and variants.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UCombinedTransformGizmoContextObject

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/TransformGizmoUtil.h

Include

#include "BaseGizmos/TransformGizmoUtil.h"

Syntax

class UCombinedTransformGizmoContextObject : public UObject

Remarks

UCombinedTransformGizmoContextObject is a utility object that registers a set of Gizmo Builders for UCombinedTransformGizmo and variants. The intended usage is to call RegisterGizmosWithManager(), and then the UCombinedTransformGizmoContextObject will register itself as a ContextObject in the InteractiveToolsContext's ContextObjectStore. Then the Create3AxisTransformGizmo()/etc functions will spawn different variants of UCombinedTransformGizmo. The above UE::TransformGizmoUtil:: functions will look up the UCombinedTransformGizmoContextObject instance in the ContextObjectStore and then call the associated function below.

Variables

Name Description

Protected variable

bool

 

bDefaultGizmosRegistered

Protected variable

TSharedPtr< FCo...

 

GizmoActorBuilder

Functions

Name Description

Public function Virtual

UCombinedTra...

 

Create3AxisTransformGizmo

(
    UInteractiveGizmoManager* Gizm...,
    void* Owner,
    const FString& InstanceIdentifier
)

Activate a new instance of the default 3-axis transformation Gizmo.

Public function Virtual

UCombinedTra...

 

CreateCustomRepositionableTransformGizmo

(
    UInteractiveGizmoManager* Gizm...,
    ETransformGizmoSubElements Elements,
    void* Owner,
    const FString& InstanceIdentifier
)

Variant of CreateCustomTransformGizmo that creates a URepositionableTransformGizmo, which is an extension to UCombinedTransformGizmo that supports various snapping interactions

Public function Virtual

UCombinedTra...

 

CreateCustomTransformGizmo

(
    UInteractiveGizmoManager* Gizm...,
    ETransformGizmoSubElements Elements,
    void* Owner,
    const FString& InstanceIdentifier
)

Activate a new customized instance of the default 3-axis transformation Gizmo, with only certain elements included.

Public function

void

 

DeregisterGizmosWithManager

(
    UInteractiveToolManager* ToolM...
)

Public function

void

 

RegisterGizmosWithManager

(
    UInteractiveToolManager* ToolM...
)

Constants