@metamesh/modeling 0.18.0 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +33 -0
- package/README.md +73 -57
- package/dist/api/engine.d.ts +7 -47
- package/dist/api/export-3mf.d.ts +2 -0
- package/dist/api/export-glb.d.ts +2 -0
- package/dist/api/export-stl.d.ts +2 -0
- package/dist/api/export.d.ts +160 -0
- package/dist/api/geometry.d.ts +7 -7
- package/dist/api/index.d.ts +85 -35
- package/dist/api/mesh.d.ts +35 -6
- package/dist/docs/guides/concepts.md +32 -535
- package/dist/docs/guides/fonts.md +4 -4
- package/dist/docs/guides/generation.md +52 -45
- package/dist/docs/guides/geometry-values.md +193 -0
- package/dist/docs/guides/hosting.md +53 -30
- package/dist/docs/guides/profiles-and-extrusion.md +252 -0
- package/dist/docs/guides/recipes.md +33 -780
- package/dist/docs/guides/resolution-and-inspection.md +133 -0
- package/dist/docs/guides/solid-joins.md +126 -0
- package/dist/docs/guides/standalone-model.md +1 -1
- package/dist/docs/guides/svg-and-text.md +215 -0
- package/dist/docs/guides/sweeps-and-lofts.md +179 -0
- package/dist/docs/guides/transforms-and-placement.md +313 -0
- package/dist/docs/manifest.json +2818 -5862
- package/dist/docs/reference/engine/GenerationOptions.md +10 -4
- package/dist/docs/reference/engine/GeometryResource.md +8 -2
- package/dist/docs/reference/engine/ModelDependencies.md +9 -3
- package/dist/docs/reference/engine/ModelEngine.md +9 -3
- package/dist/docs/reference/engine/ModelEngineOptions.md +9 -3
- package/dist/docs/reference/engine/ModelPart.md +9 -3
- package/dist/docs/reference/engine/ModelResult.md +8 -2
- package/dist/docs/reference/engine/ModelRunArguments.md +7 -1
- package/dist/docs/reference/engine/ModelRunOptions.md +10 -4
- package/dist/docs/reference/engine/ModelSession.md +7 -1
- package/dist/docs/reference/engine/SessionOptions.md +10 -4
- package/dist/docs/reference/engine/categories/host-lifecycle.md +3 -8
- package/dist/docs/reference/engine/checkModel.md +7 -1
- package/dist/docs/reference/engine/createModelEngine.md +10 -3
- package/dist/docs/reference/engine/defaultModelingLimits.md +9 -3
- package/dist/docs/reference/engine/modelingWasmUrl.md +7 -1
- package/dist/docs/reference/engine.md +7 -7
- package/dist/docs/reference/export/Export3mfOptions.md +24 -0
- package/dist/docs/reference/export/ExportDiagnostic.md +59 -0
- package/dist/docs/reference/export/ExportFormat.md +25 -0
- package/dist/docs/reference/export/ExportGeometry.md +39 -0
- package/dist/docs/reference/export/ExportGlbOptions.md +118 -0
- package/dist/docs/reference/export/ExportLimits.md +83 -0
- package/dist/docs/reference/export/ExportMaterial.md +47 -0
- package/dist/docs/reference/export/ExportOptions.md +94 -0
- package/dist/docs/reference/export/ExportPart.md +88 -0
- package/dist/docs/reference/export/ExportReport.md +82 -0
- package/dist/docs/reference/export/ExportSink.md +39 -0
- package/dist/docs/reference/export/ExportStlOptions.md +24 -0
- package/dist/docs/reference/export/ExportedFile.md +110 -0
- package/dist/docs/reference/export/categories/mesh-serialization.md +47 -0
- package/dist/docs/reference/export/defaultExportLimits.md +20 -0
- package/dist/docs/reference/export/export3mf.md +64 -0
- package/dist/docs/reference/export/exportGlb.md +68 -0
- package/dist/docs/reference/export/exportStl.md +64 -0
- package/dist/docs/reference/export/write3mf.md +71 -0
- package/dist/docs/reference/export/writeGlb.md +75 -0
- package/dist/docs/reference/export/writeStl.md +71 -0
- package/dist/docs/reference/export.md +21 -0
- package/dist/docs/reference/geometry/AcmeThreadProfileSpec.md +16 -2
- package/dist/docs/reference/geometry/AlignedCircularSegmentsOptions.md +7 -1
- package/dist/docs/reference/geometry/Anchor3-type.md +13 -3
- package/dist/docs/reference/geometry/ArcCurve2.md +8 -2
- package/dist/docs/reference/geometry/ArcCurve3.md +8 -2
- package/dist/docs/reference/geometry/AttachOptions.md +13 -3
- package/dist/docs/reference/geometry/AxisAngleRotation3.md +9 -3
- package/dist/docs/reference/geometry/Bevel.md +16 -2
- package/dist/docs/reference/geometry/BevelSize.md +16 -2
- package/dist/docs/reference/geometry/Bounds2-type.md +18 -4
- package/dist/docs/reference/geometry/Bounds2Data.md +22 -4
- package/dist/docs/reference/geometry/Bounds2Input.md +18 -4
- package/dist/docs/reference/geometry/Bounds2Options.md +14 -4
- package/dist/docs/reference/geometry/Bounds3-type.md +18 -4
- package/dist/docs/reference/geometry/Bounds3Data.md +18 -4
- package/dist/docs/reference/geometry/Bounds3Input.md +18 -4
- package/dist/docs/reference/geometry/Bounds3Options.md +14 -4
- package/dist/docs/reference/geometry/BoundsFit2.md +10 -4
- package/dist/docs/reference/geometry/BoundsFit3.md +10 -4
- package/dist/docs/reference/geometry/BoundsFitOptions.md +10 -4
- package/dist/docs/reference/geometry/BoxAnchorFace.md +9 -3
- package/dist/docs/reference/geometry/BoxAnchorOptions.md +9 -3
- package/dist/docs/reference/geometry/BoxEdge.md +11 -1
- package/dist/docs/reference/geometry/BoxEdgeSelection.md +11 -1
- package/dist/docs/reference/geometry/BoxEdgeTreatments.md +11 -1
- package/dist/docs/reference/geometry/BoxOptions.md +11 -1
- package/dist/docs/reference/geometry/ButtressPressureFlankSide.md +16 -2
- package/dist/docs/reference/geometry/ButtressThreadProfileSpec.md +16 -2
- package/dist/docs/reference/geometry/ChamferedEdgeTreatment.md +11 -1
- package/dist/docs/reference/geometry/CircleContourOptions.md +12 -2
- package/dist/docs/reference/geometry/CircularPrimitiveOptions.md +15 -1
- package/dist/docs/reference/geometry/CircularResolutionOptions.md +7 -1
- package/dist/docs/reference/geometry/CircularSampling.md +7 -1
- package/dist/docs/reference/geometry/CircularSamplingOptions.md +7 -1
- package/dist/docs/reference/geometry/ClearanceHoleDimensions.md +8 -2
- package/dist/docs/reference/geometry/ClearanceHoleFit.md +8 -2
- package/dist/docs/reference/geometry/CompensatedThreadDiameters.md +8 -2
- package/dist/docs/reference/geometry/Contour.md +12 -2
- package/dist/docs/reference/geometry/ContourCurve.md +8 -2
- package/dist/docs/reference/geometry/ContourPoint.md +8 -2
- package/dist/docs/reference/geometry/ContourSegment.md +8 -2
- package/dist/docs/reference/geometry/CorrespondingComponent.md +12 -2
- package/dist/docs/reference/geometry/CorrespondingContour.md +12 -2
- package/dist/docs/reference/geometry/CorrespondingProfile.md +12 -2
- package/dist/docs/reference/geometry/CorrespondingProfileStation.md +12 -2
- package/dist/docs/reference/geometry/CubicBezierCurve2.md +8 -2
- package/dist/docs/reference/geometry/CubicBezierCurve3.md +8 -2
- package/dist/docs/reference/geometry/Curve2.md +8 -2
- package/dist/docs/reference/geometry/Curve3.md +8 -2
- package/dist/docs/reference/geometry/CurveSamplingOptions.md +16 -2
- package/dist/docs/reference/geometry/CustomThreadProfileSpec.md +16 -2
- package/dist/docs/reference/geometry/CylinderAnchorFace.md +9 -3
- package/dist/docs/reference/geometry/CylinderAnchorOptions.md +9 -3
- package/dist/docs/reference/geometry/CylinderOptions.md +11 -1
- package/dist/docs/reference/geometry/CylindricalGearDimensions.md +8 -2
- package/dist/docs/reference/geometry/CylindricalGearMeshKind.md +8 -2
- package/dist/docs/reference/geometry/CylindricalGearOutlineOptions.md +8 -2
- package/dist/docs/reference/geometry/CylindricalGearPairDimensions.md +8 -2
- package/dist/docs/reference/geometry/CylindricalGearPairMotionOptions.md +8 -2
- package/dist/docs/reference/geometry/CylindricalGearPairMotionReport.md +8 -2
- package/dist/docs/reference/geometry/CylindricalGearPairSpec.md +8 -2
- package/dist/docs/reference/geometry/CylindricalGearSpec.md +8 -2
- package/dist/docs/reference/geometry/DEFAULT_GEOMETRY_TOLERANCE.md +7 -1
- package/dist/docs/reference/geometry/EdgeTreatment.md +11 -1
- package/dist/docs/reference/geometry/EllipseContourOptions.md +12 -2
- package/dist/docs/reference/geometry/EndTreatments.md +12 -2
- package/dist/docs/reference/geometry/ExtrudeMeshOptions.md +16 -2
- package/dist/docs/reference/geometry/ExtrudeOptions.md +13 -3
- package/dist/docs/reference/geometry/ExtrusionSamplingOptions.md +16 -2
- package/dist/docs/reference/geometry/FittedTextLayout.md +8 -2
- package/dist/docs/reference/geometry/Frame3.md +16 -2
- package/dist/docs/reference/geometry/GeometryError.md +11 -1
- package/dist/docs/reference/geometry/GeometryErrorCode.md +11 -1
- package/dist/docs/reference/geometry/GeometryErrorContext.md +11 -1
- package/dist/docs/reference/geometry/GeometryResolution.md +15 -1
- package/dist/docs/reference/geometry/GeometrySamplingLimits.md +16 -2
- package/dist/docs/reference/geometry/GeometryToleranceOptions.md +15 -1
- package/dist/docs/reference/geometry/GridPatternOptions.md +12 -2
- package/dist/docs/reference/geometry/HeightfieldMeshLimits.md +12 -2
- package/dist/docs/reference/geometry/HeightfieldOptions.md +16 -2
- package/dist/docs/reference/geometry/HeightfieldPreflight.md +12 -2
- package/dist/docs/reference/geometry/IDENTITY_TRANSFORM3.md +9 -3
- package/dist/docs/reference/geometry/ImmutableBuffer-type.md +16 -14
- package/dist/docs/reference/geometry/ImmutableTriangleMesh.md +17 -3
- package/dist/docs/reference/geometry/InternalThreadCutterOptions.md +12 -2
- package/dist/docs/reference/geometry/KnuckleHingeBaseSpec.md +12 -2
- package/dist/docs/reference/geometry/KnuckleHingeDimensions.md +8 -2
- package/dist/docs/reference/geometry/KnuckleHingeInterval.md +8 -2
- package/dist/docs/reference/geometry/KnuckleHingeSamplingOptions.md +12 -2
- package/dist/docs/reference/geometry/KnuckleHingeSpec.md +12 -2
- package/dist/docs/reference/geometry/LineCurve2.md +8 -2
- package/dist/docs/reference/geometry/LineCurve3.md +8 -2
- package/dist/docs/reference/geometry/LinearPatternOptions.md +12 -2
- package/dist/docs/reference/geometry/LoftCorrespondence.md +16 -2
- package/dist/docs/reference/geometry/LoftMeshStation.md +12 -2
- package/dist/docs/reference/geometry/LoftOptions.md +16 -2
- package/dist/docs/reference/geometry/LoftPlacement.md +16 -2
- package/dist/docs/reference/geometry/METRIC_FASTENER_STANDARDS.md +8 -2
- package/dist/docs/reference/geometry/MatchProfilesOptions.md +12 -2
- package/dist/docs/reference/geometry/MetricFastenerSize.md +8 -2
- package/dist/docs/reference/geometry/MetricFastenerStandard.md +8 -2
- package/dist/docs/reference/geometry/MetricHexNutDimensions.md +8 -2
- package/dist/docs/reference/geometry/MetricSocketCapHeadDimensions.md +8 -2
- package/dist/docs/reference/geometry/ModelingLimits.md +19 -1
- package/dist/docs/reference/geometry/NumericArray.md +16 -2
- package/dist/docs/reference/geometry/PRINTABLE_THREAD_FIT_POLICIES.md +8 -2
- package/dist/docs/reference/geometry/Path2-type.md +16 -2
- package/dist/docs/reference/geometry/Path2Data.md +16 -2
- package/dist/docs/reference/geometry/Path2Input.md +16 -2
- package/dist/docs/reference/geometry/Path3-type.md +16 -2
- package/dist/docs/reference/geometry/Path3Data.md +16 -2
- package/dist/docs/reference/geometry/Path3Input.md +16 -2
- package/dist/docs/reference/geometry/PathFrame.md +8 -2
- package/dist/docs/reference/geometry/PathLocation.md +16 -2
- package/dist/docs/reference/geometry/PathNormalGuide.md +16 -2
- package/dist/docs/reference/geometry/PathOptions.md +12 -2
- package/dist/docs/reference/geometry/PathPatternOptions.md +12 -2
- package/dist/docs/reference/geometry/PathPlacement.md +8 -2
- package/dist/docs/reference/geometry/PathResamplingOptions.md +16 -2
- package/dist/docs/reference/geometry/Pivot2Options.md +17 -3
- package/dist/docs/reference/geometry/Pivot3Options.md +17 -3
- package/dist/docs/reference/geometry/PlanarMeshOptimizationFallbackReason.md +12 -2
- package/dist/docs/reference/geometry/PlanarMeshOptimizationOptions.md +12 -2
- package/dist/docs/reference/geometry/PlanarMeshOptimizationResult.md +12 -2
- package/dist/docs/reference/geometry/PlanarPatchQuality.md +12 -2
- package/dist/docs/reference/geometry/PolygonData.md +12 -2
- package/dist/docs/reference/geometry/PolylineResamplingOptions.md +8 -2
- package/dist/docs/reference/geometry/PrimitiveAttachment.md +11 -1
- package/dist/docs/reference/geometry/PrimitiveAttachmentOptions.md +11 -1
- package/dist/docs/reference/geometry/PrintableThreadFit.md +12 -2
- package/dist/docs/reference/geometry/PrintableThreadFitPolicy.md +12 -2
- package/dist/docs/reference/geometry/Profile.md +8 -2
- package/dist/docs/reference/geometry/ProfileComponent2.md +12 -2
- package/dist/docs/reference/geometry/ProfileContour2.md +12 -2
- package/dist/docs/reference/geometry/ProfileSpan2.md +12 -2
- package/dist/docs/reference/geometry/ProfiledEdgeTreatment.md +11 -1
- package/dist/docs/reference/geometry/RackPitchDimensions.md +8 -2
- package/dist/docs/reference/geometry/RackPitchSpec.md +8 -2
- package/dist/docs/reference/geometry/RadialPatternOptions.md +12 -2
- package/dist/docs/reference/geometry/RadialSizing.md +11 -1
- package/dist/docs/reference/geometry/RadialSizingOptions.md +11 -1
- package/dist/docs/reference/geometry/RectangleContourOptions.md +12 -2
- package/dist/docs/reference/geometry/RectangleCornerTreatment.md +12 -2
- package/dist/docs/reference/geometry/RectangleCornerTreatments.md +12 -2
- package/dist/docs/reference/geometry/RectangleProfileOptions.md +8 -2
- package/dist/docs/reference/geometry/RegionData.md +12 -2
- package/dist/docs/reference/geometry/RegularPolygonContourOptions.md +8 -2
- package/dist/docs/reference/geometry/ResolvedGeometryTolerance.md +7 -1
- package/dist/docs/reference/geometry/RevolveOptions.md +16 -2
- package/dist/docs/reference/geometry/RoundedEdgeTreatment.md +11 -1
- package/dist/docs/reference/geometry/RowLayoutOptions.md +10 -4
- package/dist/docs/reference/geometry/SampleContourOptions.md +8 -2
- package/dist/docs/reference/geometry/SampleHelixOptions.md +8 -2
- package/dist/docs/reference/geometry/SampleSideProfileOptions.md +8 -2
- package/dist/docs/reference/geometry/SampledCurve2.md +8 -2
- package/dist/docs/reference/geometry/SampledCurve3.md +8 -2
- package/dist/docs/reference/geometry/SampledThreadHelices.md +8 -2
- package/dist/docs/reference/geometry/SideProfileCurve.md +8 -2
- package/dist/docs/reference/geometry/SideProfilePoint.md +8 -2
- package/dist/docs/reference/geometry/SideProfileSegment.md +8 -2
- package/dist/docs/reference/geometry/SmoothEdgeTreatment.md +11 -1
- package/dist/docs/reference/geometry/SolidMeshValidationOptions.md +12 -2
- package/dist/docs/reference/geometry/SphereOptions.md +11 -1
- package/dist/docs/reference/geometry/SquareThreadProfileSpec.md +16 -2
- package/dist/docs/reference/geometry/StarContourOptions.md +12 -2
- package/dist/docs/reference/geometry/StrokeCap.md +12 -2
- package/dist/docs/reference/geometry/StrokeJoin.md +12 -2
- package/dist/docs/reference/geometry/StrokeOptions.md +12 -2
- package/dist/docs/reference/geometry/SvgImportOptions.md +8 -2
- package/dist/docs/reference/geometry/SvgRegionPreflight.md +8 -2
- package/dist/docs/reference/geometry/SvgRegionPreflightGeometryMetrics.md +8 -2
- package/dist/docs/reference/geometry/SvgRegionPreflightRepairs.md +8 -2
- package/dist/docs/reference/geometry/SvgRegionPreflightSourceMetrics.md +8 -2
- package/dist/docs/reference/geometry/SweepOptions.md +16 -2
- package/dist/docs/reference/geometry/SweepOrientation.md +16 -2
- package/dist/docs/reference/geometry/ThreadBevelOptions.md +12 -2
- package/dist/docs/reference/geometry/ThreadCircularSegmentsOptions.md +8 -2
- package/dist/docs/reference/geometry/ThreadCompensationOptions.md +8 -2
- package/dist/docs/reference/geometry/ThreadEndStyle.md +16 -2
- package/dist/docs/reference/geometry/ThreadEndTreatmentOptions.md +16 -2
- package/dist/docs/reference/geometry/ThreadHandedness.md +16 -2
- package/dist/docs/reference/geometry/ThreadHelixOptions.md +8 -2
- package/dist/docs/reference/geometry/ThreadLeadInEnvelope.md +16 -2
- package/dist/docs/reference/geometry/ThreadLeadInShape.md +16 -2
- package/dist/docs/reference/geometry/ThreadProfile-type.md +16 -2
- package/dist/docs/reference/geometry/ThreadProfileBaseSpec.md +16 -2
- package/dist/docs/reference/geometry/ThreadProfileSpec.md +16 -2
- package/dist/docs/reference/geometry/ThreadRidgeOptions.md +16 -2
- package/dist/docs/reference/geometry/ThreadRole.md +8 -2
- package/dist/docs/reference/geometry/ThreadSolidOptions.md +12 -2
- package/dist/docs/reference/geometry/ThreadSolidPreflight.md +16 -2
- package/dist/docs/reference/geometry/ThreadedNutOptions.md +12 -2
- package/dist/docs/reference/geometry/ThreadedNutPreflight.md +12 -2
- package/dist/docs/reference/geometry/ThreadedNutShape.md +12 -2
- package/dist/docs/reference/geometry/ThreadedRodOptions.md +12 -2
- package/dist/docs/reference/geometry/TorusOptions.md +11 -1
- package/dist/docs/reference/geometry/Transform2-type.md +17 -3
- package/dist/docs/reference/geometry/Transform2Data.md +17 -3
- package/dist/docs/reference/geometry/Transform2Input.md +17 -3
- package/dist/docs/reference/geometry/Transform3-type.md +17 -3
- package/dist/docs/reference/geometry/Transform3Data.md +17 -3
- package/dist/docs/reference/geometry/Transform3Input.md +17 -3
- package/dist/docs/reference/geometry/TrapezoidalThreadProfileSpec.md +16 -2
- package/dist/docs/reference/geometry/TriangleMesh.md +20 -2
- package/dist/docs/reference/geometry/TriangleMeshAnalysis.md +16 -2
- package/dist/docs/reference/geometry/TriangleMeshAnalysisOptions.md +12 -2
- package/dist/docs/reference/geometry/TriangleMeshInput.md +12 -2
- package/dist/docs/reference/geometry/TriangleMeshMeasurements.md +16 -2
- package/dist/docs/reference/geometry/TriangleMeshQualityOptions.md +12 -2
- package/dist/docs/reference/geometry/TriangleMeshQualityReport.md +12 -2
- package/dist/docs/reference/geometry/TriangleMeshSignature.md +12 -2
- package/dist/docs/reference/geometry/TriangleMeshSignatureOptions.md +12 -2
- package/dist/docs/reference/geometry/TriangleMeshSignatureTolerances.md +12 -2
- package/dist/docs/reference/geometry/TriangleMeshTopologyAnalysis.md +16 -2
- package/dist/docs/reference/geometry/TriangleMeshValidationOptions.md +12 -2
- package/dist/docs/reference/geometry/TriangularThreadProfileSpec.md +16 -2
- package/dist/docs/reference/geometry/TubeOptions.md +11 -1
- package/dist/docs/reference/geometry/Vector2-type.md +17 -3
- package/dist/docs/reference/geometry/Vector2Data.md +21 -3
- package/dist/docs/reference/geometry/Vector2Input.md +17 -3
- package/dist/docs/reference/geometry/Vector3-type.md +17 -3
- package/dist/docs/reference/geometry/Vector3Data.md +17 -3
- package/dist/docs/reference/geometry/Vector3Input.md +17 -3
- package/dist/docs/reference/geometry/VectorTextArcBaseline.md +12 -2
- package/dist/docs/reference/geometry/VectorTextLayout.md +16 -2
- package/dist/docs/reference/geometry/VectorTextLayoutOptions.md +12 -2
- package/dist/docs/reference/geometry/VectorTextMetrics.md +16 -2
- package/dist/docs/reference/geometry/VectorTextOptions.md +12 -2
- package/dist/docs/reference/geometry/add2.md +9 -3
- package/dist/docs/reference/geometry/add3.md +9 -3
- package/dist/docs/reference/geometry/anchor3.md +9 -3
- package/dist/docs/reference/geometry/anchorFrame3.md +8 -2
- package/dist/docs/reference/geometry/applyTransformDirection3.md +9 -3
- package/dist/docs/reference/geometry/applyTransformPoint3.md +9 -3
- package/dist/docs/reference/geometry/attachmentTransform3.md +9 -3
- package/dist/docs/reference/geometry/bounds2.md +16 -6
- package/dist/docs/reference/geometry/bounds3.md +16 -6
- package/dist/docs/reference/geometry/boundsCenter.md +10 -4
- package/dist/docs/reference/geometry/boundsSize.md +10 -4
- package/dist/docs/reference/geometry/boxAnchor3.md +9 -3
- package/dist/docs/reference/geometry/categories/bounds-layout.md +4 -4
- package/dist/docs/reference/geometry/categories/curves-paths.md +2 -2
- package/dist/docs/reference/geometry/categories/mechanical.md +2 -2
- package/dist/docs/reference/geometry/categories/meshes.md +3 -3
- package/dist/docs/reference/geometry/categories/pattern-placement.md +2 -2
- package/dist/docs/reference/geometry/categories/primitive-options.md +2 -2
- package/dist/docs/reference/geometry/categories/profiles-regions.md +2 -2
- package/dist/docs/reference/geometry/categories/resolution-errors.md +1 -1
- package/dist/docs/reference/geometry/categories/transforms-math.md +3 -3
- package/dist/docs/reference/geometry/categories/vector-import.md +2 -2
- package/dist/docs/reference/geometry/circleContour.md +8 -2
- package/dist/docs/reference/geometry/closeToAxis.md +8 -2
- package/dist/docs/reference/geometry/compensateThreadDiameters.md +8 -2
- package/dist/docs/reference/geometry/compensateThreadProfileAxially.md +8 -2
- package/dist/docs/reference/geometry/compensateThreadProfileForFaceting.md +8 -2
- package/dist/docs/reference/geometry/composeTransform3.md +9 -3
- package/dist/docs/reference/geometry/computeClosedParallelTransportFrames.md +8 -2
- package/dist/docs/reference/geometry/computeParallelTransportFrames.md +8 -2
- package/dist/docs/reference/geometry/contourContainsPoint.md +8 -2
- package/dist/docs/reference/geometry/cross2.md +9 -3
- package/dist/docs/reference/geometry/cross3.md +9 -3
- package/dist/docs/reference/geometry/cylinderAnchor3.md +9 -3
- package/dist/docs/reference/geometry/defaultGeometrySamplingLimits.md +8 -2
- package/dist/docs/reference/geometry/distance2.md +9 -3
- package/dist/docs/reference/geometry/distance3.md +9 -3
- package/dist/docs/reference/geometry/distributeAlongPath.md +8 -2
- package/dist/docs/reference/geometry/dot2.md +9 -3
- package/dist/docs/reference/geometry/dot3.md +9 -3
- package/dist/docs/reference/geometry/ellipseContour.md +8 -2
- package/dist/docs/reference/geometry/eulerTransform3.md +9 -3
- package/dist/docs/reference/geometry/fitBounds.md +10 -4
- package/dist/docs/reference/geometry/fitTextLayout.md +8 -2
- package/dist/docs/reference/geometry/frameTransform3.md +9 -3
- package/dist/docs/reference/geometry/getMetricClearanceHoleDiameter.md +8 -2
- package/dist/docs/reference/geometry/getMetricFastenerStandard.md +8 -2
- package/dist/docs/reference/geometry/gridPatternTransforms.md +8 -2
- package/dist/docs/reference/geometry/immutableBuffer.md +12 -2
- package/dist/docs/reference/geometry/inverseTransform3.md +9 -3
- package/dist/docs/reference/geometry/isGeometryError.md +11 -1
- package/dist/docs/reference/geometry/layoutRow.md +10 -4
- package/dist/docs/reference/geometry/length2.md +9 -3
- package/dist/docs/reference/geometry/length3.md +9 -3
- package/dist/docs/reference/geometry/lerp2.md +9 -3
- package/dist/docs/reference/geometry/lerp3.md +9 -3
- package/dist/docs/reference/geometry/linearPatternTransforms.md +8 -2
- package/dist/docs/reference/geometry/matchProfiles.md +8 -2
- package/dist/docs/reference/geometry/measureInternalCylindricalGearPairMotion.md +8 -2
- package/dist/docs/reference/geometry/minimumCylindricalGearToothCountWithoutUndercut.md +8 -2
- package/dist/docs/reference/geometry/normalize2.md +9 -3
- package/dist/docs/reference/geometry/normalize3.md +9 -3
- package/dist/docs/reference/geometry/normalizeContour.md +8 -2
- package/dist/docs/reference/geometry/normalizePolygon.md +8 -2
- package/dist/docs/reference/geometry/normalizeRegion.md +8 -2
- package/dist/docs/reference/geometry/path2.md +12 -2
- package/dist/docs/reference/geometry/path3.md +12 -2
- package/dist/docs/reference/geometry/pathPatternTransforms.md +8 -2
- package/dist/docs/reference/geometry/preflightInternalThreadCutter.md +8 -2
- package/dist/docs/reference/geometry/preflightSvgRegion.md +8 -2
- package/dist/docs/reference/geometry/preflightThreadedNut.md +8 -2
- package/dist/docs/reference/geometry/preflightThreadedRod.md +8 -2
- package/dist/docs/reference/geometry/projectOntoPlane3.md +9 -3
- package/dist/docs/reference/geometry/radialPatternTransforms.md +8 -2
- package/dist/docs/reference/geometry/rectangleContour.md +8 -2
- package/dist/docs/reference/geometry/rectangleProfile.md +8 -2
- package/dist/docs/reference/geometry/regionArea.md +8 -2
- package/dist/docs/reference/geometry/regionBounds.md +8 -2
- package/dist/docs/reference/geometry/regularPolygonContour.md +8 -2
- package/dist/docs/reference/geometry/resamplePolyline2.md +8 -2
- package/dist/docs/reference/geometry/resamplePolyline3.md +8 -2
- package/dist/docs/reference/geometry/resolveAlignedCircularSegments.md +7 -1
- package/dist/docs/reference/geometry/resolveArcSegments.md +7 -1
- package/dist/docs/reference/geometry/resolveCircularSampling.md +7 -1
- package/dist/docs/reference/geometry/resolveCircularSegments.md +7 -1
- package/dist/docs/reference/geometry/resolveCylindricalGear.md +8 -2
- package/dist/docs/reference/geometry/resolveCylindricalGearPair.md +8 -2
- package/dist/docs/reference/geometry/resolveExtrusionDivisions.md +8 -2
- package/dist/docs/reference/geometry/resolveGeometrySamplingLimits.md +8 -2
- package/dist/docs/reference/geometry/resolveGeometryTolerance.md +7 -1
- package/dist/docs/reference/geometry/resolveKnuckleHinge.md +8 -2
- package/dist/docs/reference/geometry/resolvePrintableThreadFitPolicy.md +8 -2
- package/dist/docs/reference/geometry/resolveRackPitch.md +8 -2
- package/dist/docs/reference/geometry/resolveThreadCircularSegments.md +8 -2
- package/dist/docs/reference/geometry/rotate2.md +9 -3
- package/dist/docs/reference/geometry/rotationTransform3.md +9 -3
- package/dist/docs/reference/geometry/roundClosedPolylinePath.md +8 -2
- package/dist/docs/reference/geometry/sampleContour.md +8 -2
- package/dist/docs/reference/geometry/sampleCurve2.md +8 -2
- package/dist/docs/reference/geometry/sampleCurve3.md +8 -2
- package/dist/docs/reference/geometry/sampleCylindricalGearOutline.md +8 -2
- package/dist/docs/reference/geometry/sampleHelix.md +8 -2
- package/dist/docs/reference/geometry/sampleInternalCylindricalGearSpaceOutline.md +8 -2
- package/dist/docs/reference/geometry/sampleRackToothPath.md +8 -2
- package/dist/docs/reference/geometry/sampleSideProfile.md +8 -2
- package/dist/docs/reference/geometry/sampleTextContours.md +8 -2
- package/dist/docs/reference/geometry/sampleThreadHelices.md +8 -2
- package/dist/docs/reference/geometry/scale2.md +9 -3
- package/dist/docs/reference/geometry/scale3.md +9 -3
- package/dist/docs/reference/geometry/scaleTransform3.md +9 -3
- package/dist/docs/reference/geometry/signedContourArea.md +8 -2
- package/dist/docs/reference/geometry/starContour.md +8 -2
- package/dist/docs/reference/geometry/strokeRegionData.md +8 -2
- package/dist/docs/reference/geometry/subtract2.md +9 -3
- package/dist/docs/reference/geometry/subtract3.md +9 -3
- package/dist/docs/reference/geometry/threadProfile.md +8 -2
- package/dist/docs/reference/geometry/transform2.md +13 -3
- package/dist/docs/reference/geometry/transform3.md +13 -3
- package/dist/docs/reference/geometry/transformDeterminant3.md +9 -3
- package/dist/docs/reference/geometry/transformRegionData.md +8 -2
- package/dist/docs/reference/geometry/translationTransform3.md +9 -3
- package/dist/docs/reference/geometry/triangulateContour.md +8 -2
- package/dist/docs/reference/geometry/validateRigidTransform3.md +9 -3
- package/dist/docs/reference/geometry/validateTransform3.md +9 -3
- package/dist/docs/reference/geometry/vector2.md +13 -3
- package/dist/docs/reference/geometry/vector3.md +13 -3
- package/dist/docs/reference/geometry.md +2 -2
- package/dist/docs/reference/mesh/MeshRenderOptions.md +28 -0
- package/dist/docs/reference/mesh/RenderMesh.md +68 -0
- package/dist/docs/reference/mesh/analyze.md +12 -6
- package/dist/docs/reference/mesh/analyzeQuality.md +11 -5
- package/dist/docs/reference/mesh/bounds.md +10 -4
- package/dist/docs/reference/mesh/categories/operations.md +5 -95
- package/dist/docs/reference/mesh/centroid.md +10 -4
- package/dist/docs/reference/mesh/extrude.md +11 -5
- package/dist/docs/reference/mesh/heightfield.md +11 -5
- package/dist/docs/reference/mesh/immutable.md +13 -9
- package/dist/docs/reference/mesh/join.md +10 -4
- package/dist/docs/reference/mesh/loft.md +11 -5
- package/dist/docs/reference/mesh/optimizePlanarPatches.md +11 -5
- package/dist/docs/reference/mesh/preflightHeightfield.md +11 -5
- package/dist/docs/reference/mesh/preflightThreadSolid.md +10 -4
- package/dist/docs/reference/mesh/render.md +57 -0
- package/dist/docs/reference/mesh/reverse.md +10 -4
- package/dist/docs/reference/mesh/revolve.md +11 -5
- package/dist/docs/reference/mesh/signature.md +11 -5
- package/dist/docs/reference/mesh/sweep.md +12 -6
- package/dist/docs/reference/mesh/threadRidge.md +10 -4
- package/dist/docs/reference/mesh/threadSolid.md +10 -4
- package/dist/docs/reference/mesh/transform.md +11 -5
- package/dist/docs/reference/mesh/validate.md +10 -4
- package/dist/docs/reference/mesh/validateSolid.md +10 -4
- package/dist/docs/reference/mesh.md +1 -1
- package/dist/docs/reference/model/CircleOptions.md +13 -7
- package/dist/docs/reference/model/DiagnosticOptions.md +7 -1
- package/dist/docs/reference/model/EllipseOptions.md +13 -7
- package/dist/docs/reference/model/GenerateCallback.md +7 -1
- package/dist/docs/reference/model/GenerateContext.md +14 -39
- package/dist/docs/reference/model/GenerationDiagnostic.md +7 -1
- package/dist/docs/reference/model/GenerationError.md +8 -2
- package/dist/docs/reference/model/HoleCutterOptions.md +17 -10
- package/dist/docs/reference/model/HoleCutterOverrun.md +10 -3
- package/dist/docs/reference/model/HoleCutterRecess.md +10 -3
- package/dist/docs/reference/model/HullOptions.md +13 -6
- package/dist/docs/reference/model/ImmutableValue.md +7 -1
- package/dist/docs/reference/model/ImplicitOptions.md +12 -6
- package/dist/docs/reference/model/JoinOptions.md +76 -0
- package/dist/docs/reference/model/JoinTransition.md +54 -0
- package/dist/docs/reference/model/KnuckleHinge-type.md +9 -3
- package/dist/docs/reference/model/KnuckleHingeHalfOptions.md +7 -1
- package/dist/docs/reference/model/KnuckleHingeOptions.md +10 -4
- package/dist/docs/reference/model/KnuckleHingeWeb.md +7 -1
- package/dist/docs/reference/model/LoftStation.md +16 -9
- package/dist/docs/reference/model/Memo.md +54 -0
- package/dist/docs/reference/model/ModelProgram.md +7 -1
- package/dist/docs/reference/model/PartDeclaration.md +11 -6
- package/dist/docs/reference/model/PartGeometry.md +10 -4
- package/dist/docs/reference/model/PartOptions.md +11 -6
- package/dist/docs/reference/model/PatternSource.md +10 -4
- package/dist/docs/reference/model/PlaneOptions.md +11 -4
- package/dist/docs/reference/model/PolygonOptions.md +20 -14
- package/dist/docs/reference/model/Profile.md +10 -4
- package/dist/docs/reference/model/RectangleOptions.md +28 -22
- package/dist/docs/reference/model/RegularPolygonOptions.md +13 -7
- package/dist/docs/reference/model/Section.md +68 -74
- package/dist/docs/reference/model/SectionHullOptions.md +13 -6
- package/dist/docs/reference/model/SectionInspection.md +10 -4
- package/dist/docs/reference/model/SectionOffsetJoin.md +10 -4
- package/dist/docs/reference/model/SectionOffsetOptions.md +12 -6
- package/dist/docs/reference/model/Solid.md +101 -53
- package/dist/docs/reference/model/SolidInspection.md +10 -4
- package/dist/docs/reference/model/SolidSegmentHit.md +11 -5
- package/dist/docs/reference/model/StarOptions.md +24 -18
- package/dist/docs/reference/model/SvgOrigin.md +10 -4
- package/dist/docs/reference/model/SvgPathSectionOptions.md +14 -8
- package/dist/docs/reference/model/SvgSectionOptions.md +16 -10
- package/dist/docs/reference/model/TextSectionOptions.md +14 -8
- package/dist/docs/reference/model/box.md +18 -11
- package/dist/docs/reference/model/categories/boolean-operations.md +8 -2
- package/dist/docs/reference/model/categories/bounded-surfaces.md +1 -7
- package/dist/docs/reference/model/categories/explicit-profiles.md +1 -14
- package/dist/docs/reference/model/categories/extrude-revolve-sweep.md +6 -20
- package/dist/docs/reference/model/categories/generation.md +5 -10
- package/dist/docs/reference/model/categories/hinges.md +1 -4
- package/dist/docs/reference/model/categories/mesh-inspection.md +2 -6
- package/dist/docs/reference/model/categories/primitives.md +5 -21
- package/dist/docs/reference/model/categories/sections.md +4 -15
- package/dist/docs/reference/model/categories/threads.md +2 -39
- package/dist/docs/reference/model/categories/transforms-placement.md +4 -33
- package/dist/docs/reference/model/circle.md +10 -4
- package/dist/docs/reference/model/cylinder.md +13 -6
- package/dist/docs/reference/model/ellipse.md +10 -4
- package/dist/docs/reference/model/extrude.md +26 -19
- package/dist/docs/reference/model/generate.md +8 -2
- package/dist/docs/reference/model/gridPattern.md +15 -9
- package/dist/docs/reference/model/heightfield.md +10 -4
- package/dist/docs/reference/model/holeCutter.md +10 -3
- package/dist/docs/reference/model/hull.md +9 -2
- package/dist/docs/reference/model/implicit.md +9 -3
- package/dist/docs/reference/model/internalThreadCutter.md +23 -17
- package/dist/docs/reference/model/intersect.md +9 -2
- package/dist/docs/reference/model/join.md +89 -0
- package/dist/docs/reference/model/knuckleHinge.md +7 -1
- package/dist/docs/reference/model/linearPattern.md +15 -9
- package/dist/docs/reference/model/loft.md +31 -24
- package/dist/docs/reference/model/matchProfiles.md +14 -8
- package/dist/docs/reference/model/minkowskiSum.md +9 -2
- package/dist/docs/reference/model/pathPattern.md +25 -19
- package/dist/docs/reference/model/polygon.md +13 -7
- package/dist/docs/reference/model/preflightInternalThreadCutter.md +25 -19
- package/dist/docs/reference/model/preflightThreadedNut.md +29 -23
- package/dist/docs/reference/model/preflightThreadedRod.md +25 -19
- package/dist/docs/reference/model/radialPattern.md +15 -9
- package/dist/docs/reference/model/rectangle.md +14 -8
- package/dist/docs/reference/model/regularPolygon.md +10 -4
- package/dist/docs/reference/model/revolve.md +22 -15
- package/dist/docs/reference/model/solidFromMesh.md +12 -6
- package/dist/docs/reference/model/sphere.md +13 -6
- package/dist/docs/reference/model/star.md +12 -6
- package/dist/docs/reference/model/stroke.md +21 -15
- package/dist/docs/reference/model/svgPathSection.md +12 -6
- package/dist/docs/reference/model/svgSection.md +13 -7
- package/dist/docs/reference/model/sweep.md +27 -20
- package/dist/docs/reference/model/textSection.md +15 -9
- package/dist/docs/reference/model/threadRidge.md +21 -15
- package/dist/docs/reference/model/threadedNut.md +27 -21
- package/dist/docs/reference/model/threadedRod.md +23 -17
- package/dist/docs/reference/model/torus.md +20 -13
- package/dist/docs/reference/model/tube.md +13 -6
- package/dist/docs/reference/model/union.md +9 -2
- package/dist/docs/reference/model.md +3 -8
- package/dist/docs/reference/text/MAX_VECTOR_FONT_BYTES.md +7 -1
- package/dist/docs/reference/text/VectorFont.md +39 -33
- package/dist/docs/reference/text/VectorFontOptions.md +7 -1
- package/dist/docs/reference/text/categories/font-preparation.md +1 -13
- package/dist/docs/reference/text/prepareVectorFont.md +7 -1
- package/dist/docs/reference/text.md +1 -1
- package/dist/engine/finalization.js +2 -74
- package/dist/engine/index.js +2 -2
- package/dist/engine/native/construction-mesh.js +41 -0
- package/dist/engine/native/material-components.js +2 -51
- package/dist/engine/native/mesh-observation.js +55 -0
- package/dist/engine/native/regions.js +2 -1
- package/dist/engine/operations/context.js +2 -0
- package/dist/engine/operations/extrusion-finishing.js +17 -16
- package/dist/engine/operations/join-collar-profile.js +120 -0
- package/dist/engine/operations/join.js +508 -0
- package/dist/engine/recipe-realization.js +1 -1
- package/dist/engine/session/dependencies.js +89 -42
- package/dist/engine/session/graph.js +319 -342
- package/dist/engine/session/native-cache.js +1 -1
- package/dist/engine/session/session.js +5 -5
- package/dist/engine/session/snapshot-cache.js +2 -2
- package/dist/export/3mf.js +190 -0
- package/dist/export/capture.js +178 -0
- package/dist/export/glb.js +209 -0
- package/dist/export/index.js +5 -0
- package/dist/export/limits.js +18 -0
- package/dist/export/stl.js +105 -0
- package/dist/export/types.js +1 -0
- package/dist/export/writer.js +54 -0
- package/dist/geometry/bounds-value.js +4 -4
- package/dist/geometry/immutable-buffer.js +4 -6
- package/dist/geometry/join-geometry.js +839 -0
- package/dist/geometry/mesh/mesh-render.js +205 -0
- package/dist/geometry/mesh/mesh-solid-intersections.js +43 -17
- package/dist/geometry/mesh/mesh-solid.js +6 -2
- package/dist/geometry/mesh-api.js +1 -0
- package/dist/geometry/region-offset.js +278 -0
- package/dist/geometry/regions.js +11 -1
- package/dist/model/execution-binding.js +3 -3
- package/dist/model/generation.js +2 -2
- package/dist/model/immutable-generation-data.js +13 -13
- package/dist/model/join.js +1 -0
- package/dist/model/operations.js +20 -0
- package/dist/model/recipe-declaration.js +1 -0
- package/dist/model/shape-handles.js +1 -0
- package/package.json +18 -1
- package/dist/docs/reference/engine/Export3mfOptions.md +0 -46
- package/dist/docs/reference/engine/ExportMeshPart.md +0 -31
- package/dist/docs/reference/engine/ModelingLimits.md +0 -121
- package/dist/docs/reference/engine/export3mf.md +0 -55
- package/dist/docs/reference/mesh/AcmeThreadProfileSpec.md +0 -79
- package/dist/docs/reference/mesh/Bevel.md +0 -18
- package/dist/docs/reference/mesh/BevelSize.md +0 -14
- package/dist/docs/reference/mesh/Bounds2.md +0 -125
- package/dist/docs/reference/mesh/Bounds2Data.md +0 -43
- package/dist/docs/reference/mesh/Bounds2Input.md +0 -19
- package/dist/docs/reference/mesh/Bounds3.md +0 -125
- package/dist/docs/reference/mesh/Bounds3Data.md +0 -43
- package/dist/docs/reference/mesh/Bounds3Input.md +0 -19
- package/dist/docs/reference/mesh/ButtressPressureFlankSide.md +0 -14
- package/dist/docs/reference/mesh/ButtressThreadProfileSpec.md +0 -97
- package/dist/docs/reference/mesh/CircularPrimitiveOptions.md +0 -60
- package/dist/docs/reference/mesh/CurveSamplingOptions.md +0 -69
- package/dist/docs/reference/mesh/CustomThreadProfileSpec.md +0 -77
- package/dist/docs/reference/mesh/ExtrudeMeshOptions.md +0 -129
- package/dist/docs/reference/mesh/ExtrusionSamplingOptions.md +0 -81
- package/dist/docs/reference/mesh/Frame3.md +0 -62
- package/dist/docs/reference/mesh/GeometryResolution.md +0 -74
- package/dist/docs/reference/mesh/GeometrySamplingLimits.md +0 -66
- package/dist/docs/reference/mesh/GeometryToleranceOptions.md +0 -46
- package/dist/docs/reference/mesh/HeightfieldMeshLimits.md +0 -18
- package/dist/docs/reference/mesh/HeightfieldOptions.md +0 -72
- package/dist/docs/reference/mesh/HeightfieldPreflight.md +0 -58
- package/dist/docs/reference/mesh/ImmutableBuffer.md +0 -108
- package/dist/docs/reference/mesh/ImmutableTriangleMesh.md +0 -43
- package/dist/docs/reference/mesh/LoftCorrespondence.md +0 -24
- package/dist/docs/reference/mesh/LoftMeshStation.md +0 -31
- package/dist/docs/reference/mesh/LoftOptions.md +0 -88
- package/dist/docs/reference/mesh/LoftPlacement.md +0 -70
- package/dist/docs/reference/mesh/ModelingLimits.md +0 -130
- package/dist/docs/reference/mesh/NumericArray.md +0 -14
- package/dist/docs/reference/mesh/Path2.md +0 -197
- package/dist/docs/reference/mesh/Path2Data.md +0 -50
- package/dist/docs/reference/mesh/Path2Input.md +0 -20
- package/dist/docs/reference/mesh/Path3.md +0 -197
- package/dist/docs/reference/mesh/Path3Data.md +0 -50
- package/dist/docs/reference/mesh/Path3Input.md +0 -20
- package/dist/docs/reference/mesh/PathLocation.md +0 -69
- package/dist/docs/reference/mesh/PathNormalGuide.md +0 -43
- package/dist/docs/reference/mesh/PathResamplingOptions.md +0 -84
- package/dist/docs/reference/mesh/Pivot2Options.md +0 -26
- package/dist/docs/reference/mesh/Pivot3Options.md +0 -26
- package/dist/docs/reference/mesh/PlanarMeshOptimizationFallbackReason.md +0 -14
- package/dist/docs/reference/mesh/PlanarMeshOptimizationOptions.md +0 -160
- package/dist/docs/reference/mesh/PlanarMeshOptimizationResult.md +0 -124
- package/dist/docs/reference/mesh/PlanarPatchQuality.md +0 -194
- package/dist/docs/reference/mesh/RevolveOptions.md +0 -91
- package/dist/docs/reference/mesh/SolidMeshValidationOptions.md +0 -38
- package/dist/docs/reference/mesh/SquareThreadProfileSpec.md +0 -79
- package/dist/docs/reference/mesh/SweepOptions.md +0 -113
- package/dist/docs/reference/mesh/SweepOrientation.md +0 -113
- package/dist/docs/reference/mesh/ThreadEndStyle.md +0 -14
- package/dist/docs/reference/mesh/ThreadEndTreatmentOptions.md +0 -117
- package/dist/docs/reference/mesh/ThreadHandedness.md +0 -14
- package/dist/docs/reference/mesh/ThreadLeadInEnvelope.md +0 -14
- package/dist/docs/reference/mesh/ThreadLeadInShape.md +0 -14
- package/dist/docs/reference/mesh/ThreadProfile.md +0 -86
- package/dist/docs/reference/mesh/ThreadProfileBaseSpec.md +0 -53
- package/dist/docs/reference/mesh/ThreadProfileSpec.md +0 -23
- package/dist/docs/reference/mesh/ThreadRidgeOptions.md +0 -145
- package/dist/docs/reference/mesh/ThreadSolidOptions.md +0 -222
- package/dist/docs/reference/mesh/ThreadSolidPreflight.md +0 -58
- package/dist/docs/reference/mesh/Transform2.md +0 -256
- package/dist/docs/reference/mesh/Transform2Data.md +0 -14
- package/dist/docs/reference/mesh/Transform2Input.md +0 -19
- package/dist/docs/reference/mesh/Transform3.md +0 -296
- package/dist/docs/reference/mesh/Transform3Data.md +0 -17
- package/dist/docs/reference/mesh/Transform3Input.md +0 -19
- package/dist/docs/reference/mesh/TrapezoidalThreadProfileSpec.md +0 -96
- package/dist/docs/reference/mesh/TriangleMesh.md +0 -34
- package/dist/docs/reference/mesh/TriangleMeshAnalysis.md +0 -129
- package/dist/docs/reference/mesh/TriangleMeshAnalysisOptions.md +0 -79
- package/dist/docs/reference/mesh/TriangleMeshInput.md +0 -19
- package/dist/docs/reference/mesh/TriangleMeshMeasurements.md +0 -79
- package/dist/docs/reference/mesh/TriangleMeshQualityOptions.md +0 -43
- package/dist/docs/reference/mesh/TriangleMeshQualityReport.md +0 -194
- package/dist/docs/reference/mesh/TriangleMeshSignature.md +0 -111
- package/dist/docs/reference/mesh/TriangleMeshSignatureOptions.md +0 -46
- package/dist/docs/reference/mesh/TriangleMeshSignatureTolerances.md +0 -34
- package/dist/docs/reference/mesh/TriangleMeshTopologyAnalysis.md +0 -131
- package/dist/docs/reference/mesh/TriangleMeshValidationOptions.md +0 -55
- package/dist/docs/reference/mesh/TriangularThreadProfileSpec.md +0 -95
- package/dist/docs/reference/mesh/Vector2.md +0 -270
- package/dist/docs/reference/mesh/Vector2Data.md +0 -14
- package/dist/docs/reference/mesh/Vector2Input.md +0 -19
- package/dist/docs/reference/mesh/Vector3.md +0 -282
- package/dist/docs/reference/mesh/Vector3Data.md +0 -14
- package/dist/docs/reference/mesh/Vector3Input.md +0 -19
- package/dist/docs/reference/model/AcmeThreadProfileSpec.md +0 -80
- package/dist/docs/reference/model/Anchor3.md +0 -55
- package/dist/docs/reference/model/AttachOptions.md +0 -69
- package/dist/docs/reference/model/Bevel.md +0 -19
- package/dist/docs/reference/model/BevelSize.md +0 -15
- package/dist/docs/reference/model/Bounds2-type.md +0 -125
- package/dist/docs/reference/model/Bounds2Data.md +0 -44
- package/dist/docs/reference/model/Bounds2Input.md +0 -19
- package/dist/docs/reference/model/Bounds2Options.md +0 -110
- package/dist/docs/reference/model/Bounds3-type.md +0 -125
- package/dist/docs/reference/model/Bounds3Data.md +0 -44
- package/dist/docs/reference/model/Bounds3Input.md +0 -19
- package/dist/docs/reference/model/Bounds3Options.md +0 -110
- package/dist/docs/reference/model/BoxEdge.md +0 -15
- package/dist/docs/reference/model/BoxEdgeSelection.md +0 -19
- package/dist/docs/reference/model/BoxEdgeTreatments.md +0 -20
- package/dist/docs/reference/model/BoxOptions.md +0 -92
- package/dist/docs/reference/model/ButtressPressureFlankSide.md +0 -15
- package/dist/docs/reference/model/ButtressThreadProfileSpec.md +0 -98
- package/dist/docs/reference/model/ChamferedEdgeTreatment.md +0 -35
- package/dist/docs/reference/model/CircleContourOptions.md +0 -21
- package/dist/docs/reference/model/CircularPrimitiveOptions.md +0 -62
- package/dist/docs/reference/model/Computed.md +0 -44
- package/dist/docs/reference/model/ComputedValue.md +0 -24
- package/dist/docs/reference/model/Contour.md +0 -24
- package/dist/docs/reference/model/CorrespondingComponent.md +0 -46
- package/dist/docs/reference/model/CorrespondingContour.md +0 -46
- package/dist/docs/reference/model/CorrespondingProfile.md +0 -22
- package/dist/docs/reference/model/CorrespondingProfileStation.md +0 -27
- package/dist/docs/reference/model/CurveSamplingOptions.md +0 -68
- package/dist/docs/reference/model/CustomThreadProfileSpec.md +0 -78
- package/dist/docs/reference/model/CylinderOptions.md +0 -58
- package/dist/docs/reference/model/EdgeTreatment.md +0 -22
- package/dist/docs/reference/model/EllipseContourOptions.md +0 -21
- package/dist/docs/reference/model/EndTreatments.md +0 -39
- package/dist/docs/reference/model/ExtrudeMeshOptions.md +0 -133
- package/dist/docs/reference/model/ExtrudeOptions.md +0 -149
- package/dist/docs/reference/model/ExtrusionSamplingOptions.md +0 -84
- package/dist/docs/reference/model/Frame3.md +0 -63
- package/dist/docs/reference/model/GeometryError.md +0 -102
- package/dist/docs/reference/model/GeometryErrorCode.md +0 -15
- package/dist/docs/reference/model/GeometryErrorContext.md +0 -35
- package/dist/docs/reference/model/GeometryResolution.md +0 -70
- package/dist/docs/reference/model/GeometrySamplingLimits.md +0 -62
- package/dist/docs/reference/model/GeometryToleranceOptions.md +0 -46
- package/dist/docs/reference/model/GridPatternOptions.md +0 -50
- package/dist/docs/reference/model/HeightfieldOptions.md +0 -68
- package/dist/docs/reference/model/ImmutableBuffer-type.md +0 -108
- package/dist/docs/reference/model/ImmutableTriangleMesh.md +0 -43
- package/dist/docs/reference/model/InternalThreadCutterOptions.md +0 -216
- package/dist/docs/reference/model/KnuckleHingeBaseSpec.md +0 -77
- package/dist/docs/reference/model/KnuckleHingeSamplingOptions.md +0 -47
- package/dist/docs/reference/model/KnuckleHingeSpec.md +0 -18
- package/dist/docs/reference/model/LinearPatternOptions.md +0 -39
- package/dist/docs/reference/model/LoftCorrespondence.md +0 -27
- package/dist/docs/reference/model/LoftOptions.md +0 -91
- package/dist/docs/reference/model/LoftPlacement.md +0 -73
- package/dist/docs/reference/model/MatchProfilesOptions.md +0 -35
- package/dist/docs/reference/model/ModelingLimits.md +0 -126
- package/dist/docs/reference/model/NumericArray.md +0 -14
- package/dist/docs/reference/model/Path2-type.md +0 -196
- package/dist/docs/reference/model/Path2Data.md +0 -50
- package/dist/docs/reference/model/Path2Input.md +0 -20
- package/dist/docs/reference/model/Path3-type.md +0 -196
- package/dist/docs/reference/model/Path3Data.md +0 -50
- package/dist/docs/reference/model/Path3Input.md +0 -20
- package/dist/docs/reference/model/PathLocation.md +0 -69
- package/dist/docs/reference/model/PathNormalGuide.md +0 -46
- package/dist/docs/reference/model/PathOptions.md +0 -38
- package/dist/docs/reference/model/PathPatternOptions.md +0 -48
- package/dist/docs/reference/model/PathResamplingOptions.md +0 -84
- package/dist/docs/reference/model/Pivot2Options.md +0 -28
- package/dist/docs/reference/model/Pivot3Options.md +0 -28
- package/dist/docs/reference/model/PolygonData.md +0 -44
- package/dist/docs/reference/model/PrimitiveAttachment.md +0 -39
- package/dist/docs/reference/model/PrimitiveAttachmentOptions.md +0 -110
- package/dist/docs/reference/model/PrintableThreadFit.md +0 -15
- package/dist/docs/reference/model/PrintableThreadFitPolicy.md +0 -51
- package/dist/docs/reference/model/ProfileComponent2.md +0 -46
- package/dist/docs/reference/model/ProfileContour2.md +0 -36
- package/dist/docs/reference/model/ProfileSpan2.md +0 -47
- package/dist/docs/reference/model/ProfiledEdgeTreatment.md +0 -41
- package/dist/docs/reference/model/RadialPatternOptions.md +0 -59
- package/dist/docs/reference/model/RadialSizing.md +0 -15
- package/dist/docs/reference/model/RadialSizingOptions.md +0 -40
- package/dist/docs/reference/model/RectangleContourOptions.md +0 -72
- package/dist/docs/reference/model/RectangleCornerTreatment.md +0 -40
- package/dist/docs/reference/model/RectangleCornerTreatments.md +0 -20
- package/dist/docs/reference/model/RegionData.md +0 -19
- package/dist/docs/reference/model/RevolveOptions.md +0 -94
- package/dist/docs/reference/model/RoundedEdgeTreatment.md +0 -96
- package/dist/docs/reference/model/SmoothEdgeTreatment.md +0 -76
- package/dist/docs/reference/model/SphereOptions.md +0 -20
- package/dist/docs/reference/model/SquareThreadProfileSpec.md +0 -80
- package/dist/docs/reference/model/StarContourOptions.md +0 -81
- package/dist/docs/reference/model/StrokeCap.md +0 -16
- package/dist/docs/reference/model/StrokeJoin.md +0 -16
- package/dist/docs/reference/model/StrokeOptions.md +0 -91
- package/dist/docs/reference/model/SweepOptions.md +0 -116
- package/dist/docs/reference/model/SweepOrientation.md +0 -116
- package/dist/docs/reference/model/ThreadBevelOptions.md +0 -35
- package/dist/docs/reference/model/ThreadEndStyle.md +0 -15
- package/dist/docs/reference/model/ThreadEndTreatmentOptions.md +0 -118
- package/dist/docs/reference/model/ThreadHandedness.md +0 -15
- package/dist/docs/reference/model/ThreadLeadInEnvelope.md +0 -15
- package/dist/docs/reference/model/ThreadLeadInShape.md +0 -15
- package/dist/docs/reference/model/ThreadProfile.md +0 -87
- package/dist/docs/reference/model/ThreadProfileBaseSpec.md +0 -54
- package/dist/docs/reference/model/ThreadProfileSpec.md +0 -24
- package/dist/docs/reference/model/ThreadRidgeOptions.md +0 -141
- package/dist/docs/reference/model/ThreadSolidPreflight.md +0 -59
- package/dist/docs/reference/model/ThreadedNutOptions.md +0 -263
- package/dist/docs/reference/model/ThreadedNutPreflight.md +0 -111
- package/dist/docs/reference/model/ThreadedNutShape.md +0 -15
- package/dist/docs/reference/model/ThreadedRodOptions.md +0 -216
- package/dist/docs/reference/model/TorusOptions.md +0 -110
- package/dist/docs/reference/model/Transform2-type.md +0 -257
- package/dist/docs/reference/model/Transform2Data.md +0 -16
- package/dist/docs/reference/model/Transform2Input.md +0 -21
- package/dist/docs/reference/model/Transform3-type.md +0 -297
- package/dist/docs/reference/model/Transform3Data.md +0 -19
- package/dist/docs/reference/model/Transform3Input.md +0 -21
- package/dist/docs/reference/model/TrapezoidalThreadProfileSpec.md +0 -97
- package/dist/docs/reference/model/TriangleMesh.md +0 -34
- package/dist/docs/reference/model/TriangleMeshAnalysis.md +0 -129
- package/dist/docs/reference/model/TriangleMeshMeasurements.md +0 -79
- package/dist/docs/reference/model/TriangleMeshTopologyAnalysis.md +0 -131
- package/dist/docs/reference/model/TriangularThreadProfileSpec.md +0 -96
- package/dist/docs/reference/model/TubeOptions.md +0 -67
- package/dist/docs/reference/model/Vector2-type.md +0 -271
- package/dist/docs/reference/model/Vector2Data.md +0 -15
- package/dist/docs/reference/model/Vector2Input.md +0 -21
- package/dist/docs/reference/model/Vector3-type.md +0 -283
- package/dist/docs/reference/model/Vector3Data.md +0 -15
- package/dist/docs/reference/model/Vector3Input.md +0 -21
- package/dist/docs/reference/model/VectorTextLayout.md +0 -40
- package/dist/docs/reference/model/VectorTextMetrics.md +0 -100
- package/dist/docs/reference/model/bounds2.md +0 -37
- package/dist/docs/reference/model/bounds3.md +0 -37
- package/dist/docs/reference/model/categories/bounds.md +0 -38
- package/dist/docs/reference/model/categories/contracts.md +0 -16
- package/dist/docs/reference/model/categories/core-values-errors.md +0 -44
- package/dist/docs/reference/model/categories/paths.md +0 -42
- package/dist/docs/reference/model/categories/resolution.md +0 -20
- package/dist/docs/reference/model/immutableBuffer.md +0 -49
- package/dist/docs/reference/model/isGeometryError.md +0 -34
- package/dist/docs/reference/model/path2.md +0 -54
- package/dist/docs/reference/model/path3.md +0 -49
- package/dist/docs/reference/model/transform2.md +0 -46
- package/dist/docs/reference/model/transform3.md +0 -48
- package/dist/docs/reference/model/vector2.md +0 -40
- package/dist/docs/reference/model/vector3.md +0 -47
- package/dist/docs/reference/text/Bounds2Data.md +0 -34
- package/dist/docs/reference/text/Vector2Data.md +0 -7
- package/dist/docs/reference/text/VectorTextArcBaseline.md +0 -53
- package/dist/docs/reference/text/VectorTextLayout.md +0 -34
- package/dist/docs/reference/text/VectorTextLayoutOptions.md +0 -111
- package/dist/docs/reference/text/VectorTextMetrics.md +0 -94
- package/dist/docs/reference/text/VectorTextOptions.md +0 -50
- package/dist/engine/export-3mf.js +0 -23
- package/dist/engine/serialize-3mf.js +0 -116
- /package/dist/{engine → geometry/mesh}/mesh-view-cache.js +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Explicit polygon topology or compound contours; all closing edges are implicit.
|
|
4
4
|
|
|
5
|
-
**PolygonOptions** = \{ `outer`: [`Path2Input`](Path2Input.md); `holes?`: readonly [`Path2Input`](Path2Input.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \} \| \{ `contours`: readonly [`Path2Input`](Path2Input.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \} \| \{ `polygons`: [`RegionData`](RegionData.md); `outer?`: `never`; `holes?`: `never`; `contours?`: `never`; `fillRule?`: `never`; \}
|
|
5
|
+
**PolygonOptions** = \{ `outer`: [`Path2Input`](../geometry/Path2Input.md); `holes?`: readonly [`Path2Input`](../geometry/Path2Input.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \} \| \{ `contours`: readonly [`Path2Input`](../geometry/Path2Input.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \} \| \{ `polygons`: [`RegionData`](../geometry/RegionData.md); `outer?`: `never`; `holes?`: `never`; `contours?`: `never`; `fillRule?`: `never`; \}
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
@@ -10,13 +10,13 @@ Explicit polygon topology or compound contours; all closing edges are implicit.
|
|
|
10
10
|
|
|
11
11
|
### Type Literal
|
|
12
12
|
|
|
13
|
-
\{ `outer`: [`Path2Input`](Path2Input.md); `holes?`: readonly [`Path2Input`](Path2Input.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \}
|
|
13
|
+
\{ `outer`: [`Path2Input`](../geometry/Path2Input.md); `holes?`: readonly [`Path2Input`](../geometry/Path2Input.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \}
|
|
14
14
|
|
|
15
15
|
#### outer
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
19
|
-
`readonly` **outer**: [`Path2Input`](Path2Input.md)
|
|
19
|
+
`readonly` **outer**: [`Path2Input`](../geometry/Path2Input.md)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ One simple exterior boundary, normalized to counterclockwise winding.
|
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
29
|
-
`readonly` `optional` **holes?**: readonly [`Path2Input`](Path2Input.md)[]
|
|
29
|
+
`readonly` `optional` **holes?**: readonly [`Path2Input`](../geometry/Path2Input.md)[]
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
@@ -66,13 +66,13 @@ Explicit topology excludes serialized multi-polygon data.
|
|
|
66
66
|
|
|
67
67
|
### Type Literal
|
|
68
68
|
|
|
69
|
-
\{ `contours`: readonly [`Path2Input`](Path2Input.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \}
|
|
69
|
+
\{ `contours`: readonly [`Path2Input`](../geometry/Path2Input.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \}
|
|
70
70
|
|
|
71
71
|
#### contours
|
|
72
72
|
|
|
73
73
|
|
|
74
74
|
|
|
75
|
-
`readonly` **contours**: readonly [`Path2Input`](Path2Input.md)[]
|
|
75
|
+
`readonly` **contours**: readonly [`Path2Input`](../geometry/Path2Input.md)[]
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
|
|
@@ -122,13 +122,13 @@ Compound fill excludes serialized multi-polygon data.
|
|
|
122
122
|
|
|
123
123
|
### Type Literal
|
|
124
124
|
|
|
125
|
-
\{ `polygons`: [`RegionData`](RegionData.md); `outer?`: `never`; `holes?`: `never`; `contours?`: `never`; `fillRule?`: `never`; \}
|
|
125
|
+
\{ `polygons`: [`RegionData`](../geometry/RegionData.md); `outer?`: `never`; `holes?`: `never`; `contours?`: `never`; `fillRule?`: `never`; \}
|
|
126
126
|
|
|
127
127
|
#### polygons
|
|
128
128
|
|
|
129
129
|
|
|
130
130
|
|
|
131
|
-
`readonly` **polygons**: [`RegionData`](RegionData.md)
|
|
131
|
+
`readonly` **polygons**: [`RegionData`](../geometry/RegionData.md)
|
|
132
132
|
|
|
133
133
|
|
|
134
134
|
|
|
@@ -177,13 +177,19 @@ Serialized polygons define fill explicitly.
|
|
|
177
177
|
|
|
178
178
|
## Related APIs
|
|
179
179
|
|
|
180
|
-
- [Path2Input](Path2Input.md)
|
|
181
|
-
- [RegionData](RegionData.md)
|
|
180
|
+
- [Path2Input](../geometry/Path2Input.md)
|
|
181
|
+
- [RegionData](../geometry/RegionData.md)
|
|
182
182
|
|
|
183
183
|
## Guides
|
|
184
184
|
|
|
185
|
-
- [Section, hole, offset, and extrusion](../../guides/
|
|
186
|
-
- [SVG sections: fills and strokes are different inputs](../../guides/
|
|
187
|
-
- [Text and font variability](../../guides/
|
|
185
|
+
- [Section, hole, offset, and extrusion](../../guides/profiles-and-extrusion.md#section-hole-offset-and-extrusion)
|
|
186
|
+
- [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
|
|
187
|
+
- [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
|
|
188
188
|
|
|
189
|
-
|
|
189
|
+
## Supported imports
|
|
190
|
+
|
|
191
|
+
```ts
|
|
192
|
+
import type { PolygonOptions } from "@metamesh/modeling";
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Package: `@metamesh/modeling@0.19.0`.
|
|
@@ -8,7 +8,7 @@ An explicit component/contour/span topology, before shared family sampling with
|
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
`readonly` **components**: readonly [`ProfileComponent2`](ProfileComponent2.md)[]
|
|
11
|
+
`readonly` **components**: readonly [`ProfileComponent2`](../geometry/ProfileComponent2.md)[]
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
|
|
@@ -17,8 +17,14 @@ Ordered components with explicit contour identities.
|
|
|
17
17
|
|
|
18
18
|
## Related APIs
|
|
19
19
|
|
|
20
|
-
- [ProfileComponent2](ProfileComponent2.md)
|
|
21
|
-
- [CorrespondingProfile](CorrespondingProfile.md)
|
|
20
|
+
- [ProfileComponent2](../geometry/ProfileComponent2.md)
|
|
21
|
+
- [CorrespondingProfile](../geometry/CorrespondingProfile.md)
|
|
22
22
|
- [matchProfiles](matchProfiles.md)
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
## Supported imports
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import type { Profile } from "@metamesh/modeling";
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Package: `@metamesh/modeling@0.19.0`.
|
|
@@ -4,8 +4,8 @@ Rectangle dimensions, placement and uniform or per-corner treatment.
|
|
|
4
4
|
|
|
5
5
|
## Extends
|
|
6
6
|
|
|
7
|
-
- [`RectangleContourOptions`](RectangleContourOptions.md)
|
|
8
|
-
- [`PrimitiveAttachment`](PrimitiveAttachment.md)
|
|
7
|
+
- [`RectangleContourOptions`](../geometry/RectangleContourOptions.md)
|
|
8
|
+
- [`PrimitiveAttachment`](../geometry/PrimitiveAttachment.md)
|
|
9
9
|
|
|
10
10
|
## Properties
|
|
11
11
|
|
|
@@ -13,7 +13,7 @@ Rectangle dimensions, placement and uniform or per-corner treatment.
|
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
|
|
16
|
+
`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](../geometry/PrimitiveAttachmentOptions.md)
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -21,7 +21,7 @@ Applied after local construction; Section attachment must preserve the XY plane.
|
|
|
21
21
|
|
|
22
22
|
#### Inherited from
|
|
23
23
|
|
|
24
|
-
[`PrimitiveAttachment`](PrimitiveAttachment.md).[`attachment`](PrimitiveAttachment.md#attachment)
|
|
24
|
+
[`PrimitiveAttachment`](../geometry/PrimitiveAttachment.md).[`attachment`](../geometry/PrimitiveAttachment.md#attachment)
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ Applied after local construction; Section attachment must preserve the XY plane.
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
`readonly` **size**: `number` \| [`Vector2Input`](Vector2Input.md)
|
|
32
|
+
`readonly` **size**: `number` \| [`Vector2Input`](../geometry/Vector2Input.md)
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -37,7 +37,7 @@ Positive uniform size or explicit XY extents in millimetres.
|
|
|
37
37
|
|
|
38
38
|
#### Inherited from
|
|
39
39
|
|
|
40
|
-
[`RectangleContourOptions`](RectangleContourOptions.md).[`size`](RectangleContourOptions.md#size)
|
|
40
|
+
[`RectangleContourOptions`](../geometry/RectangleContourOptions.md).[`size`](../geometry/RectangleContourOptions.md#size)
|
|
41
41
|
|
|
42
42
|
***
|
|
43
43
|
|
|
@@ -53,7 +53,7 @@ Center on XY; otherwise the minimum corner is the origin. Defaults to true.
|
|
|
53
53
|
|
|
54
54
|
#### Inherited from
|
|
55
55
|
|
|
56
|
-
[`RectangleContourOptions`](RectangleContourOptions.md).[`center`](RectangleContourOptions.md#center)
|
|
56
|
+
[`RectangleContourOptions`](../geometry/RectangleContourOptions.md).[`center`](../geometry/RectangleContourOptions.md#center)
|
|
57
57
|
|
|
58
58
|
***
|
|
59
59
|
|
|
@@ -61,7 +61,7 @@ Center on XY; otherwise the minimum corner is the origin. Defaults to true.
|
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
|
|
64
|
-
`readonly` `optional` **treatment?**: [`EdgeTreatment`](EdgeTreatment.md) \| [`RectangleCornerTreatments`](RectangleCornerTreatments.md)
|
|
64
|
+
`readonly` `optional` **treatment?**: [`EdgeTreatment`](../geometry/EdgeTreatment.md) \| [`RectangleCornerTreatments`](../geometry/RectangleCornerTreatments.md)
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
|
|
@@ -69,7 +69,7 @@ Uniform treatment or four corner treatments. Exact round segments describe a com
|
|
|
69
69
|
|
|
70
70
|
#### Inherited from
|
|
71
71
|
|
|
72
|
-
[`RectangleContourOptions`](RectangleContourOptions.md).[`treatment`](RectangleContourOptions.md#treatment)
|
|
72
|
+
[`RectangleContourOptions`](../geometry/RectangleContourOptions.md).[`treatment`](../geometry/RectangleContourOptions.md#treatment)
|
|
73
73
|
|
|
74
74
|
***
|
|
75
75
|
|
|
@@ -77,7 +77,7 @@ Uniform treatment or four corner treatments. Exact round segments describe a com
|
|
|
77
77
|
|
|
78
78
|
|
|
79
79
|
|
|
80
|
-
`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
|
|
80
|
+
`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\>
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
|
|
@@ -85,23 +85,29 @@ Explicit sampling ceiling for the complete output profile.
|
|
|
85
85
|
|
|
86
86
|
#### Inherited from
|
|
87
87
|
|
|
88
|
-
[`RectangleContourOptions`](RectangleContourOptions.md).[`limits`](RectangleContourOptions.md#limits)
|
|
88
|
+
[`RectangleContourOptions`](../geometry/RectangleContourOptions.md).[`limits`](../geometry/RectangleContourOptions.md#limits)
|
|
89
89
|
|
|
90
90
|
|
|
91
91
|
## Related APIs
|
|
92
92
|
|
|
93
|
-
- [EdgeTreatment](EdgeTreatment.md)
|
|
94
|
-
- [GeometrySamplingLimits](GeometrySamplingLimits.md)
|
|
95
|
-
- [PrimitiveAttachment](PrimitiveAttachment.md)
|
|
96
|
-
- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
|
|
97
|
-
- [RectangleContourOptions](RectangleContourOptions.md)
|
|
98
|
-
- [RectangleCornerTreatments](RectangleCornerTreatments.md)
|
|
99
|
-
- [Vector2Input](Vector2Input.md)
|
|
93
|
+
- [EdgeTreatment](../geometry/EdgeTreatment.md)
|
|
94
|
+
- [GeometrySamplingLimits](../geometry/GeometrySamplingLimits.md)
|
|
95
|
+
- [PrimitiveAttachment](../geometry/PrimitiveAttachment.md)
|
|
96
|
+
- [PrimitiveAttachmentOptions](../geometry/PrimitiveAttachmentOptions.md)
|
|
97
|
+
- [RectangleContourOptions](../geometry/RectangleContourOptions.md)
|
|
98
|
+
- [RectangleCornerTreatments](../geometry/RectangleCornerTreatments.md)
|
|
99
|
+
- [Vector2Input](../geometry/Vector2Input.md)
|
|
100
100
|
|
|
101
101
|
## Guides
|
|
102
102
|
|
|
103
|
-
- [Section, hole, offset, and extrusion](../../guides/
|
|
104
|
-
- [SVG sections: fills and strokes are different inputs](../../guides/
|
|
105
|
-
- [Text and font variability](../../guides/
|
|
103
|
+
- [Section, hole, offset, and extrusion](../../guides/profiles-and-extrusion.md#section-hole-offset-and-extrusion)
|
|
104
|
+
- [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
|
|
105
|
+
- [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
|
|
106
106
|
|
|
107
|
-
|
|
107
|
+
## Supported imports
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
import type { RectangleOptions } from "@metamesh/modeling";
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Package: `@metamesh/modeling@0.19.0`.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Regular polygon dimensions, radial convention and degree rotation.
|
|
4
4
|
|
|
5
|
-
**RegularPolygonOptions** = [`RadialSizingOptions`](RadialSizingOptions.md) & [`PrimitiveAttachment`](PrimitiveAttachment.md) & `object`
|
|
5
|
+
**RegularPolygonOptions** = [`RadialSizingOptions`](../geometry/RadialSizingOptions.md) & [`PrimitiveAttachment`](../geometry/PrimitiveAttachment.md) & `object`
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
@@ -41,13 +41,19 @@ Counterclockwise rotation in degrees; defaults to zero with a vertex on +X.
|
|
|
41
41
|
|
|
42
42
|
## Related APIs
|
|
43
43
|
|
|
44
|
-
- [PrimitiveAttachment](PrimitiveAttachment.md)
|
|
45
|
-
- [RadialSizingOptions](RadialSizingOptions.md)
|
|
44
|
+
- [PrimitiveAttachment](../geometry/PrimitiveAttachment.md)
|
|
45
|
+
- [RadialSizingOptions](../geometry/RadialSizingOptions.md)
|
|
46
46
|
|
|
47
47
|
## Guides
|
|
48
48
|
|
|
49
|
-
- [Section, hole, offset, and extrusion](../../guides/
|
|
50
|
-
- [SVG sections: fills and strokes are different inputs](../../guides/
|
|
51
|
-
- [Text and font variability](../../guides/
|
|
49
|
+
- [Section, hole, offset, and extrusion](../../guides/profiles-and-extrusion.md#section-hole-offset-and-extrusion)
|
|
50
|
+
- [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
|
|
51
|
+
- [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
## Supported imports
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
import type { RegularPolygonOptions } from "@metamesh/modeling";
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Package: `@metamesh/modeling@0.19.0`.
|
|
@@ -18,25 +18,13 @@ const body = rectangle({ size: [20, 12] })
|
|
|
18
18
|
.extrude({ height: 4 });
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
### \[sectionBrand\]
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
`readonly` **\[sectionBrand\]**: `"Section"`
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
Compile-time identity brand for an immutable filled section recipe.
|
|
32
|
-
|
|
33
21
|
## Methods
|
|
34
22
|
|
|
35
23
|
### translate()
|
|
36
24
|
|
|
37
25
|
|
|
38
26
|
|
|
39
|
-
**translate**(`offset`: [`Vector2Input`](Vector2Input.md)): `Section`
|
|
27
|
+
**translate**(`offset`: [`Vector2Input`](../geometry/Vector2Input.md)): `Section`
|
|
40
28
|
|
|
41
29
|
|
|
42
30
|
|
|
@@ -46,7 +34,7 @@ Translates XY coordinates in millimetres.
|
|
|
46
34
|
|
|
47
35
|
<a id="offset"></a>
|
|
48
36
|
|
|
49
|
-
**`offset`** · [`Vector2Input`](Vector2Input.md) · Required
|
|
37
|
+
**`offset`** · [`Vector2Input`](../geometry/Vector2Input.md) · Required
|
|
50
38
|
|
|
51
39
|
|
|
52
40
|
|
|
@@ -60,7 +48,7 @@ Translates XY coordinates in millimetres.
|
|
|
60
48
|
|
|
61
49
|
|
|
62
50
|
|
|
63
|
-
**rotate**(`degrees`: `number`, `options?`: [`Pivot2Options`](Pivot2Options.md)): `Section`
|
|
51
|
+
**rotate**(`degrees`: `number`, `options?`: [`Pivot2Options`](../geometry/Pivot2Options.md)): `Section`
|
|
64
52
|
|
|
65
53
|
|
|
66
54
|
|
|
@@ -77,9 +65,9 @@ Rotates counterclockwise in degrees.
|
|
|
77
65
|
|
|
78
66
|
<a id="options"></a>
|
|
79
67
|
|
|
80
|
-
**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
|
|
68
|
+
**`options`** · [`Pivot2Options`](../geometry/Pivot2Options.md) · Optional
|
|
81
69
|
|
|
82
|
-
- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
|
|
70
|
+
- [`pivot`](../geometry/Pivot2Options.md#pivot) · [`Vector2Input`](../geometry/Vector2Input.md) · Optional
|
|
83
71
|
|
|
84
72
|
World-space point left fixed by rotation or scaling.
|
|
85
73
|
|
|
@@ -95,7 +83,7 @@ Rotates counterclockwise in degrees.
|
|
|
95
83
|
|
|
96
84
|
|
|
97
85
|
|
|
98
|
-
**scale**(`factors`: `number` \| [`Vector2Input`](Vector2Input.md), `options?`: [`Pivot2Options`](Pivot2Options.md)): `Section`
|
|
86
|
+
**scale**(`factors`: `number` \| [`Vector2Input`](../geometry/Vector2Input.md), `options?`: [`Pivot2Options`](../geometry/Pivot2Options.md)): `Section`
|
|
99
87
|
|
|
100
88
|
|
|
101
89
|
|
|
@@ -106,15 +94,15 @@ Uniform or per-axis nonsingular scaling; negative factors reflect geometry.
|
|
|
106
94
|
|
|
107
95
|
<a id="factors"></a>
|
|
108
96
|
|
|
109
|
-
**`factors`** · `number` \| [`Vector2Input`](Vector2Input.md) · Required
|
|
97
|
+
**`factors`** · `number` \| [`Vector2Input`](../geometry/Vector2Input.md) · Required
|
|
110
98
|
|
|
111
99
|
|
|
112
100
|
|
|
113
101
|
<a id="options-1"></a>
|
|
114
102
|
|
|
115
|
-
**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
|
|
103
|
+
**`options`** · [`Pivot2Options`](../geometry/Pivot2Options.md) · Optional
|
|
116
104
|
|
|
117
|
-
- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
|
|
105
|
+
- [`pivot`](../geometry/Pivot2Options.md#pivot) · [`Vector2Input`](../geometry/Vector2Input.md) · Optional
|
|
118
106
|
|
|
119
107
|
World-space point left fixed by rotation or scaling.
|
|
120
108
|
|
|
@@ -130,7 +118,7 @@ Uniform or per-axis nonsingular scaling; negative factors reflect geometry.
|
|
|
130
118
|
|
|
131
119
|
|
|
132
120
|
|
|
133
|
-
**mirror**(`normal`: [`Vector2Input`](Vector2Input.md)): `Section`
|
|
121
|
+
**mirror**(`normal`: [`Vector2Input`](../geometry/Vector2Input.md)): `Section`
|
|
134
122
|
|
|
135
123
|
|
|
136
124
|
|
|
@@ -140,7 +128,7 @@ Reflection across an origin line/plane.
|
|
|
140
128
|
|
|
141
129
|
<a id="normal"></a>
|
|
142
130
|
|
|
143
|
-
**`normal`** · [`Vector2Input`](Vector2Input.md) · Required
|
|
131
|
+
**`normal`** · [`Vector2Input`](../geometry/Vector2Input.md) · Required
|
|
144
132
|
|
|
145
133
|
|
|
146
134
|
|
|
@@ -154,7 +142,7 @@ Reflection across an origin line/plane.
|
|
|
154
142
|
|
|
155
143
|
|
|
156
144
|
|
|
157
|
-
**transform**(`placement`: [`Transform2Input`](Transform2Input.md)): `Section`
|
|
145
|
+
**transform**(`placement`: [`Transform2Input`](../geometry/Transform2Input.md)): `Section`
|
|
158
146
|
|
|
159
147
|
|
|
160
148
|
|
|
@@ -164,7 +152,7 @@ Applies a reusable XY placement or canonical row-major matrix.
|
|
|
164
152
|
|
|
165
153
|
<a id="placement"></a>
|
|
166
154
|
|
|
167
|
-
**`placement`** · [`Transform2Input`](Transform2Input.md) · Required
|
|
155
|
+
**`placement`** · [`Transform2Input`](../geometry/Transform2Input.md) · Required
|
|
168
156
|
|
|
169
157
|
|
|
170
158
|
|
|
@@ -178,7 +166,7 @@ Applies a reusable XY placement or canonical row-major matrix.
|
|
|
178
166
|
|
|
179
167
|
|
|
180
168
|
|
|
181
|
-
**toRegionData**(): [`RegionData`](RegionData.md)
|
|
169
|
+
**toRegionData**(): [`RegionData`](../geometry/RegionData.md)
|
|
182
170
|
|
|
183
171
|
|
|
184
172
|
|
|
@@ -186,7 +174,7 @@ Copies canonical filled polygons for interchange; requires an active model execu
|
|
|
186
174
|
|
|
187
175
|
#### Returns
|
|
188
176
|
|
|
189
|
-
[`RegionData`](RegionData.md)
|
|
177
|
+
[`RegionData`](../geometry/RegionData.md)
|
|
190
178
|
|
|
191
179
|
***
|
|
192
180
|
|
|
@@ -294,7 +282,7 @@ than selecting a lower rendering quality; fine features may be removed.
|
|
|
294
282
|
|
|
295
283
|
|
|
296
284
|
|
|
297
|
-
**withAnchors**(`anchors`: `Readonly`\<`Record`\<`string`, [`Anchor3`](Anchor3.md)\>\>): `Section`
|
|
285
|
+
**withAnchors**(`anchors`: `Readonly`\<`Record`\<`string`, [`Anchor3`](../geometry/Anchor3-type.md)\>\>): `Section`
|
|
298
286
|
|
|
299
287
|
|
|
300
288
|
|
|
@@ -304,7 +292,7 @@ Returns a new recipe with copied named anchors; existing names may be replaced.
|
|
|
304
292
|
|
|
305
293
|
<a id="anchors"></a>
|
|
306
294
|
|
|
307
|
-
**`anchors`** · `Readonly`\<`Record`\<`string`, [`Anchor3`](Anchor3.md)\>\> · Required
|
|
295
|
+
**`anchors`** · `Readonly`\<`Record`\<`string`, [`Anchor3`](../geometry/Anchor3-type.md)\>\> · Required
|
|
308
296
|
|
|
309
297
|
|
|
310
298
|
|
|
@@ -348,7 +336,7 @@ Native millimetre offset preserving holes.
|
|
|
348
336
|
|
|
349
337
|
Maximum miter extension in offset-distance multiples; at least two.
|
|
350
338
|
|
|
351
|
-
- [`resolution`](SectionOffsetOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
|
|
339
|
+
- [`resolution`](SectionOffsetOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
|
|
352
340
|
|
|
353
341
|
Operation-level physical tessellation policy over the active model-wide policy.
|
|
354
342
|
|
|
@@ -364,7 +352,7 @@ Native millimetre offset preserving holes.
|
|
|
364
352
|
|
|
365
353
|
|
|
366
354
|
|
|
367
|
-
**extrude**(`options`: [`ExtrudeOptions`](ExtrudeOptions.md)): [`Solid`](Solid.md)
|
|
355
|
+
**extrude**(`options`: [`ExtrudeOptions`](../geometry/ExtrudeOptions.md)): [`Solid`](Solid.md)
|
|
368
356
|
|
|
369
357
|
|
|
370
358
|
|
|
@@ -374,37 +362,37 @@ Extrudes along +Z with degree twist and top scaling.
|
|
|
374
362
|
|
|
375
363
|
<a id="options-3"></a>
|
|
376
364
|
|
|
377
|
-
**`options`** · [`ExtrudeOptions`](ExtrudeOptions.md) · Required
|
|
365
|
+
**`options`** · [`ExtrudeOptions`](../geometry/ExtrudeOptions.md) · Required
|
|
378
366
|
|
|
379
|
-
- [`height`](ExtrudeOptions.md#height) · `number` · Required
|
|
367
|
+
- [`height`](../geometry/ExtrudeOptions.md#height) · `number` · Required
|
|
380
368
|
|
|
381
369
|
Positive extrusion height in millimetres.
|
|
382
370
|
|
|
383
|
-
- [`center`](ExtrudeOptions.md#center) · `boolean` · Optional
|
|
371
|
+
- [`center`](../geometry/ExtrudeOptions.md#center) · `boolean` · Optional
|
|
384
372
|
|
|
385
373
|
Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
|
|
386
374
|
|
|
387
|
-
- [`ends`](ExtrudeOptions.md#ends) · [`EndTreatments`](EndTreatments.md) · Optional
|
|
375
|
+
- [`ends`](../geometry/ExtrudeOptions.md#ends) · [`EndTreatments`](../geometry/EndTreatments.md) · Optional
|
|
388
376
|
|
|
389
|
-
Independent inward
|
|
377
|
+
Independent inward treatments on every material rim of a straight, topology-preserving extrusion.
|
|
390
378
|
|
|
391
|
-
- [`divisions`](ExtrudeOptions.md#divisions) · `number` · Optional
|
|
379
|
+
- [`divisions`](../geometry/ExtrudeOptions.md#divisions) · `number` · Optional
|
|
392
380
|
|
|
393
381
|
Exact number of intermediate profiles, nonnegative; overrides physical sampling.
|
|
394
382
|
|
|
395
|
-
- [`limits`](ExtrudeOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
|
|
383
|
+
- [`limits`](../geometry/ExtrudeOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
|
|
396
384
|
|
|
397
385
|
Explicit output and sampling allocation ceilings.
|
|
398
386
|
|
|
399
|
-
- [`resolution`](ExtrudeOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
|
|
387
|
+
- [`resolution`](../geometry/ExtrudeOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
|
|
400
388
|
|
|
401
389
|
Operation-level physical policy over the nearest model scope.
|
|
402
390
|
|
|
403
|
-
- [`scaleTop`](ExtrudeOptions.md#scaletop) · `number` \| [`Vector2Input`](Vector2Input.md) · Optional
|
|
391
|
+
- [`scaleTop`](../geometry/ExtrudeOptions.md#scaletop) · `number` \| [`Vector2Input`](../geometry/Vector2Input.md) · Optional
|
|
404
392
|
|
|
405
393
|
Finite uniform or XY scale of the top profile; defaults to one.
|
|
406
394
|
|
|
407
|
-
- [`twist`](ExtrudeOptions.md#twist) · `number` · Optional
|
|
395
|
+
- [`twist`](../geometry/ExtrudeOptions.md#twist) · `number` · Optional
|
|
408
396
|
|
|
409
397
|
Finite rotation of the top profile about +Z, in degrees; defaults to zero.
|
|
410
398
|
|
|
@@ -420,7 +408,7 @@ Extrudes along +Z with degree twist and top scaling.
|
|
|
420
408
|
|
|
421
409
|
|
|
422
410
|
|
|
423
|
-
**revolve**(`options?`: [`RevolveOptions`](RevolveOptions.md)): [`Solid`](Solid.md)
|
|
411
|
+
**revolve**(`options?`: [`RevolveOptions`](../geometry/RevolveOptions.md)): [`Solid`](Solid.md)
|
|
424
412
|
|
|
425
413
|
|
|
426
414
|
|
|
@@ -430,20 +418,20 @@ Revolves a filled radial/Z shape around +Z, with caps for partial sweeps.
|
|
|
430
418
|
|
|
431
419
|
<a id="options-4"></a>
|
|
432
420
|
|
|
433
|
-
**`options`** · [`RevolveOptions`](RevolveOptions.md) · Optional
|
|
421
|
+
**`options`** · [`RevolveOptions`](../geometry/RevolveOptions.md) · Optional
|
|
434
422
|
|
|
435
|
-
- [`segments`](RevolveOptions.md#segments) · `number` · Optional
|
|
423
|
+
- [`segments`](../geometry/RevolveOptions.md#segments) · `number` · Optional
|
|
436
424
|
|
|
437
425
|
Exact circumferential segment count from three through the configured safety limit.
|
|
438
426
|
|
|
439
|
-
This local topology override takes precedence over [CircularPrimitiveOptions.resolution](CircularPrimitiveOptions.md#resolution)
|
|
427
|
+
This local topology override takes precedence over [CircularPrimitiveOptions.resolution](../geometry/CircularPrimitiveOptions.md#resolution)
|
|
440
428
|
and any active model-wide resolution policy.
|
|
441
429
|
|
|
442
|
-
- [`resolution`](RevolveOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
|
|
430
|
+
- [`resolution`](../geometry/RevolveOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
|
|
443
431
|
|
|
444
432
|
Operation-level physical tessellation policy over the active model-wide policy.
|
|
445
433
|
|
|
446
|
-
- [`degrees`](RevolveOptions.md#degrees) · `number` · Optional · Default: `360`
|
|
434
|
+
- [`degrees`](../geometry/RevolveOptions.md#degrees) · `number` · Optional · Default: `360`
|
|
447
435
|
|
|
448
436
|
Positive sweep in degrees, no greater than 360. Defaults to a full revolution;
|
|
449
437
|
smaller sweeps form partial revolutions with end caps.
|
|
@@ -451,7 +439,7 @@ Revolves a filled radial/Z shape around +Z, with caps for partial sweeps.
|
|
|
451
439
|
revolutions require at least three sweep intervals: adaptive sampling refines to that floor,
|
|
452
440
|
while exact counts that imply fewer intervals reject. Pure mesh.revolve supports one interval.
|
|
453
441
|
|
|
454
|
-
- [`limits`](RevolveOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
|
|
442
|
+
- [`limits`](../geometry/RevolveOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
|
|
455
443
|
|
|
456
444
|
Explicit output and sampling allocation ceilings.
|
|
457
445
|
|
|
@@ -467,7 +455,7 @@ Revolves a filled radial/Z shape around +Z, with caps for partial sweeps.
|
|
|
467
455
|
|
|
468
456
|
|
|
469
457
|
|
|
470
|
-
**sweep**(`path`: [`Path3Input`](Path3Input.md), `options?`: [`SweepOptions`](SweepOptions.md)): [`Solid`](Solid.md)
|
|
458
|
+
**sweep**(`path`: [`Path3Input`](../geometry/Path3Input.md), `options?`: [`SweepOptions`](../geometry/SweepOptions.md)): [`Solid`](Solid.md)
|
|
471
459
|
|
|
472
460
|
|
|
473
461
|
|
|
@@ -477,43 +465,43 @@ Sweeps this filled section using the selected frame policy and degree twist.
|
|
|
477
465
|
|
|
478
466
|
<a id="path"></a>
|
|
479
467
|
|
|
480
|
-
**`path`** · [`Path3Input`](Path3Input.md) · Required
|
|
468
|
+
**`path`** · [`Path3Input`](../geometry/Path3Input.md) · Required
|
|
481
469
|
|
|
482
470
|
|
|
483
471
|
|
|
484
472
|
<a id="options-5"></a>
|
|
485
473
|
|
|
486
|
-
**`options`** · [`SweepOptions`](SweepOptions.md) · Optional
|
|
474
|
+
**`options`** · [`SweepOptions`](../geometry/SweepOptions.md) · Optional
|
|
487
475
|
|
|
488
|
-
- [`closed`](SweepOptions.md#closed) · `boolean` · Optional
|
|
476
|
+
- [`closed`](../geometry/SweepOptions.md#closed) · `boolean` · Optional
|
|
489
477
|
|
|
490
478
|
Raw point closure defaults to false; a Path3 supplies its closure and rejects conflicts.
|
|
491
479
|
|
|
492
|
-
- [`limits`](SweepOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
|
|
480
|
+
- [`limits`](../geometry/SweepOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
|
|
493
481
|
|
|
494
482
|
Explicit output and sampling allocation ceilings.
|
|
495
483
|
|
|
496
|
-
- [`orientation`](SweepOptions.md#orientation) · [`SweepOrientation`](SweepOrientation.md) · Optional
|
|
484
|
+
- [`orientation`](../geometry/SweepOptions.md#orientation) · [`SweepOrientation`](../geometry/SweepOrientation.md) · Optional
|
|
497
485
|
|
|
498
486
|
Explicit frame policy; default transport minimizes rotations, initially projecting +X then +Y then +Z.
|
|
499
487
|
|
|
500
|
-
- [`resolution`](SweepOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
|
|
488
|
+
- [`resolution`](../geometry/SweepOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
|
|
501
489
|
|
|
502
490
|
Physical sampling of nonzero twist; inserted stations retain authored station controls.
|
|
503
491
|
|
|
504
|
-
- [`twist`](SweepOptions.md#twist) · `number` · Optional
|
|
492
|
+
- [`twist`](../geometry/SweepOptions.md#twist) · `number` · Optional
|
|
505
493
|
|
|
506
494
|
Total additional profile rotation in degrees, with progression selected by twistBy.
|
|
507
495
|
|
|
508
|
-
- [`twistBy`](SweepOptions.md#twistby) · `"length"` \| `"stations"` · Optional
|
|
496
|
+
- [`twistBy`](../geometry/SweepOptions.md#twistby) · `"length"` \| `"stations"` · Optional
|
|
509
497
|
|
|
510
498
|
Twist advances by physical path length (default), or normalized authored station position, including a closed seam gap.
|
|
511
499
|
|
|
512
|
-
- [`scale`](SweepOptions.md#scale) · `number` \| [`Vector2Input`](Vector2Input.md) \| readonly [`Vector2Input`](Vector2Input.md)[] · Optional
|
|
500
|
+
- [`scale`](../geometry/SweepOptions.md#scale) · `number` \| [`Vector2Input`](../geometry/Vector2Input.md) \| readonly [`Vector2Input`](../geometry/Vector2Input.md)[] · Optional
|
|
513
501
|
|
|
514
502
|
Positive uniform/XY scale, or one XY pair per path station. Defaults to one.
|
|
515
503
|
|
|
516
|
-
- [`seamProfileOffset`](SweepOptions.md#seamprofileoffset) · `number` · Optional
|
|
504
|
+
- [`seamProfileOffset`](../geometry/SweepOptions.md#seamprofileoffset) · `number` · Optional
|
|
517
505
|
|
|
518
506
|
Corresponding point-index advance at a rotationally equivalent closed seam.
|
|
519
507
|
|
|
@@ -580,7 +568,7 @@ readonly `Section`[]
|
|
|
580
568
|
|
|
581
569
|
|
|
582
570
|
|
|
583
|
-
**anchor**(`name`: `string`): [`Anchor3`](Anchor3.md)
|
|
571
|
+
**anchor**(`name`: `string`): [`Anchor3`](../geometry/Anchor3-type.md)
|
|
584
572
|
|
|
585
573
|
|
|
586
574
|
|
|
@@ -596,28 +584,34 @@ Reads a copied immutable named anchor during active synchronous model execution.
|
|
|
596
584
|
|
|
597
585
|
#### Returns
|
|
598
586
|
|
|
599
|
-
[`Anchor3`](Anchor3.md)
|
|
587
|
+
[`Anchor3`](../geometry/Anchor3-type.md)
|
|
600
588
|
|
|
601
589
|
|
|
602
590
|
## Related APIs
|
|
603
591
|
|
|
604
|
-
- [Anchor3](Anchor3.md)
|
|
605
|
-
- [ExtrudeOptions](ExtrudeOptions.md)
|
|
606
|
-
- [Path3Input](Path3Input.md)
|
|
607
|
-
- [Pivot2Options](Pivot2Options.md)
|
|
608
|
-
- [RegionData](RegionData.md)
|
|
609
|
-
- [RevolveOptions](RevolveOptions.md)
|
|
592
|
+
- [Anchor3](../geometry/Anchor3-type.md)
|
|
593
|
+
- [ExtrudeOptions](../geometry/ExtrudeOptions.md)
|
|
594
|
+
- [Path3Input](../geometry/Path3Input.md)
|
|
595
|
+
- [Pivot2Options](../geometry/Pivot2Options.md)
|
|
596
|
+
- [RegionData](../geometry/RegionData.md)
|
|
597
|
+
- [RevolveOptions](../geometry/RevolveOptions.md)
|
|
610
598
|
- [SectionInspection](SectionInspection.md)
|
|
611
599
|
- [SectionOffsetOptions](SectionOffsetOptions.md)
|
|
612
600
|
- [Solid](Solid.md)
|
|
613
|
-
- [SweepOptions](SweepOptions.md)
|
|
614
|
-
- [Transform2Input](Transform2Input.md)
|
|
615
|
-
- [Vector2Input](Vector2Input.md)
|
|
601
|
+
- [SweepOptions](../geometry/SweepOptions.md)
|
|
602
|
+
- [Transform2Input](../geometry/Transform2Input.md)
|
|
603
|
+
- [Vector2Input](../geometry/Vector2Input.md)
|
|
616
604
|
|
|
617
605
|
## Guides
|
|
618
606
|
|
|
619
|
-
- [Section, hole, offset, and extrusion](../../guides/
|
|
620
|
-
- [SVG sections: fills and strokes are different inputs](../../guides/
|
|
621
|
-
- [Text and font variability](../../guides/
|
|
607
|
+
- [Section, hole, offset, and extrusion](../../guides/profiles-and-extrusion.md#section-hole-offset-and-extrusion)
|
|
608
|
+
- [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
|
|
609
|
+
- [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
|
|
610
|
+
|
|
611
|
+
## Supported imports
|
|
612
|
+
|
|
613
|
+
```ts
|
|
614
|
+
import type { Section } from "@metamesh/modeling";
|
|
615
|
+
```
|
|
622
616
|
|
|
623
|
-
Package: `@metamesh/modeling@0.
|
|
617
|
+
Package: `@metamesh/modeling@0.19.0`.
|