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

TSpline Nodes Documentation - Second set #14550

Conversation

dariaivanciucova
Copy link
Contributor

@dariaivanciucova dariaivanciucova commented Nov 1, 2023

Purpose

A second batch of documentation help files for T-Spline nodes.
The In-Depth description follows this guidance.
This batch includes In-Depth, Example image, and .dyn files for the following 38 nodes:

TSplineInitialSymmetry

  • TSplineInitialSymmetry.ByAxial
  • TSplineInitialSymmetry.ByRadial
  • TSplineInitialSymmetry.IsRadial
  • TSplineInitialSymmetry.RadialSymmetryFaces
  • TSplineInitialSymmetry.XAxis
  • TSplineInitialSymmetry.YAxis
  • TSplineInitialSymmetry.ZAxis

TSplineReflection

  • TSplineReflection.ByAxial
  • TSplineReflection.ByRadial
  • TSplineReflection.Axis
  • TSplineReflection.IsRadial
  • TSplineReflection.Plane
  • TSplineReflection.SegmentAngle
  • TSplineReflection.SegmentsCount

TSplineSurface related to Reflection

  • TSplineSurface.Reflections
  • TSplineSurface.AddReflections
  • TSplineSurface.RemoveReflections

TSplineSurface Create

  • TSplineSurface.BuildFromLines
  • TSplineSurface.ByCombinedTSplineSurfaces
  • TSplineSurface.ByNurbsSurfaceCurvature In-Depth is copied from short description
  • TSplineSurface.ByNurbsSurfaceUniform In-Depth is copied from short description
  • TSplineSurface.ByRevolve
  • TSplineSurface.BySweep

TSplineSurface Action

  • TSplineSurface.BevelEdges
  • TSplineSurface.CreaseEdges
  • TSplineSurface.CreaseVertices
  • TSplineSurface.UncreaseVertices
  • TSplineSurface.UncreaseEdges
  • TSplineSurface.UnweldEdges
  • TSplineSurface.UnweldVertices
  • TSplineSurface.BridgeEdgesToEdges
  • TSplineSurface.BridgeEdgesToFaces
  • TSplineSurface.BridgeFacesToEdges
  • TSplineSurface.BridgeFacesToFaces
  • TSplineSurface.CompressIndexes
  • TSplineSurface.DeleteFaces
  • TSplineSurface.DeleteEdges
  • TSplineSurface.DeleteVertices

Example of In-Depth description:

image

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated
  • This PR contains no files larger than 50 MB

Release Notes

For these nodes, the short description is too long and can be moved into the In-Depth description section.

Reviewers

(FILL ME IN) Reviewer 1 (If possible, assign the Reviewer for the PR)

(FILL ME IN, optional) Any additional notes to reviewers or testers.

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

Copy link

github-actions bot commented Nov 1, 2023

Bin Diff Issue Resolved.
(♻️ Updated: 2024-02-01-03:51:28)

@dariaivanciucova dariaivanciucova marked this pull request as ready for review November 16, 2023 13:31
Copy link
Collaborator

@hwahlstrom hwahlstrom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with small fixes


For more information about adding documentation to nodes see https://github.com/DynamoDS/Dynamo/wiki/Create-and-Add-Custom-Documentation-to-Nodes
In the example below, Unweld operation is performed on row of edges of a TSpline surface. As a result, the vertices of selected edges are disjointed. Unlike Uncrease that creates a sharp transition around the edge while maintaining the connection, Unweld creates a discontinuity. This can be proven by comparing the number of vertices before and after the operation was performed. Any subsequent operations on unwelded edges or vertices will also demonstrate that the surface is disconnected along the unwelded edge.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"performed on a row of edges..."

@QilongTang QilongTang added this to the 3.1 milestone Dec 12, 2023
Copy link

github-actions bot commented Feb 1, 2024

UI Smoke Tests

Test: success. 2 passed, 0 failed.
TestComplete Test Result
Workflow Run: UI Smoke Tests
Check: UI Smoke Tests - net8.0

@QilongTang QilongTang merged commit 9136633 into DynamoDS:master Feb 1, 2024
20 of 21 checks passed
QilongTang pushed a commit that referenced this pull request Feb 6, 2024
* DYN-6535 DynamoRevit Improve Search Fix 2

The specific case "element set parameter" was failing on Revit 2025 (not finding anything), then I've modified the code so that check if the first term is a category if that is the case it will create a specific query using the first term as category and the next terms as node name.

* DYN-6535 DynamoRevit Improve Search Fix 2 Code Review

Updating Linq query so that is executed only once.

* Squashed commit of the following:

commit 3893c85
Author: Ashish Aggarwal <[email protected]>
Date:   Mon Feb 5 12:53:49 2024 -0500

    Fix retain package structure flow where nested directory at root level were lost (#14918)

    * optimize

    * comments and a test

    * add subdir test and comments

    * add child test

    * test updates

commit d0bd96e
Author: Aaron (Qilong) <[email protected]>
Date:   Fri Feb 2 15:56:03 2024 -0500

    Fix API breaking changes (#14916)

    * Fix API breaking changes

    * Update OpenFileCommand

    * update

commit 8f123fe
Author: Daria Ivanciucova <[email protected]>
Date:   Fri Feb 2 03:20:48 2024 +0000

    TSpline rename hashed nodes  (#14921)

    * renamed 2 nodes

    TSplineSurface.BySphereCenterPointRadius
    TSplineSurface.ByCylinderPointsRadiu

    * TSplineSurface.ByPlaneOriginNormal

    * TSplineSurface.ByQuadballCenterRadius

    * TSplineSurface.BySphereFourPoints

    * TSplineSurface.ByPlaneOriginNormalXAxis

    * TSplineSurface.ByPlaneOriginXAxisYAxis

    * TSplineVertex.FunctionalValence

    * TSplineSurface.ByConeCoordinateSystemHeightRadii

    * TSplineSurface.ByPlaneBestFitThroughPoints

    * TSplineSurface.ByPlaneLineAndPoint

    * TSplineSurface.ByPlaneThreePoints

    * TSplineSurface.ByTorusCenterRadii

    * TSplineSurface.ByTorusCoordinateSystemRadii

    * TSplineTopology.TPointVertices

    * TSplineSurface.AddReflections

    * TSplineSurface.DeleteVertices

    * TSplineSurface.CompressIndices

    * TSplineSurface.RemoveReflections

    * TSplineSurface.ByNurbsSurfaceUniform

    * TSplineSurface.UnweldVertices

    * TSplineSurface.BridgeFacesToEdges

    * TSplineReflection.SegmentsCount

    * TSplineSurface.ByNurbsSurfaceCurvature

    * TSplineSurface.BridgeEdgesToFaces

    * TSplineInitialSymmetry.IsRadial; TSplineInitialSymmetry.RadialSymmetryFaces

    * TSplineReflection.SegmentsAngle

    * .TSplineSurface.BridgeFacesToFaces

    * TSplineSurface.BridgeEdgesToEdges

    * TSplineInitialSymmetry.ByRadial

    * SplineSurface.ByCombinedTSplineSurfaces

    * TSplineSurface.UncreaseVertices

    * BuildFromLines

    * TSplineSurface.CreaseVertice

    * TSplineTopology.RegularVertices

    * TSplineTopology.VertexByIndex

    * TSplineSurface.DeserializeFromTSM

    * TSplineSurface.SerializeAsTSM

    * TSplineTopology.BorderVertices

    * TSplineSurface.EnableSmoothMode

    * TSplineTopology.NonManifoldVertices

    * TSplineTopology.VerticesCoun

    * TSplineSurface.DuplicateFaces

    * TSplineSurface.ExtrudeEdgesAlongCurve

    * TSplineTopology.StarPointVertices

    * TSplineTopology.NonManifoldEdges

    * TSplineSurface.WeldCoincidentVertices

    * TSplineSurface.SubdivideFaces

    * TSplineSurface.ExtrudeFacesAlongCurve

    * TSplineSurface.ByConeCoordinateSystemHeightRadius

    * TSplineSurface.ByCylinderRadiusHeight

commit 2bb51dc
Author: Daria Ivanciucova <[email protected]>
Date:   Thu Feb 1 17:43:53 2024 +0000

    TSpline Nodes Documentation - Third set (#14598)

    * FillHole, IsClosed, IsInBoxMode

    * BorderFaces, BorderEdges, BorderVertices, DuplicateFaces

    * EnableSmoothMode, ExportToTSS, ExportToTSM

    * ImportFromTSM (2)

    * ImportFromTSS(2)

    * ExtrudeFaces, Interpolate, SubdivideFaces, FlattenVertices (2)

    * IsStandard, Standardize, Thicken (2)

    * Decomposed (3), EdgeByIndex, EdgeCount, InnerEdges, InnerFaces, InnerVertices, NGonFaces, NonManifoldEdges, NonManifoldVertices

    * RegularFaces, RegularVertices, StarPoints, TPoints

    * Repair, Serialize, Deserialize

    * ExtrudeEdges, ExtrudeEdgesAlongCurve, ExtrudeFacesAlongCurve

    * FlipNormals, IsExtractable

    * MoveVertices, FaceByIndex, VertexByIndex

    * Is Watertight, FacesCount, VerticesCount, SlideEdges, MergeEdges, WeldCoincidentVertices, WeldVertices(2)

    * ToBrep, ToMesh

    * Update WSNXB54TDQEZRTUNRFCTUDK74DHVPQPXBXEYJUZJPW6T2F7XERDQ.md

    * CreateMatch (2), PullVertices

    * MakeUniform

    * updated to better method for highlighting edges

    * spell check

    * Update 6ICXLN4V6DNK5KMYTY5LPCJBE27IRW5VOBKCCVFQGO3HST752ZNQ.md

    * added TSM, TSS files, typos

    * Helena's comments

    ---------

    Co-authored-by: Deyan Nenov <[email protected]>
    Co-authored-by: Aaron (Qilong) <[email protected]>

commit 9136633
Author: Daria Ivanciucova <[email protected]>
Date:   Thu Feb 1 16:59:41 2024 +0000

    TSpline Nodes Documentation - Second set (#14550)

    * TSplineInitialSymmetry nodes

    * TSplineReflection nodes documentation

    * two more Reflections nodes

    * 7 more nodes

    - Bevel Edges
    - Crease Edges
    - Crease Vertices
    - Uncrease Edges
    - Uncrease Vertices
    - Unweld Edges
    - Unweld Vertices

    * ByNurbs and ByCombinedSurfaces

    - ByNurbsSurfaceCurvature
    -ByNurbsSurfaceUniform
    - ByCombinedTSplineSurfaces

    * 4 Bridge nodes

    * Compress Indexes, BySweep, ByRevolve, BuildFromLines

    * DeleteEdges, DeleteFaces, DeleteVertices

    * Update Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.BridgeEdgesToEdges.md

    * Update Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.BridgeEdgesToFaces.md

    * Update Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.BridgeFacesToEdges.md

    * Update Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.BridgeFacesToFaces.md

    * Update Autodesk.DesignScript.Geometry.TSpline.TSplineSurface.BuildFromLines.md

    * added missing TSplineSurface.Reflections node

    * Helena's comments

    ---------

    Co-authored-by: Deyan Nenov <[email protected]>
    Co-authored-by: Aaron (Qilong) <[email protected]>

commit 99cf281
Author: Deyan Nenov <[email protected]>
Date:   Thu Feb 1 16:58:27 2024 +0000

    binding issues resolved (#14682)

    - fixed null exception when trying to assign click handler on a context menu button when the parent button
    - also fixed another incorrect binding issue

commit d2e57b5
Author: Daria Ivanciucova <[email protected]>
Date:   Thu Feb 1 15:58:29 2024 +0000

    TSpline Nodes Documentation - First set (#14549)

    * TSEdge and TSFace nodes documentation

    * TSpline Vertex nodes documentation

    * TSpline.UVNFrame nodes documentation

    * Update Autodesk.DesignScript.Geometry.TSpline.TSplineVertex.IsStarPoint.md

    * TSpline Box docs

    * TSplineSurface.ByPlane nodes docs

    * TSplineSurface.ByCone docs

    * TSplineSurface - Cylinder docs

    * TSplineSurface.ByQuadball nodes

    * replaced with renamed files for ByBox nodes

    * BySphere nodes

    * TSplineSurface.ByTorus nodes

    * BuildPipes and ByExtrude

    * Update Autodesk.DesignScript.Geometry.TSpline.TSplineVertex.Index.md

    * corrected the description for Torus nodes

    * Helena's comments

    ---------

    Co-authored-by: Deyan Nenov <[email protected]>
    Co-authored-by: Aaron (Qilong) <[email protected]>

* Revert "Squashed commit of the following:"

This reverts commit c182c1b.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants