Dynamo Visual Programming Platform

The NodeDocumentationGenerator is a CLI tool designed to generate markdown documentation stubs for Dynamo nodes. It can create files containing default content or content extracted from the DynamoDictionary.

High-level Commands

• Create Documentation From Directory: Generates documentation for DLLs and DYF files found in a specified input directory.
• Create Documentation From Package: Uses the pkg.json file of a package to identify node libraries and generate documentation for those DLLs and any DYF files in the /dyf folder.
• Rename Documentation Package: Shortens long documentation filenames (and their associated support files) to prevent issues with CI/CD or installers. The original name is preserved as a comment within the new MD file for searchability.

The extern/Autodesk/Artifakt-Element-Font/ directory contains the .otf (Open Type Format) files for the Autodesk Artifakt-Element font used within Dynamo.

Important Licensing Note: These fonts are not licensed under Apache 2.0. They are subject to specific Autodesk license terms. You should not use these fonts in your own projects without obtaining explicit permission. Please review the license.txt file in the same directory before any use.

Use NurbsCurve.PeriodicKnots when exporting a closed NURBS curve to external CAD systems (such as Alias) that require the curve in its periodic form for round-trip accuracy.

While NurbsCurve.Knots returns the knot vector in its clamped form (where knots repeat at the start and end to pin the curve to the parameter range), NurbsCurve.PeriodicKnots returns the knot vector in its periodic (unclamped) form. In the periodic form, the knot spacing repeats at the start and end to define a smooth closed loop. Both methods return arrays of the same length, but the values within the arrays will differ to represent the different mathematical descriptions of the same curve.

The BasePlane method returns the plane of a planar PolyCurve.

Constraints and Errors:

• The PolyCurve must be planar.
• If the curve is not planar (i.e., its points do not all lie on a single plane), the method will return an error.

The % node is the modulo operator. It calculates the remainder of the first input (x) after it is divided by the second input (y).

In a visual programming context, you can control the inputs to this operator using nodes like number sliders to observe how the remainder changes based on the divisor.

The AngleAboutAxis method calculates the angle measurement between two Vector objects in degrees, ranging from 0 to 360, relative to a specified axis of rotation.

In typical usage, you provide two vectors and an axis (for example, the Z axis). The resulting value represents the angular displacement between the vectors when rotated around that axis.

The PlaneDeviation node calculates how much a polygon deviates from a flat surface. It works by first determining the best-fit plane through all the points of the provided polygon, and then computing the distance from each individual point to that plane. The result is the maximum distance (deviation) found among all points.

To use this for testing non-planar geometry, you can generate a set of points using cylindrical coordinates with randomized angles, elevations, and radii, create a polygon from those points using Polygon By Points, and then pass that polygon into PlaneDeviation.