git mv Code\Sandbox\Editor Code/Editor

Signed-off-by: Esteban Papp <81431996+amznestebanpapp@users.noreply.github.com>
2021-06-29 12:41:59 -07:00
parent 9f0bbf3b74
commit e34e36cb35
1415 changed files with 0 additions and 0 deletions
@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) Contributors to the Open 3D Engine Project
+ * 
+ * SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ */
+
+
+// Description : To add plug-in to the Editor create a new DLL with class implementation derived from IPlugin
+
+
+#ifndef CRYINCLUDE_EDITOR_INCLUDE_IPLUGIN_H
+#define CRYINCLUDE_EDITOR_INCLUDE_IPLUGIN_H
+#pragma once
+
+#include <IEditor.h>
+
+// forbid plugins from loading across debug and release:
+
+#define SANDBOX_PLUGIN_SYSTEM_BASE_VERSION 1
+
+#if defined(_DEBUG)
+    #define SANDBOX_PLUGIN_SYSTEM_VERSION (100000 + SANDBOX_PLUGIN_SYSTEM_BASE_VERSION)
+#else
+    #define SANDBOX_PLUGIN_SYSTEM_VERSION SANDBOX_PLUGIN_SYSTEM_BASE_VERSION
+#endif
+
+// Interface for instantiating the plugin for the editor
+struct IPlugin
+{
+    enum EError
+    {
+        eError_None = 0,
+        eError_VersionMismatch = 1
+    };
+
+    virtual ~IPlugin() = default;
+    
+    // Releases plugin.
+    virtual void Release() = 0;
+    //! Show a modal about dialog / message box for the plugin
+    virtual void ShowAbout() = 0;
+    //! Return the GUID of the plugin
+    virtual const char* GetPluginGUID() = 0;
+    virtual DWORD GetPluginVersion() = 0;
+    //! Return the human readable name of the plugin
+    virtual const char* GetPluginName() = 0;
+    //! Asks if the plugin can exit now. This might involve asking the user if he wants to save
+    //! data. The plugin is only supposed to ask for unsaved data which is not serialize into
+    //! the editor project file. When data is modified which is saved into the project file, the
+    //! plugin should call IEditor::SetDataModified() to make the editor ask
+    virtual bool CanExitNow() = 0;
+    //! this method is called when there is an event triggered inside the editor
+    virtual void OnEditorNotify(EEditorNotifyEvent aEventId) = 0;
+};
+
+// Initialization structure
+struct PLUGIN_INIT_PARAM
+{
+    IEditor* pIEditorInterface;
+    int pluginVersion;
+    IPlugin::EError outErrorCode;
+};
+
+// Plugin Settings structure
+struct SPluginSettings
+{
+    // note: the pluginVersion in PLUGIN_INIT_PARAM denotes the version of the plugin manager
+    // whereas this denotes the version of the individual plugin.
+    // future: manage plugin versions.
+    int pluginVersion;
+    bool autoLoad;
+};
+
+// Factory API
+extern "C"
+{
+PLUGIN_API IPlugin* CreatePluginInstance(PLUGIN_INIT_PARAM* pInitParam);
+PLUGIN_API void QueryPluginSettings(SPluginSettings& settings);
+}
+#endif // CRYINCLUDE_EDITOR_INCLUDE_IPLUGIN_H