Set05| Add Node Documentation for... (#3092)

* Revit.Elements.Material.ByName * Material.Name, Material.Shininess * Material.Smoothness * Material.Transparency * Material.SurfacePatternColor * Material.MaterialClass * Material.CutPatternColor * Material.Color * Material.CutPatternId * Material.AppearanceAssetElement * Update Revit.Elements.Material.Color.md * Move files from review
DynamoDS · Sep 20, 2024 · ff6d22f · ff6d22f
1 parent 1d16e2b
commit ff6d22f
Show file tree

Hide file tree

Showing 33 changed files with 2,181 additions and 0 deletions.
diff --git a/doc/distrib/NodeHelpFiles/Revit.Elements.Material.AppearanceAssetElement.dyn b/doc/distrib/NodeHelpFiles/Revit.Elements.Material.AppearanceAssetElement.dyn
@@ -0,0 +1,193 @@
+{
+  "Uuid": "c97b33fa-c5fd-4bee-a621-e00a9d86ccb3",
+  "IsCustomNode": false,
+  "Description": "",
+  "Name": "Revit.Elements.Material.AppearanceAssetElement",
+  "ElementResolver": {
+    "ResolutionMap": {}
+  },
+  "Inputs": [],
+  "Outputs": [],
+  "Nodes": [
+    {
+      "ConcreteType": "DSRevitNodesUI.Categories, DSRevitNodesUI",
+      "SelectedIndex": 344,
+      "SelectedString": "OST_Materials",
+      "Id": "1d6cc464b8224c6ba2b8f3ba479952e9",
+      "NodeType": "ExtensionNode",
+      "Inputs": [],
+      "Outputs": [
+        {
+          "Id": "ded8d0519a5b487eb09366c5be75830d",
+          "Name": "Category",
+          "Description": "The selected Category.",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Replication": "Disabled",
+      "Description": "All built-in categories."
+    },
+    {
+      "ConcreteType": "DSRevitNodesUI.ElementsOfCategory, DSRevitNodesUI",
+      "Id": "ecafb539633c4692ac20fe8c76f571d0",
+      "NodeType": "ExtensionNode",
+      "Inputs": [
+        {
+          "Id": "8064f76c9d994ec8b95ed5d799b42422",
+          "Name": "Category",
+          "Description": "The Category",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Outputs": [
+        {
+          "Id": "7f458aa394c844a2a82bc77d86c32f1e",
+          "Name": "Elements",
+          "Description": "An element class.",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Replication": "Disabled",
+      "Description": "Get all elements of the specified category from the model."
+    },
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
+      "Id": "938b8531e3454847aef22129ccd3874a",
+      "NodeType": "FunctionNode",
+      "Inputs": [
+        {
+          "Id": "6f6ca90105e6435a84e20b5f8697de1a",
+          "Name": "material",
+          "Description": "Revit.Elements.Material",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Outputs": [
+        {
+          "Id": "11a45144e7a547f686ca1402fd11f0a0",
+          "Name": "AppearanceAssetElement",
+          "Description": "AppearanceAssetElement",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "FunctionSignature": "Revit.Elements.Material.AppearanceAssetElement",
+      "Replication": "Auto",
+      "Description": "Get AppearanceAssetElement of this Material.\n\nMaterial.AppearanceAssetElement: AppearanceAssetElement"
+    }
+  ],
+  "Connectors": [
+    {
+      "Start": "ded8d0519a5b487eb09366c5be75830d",
+      "End": "8064f76c9d994ec8b95ed5d799b42422",
+      "Id": "a3a175e7e51042a69d968f103d8e3d87",
+      "IsHidden": "False"
+    },
+    {
+      "Start": "7f458aa394c844a2a82bc77d86c32f1e",
+      "End": "6f6ca90105e6435a84e20b5f8697de1a",
+      "Id": "7e6def02f0e84072923846419572a3bf",
+      "IsHidden": "False"
+    }
+  ],
+  "Dependencies": [],
+  "NodeLibraryDependencies": [],
+  "EnableLegacyPolyCurveBehavior": true,
+  "Thumbnail": "",
+  "GraphDocumentationURL": null,
+  "ExtensionWorkspaceData": [
+    {
+      "ExtensionGuid": "28992e1d-abb9-417f-8b1b-05e053bee670",
+      "Name": "Properties",
+      "Version": "3.2",
+      "Data": {}
+    },
+    {
+      "ExtensionGuid": "DFBD9CC0-DB40-457A-939E-8C8555555A9D",
+      "Name": "Generative Design",
+      "Version": "8.1",
+      "Data": {}
+    }
+  ],
+  "Author": "",
+  "Linting": {
+    "activeLinter": "None",
+    "activeLinterId": "7b75fb44-43fd-4631-a878-29f4d5d8399a",
+    "warningCount": 0,
+    "errorCount": 0
+  },
+  "Bindings": [],
+  "View": {
+    "Dynamo": {
+      "ScaleFactor": 1.0,
+      "HasRunWithoutCrash": true,
+      "IsVisibleInDynamoLibrary": true,
+      "Version": "3.2.1.5366",
+      "RunType": "Manual",
+      "RunPeriod": "1000"
+    },
+    "Camera": {
+      "Name": "_Background Preview",
+      "EyeX": -17.0,
+      "EyeY": 24.0,
+      "EyeZ": 50.0,
+      "LookX": 12.0,
+      "LookY": -13.0,
+      "LookZ": -58.0,
+      "UpX": 0.0,
+      "UpY": 1.0,
+      "UpZ": 0.0
+    },
+    "ConnectorPins": [],
+    "NodeViews": [
+      {
+        "Id": "1d6cc464b8224c6ba2b8f3ba479952e9",
+        "Name": "Categories",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 43.42786838480748,
+        "Y": 328.3254800342019
+      },
+      {
+        "Id": "ecafb539633c4692ac20fe8c76f571d0",
+        "Name": "All Elements of Category",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 379.4278683848075,
+        "Y": 328.3254800342019
+      },
+      {
+        "Id": "938b8531e3454847aef22129ccd3874a",
+        "Name": "Material.AppearanceAssetElement",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 735.4899768699463,
+        "Y": 328.325480034202
+      }
+    ],
+    "Annotations": [],
+    "X": -202.80826796906138,
+    "Y": -306.2526750825067,
+    "Zoom": 1.626142416395444
+  }
+}
diff --git a/doc/distrib/NodeHelpFiles/Revit.Elements.Material.AppearanceAssetElement.md b/doc/distrib/NodeHelpFiles/Revit.Elements.Material.AppearanceAssetElement.md
@@ -0,0 +1,11 @@
+## In Depth
+`Material.AppearanceAssetElement` returns the appearance asset for the given material (if available).
+
+Appearance assets control how materials display in rendered images. For more information, refer to this [article](https://help.autodesk.com/view/RVT/2025/ENU/?guid=GUID-6E3C9EF0-F657-4F79-90BD-A2FB88B0467D).
+
+In the example below, all materials are collected from the current document. The materials' appearance assets are returned with `Material.AppearanceAssetElement`.
+
+___
+## Example File
+
+![Material.AppearanceAssetElement](./Revit.Elements.Material.AppearanceAssetElement_img.jpg)
diff --git a/doc/distrib/NodeHelpFiles/Revit.Elements.Material.AppearanceAssetElement_img.jpg b/doc/distrib/NodeHelpFiles/Revit.Elements.Material.AppearanceAssetElement_img.jpg
diff --git a/doc/distrib/NodeHelpFiles/Revit.Elements.Material.ByName.dyn b/doc/distrib/NodeHelpFiles/Revit.Elements.Material.ByName.dyn
@@ -0,0 +1,156 @@
+{
+  "Uuid": "c97b33fa-c5fd-4bee-a621-e00a9d86ccb3",
+  "IsCustomNode": false,
+  "Description": "",
+  "Name": "Revit.Elements.Material.ByName",
+  "ElementResolver": {
+    "ResolutionMap": {}
+  },
+  "Inputs": [
+    {
+      "Id": "10fc2c452c9b44598804a75a9d61c2b5",
+      "Name": "String",
+      "Type": "string",
+      "Type2": "string",
+      "Value": "Metal - Aluminium",
+      "Description": "Creates a string"
+    }
+  ],
+  "Outputs": [],
+  "Nodes": [
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
+      "Id": "e030984adf6241cbbacdb94b6b74f230",
+      "NodeType": "FunctionNode",
+      "Inputs": [
+        {
+          "Id": "e5224b4b964b4cd3b7d5182f5d405b83",
+          "Name": "name",
+          "Description": "The name of the material\n\nstring",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Outputs": [
+        {
+          "Id": "f24e86eaf8134ea9b3a9182437e7361f",
+          "Name": "Material",
+          "Description": "Material",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "FunctionSignature": "Revit.Elements.Material.ByName@string",
+      "Replication": "Auto",
+      "Description": "Select a material from the current document by the name\n\nMaterial.ByName (name: string): Material"
+    },
+    {
+      "ConcreteType": "CoreNodeModels.Input.StringInput, CoreNodeModels",
+      "Id": "10fc2c452c9b44598804a75a9d61c2b5",
+      "NodeType": "StringInputNode",
+      "Inputs": [],
+      "Outputs": [
+        {
+          "Id": "b226749d315e487283d560b5ece061d8",
+          "Name": "",
+          "Description": "String",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Replication": "Disabled",
+      "Description": "Creates a string",
+      "InputValue": "Metal - Aluminium"
+    }
+  ],
+  "Connectors": [
+    {
+      "Start": "b226749d315e487283d560b5ece061d8",
+      "End": "e5224b4b964b4cd3b7d5182f5d405b83",
+      "Id": "f2f9cdd1a15f40e19cbe9197f4a18ca6",
+      "IsHidden": "False"
+    }
+  ],
+  "Dependencies": [],
+  "NodeLibraryDependencies": [],
+  "EnableLegacyPolyCurveBehavior": null,
+  "Thumbnail": "",
+  "GraphDocumentationURL": null,
+  "ExtensionWorkspaceData": [
+    {
+      "ExtensionGuid": "28992e1d-abb9-417f-8b1b-05e053bee670",
+      "Name": "Properties",
+      "Version": "3.2",
+      "Data": {}
+    },
+    {
+      "ExtensionGuid": "DFBD9CC0-DB40-457A-939E-8C8555555A9D",
+      "Name": "Generative Design",
+      "Version": "8.1",
+      "Data": {}
+    }
+  ],
+  "Author": "",
+  "Linting": {
+    "activeLinter": "None",
+    "activeLinterId": "7b75fb44-43fd-4631-a878-29f4d5d8399a",
+    "warningCount": 0,
+    "errorCount": 0
+  },
+  "Bindings": [],
+  "View": {
+    "Dynamo": {
+      "ScaleFactor": 1.0,
+      "HasRunWithoutCrash": true,
+      "IsVisibleInDynamoLibrary": true,
+      "Version": "3.2.1.5366",
+      "RunType": "Automatic",
+      "RunPeriod": "1000"
+    },
+    "Camera": {
+      "Name": "_Background Preview",
+      "EyeX": -17.0,
+      "EyeY": 24.0,
+      "EyeZ": 50.0,
+      "LookX": 12.0,
+      "LookY": -13.0,
+      "LookZ": -58.0,
+      "UpX": 0.0,
+      "UpY": 1.0,
+      "UpZ": 0.0
+    },
+    "ConnectorPins": [],
+    "NodeViews": [
+      {
+        "Id": "e030984adf6241cbbacdb94b6b74f230",
+        "Name": "Material.ByName",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 506.0,
+        "Y": 338.4
+      },
+      {
+        "Id": "10fc2c452c9b44598804a75a9d61c2b5",
+        "Name": "String",
+        "IsSetAsInput": true,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 202.0,
+        "Y": 338.4
+      }
+    ],
+    "Annotations": [],
+    "X": -312.1277544796104,
+    "Y": -565.5681925338558,
+    "Zoom": 2.490600953125
+  }
+}
diff --git a/doc/distrib/NodeHelpFiles/Revit.Elements.Material.ByName.md b/doc/distrib/NodeHelpFiles/Revit.Elements.Material.ByName.md
@@ -0,0 +1,8 @@
+## In Depth
+Given a material name as a string, `Material.ByName` retrieves the corresponding material element from the current Revit document, if the material is available. If the material is not found, a null value is returned.
+
+In the example below, the material, "Metal - Aluminium" is returned.
+___
+## Example File
+
+![Material.ByName](./Revit.Elements.Material.ByName_img.jpg)
diff --git a/doc/distrib/NodeHelpFiles/Revit.Elements.Material.ByName_img.jpg b/doc/distrib/NodeHelpFiles/Revit.Elements.Material.ByName_img.jpg