Skip to content

Commit

Permalink
Add NodeHelpDocs in repo (#12684)
Browse files Browse the repository at this point in the history
  • Loading branch information
QilongTang authored Mar 10, 2022
1 parent 7a54503 commit d5f98ce
Show file tree
Hide file tree
Showing 1,422 changed files with 5,314 additions and 1 deletion.
5 changes: 5 additions & 0 deletions doc/distrib/NodeHelpFiles/Analysis.Label.ByPointAndString.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## ByPointAndString - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

For more information about adding documentation to nodes see https://github.com/DynamoDS/Dynamo/wiki/Create-and-Add-Custom-Documentation-to-Nodes

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![ByBestFitThroughPoints](./Autodesk.DesignScript.Geometry.Arc.ByBestFitThroughPoints_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Arc ByCenterPointRadiusAngle draws an arc relative to its center and normal direction. By entering the start and end angle, you are essentially drawing a portion of a circle. In this example, a random point is generated on the XY plane and an arc is constructed around it.
___
## Example File

![ByCenterPointRadiusAngle](./Autodesk.DesignScript.Geometry.Arc.ByCenterPointRadiusAngle_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Arc ByCenterPointStartPointEndPoint draws a best-fit arc around a specified Center. The arc will always begin at the Start Point and end at the closest point possible to the given End Point. This example demonstrates this property by randomly feeding the node three random points for the center, start and end point.
___
## Example File

![ByCenterPointStartPointEndPoint](./Autodesk.DesignScript.Geometry.Arc.ByCenterPointStartPointEndPoint_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
The Arc ByCenterPointStartPointSweepAngle creates an arc around a Center Point with a given Sweep Angle. The Start Point tells Dynamo where to begin drawing the arc. This example draws an arc around a randomly generated point.
___
## Example File

![ByCenterPointStartPointSweepAngle](./Autodesk.DesignScript.Geometry.Arc.ByCenterPointStartPointSweepAngle_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Arc ByFillet draws a portion of a tangential circle along two input curves. In this example, two intersecting lines are drawn and then filleted at a controlled radius.
___
## Example File

![ByFillet](./Autodesk.DesignScript.Geometry.Arc.ByFillet_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Arc ByFilletTangentToCurve draws the best fit arc that is tangent to three input curves. In this example, we are using two input lines as reference curves and a circle for the arc to be tangent to.
___
## Example File

![ByFilletTangentToCurve](./Autodesk.DesignScript.Geometry.Arc.ByFilletTangentToCurve_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
The Arc ByStartEndAndTangencies Action creates a compound arc using two Input Points and their corresponding Vectors. In this example, two points are connected by a compound arc that is always tangent to the Y-Axis at its Start and End Points.
___
## Example File

![ByStartEndAndTangencies](./Autodesk.DesignScript.Geometry.Arc.ByStartEndAndTangencies_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Arc ByStartPointEndPointStartTangent draws an arc from two specified points and any given start vector. This example draws an arc from two random points that is always tangent to the X-Axis.
___
## Example File

![ByStartPointEndPointStartTangent](./Autodesk.DesignScript.Geometry.Arc.ByStartPointEndPointStartTangent_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![ByThreePoints](./Autodesk.DesignScript.Geometry.Arc.ByThreePoints_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![CenterPoint](./Autodesk.DesignScript.Geometry.Arc.CenterPoint_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![Radius](./Autodesk.DesignScript.Geometry.Arc.Radius_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Start Angle finds the starting angle of the ellipse arc. This is measured in degrees counter-clockwise starting from the plane X-axis. In the example, we first create an Ellipse Arc by using the XY plane and a series of number sliders. We then use Start Angle to extract the angle of the beginning pont of the ellipse.
___
## Example File

![StartAngle](./Autodesk.DesignScript.Geometry.Arc.StartAngle_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Sweep Angle finds the starting angle of the ellipse arc. This is measured in degrees counter-clockwise on the ellipse plane, starting from the start angle. The end angle of the ellipse would be equal to the start angle plus the sweep angle. In the example, we first create an Ellipse Arc by using the XY plane and a series of number sliders. We then use Sweep Angle to extract arc length of the ellipse arc.
___
## Example File

![SweepAngle](./Autodesk.DesignScript.Geometry.Arc.SweepAngle_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![ByCorners](./Autodesk.DesignScript.Geometry.BoundingBox.ByCorners_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![ByGeometry](./Autodesk.DesignScript.Geometry.BoundingBox.ByGeometry_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Bounding Box Contains tests if a specified Point is inside of a Bounding Box. Because the Point in this example is at (5,5,5), and our Origin Sphere’s Radius is larger than 5, the Contains node will return True.
___
## Example File

![Contains](./Autodesk.DesignScript.Geometry.BoundingBox.Contains_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Bounding Box Intersection solves for the Intersection for two Bounding Boxes and returns the overlapping Bounding Box. This example uses two cones to demonstrate the use of this node. In order to visualize the Box we are converting it to a Cuboid.
___
## Example File

![Intersection](./Autodesk.DesignScript.Geometry.BoundingBox.Intersection_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Bounding Box Intersects tests two bounding boxes for overlap. If the boxes intersect, the node will return True, otherwise it will return False. This example tests for an intersection between the Bounding Boxes of two input Cones.
___
## Example File

![Intersects](./Autodesk.DesignScript.Geometry.BoundingBox.Intersects_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
IsEmpty will return a boolean value based on whether the Bounding Box is empty or not.
___
## Example File

![IsEmpty](./Autodesk.DesignScript.Geometry.BoundingBox.IsEmpty_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Bounding Box MaxPoint returns the point that has the largest X, Y and Z values. This example shows a Bounding Box MaxPoint of a Sphere.
___
## Example File

![MaxPoint](./Autodesk.DesignScript.Geometry.BoundingBox.MaxPoint_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Bounding Box MinPoint returns the point that has the smallest X, Y and Z values. This example shows a Bounding Box MinPoint of a Sphere.
___
## Example File

![MinPoint](./Autodesk.DesignScript.Geometry.BoundingBox.MinPoint_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Bounding Box ToCuboid creates a Cuboid geometry from a Bounding Box. In order to visualize the relationship of the input Sphere to the Cuboid in the example, we are extracting its edge curves.
___
## Example File

![ToCuboid](./Autodesk.DesignScript.Geometry.BoundingBox.ToCuboid_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
ToPolySurface will return a bounding box as a PolySurface. In the example below, the bounding box of several unioned spheres is returned as a PolySurface. The resulting PolySurface is displayed with a color and transparency to show the original geometry inside.
___
## Example File

![ToPolySurface](./Autodesk.DesignScript.Geometry.BoundingBox.ToPolySurface_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![ByBestFitThroughPoints](./Autodesk.DesignScript.Geometry.Circle.ByBestFitThroughPoints_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![ByCenterPointRadius](./Autodesk.DesignScript.Geometry.Circle.ByCenterPointRadius_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Circle By Center Point Radius Normal creates a circle at a point with a controllable radius and normal. In this example, we create a vector from the Origin Point to the Point By Coordinates to control the direction of the circle.
___
## Example File

![ByCenterPointRadiusNormal](./Autodesk.DesignScript.Geometry.Circle.ByCenterPointRadiusNormal_img.jpg)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Circle By Plane Radius is a condensed node to create any type of circle. In this example, we use the YZ plane to determine the circle direction, and a Number slider to dynamically control the circle’s radius.
___
## Example File

![ByPlaneRadius](./Autodesk.DesignScript.Geometry.Circle.ByPlaneRadius_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![ByThreePoints](./Autodesk.DesignScript.Geometry.Circle.ByThreePoints_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![CenterPoint](./Autodesk.DesignScript.Geometry.Circle.CenterPoint_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 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.
___
## Example File

![Radius](./Autodesk.DesignScript.Geometry.Circle.Radius_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Cone ByCoordinateSystemHeightRadii creates a truncated Cone geometry from two Radii, the starting Origin, and a Height value. This example shows a dynamic Cone around the World Origin, constructed with three Number Sliders.
___
## Example File

![ByCoordinateSystemHeightRadii](./Autodesk.DesignScript.Geometry.Cone.ByCoordinateSystemHeightRadii_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Cone ByCoordinateSystemHeightRadius creates a Cone geometry from a Radius, the Cone Origin, and a Height value. This example shows a dynamic Cone around the World Origin, constructed with two Number Sliders.
___
## Example File

![ByCoordinateSystemHeightRadius](./Autodesk.DesignScript.Geometry.Cone.ByCoordinateSystemHeightRadius_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Cone ByPointsRadii creates a truncated Cone geometry from a Start Point, End Point, and two Radius values. This example shows a dynamic Cone around the World Origin, constructed with three Number Sliders controlling its Height and Radius sizes.
___
## Example File

![ByPointsRadii](./Autodesk.DesignScript.Geometry.Cone.ByPointsRadii_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
ByPointsRadius will return a Cylinder from a start Point, end Point, and radius value. In the example below, adjusting the number sliders will change the point positions as well as the Cylinder's radius.
___
## Example File

![ByPointsRadius](./Autodesk.DesignScript.Geometry.Cone.ByPointsRadius_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
End Point will return the end point of an input curve. In the example below, we first create a Nurbs Curve using a ByControlPoints node, with a set of randomly generated points as the input. We can find the end point of this curve by using an EndPoint node.
___
## Example File

![EndPoint](./Autodesk.DesignScript.Geometry.Cone.EndPoint_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
End Radius will find the radius of the top circle of a truncated cone. In the example below, we create a cone by specifying a start and end point, as well as a start and end radius. We can then extract the End Radius back from the cone.
___
## Example File

![EndRadius](./Autodesk.DesignScript.Geometry.Cone.EndRadius_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Text note height is returned as a double. The height value is relative to the view scale.
___
## Example File

![Height](./Autodesk.DesignScript.Geometry.Cone.Height_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Radius Ratio will find the ratio between the top and bottom radii of the cone. This is equivalent to taking the top radius and dividing it by the bottom radius. In the example below, we create a cone by specifying a start and end point, as well as a start and end radius. We can then extract the Radius Ratio from the cone.
___
## Example File

![RadiusRatio](./Autodesk.DesignScript.Geometry.Cone.RadiusRatio_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Start Point will return the start point of an input curve. In the example below, we first create a Nurbs Curve using a ByControlPoints node, with a set of randomly generated points as the input. We can find the start point of this curve by using a StartPoint node.
___
## Example File

![StartPoint](./Autodesk.DesignScript.Geometry.Cone.StartPoint_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Start Radius will find the radius of the base circle of a cone. In the example below, we create a cone by specifying a start and end point, as well as a start and end radius. We can then extract the Start Radius back from the cone.
___
## Example File

![StartRadius](./Autodesk.DesignScript.Geometry.Cone.StartRadius_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
The Point By Cylindrical Coordinates node creates a point located within a cylindrical space. Here, we set the lacing to Cross-Reference and use a range of angles and elevations to generate a grid of points along a cylinder with a dynamic radius.
___
## Example File

![ByCylindricalCoordinates](./Autodesk.DesignScript.Geometry.CoordinateSystem.ByCylindricalCoordinates_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
ByOrigin (origin) will return a new CoordinateSystem with it's origin at the input Point. In the example below, a new CoordinateSystem is created with its origin at (4,4,0).
___
## Example File

![ByOrigin (origin)](./Autodesk.DesignScript.Geometry.CoordinateSystem.ByOrigin(origin)_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
ByOrigin (x, y) will return a new CoordinateSystem with the X and Y values of its origin as inputs. In the example below, a new CoordinateSystem is created with it's origin at (4,2,0) from inputs 4 and 2 into X and Y respectively.
___
## Example File

![ByOrigin (x, y)](./Autodesk.DesignScript.Geometry.CoordinateSystem.ByOrigin(x,%20y)_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
ByOrigin (x, y, z) will return a new CoordinateSystem with the X, Y, and Z values of its origin as the node's inputs. In the example below, a new CoordinateSystem is created with it's origin at (4,2,1) from inputs 4, 2, and 1 into X, Y, and Z respectively.
___
## Example File

![ByOrigin (x, y, z)](./Autodesk.DesignScript.Geometry.CoordinateSystem.ByOrigin(x,%20y,%20z)_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
ByOriginVectors (origin, xAxis, yAxis) will return a new CoordinateSystem at an input origin point with input X and Y axes. In the example below, the CoordinateSystem is placed at an origin with new vectors for the X and Y axes. The result is a CoordinateSystem rotated relative to the original CoordinateSystem.
___
## Example File

![ByOriginVectors (origin, xAxis, yAxis)](./Autodesk.DesignScript.Geometry.CoordinateSystem.ByOriginVectors(origin,%20xAxis,%20yAxis)_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Add in-depth information about ByOriginVectors (origin, xAxis, yAxis, zAxis)...
___
## Example File

![ByOriginVectors (origin, xAxis, yAxis, zAxis)](./Autodesk.DesignScript.Geometry.CoordinateSystem.ByOriginVectors(origin,%20xAxis,%20yAxis,%20zAxis)_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Sketch planes are used in the creation of 2D and 3D geometry in Revit.
___
## Example File

![ByPlane](./Autodesk.DesignScript.Geometry.CoordinateSystem.ByPlane_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
The Point By Spherical Coordinates node creates a point located within a spherical space. Here, we set the lacing to Cross-Reference and use a range of phi and theta angles to generate a grid of points along a cylinder with a dynamic radius. The location of the sphere is set to a Coordinate System with the origin (1, 5, 1).
___
## Example File

![BySphericalCoordinates](./Autodesk.DesignScript.Geometry.CoordinateSystem.BySphericalCoordinates_img.jpg)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## In Depth
Obtain the Determinant of this CoordinateSystem.
___
## Example File

![Determinant](./Autodesk.DesignScript.Geometry.CoordinateSystem.Determinant_img.jpg)

Loading

0 comments on commit d5f98ce

Please sign in to comment.