18#include <unordered_map>
24struct RegisteredMenuItem
27 std::string mMenuPath;
28 std::string mItemPath;
29 MenuCallback mCallback;
31 std::string mShortcut;
32 bool mIsSeparator =
false;
38struct RegisteredWindow
41 std::string mWindowName;
42 std::string mWindowId;
43 WindowDrawCallback mDrawFunc;
51struct RegisteredInspector
54 std::string mNodeTypeName;
55 InspectorDrawCallback mDrawFunc;
62struct RegisteredContextItem
65 std::string mItemPath;
66 std::string mAssetTypeFilter;
67 MenuCallback mCallback;
75struct RegisteredEventCallback
78 EventCallback mCallback;
85struct RegisteredStringEventCallback
88 StringEventCallback mCallback;
95struct RegisteredPlatformEventCallback
98 PlatformEventCallback mCallback;
105struct RegisteredPackageFinishedCallback
108 PackageFinishedCallback mCallback;
115struct RegisteredPlayModeCallback
118 PlayModeCallback mCallback;
125struct RegisteredTopLevelMenu
128 std::string mMenuName;
129 TopLevelMenuDrawCallback mDrawFunc;
143 int32_t mPosition = -1;
149struct RegisteredToolbarItem
152 std::string mItemName;
153 ToolbarDrawCallback mDrawFunc;
160struct RegisteredMenuItemEx
163 std::string mMenuPath;
164 std::string mItemPath;
165 MenuCallback mCallback;
167 std::string mShortcut;
168 MenuValidationCallback mValidateFunc;
174struct RegisteredNodeMenuItems
177 std::string mCategory;
178 MenuSectionDrawCallback mDrawFunc;
185struct RegisteredCreateAssetItems
188 MenuSectionDrawCallback mDrawFunc;
200struct RegisteredCreateAssetItem
204 MenuCallback mCallback;
211struct RegisteredSpawnItems
214 MenuSectionDrawCallback mDrawFunc;
221struct RegisteredSceneType
224 std::string mTypeName;
225 SceneCreationCallback mCreateFunc;
232struct RegisteredViewportContextItem
235 std::string mItemPath;
236 MenuCallback mCallback;
243struct RegisteredViewportOverlay
246 std::string mOverlayName;
247 ViewportOverlayCallback mDrawFunc;
260struct RegisteredFileDropHandler
263 EditorUIHooks::FileDropCallback mCallback;
275struct RegisteredViewportMode
279 std::string mDisplayName;
280 int32_t mSortOrder = 0;
281 EditorUIHooks::ViewportModeCanActivateCallback mCanActivate =
nullptr;
282 EditorUIHooks::ViewportModeActivateCallback mOnActivate =
nullptr;
283 EditorUIHooks::ViewportModeDeactivateCallback mOnDeactivate =
nullptr;
284 EditorUIHooks::ViewportModeTickCallback mTick =
nullptr;
285 EditorUIHooks::ViewportModeDrawPanelCallback mDrawPanel =
nullptr;
286 void* mUserData =
nullptr;
292struct RegisteredPreferencesPanel
295 std::string mPanelName;
296 std::string mPanelCategory;
297 PreferencesPanelDrawCallback mDrawFunc;
298 PreferencesLoadCallback mLoadFunc;
299 PreferencesSaveCallback mSaveFunc;
306struct RegisteredShortcut
309 std::string mShortcutId;
310 std::string mDisplayName;
311 std::string mDefaultBinding;
312 ShortcutCallback mCallback;
318 int32_t mKeyCode = -1;
324struct RegisteredPropertyDrawer
327 std::string mPropertyTypeName;
328 PropertyDrawCallback mDrawFunc;
335struct RegisteredHierarchyItemGUI
338 HierarchyItemGUICallback mDrawFunc;
345struct RegisteredAssetItemGUI
348 AssetItemGUICallback mDrawFunc;
355struct RegisteredHierarchyChangedCallback
358 HierarchyChangedCallback mCallback;
365struct RegisteredSimpleContextItem
368 std::string mItemPath;
369 MenuCallback mCallback;
376struct RegisteredGamePreviewResolution
387struct RegisteredPlayTarget
390 std::string mTargetName;
391 std::string mIconText;
392 PlayTargetCallback mCallback;
399struct RegisteredDragDropHandler
402 std::string mTargetArea;
403 DragDropHandlerCallback mHandler;
410struct RegisteredAssetImporter
413 std::string mExtension;
414 AssetImportCallback mImportFunc;
421struct RegisteredPreImportCallback
424 PreImportCallback mCallback;
431struct RegisteredPreBuildCallback
434 PreBuildCallback mCallback;
441struct RegisteredEditorModeCallback
444 EditorModeCallback mCallback;
451struct RegisteredGizmoTool
454 std::string mToolName;
455 std::string mIconText;
456 std::string mTooltip;
457 GizmoToolDrawCallback mDrawFunc;
459 bool mIsActive =
false;
465struct RegisteredControllerRoute
470 ControllerRouteCallback mCallback;
477struct RegisteredControllerServerEvent
480 ControllerServerEventCallback mCallback;
487struct RegisteredTargetOptions
491 TargetOptionsDrawCallback mDrawFunc;
498struct RegisteredModal
502 ModalDrawCallback mDrawFunc;
512class EditorUIHookManager
515 static void Create();
517 static EditorUIHookManager*
Get();
522 EditorUIHooks* GetHooks() {
return &mHooks; }
529 const std::vector<RegisteredMenuItem>& GetMenuItems(
const std::string& menuPath)
const;
535 void DrawMenuItems(
const std::string& menuPath);
542 const std::vector<RegisteredWindow>& GetWindows()
const {
return mWindows; }
557 void OpenWindow(
const std::string& windowId);
562 void CloseWindow(
const std::string& windowId);
567 bool IsWindowOpen(
const std::string& windowId)
const;
575 const RegisteredInspector* GetInspector(
const std::string& nodeTypeName)
const;
581 bool DrawInspector(
const std::string& nodeTypeName,
void* node);
588 void DrawNodeContextItems();
594 void DrawAssetContextItems(
const std::string& assetType);
601 void DrawTopLevelMenus();
608 void DrawTopLevelMenusAtPosition(int32_t builtinPosition);
612 void DrawToolbarItems();
616 void DrawNodeMenuItems(
const char* category,
void* parentNode);
617 void DrawCustomNodeCategories(
void* parentNode);
618 void DrawCreateAssetItems();
619 void DrawSpawnBasic3dItems(
void* parentNode);
620 void DrawSpawnBasicWidgetItems(
void* parentNode);
624 const std::vector<RegisteredSceneType>& GetSceneTypes()
const {
return mSceneTypes; }
625 void FireSceneCreation(
const std::string& typeName,
const char* sceneName,
void* rootNode);
629 void DrawViewportContextItems();
630 void DrawViewportOverlays(
float viewportX,
float viewportY,
float viewportW,
float viewportH);
631 bool HasViewportContextItems()
const;
635 const std::vector<RegisteredPreferencesPanel>& GetPreferencesPanels()
const {
return mPreferencesPanels; }
636 void LoadAddonPreferences();
637 void SaveAddonPreferences();
641 void ProcessShortcuts();
645 bool DrawPropertyDrawer(
const char* propertyTypeName,
const char* propertyName,
void* propertyOwner, int32_t propertyType);
649 void DrawHierarchyItemGUI(
void* node,
float rowX,
float rowY,
float rowW,
float rowH);
650 void DrawAssetItemGUI(
const char* assetName,
const char* assetType,
float rowX,
float rowY,
float rowW,
float rowH);
651 void FireOnHierarchyChanged(int32_t changeType,
void* node);
655 void DrawSceneTabContextItems();
656 void DrawDebugLogContextItems();
657 void DrawImportMenuItems();
658 void DrawAddonsMenuItems();
659 void DrawPlayTargets();
660 bool HasPlayTargets()
const;
664 const std::vector<RegisteredGamePreviewResolution>& GetGamePreviewResolutions()
const {
return mGamePreviewResolutions; }
668 bool HandleDragDrop(
const char* targetArea,
const char* payloadType,
const void* payloadData, int32_t payloadSize);
669 bool HandleAssetImport(
const char* filePath,
const char* extension);
670 bool FireOnPreAssetImport(
const char* filePath);
671 void FireOnPostAssetImport(
const char* assetPath);
675 bool FireOnPreBuild(int32_t platform);
676 void FireOnPostBuild(int32_t platform,
bool success);
677 void FireOnEditorModeChanged(int32_t newMode);
678 void DrawGizmoTools(
void* selectedNode);
679 const std::vector<RegisteredGizmoTool>& GetGizmoTools()
const {
return mGizmoTools; }
683 void FireOnProjectOpen(
const char* projectPath);
684 void FireOnProjectClose(
const char* projectPath);
685 void FireOnProjectSave(
const char* filePath);
686 void FireOnSceneOpen(
const char* scenePath);
687 void FireOnSceneClose(
const char* scenePath);
688 void FireOnPackageStarted(int32_t platform);
691 const std::vector<RegisteredTargetOptions>& GetTargetOptions()
const {
return mTargetOptions; }
692 void FireOnPackageFinished(int32_t platform,
bool success);
693 void FireOnSelectionChanged();
694 void FireOnPlayModeChanged(int32_t state);
695 void FireOnEditorShutdown();
696 void FireOnAssetImported(
const char* assetPath);
697 void FireOnAssetDeleted(
const char* assetPath);
698 void FireOnAssetSaved(
const char* assetPath);
699 void FireOnAssetOpen(
const char* assetName);
700 void FireOnAssetOpened(
const char* assetName);
701 void FireOnUndoRedo();
702 void FireOnAssetDropHierarchy(
const char* assetName);
703 void FireOnAssetDropViewport(
const char* assetName);
707 const std::vector<RegisteredControllerRoute>& GetControllerRoutes()
const {
return mControllerRoutes; }
708 void FireOnControllerServerStateChanged(int32_t state);
718 const std::vector<RegisteredViewportMode>& GetViewportModes()
const {
return mViewportModes; }
724 std::vector<const RegisteredViewportMode*> GetViewportModesSorted()
const;
727 const RegisteredViewportMode* FindViewportMode(
const std::string& modeId)
const;
734 void FireViewportModeActivate(
const std::string& modeId);
737 void FireViewportModeDeactivate(
const std::string& modeId);
740 bool CanActivateViewportMode(
const std::string& modeId);
743 void TickActiveViewportMode(
float deltaTime);
746 void DrawActiveViewportModePanel();
753 void RemoveAllHooks(HookId hookId);
764 bool DispatchFileDrop(
const std::vector<std::string>& paths);
767 static EditorUIHookManager* sInstance;
768 EditorUIHookManager();
769 ~EditorUIHookManager();
771 void InitializeHooks();
774 std::unordered_map<std::string, std::vector<RegisteredMenuItem>> mMenuItems;
775 std::vector<RegisteredWindow> mWindows;
776 std::vector<RegisteredInspector> mInspectors;
777 std::vector<RegisteredContextItem> mContextItems;
780 std::vector<RegisteredTopLevelMenu> mTopLevelMenus;
781 std::vector<RegisteredToolbarItem> mToolbarItems;
782 std::vector<RegisteredStringEventCallback> mOnProjectOpen;
783 std::vector<RegisteredStringEventCallback> mOnProjectClose;
784 std::vector<RegisteredStringEventCallback> mOnProjectSave;
785 std::vector<RegisteredStringEventCallback> mOnSceneOpen;
786 std::vector<RegisteredStringEventCallback> mOnSceneClose;
787 std::vector<RegisteredPlatformEventCallback> mOnPackageStarted;
788 std::vector<RegisteredPackageFinishedCallback> mOnPackageFinished;
789 std::vector<RegisteredEventCallback> mOnSelectionChanged;
790 std::vector<RegisteredPlayModeCallback> mOnPlayModeChanged;
791 std::vector<RegisteredEventCallback> mOnEditorShutdown;
792 std::vector<RegisteredStringEventCallback> mOnAssetImported;
793 std::vector<RegisteredStringEventCallback> mOnAssetDeleted;
794 std::vector<RegisteredStringEventCallback> mOnAssetSaved;
795 std::vector<RegisteredStringEventCallback> mOnAssetOpen;
796 std::vector<RegisteredStringEventCallback> mOnAssetOpened;
797 std::vector<RegisteredEventCallback> mOnUndoRedo;
798 std::vector<RegisteredStringEventCallback> mOnAssetDropHierarchy;
799 std::vector<RegisteredStringEventCallback> mOnAssetDropViewport;
802 std::vector<RegisteredMenuItemEx> mMenuItemsEx;
805 std::vector<RegisteredNodeMenuItems> mNodeMenuItems;
806 std::vector<RegisteredCreateAssetItems> mCreateAssetItems;
807 std::vector<RegisteredCreateAssetItem> mCreateAssetItemSingles;
808 std::vector<RegisteredSpawnItems> mSpawnBasic3dItems;
809 std::vector<RegisteredSpawnItems> mSpawnBasicWidgetItems;
812 std::vector<RegisteredSceneType> mSceneTypes;
815 std::vector<RegisteredViewportContextItem> mViewportContextItems;
816 std::vector<RegisteredViewportOverlay> mViewportOverlays;
819 std::vector<RegisteredPreferencesPanel> mPreferencesPanels;
822 std::vector<RegisteredShortcut> mShortcuts;
825 std::vector<RegisteredPropertyDrawer> mPropertyDrawers;
828 std::vector<RegisteredHierarchyItemGUI> mHierarchyItemGUI;
829 std::vector<RegisteredAssetItemGUI> mAssetItemGUI;
830 std::vector<RegisteredHierarchyChangedCallback> mOnHierarchyChanged;
833 std::vector<RegisteredGamePreviewResolution> mGamePreviewResolutions;
836 std::vector<RegisteredSimpleContextItem> mSceneTabContextItems;
837 std::vector<RegisteredSimpleContextItem> mDebugLogContextItems;
838 std::vector<RegisteredSimpleContextItem> mImportMenuItems;
839 std::vector<RegisteredSimpleContextItem> mAddonsMenuItems;
840 std::vector<RegisteredPlayTarget> mPlayTargets;
843 std::vector<RegisteredFileDropHandler> mFileDropHandlers;
848 std::vector<RegisteredViewportMode> mViewportModes;
851 std::vector<RegisteredDragDropHandler> mDragDropHandlers;
852 std::vector<RegisteredAssetImporter> mAssetImporters;
853 std::vector<RegisteredPreImportCallback> mOnPreAssetImport;
854 std::vector<RegisteredStringEventCallback> mOnPostAssetImport;
857 std::vector<RegisteredPreBuildCallback> mOnPreBuild;
858 std::vector<RegisteredPackageFinishedCallback> mOnPostBuild;
859 std::vector<RegisteredEditorModeCallback> mOnEditorModeChanged;
860 std::vector<RegisteredGizmoTool> mGizmoTools;
863 std::vector<RegisteredControllerRoute> mControllerRoutes;
864 std::vector<RegisteredControllerServerEvent> mOnControllerServerStateChanged;
867 BuildTargetRegistry mBuildTargets;
870 std::vector<RegisteredTargetOptions> mTargetOptions;
873 std::vector<RegisteredModal> mModals;
877 BuildTargetRegistry& GetBuildTargets() {
return mBuildTargets; }
878 const BuildTargetRegistry& GetBuildTargets()
const {
return mBuildTargets; }
882 std::vector<RegisteredMenuItem> mEmptyMenuItems;
889 EditorUIHooks mHooks{};
892 void ParseKeyBinding(RegisteredShortcut& shortcut);
898HookId GenerateHookId(
const char* identifier);
Editor UI extension system for native addons.