UEditorInteractiveGizmoSubsystem

The InteractiveGizmoSubsystem provides methods for registering and unregistering selection-based gizmo builders.

Unreal Engine C++ API Reference > Editor > EditorInteractiveToolsFramework

Inheritance Hierarchy

References

   
Module EditorInteractiveToolsFramework
Header /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EditorInteractiveGizmoSubsystem.h
Include #include "EditorInteractiveGizmoSubsystem.h"

Syntax

class UEditorInteractiveGizmoSubsystem : public [UEditorSubsystem](API\Editor\EditorSubsystem\UEditorSubsystem)  

Remarks

The InteractiveGizmoSubsystem provides methods for registering and unregistering selection-based gizmo builders. This subsystem will be queried for qualified builders based on the current selection.

This subsystem should be used to register gizmo selection-based builders which are not specific to an ed mode or asset editor. For gizmo selection-based builders which are specific to an ed mode or asset editor, register with the UEditorinteractiveGizmoManager instead, when the ed mode or asset editor starts up (and deregister when the mode or asset editor shuts down).

Plugins registering gizmo types should bind to the delegates returned by:

  • OnEditorGizmoSubsystemRegisterEditorGizmoTypes()
  • OnEditorGizmoSubsystemDeregisterEditorGizmoTypes() to register and dergister their gizmo builders.

Constructors

Type Name Description
  UEditorInteractiveGizmoSubsystem ()  

Functions

Type Name Description
void DeregisterBuiltinEditorGizmoTypes () Removes all built-in Editor gizmo types and broadcast deregistration event.
void DeregisterGlobalEditorGizmoType ( EEditorGizmoCategory InGizmoCategor..., UInteractiveGizmoBuilder* InGi... ) Remove an Editor gizmo type from the set of known Editor gizmo types
void GetQualifiedGlobalEditorGizmoBuilders ( EEditorGizmoCategory InGizmoCategor..., const FToolBuilderState& InToolBui..., TArray< UInteractiveGizmoBuilder&#... ) Get all qualified Editor gizmo builders for the specified category, based on the current state.
UInteractive... GetTransformGizmoBuilder () Get transform gizmo builder used to build the Level Editor TRS gizmo.
FOnEditorGiz... OnEditorGizmoSubsystemDeregisterGlobalEditorGizmoTypes ()  
FOnEditorGiz... OnEditorGizmoSubsystemRegisterGlobalEditorGizmoTypes ()  
void RegisterBuiltinEditorGizmoTypes () Registers all built-in Editor gizmo types and broadcast registration event.
void RegisterGlobalEditorGizmoType ( EEditorGizmoCategory InGizmoCategor..., UInteractiveGizmoBuilder* InGi... ) Register a new Editor gizmo type which will be global to the Editor.

Overridden from USubsystem

Type Name Description
void Deinitialize () Implement this for deinitialization of instances of the system
void Initialize ( FSubsystemCollectionBase& Collecti... ) Implement this for initialization of instances of the system

Classes

Type Name Description
Public class FOnEditorGizmoSubsystemDeregisterGlobalEditorGizmoTypes Event which is broadcast just before default types are deregistered in the gizmo subsystem
Public class FOnEditorGizmoSubsystemRegisterGlobalEditorGizmoTypes Event which is broadcast just after default types are registered in the gizmo subsystem

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library