EditorUIHooks.h

Go to the documentation of this file.

#pragma once
 
#if EDITOR
 
#include <stdint.h>
 
// ===== Callback Types =====
 
typedef void (*MenuCallback)(void* userData);
 
typedef void (*WindowDrawCallback)(void* userData);
 
typedef void (*InspectorDrawCallback)(void* node, void* userData);
 
typedef void (*EventCallback)(void* userData);
 
typedef void (*StringEventCallback)(const char* str, void* userData);
 
typedef void (*PlatformEventCallback)(int32_t platform, void* userData);
 
typedef void (*PackageFinishedCallback)(int32_t platform, bool success, void* userData);
 
typedef void (*PlayModeCallback)(int32_t state, void* userData);
 
typedef void (*TopLevelMenuDrawCallback)(void* userData);
 
typedef void (*ToolbarDrawCallback)(void* userData);
 
typedef bool (*MenuValidationCallback)(void* userData);
 
typedef void (*MenuSectionDrawCallback)(void* parentNode, void* userData);
 
typedef void (*ViewportOverlayCallback)(float viewportX, float viewportY, float viewportW, float viewportH, void* userData);
 
typedef void (*PreferencesPanelDrawCallback)(void* userData);
 
typedef void (*PreferencesLoadCallback)(void* userData);
typedef void (*PreferencesSaveCallback)(void* userData);
 
typedef void (*ShortcutCallback)(void* userData);
 
typedef bool (*PropertyDrawCallback)(const char* propertyName, void* propertyOwner, int32_t propertyType, void* userData);
 
typedef void (*HierarchyItemGUICallback)(void* node, float rowX, float rowY, float rowW, float rowH, void* userData);
 
typedef void (*AssetItemGUICallback)(const char* assetName, const char* assetType, float rowX, float rowY, float rowW, float rowH, void* userData);
 
typedef void (*HierarchyChangedCallback)(int32_t changeType, void* node, void* userData);
 
typedef bool (*DragDropHandlerCallback)(const char* payloadType, const void* payloadData, int32_t payloadSize, void* userData);
 
typedef bool (*AssetImportCallback)(const char* filePath, const char* extension, void* userData);
 
typedef bool (*PreImportCallback)(const char* filePath, void* userData);
 
typedef bool (*PreBuildCallback)(int32_t platform, void* userData);
 
typedef void (*EditorModeCallback)(int32_t newMode, void* userData);
 
typedef void (*GizmoToolDrawCallback)(void* selectedNode, void* userData);
 
typedef void (*PlayTargetCallback)(void* userData);
 
typedef void (*SceneCreationCallback)(const char* sceneName, void* rootNode, void* userData);
 
// ===== Controller Server Hooks =====
 
typedef void (*ControllerRouteCallback)(const char* method, const char* path, const char* body, char* responseBuffer, int32_t bufferSize, void* userData);
 
typedef void (*ControllerServerEventCallback)(int32_t state, void* userData);
 
typedef uint64_t HookId;
 
struct EditorUIHooks
{
    // ===== Menu Extensions =====
 
    void (*AddMenuItem)(
        HookId hookId,
        const char* menuPath,
        const char* itemPath,
        MenuCallback callback,
        void* userData,
        const char* shortcut
    );
 
    void (*AddMenuSeparator)(HookId hookId, const char* menuPath);
 
    void (*RemoveMenuItem)(HookId hookId, const char* menuPath, const char* itemPath);
 
    // ===== Custom Windows =====
 
    void (*RegisterWindow)(
        HookId hookId,
        const char* windowName,
        const char* windowId,
        WindowDrawCallback drawFunc,
        void* userData
    );
 
    void (*UnregisterWindow)(HookId hookId, const char* windowId);
 
    void (*OpenWindow)(const char* windowId);
 
    void (*CloseWindow)(const char* windowId);
 
    bool (*IsWindowOpen)(const char* windowId);
 
    // ===== Inspector Extensions =====
 
    void (*RegisterInspector)(
        HookId hookId,
        const char* nodeTypeName,
        InspectorDrawCallback drawFunc,
        void* userData
    );
 
    void (*UnregisterInspector)(HookId hookId, const char* nodeTypeName);
 
    // ===== Context Menu Extensions =====
 
    void (*AddNodeContextItem)(
        HookId hookId,
        const char* itemPath,
        MenuCallback callback,
        void* userData
    );
 
    void (*AddAssetContextItem)(
        HookId hookId,
        const char* itemPath,
        const char* assetTypeFilter,
        MenuCallback callback,
        void* userData
    );
 
    // ===== Top-Level Menus =====
 
    void (*AddTopLevelMenuItem)(HookId hookId, const char* menuName,
                                TopLevelMenuDrawCallback drawFunc, void* userData);
 
    void (*RemoveTopLevelMenuItem)(HookId hookId, const char* menuName);
 
    // ===== Toolbar =====
 
    void (*AddToolbarItem)(HookId hookId, const char* itemName,
                           ToolbarDrawCallback drawFunc, void* userData);
 
    void (*RemoveToolbarItem)(HookId hookId, const char* itemName);
 
    // ===== Project Lifecycle Events =====
 
    void (*RegisterOnProjectOpen)(HookId hookId, StringEventCallback cb, void* userData);
 
    void (*RegisterOnProjectClose)(HookId hookId, StringEventCallback cb, void* userData);
 
    void (*RegisterOnProjectSave)(HookId hookId, StringEventCallback cb, void* userData);
 
    // ===== Scene Lifecycle Events =====
 
    void (*RegisterOnSceneOpen)(HookId hookId, StringEventCallback cb, void* userData);
 
    void (*RegisterOnSceneClose)(HookId hookId, StringEventCallback cb, void* userData);
 
    // ===== Packaging/Build Events =====
 
    void (*RegisterOnPackageStarted)(HookId hookId, PlatformEventCallback cb, void* userData);
 
    void (*RegisterOnPackageFinished)(HookId hookId, PackageFinishedCallback cb, void* userData);
 
    // ===== Editor State Events =====
 
    void (*RegisterOnSelectionChanged)(HookId hookId, EventCallback cb, void* userData);
 
    void (*RegisterOnPlayModeChanged)(HookId hookId, PlayModeCallback cb, void* userData);
 
    void (*RegisterOnEditorShutdown)(HookId hookId, EventCallback cb, void* userData);
 
    // ===== Asset Pipeline Events =====
 
    void (*RegisterOnAssetImported)(HookId hookId, StringEventCallback cb, void* userData);
 
    void (*RegisterOnAssetDeleted)(HookId hookId, StringEventCallback cb, void* userData);
 
    void (*RegisterOnAssetSaved)(HookId hookId, StringEventCallback cb, void* userData);
 
    // ===== Asset Open Events =====
 
    void (*RegisterOnAssetOpen)(HookId hookId, StringEventCallback cb, void* userData);
 
    void (*RegisterOnAssetOpened)(HookId hookId, StringEventCallback cb, void* userData);
 
    // ===== Undo/Redo =====
 
    void (*RegisterOnUndoRedo)(HookId hookId, EventCallback cb, void* userData);
 
    // ===== Drag-and-Drop Events =====
 
    void (*RegisterOnAssetDropHierarchy)(HookId hookId, StringEventCallback cb, void* userData);
 
    void (*RegisterOnAssetDropViewport)(HookId hookId, StringEventCallback cb, void* userData);
 
    // ===== Batch 1: Menu Positioning & Top-Level Menu Control =====
 
    void (*AddTopLevelMenuItemEx)(
        HookId hookId,
        const char* menuName,
        TopLevelMenuDrawCallback drawFunc,
        void* userData,
        int32_t position
    );
 
    void (*AddMenuItemEx)(
        HookId hookId,
        const char* menuPath,
        const char* itemPath,
        MenuCallback callback,
        void* userData,
        const char* shortcut,
        MenuValidationCallback validateFunc
    );
 
    // ===== Batch 2: Create/Spawn Menu Extensions =====
 
    void (*AddNodeMenuItems)(HookId hookId, const char* category, MenuSectionDrawCallback drawFunc, void* userData);
 
    void (*RemoveNodeMenuItems)(HookId hookId, const char* category);
 
    void (*AddCreateAssetItems)(HookId hookId, MenuSectionDrawCallback drawFunc, void* userData);
 
    void (*RemoveCreateAssetItems)(HookId hookId);
 
    void (*AddSpawnBasic3dItems)(HookId hookId, MenuSectionDrawCallback drawFunc, void* userData);
 
    void (*AddSpawnBasicWidgetItems)(HookId hookId, MenuSectionDrawCallback drawFunc, void* userData);
 
    // ===== Scene Type Registration =====
 
    void (*RegisterSceneType)(HookId hookId, const char* typeName, SceneCreationCallback createFunc, void* userData);
 
    void (*UnregisterSceneType)(HookId hookId, const char* typeName);
 
    // ===== Batch 3: Viewport Context Menu & Overlay Drawing =====
 
    void (*AddViewportContextItem)(HookId hookId, const char* itemPath, MenuCallback callback, void* userData);
 
    void (*RemoveViewportContextItem)(HookId hookId, const char* itemPath);
 
    void (*RegisterViewportOverlay)(HookId hookId, const char* overlayName, ViewportOverlayCallback drawFunc, void* userData);
 
    void (*UnregisterViewportOverlay)(HookId hookId, const char* overlayName);
 
    // ===== Batch 4: Custom Preferences/Settings Pages =====
 
    void (*RegisterPreferencesPanel)(
        HookId hookId,
        const char* panelName,
        const char* panelCategory,
        PreferencesPanelDrawCallback drawFunc,
        PreferencesLoadCallback loadFunc,
        PreferencesSaveCallback saveFunc,
        void* userData
    );
 
    void (*UnregisterPreferencesPanel)(HookId hookId, const char* panelName);
 
    // ===== Batch 5: Custom Keyboard Shortcuts =====
 
    void (*RegisterShortcut)(
        HookId hookId,
        const char* shortcutId,
        const char* displayName,
        const char* defaultBinding,
        ShortcutCallback callback,
        void* userData
    );
 
    void (*UnregisterShortcut)(HookId hookId, const char* shortcutId);
 
    // ===== Batch 6: Property Drawer System =====
 
    void (*RegisterPropertyDrawer)(HookId hookId, const char* propertyTypeName, PropertyDrawCallback drawFunc, void* userData);
 
    void (*UnregisterPropertyDrawer)(HookId hookId, const char* propertyTypeName);
 
    // ===== Batch 7: Hierarchy & Asset Browser Extensions =====
 
    void (*RegisterHierarchyItemGUI)(HookId hookId, HierarchyItemGUICallback drawFunc, void* userData);
 
    void (*UnregisterHierarchyItemGUI)(HookId hookId);
 
    void (*RegisterAssetItemGUI)(HookId hookId, AssetItemGUICallback drawFunc, void* userData);
 
    void (*UnregisterAssetItemGUI)(HookId hookId);
 
    void (*RegisterOnHierarchyChanged)(HookId hookId, HierarchyChangedCallback cb, void* userData);
 
    // ===== Batch 8: Additional Context Menus =====
 
    void (*AddSceneTabContextItem)(HookId hookId, const char* itemPath, MenuCallback callback, void* userData);
 
    void (*AddDebugLogContextItem)(HookId hookId, const char* itemPath, MenuCallback callback, void* userData);
 
    void (*AddImportMenuItem)(HookId hookId, const char* itemPath, MenuCallback callback, void* userData);
 
    void (*AddAddonsMenuItem)(HookId hookId, const char* itemPath, MenuCallback callback, void* userData);
 
    void (*AddPlayTarget)(HookId hookId, const char* targetName, const char* iconText, PlayTargetCallback callback, void* userData);
 
    void (*RemovePlayTarget)(HookId hookId, const char* targetName);
 
    // ===== Batch 9: Drag-Drop Enhancement & Asset Pipeline =====
 
    void (*RegisterDragDropHandler)(HookId hookId, const char* targetArea, DragDropHandlerCallback handler, void* userData);
 
    void (*RegisterAssetImporter)(HookId hookId, const char* extension, AssetImportCallback importFunc, void* userData);
 
    void (*UnregisterAssetImporter)(HookId hookId, const char* extension);
 
    void (*RegisterOnPreAssetImport)(HookId hookId, PreImportCallback cb, void* userData);
 
    void (*RegisterOnPostAssetImport)(HookId hookId, StringEventCallback cb, void* userData);
 
    // ===== Batch 10: Build Pipeline & Editor State =====
 
    void (*RegisterOnPreBuild)(HookId hookId, PreBuildCallback cb, void* userData);
 
    void (*RegisterOnPostBuild)(HookId hookId, PackageFinishedCallback cb, void* userData);
 
    void (*RegisterOnEditorModeChanged)(HookId hookId, EditorModeCallback cb, void* userData);
 
    void (*RegisterGizmoTool)(
        HookId hookId,
        const char* toolName,
        const char* iconText,
        const char* tooltip,
        GizmoToolDrawCallback drawFunc,
        void* userData
    );
 
    void (*UnregisterGizmoTool)(HookId hookId, const char* toolName);
 
    // ===== Game Preview Resolution Presets =====
 
    void (*AddGamePreviewResolution)(HookId hookId, const char* name, uint32_t width, uint32_t height);
 
    void (*RemoveGamePreviewResolution)(HookId hookId, const char* name);
 
    // ===== Controller Server Extension =====
 
    void (*RegisterControllerRoute)(HookId hookId, const char* method, const char* path, ControllerRouteCallback callback, void* userData);
 
    void (*UnregisterControllerRoute)(HookId hookId, const char* path);
 
    void (*RegisterOnControllerServerStateChanged)(HookId hookId, ControllerServerEventCallback callback, void* userData);
 
    // ===== Profiling Window Extension =====
 
    void (*RegisterProfilingStat)(HookId hookId, const char* statName, const char* category, float maxValue, bool showAsBar);
 
    void (*UnregisterProfilingStat)(HookId hookId, const char* statName);
 
    void (*SetProfilingStatValue)(const char* statName, float value);
 
    typedef void (*ProfilingSectionDrawCallback)(void* userData);
 
    void (*RegisterProfilingSection)(HookId hookId, const char* sectionName, void (*drawFunc)(void*), void* userData);
 
    void (*UnregisterProfilingSection)(HookId hookId, const char* sectionName);
 
    // ===== Cleanup =====
 
    void (*RemoveAllHooks)(HookId hookId);
};
 
HookId GenerateHookId(const char* identifier);
 
#endif // EDITOR