DYN-6009-Extended-Node-Help-Missing 4th (#14578)

I've added/updated the documentation (md, dyn, jpg files) for the next list of 29 nodes (using Monocle package): - Vector.Z - Arc.ByThreePoints - Arc.ByBestFitThroughPoints - Arc.CenterPoint - Arc.Radius - Circle.ByThreePoints - Circle.ByBestFitThroughPoints - Circle.CenterPoint - Circle.Radius - Circle.ByCenterPointRadius - Curve.SplitByParameter (curve, parameters) - Curve.Length - Curve.Normal - Ellipse.CenterPoint - EllipseArc.Plane - EllipseArc.CenterPoint - Helix.Radius - Line.ByStartPointEndPoint - Line.ByBestFitThroughPoints - PolyCurve.ByPoints - PolyCurve.Curves - Polygon.ByPoints - Curve.Extrude (curve, direction) - Curve.ExtrudeAsSolid (curve, distance) - Curve.Extrude (curve, distance) - Curve.SweepAsSolid - PolyCurve.OffsetMany - Curve.Extrude (curve, direction, distance) - Curve.NormalAtParameter (curve, param)
DynamoDS · Nov 7, 2023 · ca4574d · ca4574d
1 parent 37cf03c
commit ca4574d
Show file tree

Hide file tree

Showing 55 changed files with 4,403 additions and 309 deletions.
diff --git a/...trib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.ByBestFitThroughPoints.md b/...trib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.ByBestFitThroughPoints.md
@@ -1,5 +1,8 @@
 ## In Depth
-Plane By Best Fit Through Points uses a set of points and finds the plane that best approximates the set. In the example, we use a series of RandomList components to generate random x,y and z coordinates. The points are created By Coordinates, and the list of points is then used as an input for ByBestFitThroughPoints.
+`Arc.ByBestFitThroughPoints` draws an arc that best represents 3 or more points. 
+
+In the example below, we create an arc that approximates a list of random points ranging from 0 to 5 in the X and Y directions.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.ByThreePoints.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.ByThreePoints.md
@@ -1,5 +1,8 @@
 ## In Depth
-Plane by Three Points will create a plane that passes through the three input points. The points must not be co-linear. In the example below, we use three code blocks to define the three initial points, then use ByThreePoints to create a plane.
+`Arc.ByThreePoints` draws an arc from three points, given the start point, end point, and a point between them. 
+
+In the example below, we draw an arc from three randomly created points.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.CenterPoint.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.CenterPoint.md
@@ -1,5 +1,8 @@
 ## In Depth
-Center Point will return the center of an input sphere. In the example below, we use a ByBestFit node to create a sphere based on a set of random points. We then use a CenterPoint node to determine the center of the best fit sphere.
+`Arc.CenterPoint` returns a point at the center of an arc, the same point as the corresponding circle center. 
+
+In the example below, we create an arc from 3 randomly generated points, then return its center point with an `Arc.CenterPoint` node.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.Radius.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Arc.Radius.md
@@ -1,5 +1,8 @@
 ## In Depth
-Radius will return the center of an input sphere. In the example below, we use a ByBestFit node to create a sphere based on a set of random points. We then use a Radius node to determine the size of the best fit sphere.
+`Arc.Radius` returns the radius value of arc geometry. 
+
+In the example below, we create an arc from 3 randomly generated points, then return its radius point with an `Arc.Radius` node. We can visualize the change in radius as the input points change in the Y direction.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.BoundingBox.ByCorners.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.BoundingBox.ByCorners.md
@@ -1,5 +1,8 @@
 ## In Depth
-Cuboid By Corners creates a cuboid where the two input points are used as the opposite corners of the cuboid. In the example file, two points are randomly generated and used to create a cuboid.
+`BoundingBox.ByCorners` creates a BoundingBox from two input points. 
+
+In the example below, we use the diagonal vector to translate the start point of the box to create its end point. To visualize the box, it is converted to a PolySurface and its edge curves are extracted.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.BoundingBox.ByGeometry.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.BoundingBox.ByGeometry.md
@@ -1,5 +1,8 @@
 ## In Depth
-ByGeometry brings each input geometry into Revit as an individual Import Instance element. An Import Instance is identified as an Import Symbol in Revit.
+`BoundingBox.ByGeometry` creates a BoundingBox around geometry.
+
+In the example below, a BoundingBox is created around a sphere. To visualize the box, it is converted to a cuboid and its edge curves are extracted.
+
 ___
 ## Example File
 

diff --git a/...b/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.ByBestFitThroughPoints.md b/...b/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.ByBestFitThroughPoints.md
@@ -1,5 +1,8 @@
 ## In Depth
-Plane By Best Fit Through Points uses a set of points and finds the plane that best approximates the set. In the example, we use a series of RandomList components to generate random x,y and z coordinates. The points are created By Coordinates, and the list of points is then used as an input for ByBestFitThroughPoints.
+`Circle.ByBestFitThroughPoints` receives point inputs and creates a best-fit circle through them. 
+
+In the example below, a list of randomly generated points is used to generate a circle that best approximates them. We can dynamically increase and decrease the number of points with a number slider, altering the shape of the best-fit circle.
+
 ___
 ## Example File
 

diff --git a/...trib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.ByCenterPointRadius.md b/...trib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.ByCenterPointRadius.md
@@ -1,5 +1,8 @@
 ## In Depth
-Sphere by Center Point Radius will create a sphere centered at the input point, and with an input radius. In the example below, we use a code block to specify the coordinates of a Point created by coordinates, and we use a number slider to determine the radius of the sphere.
+`Circle.ByCenterPointRadius` creates a circle with the Z-plane normal. 
+
+In the example below, we use a code block to create a point in three-dimensional space and locate the circle around the point. The radius is controlled dynamically with a number slider.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.ByThreePoints.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.ByThreePoints.md
@@ -1,5 +1,8 @@
 ## In Depth
-Plane by Three Points will create a plane that passes through the three input points. The points must not be co-linear. In the example below, we use three code blocks to define the three initial points, then use ByThreePoints to create a plane.
+`Circle.ByThreePoints` receives 3 point inputs and creates a circle that passes through each point.
+
+In the example below, we use 3 randomly generated points on the Z-plane to create a circle.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.CenterPoint.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.CenterPoint.md
@@ -1,5 +1,8 @@
 ## In Depth
-Center Point will return the center of an input sphere. In the example below, we use a ByBestFit node to create a sphere based on a set of random points. We then use a CenterPoint node to determine the center of the best fit sphere.
+`Circle.CenterPoint` finds the center point of a given circle. 
+
+In the example below, we create a circle using `Circle.BestFitThroughPoints` and then extract the center point of the circle.
+
 ___
 ## Example File
 

diff --git a/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.Radius.md b/doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Circle.Radius.md
@@ -1,5 +1,8 @@
 ## In Depth
-Radius will return the center of an input sphere. In the example below, we use a ByBestFit node to create a sphere based on a set of random points. We then use a Radius node to determine the size of the best fit sphere.
+`Circle.Radius` finds the radius of a given circle.
+
+In the example below, we create a circle using `Circle.ByBestFitThroughPoints` and then extract the radius of the circle.
+
 ___
 ## Example File
 

diff --git a/...cript.Geometry.CoordinateSystem.ByOriginVectors(origin, xAxis, yAxis, zAxis).md b/...cript.Geometry.CoordinateSystem.ByOriginVectors(origin, xAxis, yAxis, zAxis).md
@@ -1,5 +1,8 @@
 ## In Depth
-Add in-depth information about ByOriginVectors (origin, xAxis, yAxis, zAxis)...
+`CoordinateSystem.ByOriginVectors (origin, xAxis, yAxis, zAxis)` returns a new CoordinateSystem at an input origin point with input X, Y, and Z axes. 
+
+In the example below, the CoordinateSystem is placed at an origin with new vectors for the X, Y, and Z axes. The result is a CoordinateSystem rotated relative to the original CoordinateSystem.
+
 ___
 ## Example File
 

diff --git a/...istrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.CoordinateSystem.ByPlane.md b/...istrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.CoordinateSystem.ByPlane.md
@@ -1,5 +1,8 @@
 ## In Depth
-Sketch planes are used in the creation of 2D and 3D geometry in Revit.
+`CoordinateSystem.ByPlane` returns a new CoordinateSystem based on an input plane. 
+
+In the example below, the normal of the input plane has been repositioned, resulting in a new CoordinateSystem rotated about the X axis.
+
 ___
 ## Example File
 

diff --git a/...odesk.DesignScript.Geometry.CoordinateSystem.Rotate(coordinateSystem, plane, degrees).dyn b/...odesk.DesignScript.Geometry.CoordinateSystem.Rotate(coordinateSystem, plane, degrees).dyn
@@ -0,0 +1,262 @@
+{
+  "Uuid": "ac4af643-8e4a-4317-b683-dabd4e2674a7",
+  "IsCustomNode": false,
+  "Description": "",
+  "Name": "Autodesk.DesignScript.Geometry.CoordinateSystem.Rotate",
+  "ElementResolver": {
+    "ResolutionMap": {}
+  },
+  "Inputs": [],
+  "Outputs": [],
+  "Nodes": [
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
+      "Id": "d83f3cdf35c346bb955ffef4109381cc",
+      "NodeType": "FunctionNode",
+      "Inputs": [
+        {
+          "Id": "fb7c4cefedb74442a23d6b054022b053",
+          "Name": "coordinateSystem",
+          "Description": "Autodesk.DesignScript.Geometry.CoordinateSystem",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        },
+        {
+          "Id": "c8482db7b9654c5f8d1f7eb7e41e90ae",
+          "Name": "plane",
+          "Description": "Plane to get normal from\n\nPlane",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        },
+        {
+          "Id": "254041246ba743ddb926e93567a5545c",
+          "Name": "degrees",
+          "Description": "Rotation value in degrees\n\ndouble\nDefault value : 0",
+          "UsingDefaultValue": true,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Outputs": [
+        {
+          "Id": "deda1902488f4cf89653cc97ef74dc94",
+          "Name": "CoordinateSystem",
+          "Description": "Rotated coordinate system",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "FunctionSignature": "Autodesk.DesignScript.Geometry.CoordinateSystem.Rotate@Autodesk.DesignScript.Geometry.Plane,double",
+      "Replication": "Auto",
+      "Description": "Rotates an object around the origin and normal of the given Plane by a specified degree\n\nCoordinateSystem.Rotate (plane: Plane, degrees: double = 0): CoordinateSystem"
+    },
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
+      "Id": "8ad6a2c820ea4c33acd85d6c6b9f7e42",
+      "NodeType": "FunctionNode",
+      "Inputs": [
+        {
+          "Id": "bf629aa243374e4fbe7dd36624786535",
+          "Name": "origin",
+          "Description": "Point\nDefault value : Autodesk.DesignScript.Geometry.Point.ByCoordinates(0, 0, 0)",
+          "UsingDefaultValue": true,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Outputs": [
+        {
+          "Id": "90957b0754744e92b25fc46d261d6471",
+          "Name": "CoordinateSystem",
+          "Description": "CoordinateSystem",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "FunctionSignature": "Autodesk.DesignScript.Geometry.CoordinateSystem.ByOrigin@Autodesk.DesignScript.Geometry.Point",
+      "Replication": "Auto",
+      "Description": "Create a CoordinateSystem with origin at input Point, with X and Y Axes set as WCS X and Y Axes.\n\nCoordinateSystem.ByOrigin (origin: Point = Autodesk.DesignScript.Geometry.Point.ByCoordinates(0, 0, 0)): CoordinateSystem"
+    },
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
+      "Id": "600954f1336c496497b3d78c4274732e",
+      "NodeType": "FunctionNode",
+      "Inputs": [],
+      "Outputs": [
+        {
+          "Id": "abcb37feac0b4b0e8696ed2271deacdb",
+          "Name": "Plane",
+          "Description": "Plane at YZ plane of world",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "FunctionSignature": "Autodesk.DesignScript.Geometry.Plane.YZ",
+      "Replication": "Auto",
+      "Description": "Creates a plane in the world YZ\n\nPlane.YZ ( ): Plane"
+    },
+    {
+      "ConcreteType": "Dynamo.Graph.Nodes.CodeBlockNodeModel, DynamoCore",
+      "Id": "233a9182edf24a9cb0e04918b22d5ea1",
+      "NodeType": "CodeBlockNode",
+      "Inputs": [],
+      "Outputs": [
+        {
+          "Id": "6902090b147b48e69ba4898d9684a3bb",
+          "Name": "",
+          "Description": "degrees",
+          "UsingDefaultValue": false,
+          "Level": 2,
+          "UseLevels": false,
+          "KeepListStructure": false
+        }
+      ],
+      "Replication": "Disabled",
+      "Description": "Allows for DesignScript code to be authored directly",
+      "Code": "degrees = 135;"
+    }
+  ],
+  "Connectors": [
+    {
+      "Start": "90957b0754744e92b25fc46d261d6471",
+      "End": "fb7c4cefedb74442a23d6b054022b053",
+      "Id": "f4d6e52809c14409bc0107db90964aea",
+      "IsHidden": "False"
+    },
+    {
+      "Start": "abcb37feac0b4b0e8696ed2271deacdb",
+      "End": "c8482db7b9654c5f8d1f7eb7e41e90ae",
+      "Id": "b6b61eb9ca1647079e31f6c182bedc03",
+      "IsHidden": "False"
+    },
+    {
+      "Start": "6902090b147b48e69ba4898d9684a3bb",
+      "End": "254041246ba743ddb926e93567a5545c",
+      "Id": "5da7c279d3d04bbf988fa8210a569aa1",
+      "IsHidden": "False"
+    }
+  ],
+  "Dependencies": [],
+  "NodeLibraryDependencies": [],
+  "Thumbnail": "",
+  "GraphDocumentationURL": null,
+  "ExtensionWorkspaceData": [
+    {
+      "ExtensionGuid": "28992e1d-abb9-417f-8b1b-05e053bee670",
+      "Name": "Properties",
+      "Version": "2.19",
+      "Data": {}
+    }
+  ],
+  "Author": "",
+  "Linting": {
+    "activeLinter": "None",
+    "activeLinterId": "7b75fb44-43fd-4631-a878-29f4d5d8399a",
+    "warningCount": 0,
+    "errorCount": 0
+  },
+  "Bindings": [],
+  "View": {
+    "Dynamo": {
+      "ScaleFactor": 100.0,
+      "HasRunWithoutCrash": true,
+      "IsVisibleInDynamoLibrary": true,
+      "Version": "2.19.0.5742",
+      "RunType": "Manual",
+      "RunPeriod": "1000"
+    },
+    "Camera": {
+      "Name": "_Background Preview",
+      "EyeX": 23.126308376732588,
+      "EyeY": 8.7204408155608029,
+      "EyeZ": 7.9356554294069479,
+      "LookX": -23.126308376732588,
+      "LookY": -8.7204408155608029,
+      "LookZ": -7.9356554294069479,
+      "UpX": -0.11936696618795395,
+      "UpY": 0.992004930973053,
+      "UpZ": -0.040960114449262619
+    },
+    "ConnectorPins": [],
+    "NodeViews": [
+      {
+        "Id": "d83f3cdf35c346bb955ffef4109381cc",
+        "Name": "CoordinateSystem.Rotate",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 767.0533966533327,
+        "Y": 433.65461316390656
+      },
+      {
+        "Id": "8ad6a2c820ea4c33acd85d6c6b9f7e42",
+        "Name": "CoordinateSystem.ByOrigin",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 296.5,
+        "Y": 322.58625
+      },
+      {
+        "Id": "600954f1336c496497b3d78c4274732e",
+        "Name": "Plane.YZ",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 296.5,
+        "Y": 470.58625
+      },
+      {
+        "Id": "233a9182edf24a9cb0e04918b22d5ea1",
+        "Name": "Code Block",
+        "IsSetAsInput": false,
+        "IsSetAsOutput": false,
+        "Excluded": false,
+        "ShowGeometry": true,
+        "X": 296.5,
+        "Y": 618.41374999999994
+      }
+    ],
+    "Annotations": [
+      {
+        "Id": "9fe06b88ed6b4cee9b66b0428de8c6f7",
+        "Title": "Coordinate System rotated around a base YZ plane set at the 0, 0, 0 insertion point by 135 degrees",
+        "DescriptionText": null,
+        "IsExpanded": true,
+        "WidthAdjustment": 0.0,
+        "HeightAdjustment": 0.0,
+        "Nodes": [],
+        "HasNestedGroups": false,
+        "Left": 789.85339665333277,
+        "Top": 368.85461316390666,
+        "Width": 0.0,
+        "Height": 0.0,
+        "FontSize": 36.0,
+        "GroupStyleId": "00000000-0000-0000-0000-000000000000",
+        "InitialTop": 0.0,
+        "InitialHeight": 0.0,
+        "TextblockHeight": 0.0,
+        "Background": "#FFC1D676",
+        "PinnedNode": "d83f3cdf35c346bb955ffef4109381cc"
+      }
+    ],
+    "X": -25.505249382378452,
+    "Y": -149.199263666317,
+    "Zoom": 0.85276592558149733
+  }
+}