- Added createInputPort to [Node] attribute. This allows to hide the …

…input port for a node. [#6](#6)

- Added comments to ContextMenu, EdgeDropMenu so it is easier to understand & extend

Attributes/NodeAttribute.cs

@@ -8,6 +8,11 @@ namespace NewGraph {
     /// </summary>
     [AttributeUsage(AttributeTargets.Class)]
     public class NodeAttribute : Attribute {
+        /// <summary>
+        /// Should an input port be created?
+        /// </summary>
+        public bool createInputPort = true;
+
         /// <summary>
         /// Color of the node as a hex string, like #FFFFFFFF. Be aware: The last two characters are for alpha values!
         /// </summary>
@@ -42,7 +47,8 @@ public class NodeAttribute : Attribute {
         /// <param name="inputPortName">A custom name for the input port.</param>
         /// <param name="inputPortCapacity">The maximum amount of allowed connections to the input port of this node.</param>
         /// <param name="nodeName">A custom name for the node.</param>
-        public NodeAttribute(string color = null, string categories = "", string inputPortName = null, Capacity inputPortCapacity = Capacity.Multiple, string nodeName = null) {
+        /// <param name="createInputPort">The maximum amount of allowed connections to the input port of this node.</param>
+        public NodeAttribute(string color = null, string categories = "", string inputPortName = null, Capacity inputPortCapacity = Capacity.Multiple, string nodeName = null, bool createInputPort = true) {
             if (color != null) {
                 ColorUtility.TryParseHtmlString(color, out this.color);
             }
@@ -52,6 +58,7 @@ public NodeAttribute(string color = null, string categories = "", string inputPo
             this.inputPortName = inputPortName;
             this.inputPortCapacity = inputPortCapacity;
             this.categories = categories;
+            this.createInputPort = createInputPort;
         }
 
 

CHANGELOG.md

@@ -169,4 +169,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.2.8] - 2023-03-15
 ### Fixed
-- Fixed possible ArgumentException caused by the new ContextMenu architecture
+- Fixed possible ArgumentException caused by the new ContextMenu architecture
+
+## [0.2.9] - 2023-03-16
+### Added
+- Added createInputPort to [Node] attribute. This allows to hide the input port for a node. [#6](https://github.com/Gentlymad-Studios/NewGraph/issues/6)
+- Added comments to ContextMenu, EdgeDropMenu so it is easier to understand & extend

Editor/Attributes/CustomContextMenuAttribute.cs

@@ -1,6 +1,9 @@
 using System;
 
 namespace NewGraph {
+    /// <summary>
+    /// Attribute that can be attached to a class that inherits from ContextMenu to change & customize the main context menu.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class,  AllowMultiple = false)]
     public class CustomContextMenuAttribute : Attribute {
 

Editor/Attributes/CustomEdgeDropMenuAttribute.cs

@@ -1,6 +1,9 @@
 using System;
 
 namespace NewGraph {
+    /// <summary>
+    /// Attribute that can be attached to a class that inherits from EdgeDropMenu to change & customize the edge drop context menu.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
     public class CustomEdgeDropMenuAttribute : Attribute {
 

Editor/Controllers/NodeController.cs

@@ -102,7 +102,9 @@ public void DoForEachPortListProperty(Action<PortInfo, SerializedProperty> actio
         }
 
         public void DoForInputPortProperty(Action<PortInfo, SerializedProperty> action) {
-            action(propertyBag.inputPort, nodeDataProperty);
+            if (propertyBag.inputPort != null) {
+                action(propertyBag.inputPort, nodeDataProperty);
+            }
         }
 
         public void DoForNameProperty(Action<SerializedProperty> action) {

Editor/Serialization/PropertyBag.cs

@@ -34,7 +34,9 @@ public class PropertyBag {
         private PropertyBag(NodeAttribute nodeAttribute, Type nodeType, SerializedProperty nodeProperty) {
             this.nodeType = nodeType;
 
-            inputPort = new PortInfo(nodeProperty.propertyPath, nodeType, new PortBaseAttribute(nodeAttribute.inputPortName, nodeAttribute.inputPortCapacity, PortDirection.Input), Settings.defaultInputName);
+            if (nodeAttribute.createInputPort) {
+                inputPort = new PortInfo(nodeProperty.propertyPath, nodeType, new PortBaseAttribute(nodeAttribute.inputPortName, nodeAttribute.inputPortCapacity, PortDirection.Input), Settings.defaultInputName);
+            }
             InitializeAttributebehaviors();
             RetrieveAll(nodeProperty);
         }

Editor/Views/ContextMenu.cs

@@ -6,55 +6,100 @@
 using static NewGraph.GraphSettingsSingleton;
 
 namespace NewGraph {
+    /// <summary>
+    /// Main ContextMenu that is being used when performing a right-click in the graph view.
+    /// This can be inherited by a custom class that has the [CustomContextMenu] attribute.
+    /// Beware: This class inherits from GraphSearchWindowProvider and therefore is a ScriptableObject by nature.
+    /// </summary>
     public class ContextMenu : GraphSearchWindowProvider {
+        /// <summary>
+        /// static lookup table that gathers unique labels for node types.
+        /// </summary>
         protected static Dictionary<Type, string> nodeTypeToCreationLabel = new Dictionary<Type, string>();
+        /// <summary>
+        /// the graph controller this context menu operates on.
+        /// </summary>
         protected GraphController graphController;
 
+        /// <summary>
+        /// Initialize should be called after the object is created via CreateInstance
+        /// </summary>
+        /// <param name="graphController">The graph controller this context menu should operate on.</param>
         public void Initialize(GraphController graphController) {
             this.graphController = graphController;
             Initialize(this.graphController.graphView.shortcutHandler);
         }
 
+        /// <summary>
+        /// Instantiate a custom or default context menu
+        /// </summary>
+        /// <param name="graphController">The graph controller this context menu should operate on.</param>
+        /// <returns>The instance of the newly created context menu.</returns>
         public static ContextMenu CreateContextMenu(GraphController graphController) {
+            // get all types that have the [CustomContextMenu] attribute
             TypeCache.TypeCollection types = TypeCache.GetTypesWithAttribute<CustomContextMenuAttribute>();
             ContextMenu menu;
 
             foreach (Type type in types) {
+                // is the detected type actually inheriting from ContextMenu?
                 if (type.ImplementsOrInherits(typeof(ContextMenu))) {
+                    // create an instance of the custom ContextMenu type!
                     menu = CreateInstance(type) as ContextMenu;
                     menu.Initialize(graphController);
                     return menu;
                 }
             }
 
+            // no custom editor found or ineligible
             menu = CreateInstance<ContextMenu>();
             menu.Initialize(graphController);
             return menu;
         }
 
-        public virtual bool DefaultEnableCheck() {
+        /// <summary>
+        /// Default check wether a menu entry should be enabled.
+        /// </summary>
+        /// <returns>Should the menu entry be enabled?</returns>
+        public virtual bool DefaultEnabledCheck() {
             return graphController.graphView.GetSelectedNodeCount() > 0;
         }
 
+        /// <summary>
+        /// Default check for node entries and wether they should be enabled.
+        /// </summary>
+        /// <returns>Should the node entry be enabled?</returns>
         public virtual bool DefaultNodeEnabledCheck() {
             return graphController.graphData != null;
         }
 
+        /// <summary>
+        /// Header label
+        /// </summary>
+        /// <returns></returns>
         protected virtual string GetHeader() {
             return Settings.searchWindowRootHeader;
         }
 
+        /// <summary>
+        /// Creates/builds the context menu
+        /// </summary>
         public virtual void BuildContextMenu() {
             StartAddingMenuEntries(GetHeader());
             AddNodeEntries();
             ResolveNodeEntries(DefaultNodeEnabledCheck);
             AddCommands();
         }
 
+        /// <summary>
+        /// Add all node entries.
+        /// </summary>
         protected virtual void AddNodeEntries() {
             AddNodeEntriesDefault();
         }
 
+        /// <summary>
+        /// Default implementation to create all node entries.
+        /// </summary>
         protected void AddNodeEntriesDefault() {
             // get all types across all assemblies that implement our INode interface
             TypeCache.TypeCollection nodeTypes = TypeCache.GetTypesWithAttribute<NodeAttribute>();
@@ -89,19 +134,25 @@ protected void AddNodeEntriesDefault() {
             }
         }
 
+        /// <summary>
+        /// Add all command panel entries
+        /// </summary>
         protected virtual void AddCommands() {
             AddDefaultCommands();
         }
 
+        /// <summary>
+        /// defualt implementation of all commands
+        /// </summary>
         protected void AddDefaultCommands() {
             AddSeparator(Settings.searchWindowCommandHeader);
             AddShortcutEntry(Actions.Frame, SearchTreeEntry.AlwaysEnabled, graphController.FrameGraph);
             AddShortcutEntry(Actions.Rename, () => graphController.graphView.GetSelectedNodeCount() == 1, graphController.OnRename);
-            AddShortcutEntry(Actions.Cut, DefaultEnableCheck, graphController.OnCut);
-            AddShortcutEntry(Actions.Copy, DefaultEnableCheck, graphController.OnCopy);
+            AddShortcutEntry(Actions.Cut, DefaultEnabledCheck, graphController.OnCut);
+            AddShortcutEntry(Actions.Copy, DefaultEnabledCheck, graphController.OnCopy);
             AddShortcutEntry(Actions.Paste, () => graphController.copyPasteHandler.HasNodes(), graphController.OnPaste);
-            AddShortcutEntry(Actions.Duplicate, DefaultEnableCheck, graphController.OnDuplicate);
-            AddShortcutEntry(Actions.Delete, () => graphController.graphView.HasSelectedEdges() || DefaultEnableCheck(), graphController.OnDelete);
+            AddShortcutEntry(Actions.Duplicate, DefaultEnabledCheck, graphController.OnDuplicate);
+            AddShortcutEntry(Actions.Delete, () => graphController.graphView.HasSelectedEdges() || DefaultEnabledCheck(), graphController.OnDelete);
         }
     }
 

Editor/Views/EdgeDropMenu.cs

@@ -3,48 +3,80 @@
 using UnityEditor;
 
 namespace NewGraph {
+    /// <summary>
+    /// The EdgeDropMenu is being used after dropping an edge into empty space in the graph.
+    /// This can be inherited by a custom class that has the [CustomEdgeDropMenu] attribute.
+    /// Beware: This class inherits from GraphSearchWindowProvider and therefore is a ScriptableObject by nature.
+    /// </summary>
     public class EdgeDropMenu : ContextMenu {
-
+        /// <summary>
+        /// the port this menu should operate on. This is required to be updated fromt he outside.
+        /// </summary>
         public PortView port;
-
+
+        /// <summary>
+        /// Instantiate a custom or default edge drop menu
+        /// </summary>
+        /// <param name="graphController">The graph controller this edge drop menu should operate on.</param>
+        /// <returns>The instance of the newly created edge drop menu.</returns>
         public static EdgeDropMenu CreateEdgeDropMenu(GraphController graphController) {
+            // get all types that have the [CustomEgeDropMenu] attribute
             TypeCache.TypeCollection types = TypeCache.GetTypesWithAttribute<CustomEdgeDropMenuAttribute>();
             EdgeDropMenu menu;
 
             foreach (Type type in types) {
+                // is the detected type actually inheriting from ContextMenu?
                 if (type.ImplementsOrInherits(typeof(EdgeDropMenu))) {
+                    // create an instance of the custom ContextMenu type!
                     menu = CreateInstance(type) as EdgeDropMenu;
                     menu.Initialize(graphController);
                     return menu;
                 }
             }
 
+            // no custom editor found or ineligible
             menu = CreateInstance<EdgeDropMenu>();
             menu.Initialize(graphController);
             return menu;
         }
 
+        /// <summary>
+        /// Add all node entries.
+        /// </summary>
         protected override void AddNodeEntries() {
             PortView currentPort = port;
             foreach (Type type in currentPort.connectableTypes) {
                 if (nodeTypeToCreationLabel.ContainsKey(type)) {
                     void CreateNodeAndConnect() {
                         NodeView nodeView = graphController.CreateNewNode(type, false);
-                        graphController.ConnectPorts(currentPort, nodeView.inputPort);
+                        if (nodeView.inputPort != null) {
+                            graphController.ConnectPorts(currentPort, nodeView.inputPort);
+                        }
                     }
                     AddNodeEntry(nodeTypeToCreationLabel[type], (obj) => CreateNodeAndConnect());
                 }
             }
         }
 
+        /// <summary>
+        /// The edge drop menu node entries should always be enabled.
+        /// </summary>
+        /// <returns></returns>
         public override bool DefaultNodeEnabledCheck() {
             return true;
         }
 
-        public override bool DefaultEnableCheck() {
+        /// <summary>
+        /// The edge drop menu entries should always be enabled.
+        /// </summary>
+        /// <returns></returns>
+        public override bool DefaultEnabledCheck() {
             return true;
         }
 
+        /// <summary>
+        /// At least on default, the edge drop menu does not have a command panel.
+        /// </summary>
         protected override void AddCommands() {}
     }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.gentlymad.newgraph",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "displayName": "NewGraph",
   "description": "A general data oriented node graph solution. This is build upon the idea to visualize complex data structures as graph networks without having to modify already established data classes, except adding [Node], [Port] and [SerializeReference] attributes to call classes that should show in the Graph View.",
   "unity": "2022.2",