Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry-Pick DYN-5791 Applying Renaming Tool (#14844) #14869

Merged
merged 1 commit into from
Jan 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!--- Autodesk.DesignScript.Geometry.NurbsSurface.ByControlPointsWeightsKnots --->
<!--- 2SAWXHRQ333U2VRTKOVHZ2L5U6OPIQ2DHLI3MRGJWLXPMDUKVQZA --->
## In Depth
Creates a NurbsSurface with specified control vertices, knots, weights, and U V degrees. There are several restrictions on the data which, if broken, will cause the function to fail and will throw an exception. Degree: Both u- and v- degree should be >= 1 (piecewise-linear spline) and less than 26 (the maximum B-spline basis degree supported by ASM). Weights: All weight values (if supplied) should be strictly positive. Weights smaller than 1e-11 will be rejected and the function will fail. Knots: Both knot vectors should be non-decreasing sequences. Interior knot multiplicity should be no larger than degree + 1 at the start/end knot and degree at an internal knot (this allows surfaces with G1 discontinuities to be represented). Note that non-clamped knot vectors are supported, but will be converted to clamped ones, with the corresponding changes applied to the control point/weight data.
Creates a NurbsSurface with specified control vertices, knots, weights, and U V degrees. There are several restrictions on the data which, if broken, will cause the function to fail and will throw an exception. Degree: Both u- and v- degree should be >= 1 (piecewise-linear spline) and less than 26 (the maximum B-spline basis degree supported by ASM). Weights: All weight values (if supplied) should be strictly positive. Weights smaller than 1e-11 will be rejected and the function will fail. Knots: Both knot vectors should be non-decreasing sequences. Interior knot multiplicity should be no larger than degree plus 1 at the start/end knot and degree at an internal knot (this allows surfaces with G1 discontinuities to be represented). Note that non-clamped knot vectors are supported, but will be converted to clamped ones, with the corresponding changes applied to the control point/weight data.
___
## Example File

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.Thicken(distance, softEdges) --->
<!--- 2ULSD2KOLBO3IDZALZJCIBZDTDFEHC5YE6E5LZW5YR2P3X36HORQ --->
## Thicken(distance, softEdges) - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<!--- Autodesk.DesignScript.Geometry.Curve.ExtrudeAsSolid(curve, direction) --->
<!--- 32PIZL43K2RTMXYNALUOXTTTTLRY2XQHUK22D2A7KI7NAA5JTXBA --->
## In Depth
`Curve.ExtrudeAsSolid (curve, direction)` extrudes an input closed, planar curve using an input vector to determine the direction of the extrusion. The length of the vector is used for the extrusion distance. This node caps the ends of the extrusion to create a solid.

In the example below, we first create a NurbsCurve by using a `NurbsCurve.ByPoints` node, with a set of randomly generated points as the input. A code block is used to specify the X, Y, and Z components of a `Vector.ByCoordinates` node. This vector is then used as the direction input in an `Curve.ExtrudeAsSolid` node.
___
## Example File

![Curve.ExtrudeAsSolid(curve, direction)](./Autodesk.DesignScript.Geometry.Curve.ExtrudeAsSolid(curve,%20direction)_img.jpg)
![Curve.ExtrudeAsSolid(curve, direction)](./32PIZL43K2RTMXYNALUOXTTTTLRY2XQHUK22D2A7KI7NAA5JTXBA_img.jpg)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineTopology.RegularVertices --->
<!--- 3FD66JH7OUVHRJOXDSO6GCVCZV63VG7PUZEMJMDZBM67ASM2XLRA --->
## RegularVertices - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineTopology.TPointVertices --->
<!--- 3JL6REDTXILJYKG3YL47NDNEA5YHNLEAYOO3JNMRUUBMWI4GDGHA --->
## TPointVertices - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!--- Autodesk.DesignScript.Geometry.CoordinateSystem.Rotate(origin, axis, degrees) --->
<!--- 3JO6UW566EG3MSCU25AGJTTDKZSMAZZO7D4VC5APLFDZVUEMPDSA --->
## In Depth
Rotates a coordinate system around an origin and an axis by a specified degree.
___
## Example File

![Rotate (origin, axis, degrees)](./3JO6UW566EG3MSCU25AGJTTDKZSMAZZO7D4VC5APLFDZVUEMPDSA_img.jpg)

Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.BySphereCenterPointRadius --->
<!--- 3W2XHZKQEZFB7P3OTUVOZUMCD3M7PKUFQZI42URWMPFARFIN2NVQ --->
## BySphereCenterPointRadius - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ CoordinateSystem.Transform will transform the given Coordinate System from a sou
___
## Example File

![CoordinateSystem.Transform](./Autodesk.DesignScript.Geometry.CoordinateSystem.Transform(CS,%20fromCS,%20contextCS)_img.png)
![CoordinateSystem.Transform](./43XHCR2GSF5A34R3G2P7OGOWDWYKS3WCXART33FSES5M5ZF2MHJA_img.jpg)
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!--- Autodesk.DesignScript.Geometry.Surface.Thicken(thickness, both_sides) --->
<!--- 4FFK6PGYCVKERZWXQC6TEBOQTHVXXN3QLAX5MTLXGZEAB4KH4WEQ --->
## In Depth
Thicken Surface into a Solid, extruding in the direction of Surface normals. If both_sides parameter is true, surface is thickened on both sides.
___
## Example File

![Thicken (thickness, both_sides)](./4FFK6PGYCVKERZWXQC6TEBOQTHVXXN3QLAX5MTLXGZEAB4KH4WEQ_img.jpg)

Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<!--- Autodesk.DesignScript.Geometry.Curve.NormalAtParameter(curve, param) --->
<!--- 5EEABYHH2K4RVCNKX3VDCP7ZRLFAMGC7UDSBANQMVEBFNNE3SPYQ --->
## In Depth
`Curve.NormalAtParameter (curve, param)` returns a vector aligned with the normal direction at the specified parameter of a curve. The parameterization of a curve is measured in the range from 0 to 1, with 0 representing the start of the curve and 1 representing the end of the curve.

In the example below, we first create a NurbsCurve using a `NurbsCurve.ByControlPoints` node, with a set of randomly generated points as the input. A number slider set to the range 0 to 1 is used to control the `parameter` input for a `Curve.NormalAtParameter` node.
___
## Example File

![Curve.NormalAtParameter(curve, param](./Autodesk.DesignScript.Geometry.Curve.NormalAtParameter(curve,%20param)_img.jpg)
![Curve.NormalAtParameter(curve, param](./5EEABYHH2K4RVCNKX3VDCP7ZRLFAMGC7UDSBANQMVEBFNNE3SPYQ_img.jpg)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.Surface.Thicken(surface, thickness, both_sides) --->
<!--- 5HLUQKT3UZOAWPJMHUXPRYXIG5HOMTLY5RMTZVDGAABIO5MZ3OVQ --->
## In Depth
`Surface.Thicken (surface, thickness, both_sides)` creates a solid by offsetting a surface according to the `thickness` input and by capping the ends to close the solid. This node has an extra input to specify whether or not to thicken on both sides. The `both_sides` input takes a Boolean value: True to thicken on both sides, and False to thicken on one side. Note that the `thickness` parameter determines the total thickness of the final solid, so if `both_sides` is set to True, the result will be offset from the original surface by half the input thickness on both sides.

Expand All @@ -6,4 +8,4 @@ In the example below, we first create a surface by using a `Surface.BySweep2Rail
___
## Example File

![Surface.Thicken](./Autodesk.DesignScript.Geometry.Surface.Thicken(surface,%20thickness,%20both_sides)_img.jpg)
![Surface.Thicken](./5HLUQKT3UZOAWPJMHUXPRYXIG5HOMTLY5RMTZVDGAABIO5MZ3OVQ_img.jpg)
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ Scale the coordinate system non-uniformly around the origin.
___
## Example File

![Scale (xamount, yamount, zamount)](./Autodesk.DesignScript.Geometry.CoordinateSystem.Scale(xamount,%20yamount,%20zamount)_img.jpg)
![Scale (xamount, yamount, zamount)](./5IXBOJ4T7DGQ4FYV7OJBRP77VS7URLKC6BUG7AUFBR6QSPUYOFIA_img.jpg)

Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<!--- Autodesk.DesignScript.Geometry.Curve.Extrude(curve, direction, distance) --->
<!--- 5NB3FDYBJDTGURCB4X7W2I7P2TIGXAXPEUVWUMM2BTWHJ3GXRJQA --->
## In Depth
`Curve.Extrude (curve, direction, distance)` extrudes an input curve using an input vector to determine the direction of the extrusion. A separate `distance` input is used for the extrusion distance.

In the example below, we first create a NurbsCurve using a `NurbsCurve.ByControlPoints` node, with a set of randomly generated points as the input. A code block is used to specify the X, Y, and Z components of a `Vector.ByCoordinates` node. This vector is then used as the direction input in an `Curve.Extrude` node while a `number slider` is used to control the `distance` input.
___
## Example File

![Curve.Extrude(curve, direction, distance)](./Autodesk.DesignScript.Geometry.Curve.Extrude(curve,%20direction,%20distance)_img.jpg)
![Curve.Extrude(curve, direction, distance)](./5NB3FDYBJDTGURCB4X7W2I7P2TIGXAXPEUVWUMM2BTWHJ3GXRJQA_img.jpg)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.Surface.ToNurbsSurface(surface, limitSurface) --->
<!--- 62R7TNV2KCZCI3DMDQF7KVWE5WHQRXUHIVL625TVQLCENC23EMBA --->
## In Depth
`Surface.ToNurbsSurface` takes a surface as input and returns a NurbsSurface that approximates the input surface. The `limitSurface` input determines if the surface should be restored to its original parameter range before conversion, for example, when the parameter range of a surface is limited is after a Trim operation.

Expand All @@ -7,4 +9,4 @@ In the example below, we create a surface using a `Surface.ByPatch` node with a
___
## Example File

![Surface.ToNurbsSurface](./Autodesk.DesignScript.Geometry.Surface.ToNurbsSurface(surface,%20limitSurface)_img.jpg)
![Surface.ToNurbsSurface](./62R7TNV2KCZCI3DMDQF7KVWE5WHQRXUHIVL625TVQLCENC23EMBA_img.jpg)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.AddReflections --->
<!--- 6YGBDRGYLRW3BW4XJHLHBBRSCHYWA2UCJ5FQAESHDY2HMUBDUSLQ --->
## AddReflections - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<!--- Autodesk.DesignScript.Geometry.PolyCurve.ByGroupedCurves(curves, joinTolerance, trimCurves, trimLength) --->
<!--- 6Z5ORNUUOKVQFG6ZBYHMWKQR457NCZXFTI27PNFF3MSQGVPTVZ2A --->
## In Depth
`PolyCurve.ByGroupedCurves` creates a new PolyCurve by grouping multiple connected curves. It groups curves based on their proximity to other curves, either touching or within a given join tolerance, to connect them into a single PolyCurve.

In the example below, a pentagon is exploded and its curves are randomized. `PolyCurve.ByGroupedCurves` is then used to group them into a PolyCurve.
___
## Example File

![PolyCurve.ByGroupedCurves](./Autodesk.DesignScript.Geometry.PolyCurve.ByGroupedCurves(curves,%20joinTolerance,%20trimCurves,%20trimLength)_img.jpg)
![PolyCurve.ByGroupedCurves](./6Z5ORNUUOKVQFG6ZBYHMWKQR457NCZXFTI27PNFF3MSQGVPTVZ2A_img.jpg)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.DeleteVertices --->
<!--- 76IVI422OMRMPHCWZHTETSZ3PJF22AOV2AX274LZCNLPCK664PGQ --->
## DeleteVertices - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineTopology.DecomposedEdges --->
<!--- 7LMFKLQNCV53W7KLS5QWD3E27NGGA33QPHSXMUGH323WVXWJY3GQ --->
## DecomposedEdges - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineTopology.VertexByIndex --->
<!--- 7LRWGLADXMQPJN33WBBRTYBBK4NO6FQADRQICYVBDCTWPJ3FOONQ --->
## VertexByIndex - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.CompressIndexes --->
<!--- ARIV6OQ22ACATWAIKGM7OHNEJS2TQUOKUSEU6UNX6EAAVSJIMK3A --->
## CompressIndexes - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.CoordinateSystem.Rotate(coordinateSystem, origin, axis, degrees) --->
<!--- AUJIYC7MERJPYMO5VHIFF7FPJD5YMEBOHOMWKROVKZCF66ZIBZ2A --->
## In Depth
`CoordinateSystem.Rotate (coordinateSystem, origin, axis, degrees)` returns a new CoordinateSystem rotated about an origin and vector.

Expand All @@ -6,4 +8,4 @@ In the example below, a CoordinateSystem is rotated about an origin point at (2,
___
## Example File

![CoordinateSystem.Rotate(coordinateSystem, origin, axis, degrees)](./Autodesk.DesignScript.Geometry.CoordinateSystem.Rotate(coordinateSystem,%20origin,%20axis,%20degrees)_img.jpg)
![CoordinateSystem.Rotate(coordinateSystem, origin, axis, degrees)](./AUJIYC7MERJPYMO5VHIFF7FPJD5YMEBOHOMWKROVKZCF66ZIBZ2A_img.jpg)
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!--- Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.ByCylinderPointsRadius --->
<!--- AUSALFCUDD62GV5ALRNIDJ43LBF3FWW5HY5WNAQBKRB7E2JF7WUQ --->
## ByCylinderPointsRadius - Documentation
This documentation file is auto generated by NodeDocumentationMarkdownGenerator, Version=2.14.0.3986, Culture=neutral, PublicKeyToken=null.

Expand Down
Loading
Loading