Add floating popup to pins when hovered (#1565)

Added a tooltip/popup showing the name, type, value and connection of a pin!
AcademySoftwareFoundation · Oct 16, 2023 · a5780ea · a5780ea
1 parent a62a468
commit a5780ea
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 1 deletion.
diff --git a/source/MaterialXGraphEditor/Graph.cpp b/source/MaterialXGraphEditor/Graph.cpp
@@ -2257,6 +2257,7 @@ std::vector<int> Graph::createNodes(bool nodegraph)
                             }
 
                             upUiNode->outputPins[pinIndex]->addConnection(pin);
+                            pin->addConnection(upUiNode->outputPins[pinIndex]);
                         }
                         pin->setConnected(true);
                     }
@@ -2322,6 +2323,7 @@ std::vector<int> Graph::createNodes(bool nodegraph)
                                 }
                             }
                             upUiNode->outputPins[pinIndex]->addConnection(pin);
+                            pin->addConnection(upUiNode->outputPins[pinIndex]);
                         }
                         pin->setConnected(true);
                     }
@@ -2392,6 +2394,7 @@ std::vector<int> Graph::createNodes(bool nodegraph)
                                 }
                             }
                             upUiNode->outputPins[pinIndex]->addConnection(pin);
+                            pin->addConnection(upUiNode->outputPins[pinIndex]);
                         }
                     }
 
@@ -2628,6 +2631,11 @@ void Graph::addLink(ed::PinId startPinId, ed::PinId endPinId)
         _frameCount = ImGui::GetFrameCount();
         _renderer->setMaterialCompilation(true);
 
+        inputPin->addConnection(outputPin);
+        outputPin->addConnection(inputPin);
+        outputPin->setConnected(true);
+        inputPin->setConnected(true);
+
         if (uiDownNode->getNode() || uiDownNode->getNodeGraph())
         {
             mx::InputPtr connectingInput = nullptr;
@@ -2721,6 +2729,7 @@ void Graph::addLink(ed::PinId startPinId, ed::PinId endPinId)
                         }
                     }
 
+
                     pin->setConnected(true);
                     pin->_input->removeAttribute(mx::ValueElement::VALUE_ATTRIBUTE);
                     connectingInput = pin->_input;
@@ -2806,9 +2815,13 @@ void Graph::deleteLinkInfo(int startAttr, int endAttr)
                     setDefaults(_graphNodes[upNode]->getInput());
                 }
 
+                for (UiPinPtr connect : pin->_connections)
+                {
+                    pin->deleteConnection(connect);
+                }
+
                 // Remove any output reference
                 pin->_input->removeAttribute(mx::PortElement::OUTPUT_ATTRIBUTE);
-
                 pin->setConnected(false);
 
                 // If a value exists update the input with it
@@ -2833,6 +2846,10 @@ void Graph::deleteLinkInfo(int startAttr, int endAttr)
                     _graphNodes[downNode]->getNodeGraph()->getInput(pin->_name)->removeAttribute(mx::ValueElement::INTERFACE_NAME_ATTRIBUTE);
                     setDefaults(_graphNodes[upNode]->getInput());
                 }
+                for (UiPinPtr connect : pin->_connections)
+                {
+                    pin->deleteConnection(connect);
+                }
                 pin->_input->setConnectedNode(nullptr);
                 pin->setConnected(false);
                 setDefaults(pin->_input);
@@ -2847,6 +2864,10 @@ void Graph::deleteLinkInfo(int startAttr, int endAttr)
             {
                 removeEdge(downNode, upNode, pin);
                 _graphNodes[downNode]->getOutput()->removeAttribute("nodename");
+                for (UiPinPtr connect : pin->_connections)
+                {
+                    pin->deleteConnection(connect);
+                }
                 pin->setConnected(false);
             }
         }
@@ -3744,6 +3765,46 @@ void Graph::searchNodePopup(bool cursor)
     }
 }
 
+bool Graph::isPinHovered()
+{
+    ed::PinId currentPin = ed::GetHoveredPin();
+    ed::PinId nullPin = 0;
+    return currentPin != nullPin;
+}
+
+void Graph::addPinPopup()
+{
+    // Add a floating popup to pin when hovered
+    if (isPinHovered())
+    {
+        ed::Suspend();
+        UiPinPtr pin = getPin(ed::GetHoveredPin());
+        std::string connected = "";
+        std::string value = "";
+        if (pin->_connected)
+        {
+            connected = "\nConnected to";
+            int size = static_cast<int>(pin->getConnections().size());
+            for (int i = 0; i < size; i++)
+            {
+                UiPinPtr connectedPin = pin->getConnections()[i];
+                connected = connected + " " + connectedPin->_name;
+                if (i != size - 1)
+                {
+                    connected = connected + ",";
+                }
+            }
+        }
+        else if (pin->_input != nullptr)
+        {
+            value = "\nValue: " + pin->_input->getValueString();
+        }
+        const std::string message("Name: " + pin->_name + "\nType: " + pin->_type + value + connected);
+        ImGui::SetTooltip("%s", message.c_str());
+        ed::Resume();
+    }
+}
+
 void Graph::readOnlyPopup()
 {
     if (_popup)
@@ -3860,6 +3921,7 @@ void Graph::drawGraph(ImVec2 mousePos)
         ImGui::SetNextWindowSizeConstraints(ImVec2(250.0f, 300.0f), ImVec2(-1.0f, 500.0f));
         addNodePopup(TextCursor);
         searchNodePopup(TextCursor);
+        addPinPopup();
         readOnlyPopup();
         ImGui::PopStyleVar();
 

diff --git a/source/MaterialXGraphEditor/Graph.h b/source/MaterialXGraphEditor/Graph.h
@@ -213,6 +213,8 @@ class Graph
 
     void addNodePopup(bool cursor);
     void searchNodePopup(bool cursor);
+    bool isPinHovered();
+    void addPinPopup();
     bool readOnly();
     void readOnlyPopup();
 

diff --git a/source/MaterialXGraphEditor/UiNode.h b/source/MaterialXGraphEditor/UiNode.h
@@ -95,6 +95,29 @@ class UiPin
         _connections.push_back(pin);
     }
 
+    void deleteConnection(UiPinPtr pin)
+    {
+        for (size_t i = 0; i < _connections.size(); i++)
+        {
+            if (_connections[i]->_pinId == pin->_pinId)
+            {
+                _connections.erase(_connections.begin()+i);
+            }
+        }
+        for (size_t i = 0; i < pin->_connections.size(); i++)
+        {
+            if (pin->_connections[i]->_pinId == _pinId)
+            {
+                pin->_connections.erase(pin->_connections.begin() + i);
+            }
+        }
+        if (pin->_connections.size() == 0)
+        {
+            pin->setConnected(false);
+        }
+        return;
+    }
+
     const std::vector<UiPinPtr>& getConnections()
     {
         return _connections;