AGD-2199 - custom dropdown node #11958
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ## In Depth | ||
| The Custom Dropdown node allows a user to create a dropdown selection input with custom labels and values. If all values are numbers, the output will be a double, and if all values are integers the output will be an integer. In the example below, "Two" is selected in the Custom Dropdown Menu node, making the output of that node the integer `2`. | ||
| ___ | ||
| ## Example File | ||
|
|
||
|  | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Runtime.Serialization; | ||
| using System.Xml; | ||
|
|
||
| using Autodesk.DesignScript.Runtime; | ||
|
|
||
| using Dynamo.Graph; | ||
| using Dynamo.Graph.Nodes; | ||
|
|
||
| using Newtonsoft.Json; | ||
|
|
||
| using ProtoCore.AST.AssociativeAST; | ||
|
|
||
| namespace CoreNodeModels.Input | ||
| { | ||
| /// <summary> | ||
| /// This node allow the user to create a dropdown menu with an with an arbitrary number of customization items | ||
twastvedt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /// </summary> | ||
| [NodeName("Custom Dropdown Menu")] | ||
|
There was a problem hiding this comment. @LongNguyenP @saintentropy - not sure if this is worth doing, but perhaps this node should actually serialize as the There was a problem hiding this comment. @mjkkirschner We are going to look into it with follow up task |
||
| [NodeCategory(BuiltinNodeCategories.CORE_INPUT)] | ||
| [NodeDescription("CustomSelectionNodeDescription", typeof(Properties.Resources))] | ||
| [NodeSearchTags("CustomSelectionSearchTags", typeof(Properties.Resources))] | ||
| [OutPortNames("value")] | ||
| [OutPortTypes("var")] | ||
| [OutPortDescriptions("Selected value")] | ||
twastvedt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [IsDesignScriptCompatible] | ||
| public class CustomSelection : DSDropDownBase | ||
| { | ||
| private List<DynamoDropDownItem> serializedItems; | ||
|
|
||
| public List<DynamoDropDownItem> SerializedItems | ||
twastvedt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| get => serializedItems; | ||
| set | ||
| { | ||
| serializedItems = value; | ||
|
|
||
| Items.Clear(); | ||
|
|
||
| foreach (DynamoDropDownItem item in serializedItems) | ||
| { | ||
| Items.Add(item); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Construct a new Custom Dropdown Menu node | ||
| /// </summary> | ||
| public CustomSelection() : base("Value") | ||
| { | ||
| ArgumentLacing = LacingStrategy.Disabled; | ||
twastvedt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Items.Add(new DynamoDropDownItem("One", "1")); | ||
| Items.Add(new DynamoDropDownItem("Two", "2")); | ||
| Items.Add(new DynamoDropDownItem("Three", "3")); | ||
|
|
||
| SelectedIndex = 0; | ||
| } | ||
|
|
||
| [JsonConstructor] | ||
| protected CustomSelection(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPorts) : base("Value", inPorts, outPorts) | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Build the AST for this node | ||
| /// </summary> | ||
| /// <param name="inputAstNodes"></param> | ||
| /// <returns></returns> | ||
| [IsVisibleInDynamoLibrary(false)] | ||
| public override IEnumerable<AssociativeNode> BuildOutputAst(List<AssociativeNode> inputAstNodes) | ||
| { | ||
| AssociativeNode associativeNode = AstFactory.BuildPrimitiveNodeFromObject(GetSelectedValue()); | ||
|
|
||
| return new[] { AstFactory.BuildAssignment(GetAstIdentifierForOutputIndex(0), associativeNode) }; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Return the selected item as an int, or a double, or a string | ||
| /// </summary> | ||
| /// <returns></returns> | ||
| private object GetSelectedValue() | ||
| { | ||
| if (SelectedIndex == -1) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| DynamoDropDownItem selectedItem = Items[SelectedIndex]; | ||
|
|
||
| if (selectedItem?.Item is string value) | ||
| { | ||
| if (string.IsNullOrWhiteSpace(value)) | ||
| { | ||
| return value; | ||
| } | ||
|
|
||
| if (Items.All(item => item is null || ( item.Item is string v && ( string.IsNullOrEmpty(v) || int.TryParse(v, out _) ) ))) | ||
| { | ||
| int.TryParse(value, out int intValue); | ||
| return intValue; | ||
| } | ||
|
|
||
| if (Items.All(item => item is null || ( item.Item is string v && ( string.IsNullOrEmpty(v) || double.TryParse(v, out _) ) ))) | ||
| { | ||
| double.TryParse(value, out double doubleValue); | ||
| return doubleValue; | ||
| } | ||
|
|
||
| return value; | ||
| } | ||
|
|
||
| return selectedItem?.Item; | ||
| } | ||
|
|
||
| protected override SelectionState PopulateItemsCore(string currentSelection) | ||
| { | ||
| return SelectionState.Restore; | ||
| } | ||
|
|
||
| [OnSerializing] | ||
|
There was a problem hiding this comment. what does this attribute do? There was a problem hiding this comment. This is a Newtonsoft pre-serialization hook. https://www.newtonsoft.com/json/help/html/SerializationCallbacks.htm |
||
| private void OnSerializing(StreamingContext context) | ||
| { | ||
| serializedItems = Items.ToList(); | ||
| } | ||
|
|
||
| [Obsolete] | ||
| protected override void SerializeCore(XmlElement nodeElement, SaveContext context) | ||
| { | ||
| nodeElement.SetAttribute("serializedItems", JsonConvert.SerializeObject(Items)); | ||
|
|
||
| base.SerializeCore(nodeElement, context); | ||
| } | ||
|
|
||
| [Obsolete] | ||
| protected override void DeserializeCore(XmlElement nodeElement, SaveContext context) | ||
| { | ||
| XmlAttribute itemsAttribute = nodeElement.Attributes["serializedItems"]; | ||
|
|
||
| if (itemsAttribute == null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| List<DynamoDropDownItem> items = JsonConvert.DeserializeObject<List<DynamoDropDownItem>>(itemsAttribute.Value); | ||
|
|
||
| Items.Clear(); | ||
|
|
||
| foreach (DynamoDropDownItem item in items) | ||
| { | ||
| Items.Add(item); | ||
| } | ||
|
|
||
| base.DeserializeCore(nodeElement, context); | ||
| } | ||
|
|
||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what happens if the types are mixed? Can you use strings? What are valid value types etc?
Is this dynamic behavior important - I ask this because as we're working on the MSIL compiler - it's very hard to determine the output types of nodes that have dynamic behavior like this - not super important but I imagine that if we move forward with that work outside of a POC we're going to need some principles around not introducing dynamic behavior without a really good reason.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Immediate answers: values default to strings unless the criteria are met. So, anything's valid, it will just be a string unless we can make everything numbers. I'll add that, or whatever we decide here, to the description.
I'm definitely open to alternatives, though I think this behavior is pretty convenient, intuiting a user's expectations in most common scenarios. I'm not sure what the alternative to dynamic behavior here is. Separate String custom selection and Number custom selection nodes sounds awkward for the user. I imagine the original inspiration for this part may have been the experience in Grasshopper. Though there it's less a feature of the custom selection node itself and more of the global type coercion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's put this on the back burner.