gui: add Nelarius/imnodes for Dear ImGui

LICENSE

@@ -21,3 +21,29 @@ SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.
+
+-
+
+imnodes.cpp, imnodes.hpp
+
+MIT License
+
+Copyright (c) 2019 Johann Muszynski
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

app/gui/CMakeLists.txt

@@ -2,6 +2,7 @@ cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
 project(irritator-gui VERSION 0.1.0 LANGUAGES CXX)
 
 set(gui_sources
+    imnodes.cpp imnodes.hpp
     ${PROJECT_SOURCE_DIR}/../../external/imgui/imgui.cpp
     ${PROJECT_SOURCE_DIR}/../../external/imgui/imgui.h
     ${PROJECT_SOURCE_DIR}/../../external/imgui/imgui_demo.cpp

app/gui/imnodes.hpp

+/*
+ * MIT License
+ *
+ * Copyright (c) 2019 Johann Muszynski
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef NELARIUS_IMNODES_IMGUI_IMNODES_H
+#define NELARIUS_IMNODES_IMGUI_IMNODES_H
+
+#include <stddef.h>
+
+struct ImVec2;
+
+namespace imnodes
+{
+enum ColorStyle
+{
+    ColorStyle_NodeBackground = 0,
+    ColorStyle_NodeBackgroundHovered,
+    ColorStyle_NodeBackgroundSelected,
+    ColorStyle_NodeOutline,
+    ColorStyle_TitleBar,
+    ColorStyle_TitleBarHovered,
+    ColorStyle_TitleBarSelected,
+    ColorStyle_Link,
+    ColorStyle_LinkHovered,
+    ColorStyle_LinkSelected,
+    ColorStyle_Pin,
+    ColorStyle_PinHovered,
+    ColorStyle_BoxSelector,
+    ColorStyle_BoxSelectorOutline,
+    ColorStyle_GridBackground,
+    ColorStyle_GridLine,
+    ColorStyle_Count
+};
+
+enum StyleVar
+{
+    StyleVar_GridSpacing = 0,
+    StyleVar_NodeCornerRounding,
+    StyleVar_NodePaddingHorizontal,
+    StyleVar_NodePaddingVertical
+};
+
+enum StyleFlags
+{
+    StyleFlags_None = 0,
+    StyleFlags_NodeOutline = 1 << 0,
+    StyleFlags_GridLines = 1 << 2
+};
+
+enum PinShape
+{
+    PinShape_Circle = 0,
+    PinShape_CircleFilled,
+    PinShape_Triangle,
+    PinShape_TriangleFilled,
+    PinShape_Quad,
+    PinShape_QuadFilled
+};
+
+struct Style
+{
+    float grid_spacing;
+
+    float node_corner_rounding;
+    float node_padding_horizontal;
+    float node_padding_vertical;
+
+    float link_thickness;
+    float link_line_segments_per_length;
+    float link_hover_distance;
+
+    // The following variables control the look and behavior of the pins. The
+    // default size of each pin shape is balanced to occupy approximately the
+    // same surface area on the screen.
+
+    // The circle radius used when the pin shape is either PinShape_Circle or
+    // PinShape_CircleFilled.
+    float pin_circle_radius;
+    // The quad side length used when the shape is either PinShape_Quad or
+    // PinShape_QuadFilled.
+    float pin_quad_side_length;
+    // The equilateral triangle side length used when the pin shape is either
+    // PinShape_Triangle or PinShape_TriangleFilled.
+    float pin_triangle_side_length;
+    // The thickness of the line used when the pin shape is not filled.
+    float pin_line_thickness;
+    // The radius from the pin's center position inside of which it is detected
+    // as being hovered over.
+    float pin_hover_radius;
+    // Offsets the pins' positions from the edge of the node to the outside of
+    // the node.
+    float pin_offset;
+
+    // By default, StyleFlags_NodeOutline and StyleFlags_Gridlines are enabled.
+    StyleFlags flags;
+    // Set these mid-frame using Push/PopColorStyle. You can index this color
+    // array with with a ColorStyle enum value.
+    unsigned int colors[ColorStyle_Count];
+
+    Style();
+};
+
+// An editor context corresponds to a set of nodes in a single workspace
+// (created with a single Begin/EndNodeEditor pair)
+//
+// By default, the library creates an editor context behind the scenes, so
+// using any of the imnodes functions doesn't require you to explicitly create a
+// context.
+struct EditorContext;
+
+EditorContext* EditorContextCreate();
+void EditorContextFree(EditorContext*);
+void EditorContextSet(EditorContext*);
+ImVec2 EditorContextGetPanning();
+void EditorContextResetPanning(const ImVec2& pos);
+void EditorContextMoveToNode(const int node_id);
+
+// Initialize the node editor system.
+void Initialize();
+void Shutdown();
+
+// Returns the global style struct. See the struct declaration for default
+// values.
+Style& GetStyle();
+// Style presets matching the dear imgui styles of the same name.
+void StyleColorsDark(); // on by default
+void StyleColorsClassic();
+void StyleColorsLight();
+
+// The top-level function call. Call this before calling BeginNode/EndNode.
+// Calling this function will result the node editor grid workspace being
+// rendered.
+void BeginNodeEditor();
+void EndNodeEditor();
+
+// Use PushColorStyle and PopColorStyle to modify Style::colors mid-frame.
+void PushColorStyle(ColorStyle item, unsigned int color);
+void PopColorStyle();
+void PushStyleVar(StyleVar style_item, float value);
+void PopStyleVar();
+
+void BeginNode(int id);
+void EndNode();
+
+// Place your node title bar content (such as the node title, using ImGui::Text)
+// between the following function calls. These functions have to be called
+// before adding any attributes, or the layout of the node will be incorrect.
+void BeginNodeTitleBar();
+void EndNodeTitleBar();
+
+// Attributes are ImGui UI elements embedded within the node. Attributes have
+// circular pins rendered next to them. Links are created between pins.
+//
+// Input and output attributes are otherwise the same, except that pins are
+// rendered on the left of the node for input attributes, and on the right side
+// for output attributes.
+//
+// The attribute ids must be unique.
+void BeginInputAttribute(int id, PinShape shape = PinShape_CircleFilled);
+void BeginOutputAttribute(int id, PinShape shape = PinShape_CircleFilled);
+void EndAttribute();
+
+// Render a link between attributes.
+// The attributes ids used here must match the ids used in
+// Begin(Input|Output)Attribute function calls. The order of start_attr and
+// end_attr doesn't make a difference for rendering the link.
+void Link(int id, int start_attribute_id, int end_attribute_id);
+
+// Set's the node's position corresponding to the node id, either using screen
+// space coordinates, or node editor grid coordinates. You can even set the
+// position before the node has been created with BeginNode().
+
+void SetNodeScreenSpacePos(int node_id, const ImVec2& screen_space_pos);
+void SetNodeGridSpacePos(int node_id, const ImVec2& grid_pos);
+// Enable or disable the ability to click and drag a specific node.
+void SetNodeDraggable(int node_id, const bool draggable);
+
+// The following functions return true if a UI element is being hovered over by
+// the mouse cursor. Assigns the id of the UI element being hovered over to the
+// function argument. Use these functions after EndNodeEditor() has been called.
+bool IsNodeHovered(int* node_id);
+bool IsLinkHovered(int* link_id);
+bool IsPinHovered(int* attribute_id);
+
+// Use The following two functions to query the number of selected nodes or
+// links in the current editor. Use after calling EndNodeEditor().
+int NumSelectedNodes();
+int NumSelectedLinks();
+// Get the selected node/link ids. The pointer argument should point to an
+// integer array with at least as many elements as the respective
+// NumSelectedNodes/NumSelectedLinks function call returned.
+void GetSelectedNodes(int* node_ids);
+void GetSelectedLinks(int* link_ids);
+
+// Was the previous attribute active? This will continuously return true while
+// the left mouse button is being pressed over the UI content of the attribute.
+bool IsAttributeActive();
+// Was any attribute active? If so, sets the active attribute id to the output
+// function argument.
+bool IsAnyAttributeActive(int* attribute_id = 0);
+
+// The following functions should be used after calling EndNodeEditor().
+//
+// Is the user dragging a new link?
+bool IsLinkStarted(int* started_at_attribute_id);
+// Did the user drop the new link before connecting it to a second attribute?
+bool IsLinkDropped();
+// Did the user create a new link?
+bool IsLinkCreated(int* started_at_attribute_id, int* ended_at_attribute_id);
+
+// Use the following functions to write the editor context's state to a string,
+// or directly to a file. The editor context is serialized in the INI file
+// format.
+
+const char* SaveCurrentEditorStateToIniString(size_t* data_size = NULL);
+const char* SaveEditorStateToIniString(
+    const EditorContext* editor,
+    size_t* data_size = NULL);
+
+void LoadCurrentEditorStateFromIniString(const char* data, size_t data_size);
+void LoadEditorStateFromIniString(
+    EditorContext* editor,
+    const char* data,
+    size_t data_size);
+
+void SaveCurrentEditorStateToIniFile(const char* file_name);
+void SaveEditorStateToIniFile(
+    const EditorContext* editor,
+    const char* file_name);
+
+void LoadCurrentEditorStateFromIniFile(const char* file_name);
+void LoadEditorStateFromIniFile(EditorContext* editor, const char* file_name);
+} // namespace imnodes
+
+#endif
\ No newline at end of file

app/gui/main-unix.cpp

@@ -3,6 +3,7 @@
 // http://www.boost.org/LICENSE_1_0.txt)
 
 #include "imgui.h"
+#include "imnodes.hpp"
 #include "imgui_impl_glfw.h"
 #include "imgui_impl_opengl3.h"
 
@@ -116,6 +117,7 @@ main(int argc, char* argv[])
     // Setup Platform/Renderer bindings
     ImGui_ImplGlfw_InitForOpenGL(window, true);
     ImGui_ImplOpenGL3_Init(glsl_version);
+    imnodes::Initialize();
 
     // Load Fonts
     // - If no fonts are loaded, dear imgui will use the default font. You can
@@ -238,6 +240,9 @@ main(int argc, char* argv[])
     }
 
     // Cleanup
+
+    imnodes::Shutdown();
+
     ImGui_ImplOpenGL3_Shutdown();
     ImGui_ImplGlfw_Shutdown();
     ImGui::DestroyContext();

app/gui/main-windows.cpp

@@ -7,6 +7,7 @@
 // FIXME: 64-bit only for now! (Because sizeof(ImTextureId) == sizeof(void*))
 
 #include "imgui.h"
+#include "imnodes.hpp"
 #include "imgui_impl_win32.h"
 #include "imgui_impl_dx12.h"
 #include <d3d12.h>
@@ -93,6 +94,8 @@ int main(int, char**)
         g_pd3dSrvDescHeap->GetCPUDescriptorHandleForHeapStart(),
         g_pd3dSrvDescHeap->GetGPUDescriptorHandleForHeapStart());
 
+    imnodes::Initialize();
+
     // Load Fonts
     // - If no fonts are loaded, dear imgui will use the default font. You can also load multiple fonts and use ImGui::PushFont()/PopFont() to select them.
     // - AddFontFromFileTTF() will return the ImFont* so you can store it if you need to select the font among multiple.
@@ -208,6 +211,8 @@ int main(int, char**)
         frameCtxt->FenceValue = fenceValue;
     }
 
+    imnodes::Shutdown();
+
     WaitForLastSubmittedFrame();
     ImGui_ImplDX12_Shutdown();
     ImGui_ImplWin32_Shutdown();