DYN-6633: Definedata hierarchy

doc/distrib/NodeHelpFiles/CoreNodeModels.DefineData.md

@@ -1,9 +1,23 @@
 ## In Depth
 
-Validates and returns data from a currently or previously connected input node.
+The Define Data node validates the data type of incoming data. It can be used to ensure local data is of the desired type and is also designed to be used as an input or output node, declaring the type of data a graph expects or provides. The node supports a selection of commonly used Dynamo data types, for example 'String', 'Point', or 'Boolean'. The full list of supported data types is available in the drop-down menu of the node.
+
+### Behavior
+The node validates the data coming in from the input port based on the setting of the drop-down menu and the **List** toggle (see below for details). If the validation is successful, the output of the node is the same as the input. If the validation is not successful, the node will enter a warning state with a null output.
+
+The node has four inputs:
+- The "**>**" input - Connect to an upstream node to validate the type of its data.
+- The **drop-down** menu - Shows the expected data type. When the form is unlocked, set a data type for validation. When the form is locked, the data type is chosen automatically based on incoming data. Data is valid if its type matches the shown type exactly or if its type is a child of the shown type (e.g. If the drop-down is set to "Curve", objects of type "Rectangle", "Line", etc. are valid).
+- The **List** toggle - When on, the node expects incoming data to be a single flat list containing items of a valid data type (see above). When off, the node expects a single item of a valid data type.
+- The **Lock** toggle - When off/unlocked, the drop-down menu and the **List** toggle controls accept user input to set the type of data expected. When on/locked, the node will validate* the incoming data, disable the controls, and set their value based on the data connected to the node's input port.
+
+### Use as an input node
+When set as an input ("Is Input" in the node's context menu) the node can optionally use upstream nodes to set the default value for the input. A run of the graph will cache the Define Data node's value for use when running the graph externally, for example with the Engine Node.
 
 ---
 
 ## Example File
+In the example below, the first group of "DefineData" nodes have an unlocked UI. The node correctly validates the Number input provided while rejecting the String input. The second group contains a node with locked UI. The node automatically adjusts the drop-down and the **List** toggle to match the input, in this case a list of integers.
 
 ![Define_Data](./CoreNodeModels.DefineData_img.jpg)
+

src/DynamoCore/Engine/EngineController.cs

@@ -389,7 +389,6 @@ internal bool GenerateGraphSyncDataForCustomNode(IEnumerable<NodeModel> nodes, C
         /// </summary>
         /// <param name="scheduler">The scheduler on which custom node compilation 
         /// task can be scheduled.</param>
-        /// 
         internal void ProcessPendingCustomNodeSyncData(IScheduler scheduler)
         {
             while (pendingCustomNodeSyncData.Count > 0)
@@ -438,7 +437,8 @@ private bool VerifyGraphSyncData(IEnumerable<NodeModel> nodes)
 
             foreach (var node in nodes)
             {
-                if (!node.IsInputNode) continue;
+                //Ignore inputs, nodes with input ports, and nodes derived from custom nodes.
+                if (!node.IsInputNode || node.InPorts.Any() || node.IsCustomFunction) continue;
 
                 // Only one or the other of the two lists, Added or Modified, will match the node GUID if they do. 
                 bool isAdded = false;

src/DynamoCoreWpf/Properties/Resources.en-US.resx

@@ -3962,6 +3962,14 @@ To make this file into a new template, save it to a different folder, then move
   <data name="DynamoXmlFileFormat" xml:space="preserve">
     <value>Dynamo 1.x file format</value>
   </data>
+  <data name="DataInputNodeModeLockTooltip" xml:space="preserve">
+    <value>When locked, this node only accepts the selected data type as input. When unlocked, the input can be any supported data type.</value>
+    <comment>Tool-tip for the padlock toggle button controlling auto/manual mode.</comment>
+  </data>
+  <data name="DataInputNodeInformationTooltip" xml:space="preserve">
+    <value>Toggle on if the input data contains a list.</value>
+    <comment>Tool-tip for info questionmark icon.</comment>
+  </data>
   <data name="MessagePackageOlderDynamo" xml:space="preserve">
     <value>This package or one of its dependencies were created for a previous version of Dynamo. It may not work in this version. Do you want to continue?</value>
   </data>
@@ -3971,4 +3979,4 @@ To make this file into a new template, save it to a different folder, then move
   <data name="MessagePackOlderDynamoLink" xml:space="preserve">
     <value>#Learn more=https://primer2.dynamobim.org/1_developer_primer_intro/3_developing_for_dynamo/updating-your-packages-and-dynamo-libraries-for-dynamo-3x-net8</value>
   </data>
-</root>
+</root>

src/DynamoCoreWpf/Properties/Resources.resx

@@ -3949,6 +3949,14 @@ To make this file into a new template, save it to a different folder, then move
   <data name="DynamoXmlFileFormat" xml:space="preserve">
     <value>Dynamo 1.x file format</value>
   </data>
+  <data name="DataInputNodeModeLockTooltip" xml:space="preserve">
+    <value>When locked, this node only accepts the selected data type as input. When unlocked, the input can be any supported data type.</value>
+    <comment>Tool-tip for the padlock button controlling auto/manual mode.</comment>
+  </data>
+  <data name="DataInputNodeInformationTooltip" xml:space="preserve">
+    <value>Toggle on if the input data contains a list.</value>
+    <comment>Tool-tip for info questionmark icon next to the List toggle control.</comment>
+  </data>
   <data name="MessagePackageOlderDynamo" xml:space="preserve">
     <value>This package or one of its dependencies were created for a previous version of Dynamo. It may not work in this version. Do you want to continue?</value>
   </data>
@@ -3958,4 +3966,4 @@ To make this file into a new template, save it to a different folder, then move
   <data name="MessagePackOlderDynamoLink" xml:space="preserve">
     <value>#Learn more=https://primer2.dynamobim.org/1_developer_primer_intro/3_developing_for_dynamo/updating-your-packages-and-dynamo-libraries-for-dynamo-3x-net8</value>
   </data>
-</root>
+</root>

src/DynamoCoreWpf/PublicAPI.Unshipped.txt

@@ -4452,6 +4452,8 @@ static Dynamo.Wpf.Properties.Resources.CustomNodePropertyWindowName.get -> strin
 static Dynamo.Wpf.Properties.Resources.CustomNodePropertyWindowNameHint.get -> string
 static Dynamo.Wpf.Properties.Resources.CustomNodePropertyWindowTitle.get -> string
 static Dynamo.Wpf.Properties.Resources.CustomNodeTypeShortString.get -> string
+static Dynamo.Wpf.Properties.Resources.DataInputNodeInformationTooltip.get -> string
+static Dynamo.Wpf.Properties.Resources.DataInputNodeModeLockTooltip.get -> string
 static Dynamo.Wpf.Properties.Resources.DefaultPythonEngineNone.get -> string
 static Dynamo.Wpf.Properties.Resources.DeleteFailureMessageBoxTitle.get -> string
 static Dynamo.Wpf.Properties.Resources.DeprecatingPackageMessageBoxTitle.get -> string