Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UInteractiveGizmoManager
- UEditorInteractiveGizmoManager
References
| Module | EditorInteractiveToolsFramework |
| Header | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EditorInteractiveGizmoManager.h |
| Include | #include "EditorInteractiveGizmoManager.h" |
Syntax
class UEditorInteractiveGizmoManager : public UInteractiveGizmoManager
Remarks
UEditorInteractiveGizmoManager allows users of the Tools framework to register and create selection-based Gizmo instances. For each selection-based Gizmo, a builder derived from UInteractiveGizmoSelectionBuilder is registered with the GizmoManager. When the section changes, the highest priority builders for which SatisfiesCondition() return true, will be used to build gizmos.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TArray< FActiveEditorGizmo > | ActiveEditorGizmos | Set of Currently-active Gizmos |
 |
bool | bSearchLocalBuildersOnly | If false, only search gizmo builders in current gizmo manager. If true, also search gizmo subsystem |
 |
bool | bShowEditorGizmos | Whether Editor gizmos are enabled. |
 |
TMap< TObjectPtr< UInteractiveGizmoBuilder >, TObjectPtr< UInteractiveGizmo > > | CachedGizmoMap | Cache for already built gizmos, currently this only caches the transform |
 |
FEditorModeTools * | EditorModeManager | |
 |
TObjectPtr< UEditorInteractiveGizmoRegistry > | Registry | Actual registry |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
TArray< UInteractiveGizmo * > | Try to automatically activate a new Gizmo instance based on the current selection set state | |
 |
void | DeregisterEditorGizmoType
(
EEditorGizmoCategory InGizmoCategory, |
Remove an Editor gizmo type from the set of known Editor gizmo types |
  |
void | Shutdown and remove all active auto gizmos | |
  |
bool | DestroyEditorGizmo
(
UInteractiveGizmo* Gizmo |
Shutdown and remove a selection-based Gizmo |
   |
bool | Returns the current auto gizmo resolution setting | |
 |
void | GetQualifiedEditorGizmoBuilders
(
EEditorGizmoCategory InGizmoCategory, |
Get all qualified Editor gizmo builders for the specified category, based on the current state. |
  |
bool | Returns true if selection gizmos should be visible. | |
  |
bool | GetShowEditorGizmosForView
(
IToolsContextRenderAPI* RenderAPI |
Returns true if gizmos should be visible based on the current view's engine show flag. |
  |
UInteractiveGizmoBuilder * | Try to automatically activate a new Gizmo instance based on the current state | |
 |
void | HandleEditorSelectionSetChanged
(
const UTypedElementSelectionSet* InSelectionSet |
Handle Editor selection changes |
  |
void | InitializeWithEditorModeManager
(
IToolsContextQueriesAPI* QueriesAPI, |
Initialize the GizmoManager with the necessary Context-level state. |
 |
void | RegisterEditorGizmoType
(
EEditorGizmoCategory InGizmoCategory, |
Register a new Editor gizmo type. |
  |
void | SetEditorGizmoBuilderResolution
(
bool bLocalOnly |
Set how auto gizmo resolution should occur when CreateGizmosForCurrentState is invoked. |
 |
void | Updates active selection gizmos when show selection state changes |
Overridden from UInteractiveGizmoManager
| Type | Name | Description | |
|---|---|---|---|
  |
void | DrawHUD
(
FCanvas* Canvas, |
Let active Gizmos do screen space drawing. |
  |
void | Render
(
IToolsContextRenderAPI* RenderAPI |
Render any active Gizmos. |
  |
void | Shutdown () |
Shutdown the GizmoManager. |
  |
void | Tick
(
float DeltaTime |
State control (Tick any active Gizmos. Called by UInteractiveToolsContext |