@metamesh/modeling 0.17.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.
Files changed (832) hide show
  1. package/CHANGELOG.md +186 -0
  2. package/README.md +147 -157
  3. package/dist/api/engine.d.ts +106 -83
  4. package/dist/api/export-3mf.d.ts +2 -0
  5. package/dist/api/export-glb.d.ts +2 -0
  6. package/dist/api/export-stl.d.ts +2 -0
  7. package/dist/api/export.d.ts +160 -0
  8. package/dist/api/geometry.d.ts +250 -461
  9. package/dist/api/index.d.ts +470 -445
  10. package/dist/api/mesh.d.ts +489 -0
  11. package/dist/api/text.d.ts +1 -1
  12. package/dist/docs/guides/concepts.md +32 -495
  13. package/dist/docs/guides/fonts.md +14 -13
  14. package/dist/docs/guides/fundamentals.md +30 -29
  15. package/dist/docs/guides/generation.md +84 -64
  16. package/dist/docs/guides/geometry-values.md +193 -0
  17. package/dist/docs/guides/hosting.md +147 -48
  18. package/dist/docs/guides/profiles-and-extrusion.md +252 -0
  19. package/dist/docs/guides/recipes.md +33 -769
  20. package/dist/docs/guides/resolution-and-inspection.md +133 -0
  21. package/dist/docs/guides/solid-joins.md +126 -0
  22. package/dist/docs/guides/standalone-model.md +8 -7
  23. package/dist/docs/guides/svg-and-text.md +215 -0
  24. package/dist/docs/guides/sweeps-and-lofts.md +179 -0
  25. package/dist/docs/guides/transforms-and-placement.md +313 -0
  26. package/dist/docs/manifest.json +3224 -4430
  27. package/dist/docs/reference/engine/GenerationOptions.md +12 -5
  28. package/dist/docs/reference/engine/GeometryResource.md +19 -13
  29. package/dist/docs/reference/engine/ModelDependencies.md +9 -3
  30. package/dist/docs/reference/engine/ModelEngine.md +33 -24
  31. package/dist/docs/reference/engine/ModelEngineOptions.md +13 -2
  32. package/dist/docs/reference/engine/ModelPart.md +114 -0
  33. package/dist/docs/reference/engine/ModelResult.md +181 -0
  34. package/dist/docs/reference/engine/ModelRunArguments.md +34 -0
  35. package/dist/docs/reference/engine/ModelRunOptions.md +110 -0
  36. package/dist/docs/reference/engine/ModelSession.md +22 -16
  37. package/dist/docs/reference/engine/SessionOptions.md +21 -10
  38. package/dist/docs/reference/engine/categories/host-lifecycle.md +20 -15
  39. package/dist/docs/reference/engine/checkModel.md +49 -0
  40. package/dist/docs/reference/engine/createModelEngine.md +11 -13
  41. package/dist/docs/reference/engine/defaultModelingLimits.md +15 -2
  42. package/dist/docs/reference/engine/modelingWasmUrl.md +7 -1
  43. package/dist/docs/reference/engine.md +8 -15
  44. package/dist/docs/reference/export/Export3mfOptions.md +24 -0
  45. package/dist/docs/reference/export/ExportDiagnostic.md +59 -0
  46. package/dist/docs/reference/export/ExportFormat.md +25 -0
  47. package/dist/docs/reference/export/ExportGeometry.md +39 -0
  48. package/dist/docs/reference/export/ExportGlbOptions.md +118 -0
  49. package/dist/docs/reference/export/ExportLimits.md +83 -0
  50. package/dist/docs/reference/export/ExportMaterial.md +47 -0
  51. package/dist/docs/reference/export/ExportOptions.md +94 -0
  52. package/dist/docs/reference/export/ExportPart.md +88 -0
  53. package/dist/docs/reference/export/ExportReport.md +82 -0
  54. package/dist/docs/reference/export/ExportSink.md +39 -0
  55. package/dist/docs/reference/export/ExportStlOptions.md +24 -0
  56. package/dist/docs/reference/export/ExportedFile.md +110 -0
  57. package/dist/docs/reference/export/categories/mesh-serialization.md +47 -0
  58. package/dist/docs/reference/export/defaultExportLimits.md +20 -0
  59. package/dist/docs/reference/export/export3mf.md +64 -0
  60. package/dist/docs/reference/export/exportGlb.md +68 -0
  61. package/dist/docs/reference/export/exportStl.md +64 -0
  62. package/dist/docs/reference/export/write3mf.md +71 -0
  63. package/dist/docs/reference/export/writeGlb.md +75 -0
  64. package/dist/docs/reference/export/writeStl.md +71 -0
  65. package/dist/docs/reference/export.md +21 -0
  66. package/dist/docs/reference/geometry/AcmeThreadProfileSpec.md +16 -2
  67. package/dist/docs/reference/geometry/AlignedCircularSegmentsOptions.md +7 -1
  68. package/dist/docs/reference/geometry/Anchor3-type.md +13 -3
  69. package/dist/docs/reference/geometry/ArcCurve2.md +8 -2
  70. package/dist/docs/reference/geometry/ArcCurve3.md +8 -2
  71. package/dist/docs/reference/geometry/AttachOptions.md +13 -3
  72. package/dist/docs/reference/geometry/AxisAngleRotation3.md +9 -3
  73. package/dist/docs/reference/geometry/Bevel.md +32 -0
  74. package/dist/docs/reference/geometry/BevelSize.md +28 -0
  75. package/dist/docs/reference/geometry/Bounds2-type.md +18 -4
  76. package/dist/docs/reference/geometry/Bounds2Data.md +22 -4
  77. package/dist/docs/reference/geometry/Bounds2Input.md +18 -4
  78. package/dist/docs/reference/geometry/Bounds2Options.md +61 -11
  79. package/dist/docs/reference/geometry/Bounds3-type.md +18 -4
  80. package/dist/docs/reference/geometry/Bounds3Data.md +18 -4
  81. package/dist/docs/reference/geometry/Bounds3Input.md +18 -4
  82. package/dist/docs/reference/geometry/Bounds3Options.md +61 -11
  83. package/dist/docs/reference/geometry/BoundsFit2.md +10 -4
  84. package/dist/docs/reference/geometry/BoundsFit3.md +10 -4
  85. package/dist/docs/reference/geometry/BoundsFitOptions.md +10 -4
  86. package/dist/docs/reference/geometry/BoxAnchorFace.md +9 -3
  87. package/dist/docs/reference/geometry/BoxAnchorOptions.md +12 -6
  88. package/dist/docs/reference/geometry/BoxEdge.md +11 -1
  89. package/dist/docs/reference/geometry/BoxEdgeSelection.md +11 -1
  90. package/dist/docs/reference/geometry/BoxEdgeTreatments.md +11 -1
  91. package/dist/docs/reference/geometry/BoxOptions.md +13 -3
  92. package/dist/docs/reference/geometry/ButtressPressureFlankSide.md +16 -2
  93. package/dist/docs/reference/geometry/ButtressThreadProfileSpec.md +16 -2
  94. package/dist/docs/reference/geometry/ChamferedEdgeTreatment.md +11 -1
  95. package/dist/docs/reference/geometry/CircleContourOptions.md +12 -2
  96. package/dist/docs/reference/geometry/CircularPrimitiveOptions.md +15 -3
  97. package/dist/docs/reference/geometry/CircularResolutionOptions.md +7 -1
  98. package/dist/docs/reference/geometry/CircularSampling.md +7 -1
  99. package/dist/docs/reference/geometry/CircularSamplingOptions.md +7 -1
  100. package/dist/docs/reference/geometry/ClearanceHoleDimensions.md +8 -2
  101. package/dist/docs/reference/geometry/ClearanceHoleFit.md +8 -2
  102. package/dist/docs/reference/geometry/CompensatedThreadDiameters.md +8 -2
  103. package/dist/docs/reference/geometry/Contour.md +12 -2
  104. package/dist/docs/reference/geometry/ContourCurve.md +8 -2
  105. package/dist/docs/reference/geometry/ContourPoint.md +8 -2
  106. package/dist/docs/reference/geometry/ContourSegment.md +8 -2
  107. package/dist/docs/reference/geometry/CorrespondingComponent.md +12 -2
  108. package/dist/docs/reference/geometry/CorrespondingContour.md +12 -2
  109. package/dist/docs/reference/geometry/CorrespondingProfile.md +12 -2
  110. package/dist/docs/reference/geometry/CorrespondingProfileStation.md +12 -2
  111. package/dist/docs/reference/geometry/CubicBezierCurve2.md +8 -2
  112. package/dist/docs/reference/geometry/CubicBezierCurve3.md +8 -2
  113. package/dist/docs/reference/geometry/Curve2.md +8 -2
  114. package/dist/docs/reference/geometry/Curve3.md +8 -2
  115. package/dist/docs/reference/geometry/CurveSamplingOptions.md +16 -2
  116. package/dist/docs/reference/geometry/CustomThreadProfileSpec.md +16 -2
  117. package/dist/docs/reference/geometry/CylinderAnchorFace.md +9 -3
  118. package/dist/docs/reference/geometry/CylinderAnchorOptions.md +11 -5
  119. package/dist/docs/reference/geometry/CylinderOptions.md +11 -1
  120. package/dist/docs/reference/geometry/CylindricalGearDimensions.md +8 -2
  121. package/dist/docs/reference/geometry/CylindricalGearMeshKind.md +8 -2
  122. package/dist/docs/reference/geometry/CylindricalGearOutlineOptions.md +8 -2
  123. package/dist/docs/reference/geometry/CylindricalGearPairDimensions.md +8 -2
  124. package/dist/docs/reference/geometry/CylindricalGearPairMotionOptions.md +8 -2
  125. package/dist/docs/reference/geometry/CylindricalGearPairMotionReport.md +8 -2
  126. package/dist/docs/reference/geometry/CylindricalGearPairSpec.md +8 -2
  127. package/dist/docs/reference/geometry/CylindricalGearSpec.md +8 -2
  128. package/dist/docs/reference/geometry/DEFAULT_GEOMETRY_TOLERANCE.md +7 -1
  129. package/dist/docs/reference/geometry/EdgeTreatment.md +11 -1
  130. package/dist/docs/reference/geometry/EllipseContourOptions.md +14 -4
  131. package/dist/docs/reference/geometry/EndTreatments.md +12 -2
  132. package/dist/docs/reference/{model/ExtrudeOptions.md → geometry/ExtrudeMeshOptions.md} +30 -26
  133. package/dist/docs/reference/geometry/ExtrudeOptions.md +29 -11
  134. package/dist/docs/reference/geometry/ExtrusionSamplingOptions.md +18 -4
  135. package/dist/docs/reference/geometry/FittedTextLayout.md +8 -2
  136. package/dist/docs/reference/geometry/Frame3.md +16 -2
  137. package/dist/docs/reference/geometry/GeometryError.md +11 -1
  138. package/dist/docs/reference/geometry/GeometryErrorCode.md +11 -1
  139. package/dist/docs/reference/geometry/GeometryErrorContext.md +11 -1
  140. package/dist/docs/reference/geometry/GeometryResolution.md +15 -1
  141. package/dist/docs/reference/geometry/GeometrySamplingLimits.md +16 -2
  142. package/dist/docs/reference/geometry/GeometryToleranceOptions.md +15 -1
  143. package/dist/docs/reference/geometry/GridPatternOptions.md +12 -2
  144. package/dist/docs/reference/geometry/HeightfieldMeshLimits.md +12 -2
  145. package/dist/docs/reference/geometry/HeightfieldOptions.md +18 -3
  146. package/dist/docs/reference/geometry/HeightfieldPreflight.md +12 -2
  147. package/dist/docs/reference/geometry/IDENTITY_TRANSFORM3.md +9 -3
  148. package/dist/docs/reference/geometry/ImmutableBuffer-type.md +110 -0
  149. package/dist/docs/reference/geometry/ImmutableTriangleMesh.md +57 -0
  150. package/dist/docs/reference/geometry/InternalThreadCutterOptions.md +63 -84
  151. package/dist/docs/reference/geometry/KnuckleHingeBaseSpec.md +12 -2
  152. package/dist/docs/reference/geometry/KnuckleHingeDimensions.md +8 -2
  153. package/dist/docs/reference/geometry/KnuckleHingeInterval.md +8 -2
  154. package/dist/docs/reference/geometry/KnuckleHingeSamplingOptions.md +12 -2
  155. package/dist/docs/reference/geometry/KnuckleHingeSpec.md +12 -2
  156. package/dist/docs/reference/geometry/LineCurve2.md +8 -2
  157. package/dist/docs/reference/geometry/LineCurve3.md +8 -2
  158. package/dist/docs/reference/geometry/LinearPatternOptions.md +12 -2
  159. package/dist/docs/reference/geometry/LoftCorrespondence.md +16 -2
  160. package/dist/docs/reference/geometry/LoftMeshStation.md +12 -2
  161. package/dist/docs/reference/geometry/LoftOptions.md +18 -4
  162. package/dist/docs/reference/geometry/LoftPlacement.md +16 -2
  163. package/dist/docs/reference/geometry/METRIC_FASTENER_STANDARDS.md +8 -2
  164. package/dist/docs/reference/geometry/MatchProfilesOptions.md +12 -2
  165. package/dist/docs/reference/geometry/MetricFastenerSize.md +8 -2
  166. package/dist/docs/reference/geometry/MetricFastenerStandard.md +8 -2
  167. package/dist/docs/reference/geometry/MetricHexNutDimensions.md +8 -2
  168. package/dist/docs/reference/geometry/MetricSocketCapHeadDimensions.md +8 -2
  169. package/dist/docs/reference/geometry/ModelingLimits.md +19 -1
  170. package/dist/docs/reference/geometry/NumericArray.md +28 -0
  171. package/dist/docs/reference/geometry/PRINTABLE_THREAD_FIT_POLICIES.md +8 -2
  172. package/dist/docs/reference/geometry/Path2-type.md +16 -2
  173. package/dist/docs/reference/geometry/Path2Data.md +16 -2
  174. package/dist/docs/reference/geometry/Path2Input.md +16 -2
  175. package/dist/docs/reference/geometry/Path3-type.md +16 -2
  176. package/dist/docs/reference/geometry/Path3Data.md +16 -2
  177. package/dist/docs/reference/geometry/Path3Input.md +16 -2
  178. package/dist/docs/reference/geometry/PathFrame.md +8 -2
  179. package/dist/docs/reference/geometry/PathLocation.md +16 -2
  180. package/dist/docs/reference/geometry/PathNormalGuide.md +16 -2
  181. package/dist/docs/reference/geometry/PathOptions.md +12 -2
  182. package/dist/docs/reference/geometry/PathPatternOptions.md +12 -2
  183. package/dist/docs/reference/geometry/PathPlacement.md +8 -2
  184. package/dist/docs/reference/geometry/PathResamplingOptions.md +16 -2
  185. package/dist/docs/reference/geometry/Pivot2Options.md +17 -3
  186. package/dist/docs/reference/geometry/Pivot3Options.md +17 -3
  187. package/dist/docs/reference/geometry/PlanarMeshOptimizationFallbackReason.md +12 -2
  188. package/dist/docs/reference/geometry/PlanarMeshOptimizationOptions.md +12 -2
  189. package/dist/docs/reference/geometry/PlanarMeshOptimizationResult.md +12 -2
  190. package/dist/docs/reference/geometry/PlanarPatchQuality.md +12 -2
  191. package/dist/docs/reference/geometry/PolygonData.md +12 -2
  192. package/dist/docs/reference/geometry/PolylineResamplingOptions.md +8 -2
  193. package/dist/docs/reference/geometry/PrimitiveAttachment.md +11 -3
  194. package/dist/docs/reference/geometry/PrimitiveAttachmentOptions.md +11 -1
  195. package/dist/docs/reference/geometry/PrintableThreadFit.md +12 -2
  196. package/dist/docs/reference/geometry/PrintableThreadFitPolicy.md +12 -2
  197. package/dist/docs/reference/geometry/Profile.md +8 -2
  198. package/dist/docs/reference/geometry/ProfileComponent2.md +12 -2
  199. package/dist/docs/reference/geometry/ProfileContour2.md +12 -2
  200. package/dist/docs/reference/geometry/ProfileSpan2.md +12 -2
  201. package/dist/docs/reference/geometry/ProfiledEdgeTreatment.md +11 -1
  202. package/dist/docs/reference/geometry/RackPitchDimensions.md +8 -2
  203. package/dist/docs/reference/geometry/RackPitchSpec.md +8 -2
  204. package/dist/docs/reference/geometry/RadialPatternOptions.md +12 -2
  205. package/dist/docs/reference/geometry/RadialSizing.md +11 -1
  206. package/dist/docs/reference/geometry/RadialSizingOptions.md +11 -1
  207. package/dist/docs/reference/geometry/RectangleContourOptions.md +14 -4
  208. package/dist/docs/reference/geometry/RectangleCornerTreatment.md +12 -2
  209. package/dist/docs/reference/geometry/RectangleCornerTreatments.md +12 -2
  210. package/dist/docs/reference/geometry/RectangleProfileOptions.md +10 -4
  211. package/dist/docs/reference/geometry/RegionData.md +12 -2
  212. package/dist/docs/reference/geometry/RegularPolygonContourOptions.md +8 -2
  213. package/dist/docs/reference/geometry/ResolvedGeometryTolerance.md +7 -1
  214. package/dist/docs/reference/geometry/RevolveOptions.md +17 -3
  215. package/dist/docs/reference/geometry/RoundedEdgeTreatment.md +11 -1
  216. package/dist/docs/reference/geometry/RowLayoutOptions.md +10 -4
  217. package/dist/docs/reference/geometry/SampleContourOptions.md +8 -2
  218. package/dist/docs/reference/geometry/SampleHelixOptions.md +8 -2
  219. package/dist/docs/reference/geometry/SampleSideProfileOptions.md +8 -2
  220. package/dist/docs/reference/geometry/SampledCurve2.md +8 -2
  221. package/dist/docs/reference/geometry/SampledCurve3.md +8 -2
  222. package/dist/docs/reference/geometry/SampledThreadHelices.md +8 -2
  223. package/dist/docs/reference/geometry/SideProfileCurve.md +8 -2
  224. package/dist/docs/reference/geometry/SideProfilePoint.md +8 -2
  225. package/dist/docs/reference/geometry/SideProfileSegment.md +8 -2
  226. package/dist/docs/reference/geometry/SmoothEdgeTreatment.md +11 -1
  227. package/dist/docs/reference/geometry/SolidMeshValidationOptions.md +12 -2
  228. package/dist/docs/reference/geometry/SphereOptions.md +11 -1
  229. package/dist/docs/reference/geometry/SquareThreadProfileSpec.md +16 -2
  230. package/dist/docs/reference/geometry/StarContourOptions.md +84 -0
  231. package/dist/docs/reference/geometry/StrokeCap.md +12 -2
  232. package/dist/docs/reference/geometry/StrokeJoin.md +12 -2
  233. package/dist/docs/reference/geometry/StrokeOptions.md +12 -2
  234. package/dist/docs/reference/geometry/SvgImportOptions.md +8 -2
  235. package/dist/docs/reference/geometry/SvgRegionPreflight.md +8 -2
  236. package/dist/docs/reference/geometry/SvgRegionPreflightGeometryMetrics.md +8 -2
  237. package/dist/docs/reference/geometry/SvgRegionPreflightRepairs.md +8 -2
  238. package/dist/docs/reference/geometry/SvgRegionPreflightSourceMetrics.md +8 -2
  239. package/dist/docs/reference/geometry/SweepOptions.md +16 -2
  240. package/dist/docs/reference/geometry/SweepOrientation.md +16 -2
  241. package/dist/docs/reference/geometry/ThreadBevelOptions.md +18 -31
  242. package/dist/docs/reference/geometry/ThreadCircularSegmentsOptions.md +8 -2
  243. package/dist/docs/reference/geometry/ThreadCompensationOptions.md +8 -2
  244. package/dist/docs/reference/geometry/ThreadEndStyle.md +16 -2
  245. package/dist/docs/reference/geometry/ThreadEndTreatmentOptions.md +16 -2
  246. package/dist/docs/reference/geometry/ThreadHandedness.md +16 -2
  247. package/dist/docs/reference/geometry/ThreadHelixOptions.md +8 -2
  248. package/dist/docs/reference/geometry/ThreadLeadInEnvelope.md +16 -2
  249. package/dist/docs/reference/geometry/ThreadLeadInShape.md +16 -2
  250. package/dist/docs/reference/geometry/ThreadProfile-type.md +17 -3
  251. package/dist/docs/reference/geometry/ThreadProfileBaseSpec.md +16 -2
  252. package/dist/docs/reference/geometry/ThreadProfileSpec.md +16 -2
  253. package/dist/docs/reference/geometry/{HelicalThreadRidgeMeshOptions.md → ThreadRidgeOptions.md} +19 -5
  254. package/dist/docs/reference/geometry/ThreadRole.md +8 -2
  255. package/dist/docs/reference/geometry/{HelicalThreadSolidMeshOptions.md → ThreadSolidOptions.md} +29 -66
  256. package/dist/docs/reference/geometry/{HelicalThreadSolidMeshPreflight.md → ThreadSolidPreflight.md} +17 -3
  257. package/dist/docs/reference/geometry/ThreadedNutOptions.md +86 -87
  258. package/dist/docs/reference/geometry/ThreadedNutPreflight.md +29 -7
  259. package/dist/docs/reference/geometry/ThreadedNutShape.md +12 -2
  260. package/dist/docs/reference/geometry/ThreadedRodOptions.md +63 -84
  261. package/dist/docs/reference/geometry/TorusOptions.md +11 -1
  262. package/dist/docs/reference/geometry/Transform2-type.md +17 -3
  263. package/dist/docs/reference/geometry/Transform2Data.md +17 -3
  264. package/dist/docs/reference/geometry/Transform2Input.md +17 -3
  265. package/dist/docs/reference/geometry/Transform3-type.md +17 -3
  266. package/dist/docs/reference/geometry/Transform3Data.md +17 -3
  267. package/dist/docs/reference/geometry/Transform3Input.md +17 -3
  268. package/dist/docs/reference/geometry/TrapezoidalThreadProfileSpec.md +16 -2
  269. package/dist/docs/reference/geometry/TriangleMesh.md +19 -6
  270. package/dist/docs/reference/geometry/TriangleMeshAnalysis.md +25 -5
  271. package/dist/docs/reference/geometry/TriangleMeshAnalysisOptions.md +13 -3
  272. package/dist/docs/reference/geometry/TriangleMeshInput.md +29 -0
  273. package/dist/docs/reference/geometry/TriangleMeshMeasurements.md +16 -2
  274. package/dist/docs/reference/geometry/TriangleMeshQualityOptions.md +12 -2
  275. package/dist/docs/reference/geometry/TriangleMeshQualityReport.md +12 -2
  276. package/dist/docs/reference/geometry/TriangleMeshSignature.md +14 -4
  277. package/dist/docs/reference/geometry/TriangleMeshSignatureOptions.md +12 -2
  278. package/dist/docs/reference/geometry/TriangleMeshSignatureTolerances.md +12 -2
  279. package/dist/docs/reference/geometry/TriangleMeshTopologyAnalysis.md +145 -0
  280. package/dist/docs/reference/geometry/TriangleMeshValidationOptions.md +12 -2
  281. package/dist/docs/reference/geometry/TriangularThreadProfileSpec.md +16 -2
  282. package/dist/docs/reference/geometry/TubeOptions.md +20 -86
  283. package/dist/docs/reference/geometry/Vector2-type.md +17 -3
  284. package/dist/docs/reference/geometry/Vector2Data.md +21 -3
  285. package/dist/docs/reference/geometry/Vector2Input.md +17 -3
  286. package/dist/docs/reference/geometry/Vector3-type.md +17 -3
  287. package/dist/docs/reference/geometry/Vector3Data.md +17 -3
  288. package/dist/docs/reference/geometry/Vector3Input.md +17 -3
  289. package/dist/docs/reference/geometry/VectorTextArcBaseline.md +12 -2
  290. package/dist/docs/reference/geometry/VectorTextLayout.md +16 -2
  291. package/dist/docs/reference/geometry/VectorTextLayoutOptions.md +14 -4
  292. package/dist/docs/reference/geometry/VectorTextMetrics.md +16 -2
  293. package/dist/docs/reference/geometry/VectorTextOptions.md +12 -2
  294. package/dist/docs/reference/geometry/add2.md +9 -3
  295. package/dist/docs/reference/geometry/add3.md +9 -3
  296. package/dist/docs/reference/geometry/anchor3.md +9 -3
  297. package/dist/docs/reference/geometry/anchorFrame3.md +8 -2
  298. package/dist/docs/reference/geometry/applyTransformDirection3.md +9 -3
  299. package/dist/docs/reference/geometry/applyTransformPoint3.md +9 -3
  300. package/dist/docs/reference/geometry/attachmentTransform3.md +9 -3
  301. package/dist/docs/reference/geometry/bounds2.md +18 -8
  302. package/dist/docs/reference/geometry/bounds3.md +18 -8
  303. package/dist/docs/reference/geometry/boundsCenter.md +10 -4
  304. package/dist/docs/reference/geometry/boundsSize.md +10 -4
  305. package/dist/docs/reference/geometry/boxAnchor3.md +11 -5
  306. package/dist/docs/reference/geometry/categories/bounds-layout.md +6 -6
  307. package/dist/docs/reference/geometry/categories/curves-paths.md +3 -3
  308. package/dist/docs/reference/geometry/categories/mechanical.md +9 -11
  309. package/dist/docs/reference/geometry/categories/meshes.md +20 -33
  310. package/dist/docs/reference/geometry/categories/pattern-placement.md +3 -3
  311. package/dist/docs/reference/geometry/categories/primitive-options.md +4 -4
  312. package/dist/docs/reference/geometry/categories/profiles-regions.md +6 -5
  313. package/dist/docs/reference/geometry/categories/resolution-errors.md +3 -3
  314. package/dist/docs/reference/geometry/categories/transforms-math.md +5 -4
  315. package/dist/docs/reference/geometry/categories/vector-import.md +4 -4
  316. package/dist/docs/reference/geometry/circleContour.md +8 -2
  317. package/dist/docs/reference/geometry/closeToAxis.md +8 -2
  318. package/dist/docs/reference/geometry/compensateThreadDiameters.md +8 -2
  319. package/dist/docs/reference/geometry/compensateThreadProfileAxially.md +8 -2
  320. package/dist/docs/reference/geometry/compensateThreadProfileForFaceting.md +8 -2
  321. package/dist/docs/reference/geometry/composeTransform3.md +9 -3
  322. package/dist/docs/reference/geometry/computeClosedParallelTransportFrames.md +8 -2
  323. package/dist/docs/reference/geometry/computeParallelTransportFrames.md +8 -2
  324. package/dist/docs/reference/geometry/contourContainsPoint.md +8 -2
  325. package/dist/docs/reference/geometry/cross2.md +9 -3
  326. package/dist/docs/reference/geometry/cross3.md +9 -3
  327. package/dist/docs/reference/geometry/cylinderAnchor3.md +10 -4
  328. package/dist/docs/reference/geometry/defaultGeometrySamplingLimits.md +8 -2
  329. package/dist/docs/reference/geometry/distance2.md +9 -3
  330. package/dist/docs/reference/geometry/distance3.md +9 -3
  331. package/dist/docs/reference/geometry/distributeAlongPath.md +8 -2
  332. package/dist/docs/reference/geometry/dot2.md +9 -3
  333. package/dist/docs/reference/geometry/dot3.md +9 -3
  334. package/dist/docs/reference/geometry/ellipseContour.md +8 -2
  335. package/dist/docs/reference/geometry/eulerTransform3.md +9 -3
  336. package/dist/docs/reference/geometry/fitBounds.md +10 -4
  337. package/dist/docs/reference/geometry/fitTextLayout.md +8 -2
  338. package/dist/docs/reference/geometry/frameTransform3.md +9 -3
  339. package/dist/docs/reference/geometry/getMetricClearanceHoleDiameter.md +8 -2
  340. package/dist/docs/reference/geometry/getMetricFastenerStandard.md +8 -2
  341. package/dist/docs/reference/geometry/gridPatternTransforms.md +8 -2
  342. package/dist/docs/reference/{model → geometry}/immutableBuffer.md +13 -2
  343. package/dist/docs/reference/geometry/inverseTransform3.md +9 -3
  344. package/dist/docs/reference/geometry/isGeometryError.md +11 -1
  345. package/dist/docs/reference/geometry/layoutRow.md +10 -4
  346. package/dist/docs/reference/geometry/length2.md +9 -3
  347. package/dist/docs/reference/geometry/length3.md +9 -3
  348. package/dist/docs/reference/geometry/lerp2.md +9 -3
  349. package/dist/docs/reference/geometry/lerp3.md +9 -3
  350. package/dist/docs/reference/geometry/linearPatternTransforms.md +8 -2
  351. package/dist/docs/reference/geometry/matchProfiles.md +8 -2
  352. package/dist/docs/reference/geometry/measureInternalCylindricalGearPairMotion.md +8 -2
  353. package/dist/docs/reference/geometry/minimumCylindricalGearToothCountWithoutUndercut.md +8 -2
  354. package/dist/docs/reference/geometry/normalize2.md +9 -3
  355. package/dist/docs/reference/geometry/normalize3.md +9 -3
  356. package/dist/docs/reference/geometry/normalizeContour.md +8 -2
  357. package/dist/docs/reference/geometry/normalizePolygon.md +8 -2
  358. package/dist/docs/reference/geometry/normalizeRegion.md +8 -2
  359. package/dist/docs/reference/geometry/path2.md +12 -2
  360. package/dist/docs/reference/geometry/path3.md +12 -2
  361. package/dist/docs/reference/geometry/pathPatternTransforms.md +8 -2
  362. package/dist/docs/reference/geometry/preflightInternalThreadCutter.md +25 -26
  363. package/dist/docs/reference/geometry/preflightSvgRegion.md +8 -2
  364. package/dist/docs/reference/geometry/preflightThreadedNut.md +31 -27
  365. package/dist/docs/reference/geometry/preflightThreadedRod.md +25 -26
  366. package/dist/docs/reference/geometry/projectOntoPlane3.md +9 -3
  367. package/dist/docs/reference/geometry/radialPatternTransforms.md +8 -2
  368. package/dist/docs/reference/geometry/rectangleContour.md +17 -6
  369. package/dist/docs/reference/geometry/rectangleProfile.md +9 -3
  370. package/dist/docs/reference/geometry/regionArea.md +8 -2
  371. package/dist/docs/reference/geometry/regionBounds.md +8 -2
  372. package/dist/docs/reference/geometry/regularPolygonContour.md +9 -3
  373. package/dist/docs/reference/geometry/resamplePolyline2.md +8 -2
  374. package/dist/docs/reference/geometry/resamplePolyline3.md +8 -2
  375. package/dist/docs/reference/geometry/resolveAlignedCircularSegments.md +7 -1
  376. package/dist/docs/reference/geometry/resolveArcSegments.md +7 -1
  377. package/dist/docs/reference/geometry/resolveCircularSampling.md +7 -1
  378. package/dist/docs/reference/geometry/resolveCircularSegments.md +7 -1
  379. package/dist/docs/reference/geometry/resolveCylindricalGear.md +8 -2
  380. package/dist/docs/reference/geometry/resolveCylindricalGearPair.md +8 -2
  381. package/dist/docs/reference/geometry/resolveExtrusionDivisions.md +8 -2
  382. package/dist/docs/reference/geometry/resolveGeometrySamplingLimits.md +8 -2
  383. package/dist/docs/reference/geometry/resolveGeometryTolerance.md +7 -1
  384. package/dist/docs/reference/geometry/resolveKnuckleHinge.md +8 -2
  385. package/dist/docs/reference/geometry/resolvePrintableThreadFitPolicy.md +8 -2
  386. package/dist/docs/reference/geometry/resolveRackPitch.md +8 -2
  387. package/dist/docs/reference/geometry/resolveThreadCircularSegments.md +8 -2
  388. package/dist/docs/reference/geometry/rotate2.md +9 -3
  389. package/dist/docs/reference/geometry/rotationTransform3.md +9 -3
  390. package/dist/docs/reference/geometry/roundClosedPolylinePath.md +8 -2
  391. package/dist/docs/reference/geometry/sampleContour.md +8 -2
  392. package/dist/docs/reference/geometry/sampleCurve2.md +8 -2
  393. package/dist/docs/reference/geometry/sampleCurve3.md +8 -2
  394. package/dist/docs/reference/geometry/sampleCylindricalGearOutline.md +8 -2
  395. package/dist/docs/reference/geometry/sampleHelix.md +8 -2
  396. package/dist/docs/reference/geometry/sampleInternalCylindricalGearSpaceOutline.md +8 -2
  397. package/dist/docs/reference/geometry/sampleRackToothPath.md +8 -2
  398. package/dist/docs/reference/geometry/sampleSideProfile.md +8 -2
  399. package/dist/docs/reference/geometry/sampleTextContours.md +8 -2
  400. package/dist/docs/reference/geometry/sampleThreadHelices.md +8 -2
  401. package/dist/docs/reference/geometry/scale2.md +9 -3
  402. package/dist/docs/reference/geometry/scale3.md +9 -3
  403. package/dist/docs/reference/geometry/scaleTransform3.md +9 -3
  404. package/dist/docs/reference/geometry/signedContourArea.md +8 -2
  405. package/dist/docs/reference/geometry/starContour.md +24 -16
  406. package/dist/docs/reference/geometry/strokeRegionData.md +8 -2
  407. package/dist/docs/reference/geometry/subtract2.md +9 -3
  408. package/dist/docs/reference/geometry/subtract3.md +9 -3
  409. package/dist/docs/reference/geometry/threadProfile.md +8 -2
  410. package/dist/docs/reference/geometry/transform2.md +13 -3
  411. package/dist/docs/reference/geometry/transform3.md +13 -3
  412. package/dist/docs/reference/geometry/transformDeterminant3.md +9 -3
  413. package/dist/docs/reference/geometry/transformRegionData.md +8 -2
  414. package/dist/docs/reference/geometry/translationTransform3.md +9 -3
  415. package/dist/docs/reference/geometry/triangulateContour.md +8 -2
  416. package/dist/docs/reference/geometry/validateRigidTransform3.md +41 -0
  417. package/dist/docs/reference/geometry/validateTransform3.md +9 -3
  418. package/dist/docs/reference/geometry/vector2.md +13 -3
  419. package/dist/docs/reference/geometry/vector3.md +13 -3
  420. package/dist/docs/reference/geometry.md +10 -10
  421. package/dist/docs/reference/mesh/MeshRenderOptions.md +28 -0
  422. package/dist/docs/reference/mesh/RenderMesh.md +68 -0
  423. package/dist/docs/reference/mesh/analyze.md +102 -0
  424. package/dist/docs/reference/mesh/analyzeQuality.md +62 -0
  425. package/dist/docs/reference/mesh/bounds.md +45 -0
  426. package/dist/docs/reference/mesh/categories/operations.md +57 -0
  427. package/dist/docs/reference/mesh/centroid.md +45 -0
  428. package/dist/docs/reference/mesh/extrude.md +79 -0
  429. package/dist/docs/reference/mesh/heightfield.md +57 -0
  430. package/dist/docs/reference/mesh/immutable.md +51 -0
  431. package/dist/docs/reference/mesh/join.md +47 -0
  432. package/dist/docs/reference/mesh/loft.md +83 -0
  433. package/dist/docs/reference/mesh/optimizePlanarPatches.md +102 -0
  434. package/dist/docs/reference/mesh/preflightHeightfield.md +48 -0
  435. package/dist/docs/reference/mesh/preflightThreadSolid.md +96 -0
  436. package/dist/docs/reference/mesh/render.md +57 -0
  437. package/dist/docs/reference/mesh/reverse.md +41 -0
  438. package/dist/docs/reference/{geometry/revolveMesh.md → mesh/revolve.md} +23 -17
  439. package/dist/docs/reference/mesh/signature.md +70 -0
  440. package/dist/docs/reference/mesh/sweep.md +92 -0
  441. package/dist/docs/reference/mesh/threadRidge.md +78 -0
  442. package/dist/docs/reference/mesh/threadSolid.md +96 -0
  443. package/dist/docs/reference/mesh/transform.md +53 -0
  444. package/dist/docs/reference/mesh/validate.md +75 -0
  445. package/dist/docs/reference/{geometry/validateSolidMesh.md → mesh/validateSolid.md} +23 -11
  446. package/dist/docs/reference/mesh.md +21 -0
  447. package/dist/docs/reference/model/CircleOptions.md +13 -7
  448. package/dist/docs/reference/model/DiagnosticOptions.md +21 -1
  449. package/dist/docs/reference/model/EllipseOptions.md +13 -7
  450. package/dist/docs/reference/model/GenerateCallback.md +11 -5
  451. package/dist/docs/reference/model/GenerateContext.md +26 -99
  452. package/dist/docs/reference/model/GenerationDiagnostic.md +19 -1
  453. package/dist/docs/reference/model/GenerationError.md +8 -2
  454. package/dist/docs/reference/model/HoleCutterOptions.md +17 -10
  455. package/dist/docs/reference/model/HoleCutterOverrun.md +10 -3
  456. package/dist/docs/reference/model/HoleCutterRecess.md +10 -3
  457. package/dist/docs/reference/model/HullOptions.md +13 -6
  458. package/dist/docs/reference/model/ImmutableValue.md +26 -0
  459. package/dist/docs/reference/model/ImplicitOptions.md +12 -6
  460. package/dist/docs/reference/model/JoinOptions.md +76 -0
  461. package/dist/docs/reference/model/JoinTransition.md +54 -0
  462. package/dist/docs/reference/model/KnuckleHinge-type.md +9 -3
  463. package/dist/docs/reference/model/KnuckleHingeHalfOptions.md +7 -1
  464. package/dist/docs/reference/model/KnuckleHingeOptions.md +10 -4
  465. package/dist/docs/reference/model/KnuckleHingeWeb.md +7 -1
  466. package/dist/docs/reference/model/LoftStation.md +16 -9
  467. package/dist/docs/reference/model/Memo.md +54 -0
  468. package/dist/docs/reference/model/ModelProgram.md +8 -2
  469. package/dist/docs/reference/model/PartDeclaration.md +87 -0
  470. package/dist/docs/reference/model/PartGeometry.md +10 -4
  471. package/dist/docs/reference/model/PartOptions.md +16 -22
  472. package/dist/docs/reference/model/PatternSource.md +10 -4
  473. package/dist/docs/reference/model/PlaneOptions.md +11 -4
  474. package/dist/docs/reference/model/PolygonOptions.md +20 -14
  475. package/dist/docs/reference/model/Profile.md +10 -4
  476. package/dist/docs/reference/model/RectangleOptions.md +28 -22
  477. package/dist/docs/reference/model/RegularPolygonOptions.md +13 -7
  478. package/dist/docs/reference/model/Section.md +196 -77
  479. package/dist/docs/reference/model/SectionHullOptions.md +13 -6
  480. package/dist/docs/reference/model/SectionInspection.md +12 -18
  481. package/dist/docs/reference/model/SectionOffsetJoin.md +10 -4
  482. package/dist/docs/reference/model/SectionOffsetOptions.md +12 -6
  483. package/dist/docs/reference/model/Solid.md +339 -54
  484. package/dist/docs/reference/model/SolidInspection.md +12 -18
  485. package/dist/docs/reference/model/SolidSegmentHit.md +14 -4
  486. package/dist/docs/reference/model/StarOptions.md +53 -25
  487. package/dist/docs/reference/model/SvgOrigin.md +10 -4
  488. package/dist/docs/reference/model/SvgPathSectionOptions.md +14 -8
  489. package/dist/docs/reference/model/SvgSectionOptions.md +16 -10
  490. package/dist/docs/reference/model/TextSectionOptions.md +14 -8
  491. package/dist/docs/reference/model/box.md +18 -11
  492. package/dist/docs/reference/model/categories/boolean-operations.md +13 -11
  493. package/dist/docs/reference/model/categories/bounded-surfaces.md +1 -7
  494. package/dist/docs/reference/model/categories/explicit-profiles.md +1 -14
  495. package/dist/docs/reference/model/categories/extrude-revolve-sweep.md +11 -23
  496. package/dist/docs/reference/model/categories/generation.md +10 -15
  497. package/dist/docs/reference/model/categories/hinges.md +1 -4
  498. package/dist/docs/reference/model/categories/mesh-inspection.md +14 -9
  499. package/dist/docs/reference/model/categories/primitives.md +8 -24
  500. package/dist/docs/reference/model/categories/sections.md +6 -16
  501. package/dist/docs/reference/model/categories/threads.md +3 -30
  502. package/dist/docs/reference/model/categories/transforms-placement.md +5 -35
  503. package/dist/docs/reference/model/circle.md +10 -4
  504. package/dist/docs/reference/model/cylinder.md +13 -6
  505. package/dist/docs/reference/model/ellipse.md +10 -4
  506. package/dist/docs/reference/model/extrude.md +28 -20
  507. package/dist/docs/reference/model/generate.md +10 -4
  508. package/dist/docs/reference/model/gridPattern.md +15 -9
  509. package/dist/docs/reference/model/heightfield.md +10 -4
  510. package/dist/docs/reference/model/holeCutter.md +21 -4
  511. package/dist/docs/reference/model/hull.md +9 -2
  512. package/dist/docs/reference/model/implicit.md +9 -3
  513. package/dist/docs/reference/model/internalThreadCutter.md +31 -33
  514. package/dist/docs/reference/model/intersect.md +11 -4
  515. package/dist/docs/reference/model/join.md +89 -0
  516. package/dist/docs/reference/model/knuckleHinge.md +8 -2
  517. package/dist/docs/reference/model/linearPattern.md +15 -9
  518. package/dist/docs/reference/model/loft.md +36 -28
  519. package/dist/docs/reference/model/matchProfiles.md +14 -8
  520. package/dist/docs/reference/model/minkowskiSum.md +9 -2
  521. package/dist/docs/reference/model/pathPattern.md +25 -19
  522. package/dist/docs/reference/model/polygon.md +13 -7
  523. package/dist/docs/reference/model/preflightInternalThreadCutter.md +33 -35
  524. package/dist/docs/reference/model/preflightThreadedNut.md +43 -40
  525. package/dist/docs/reference/model/preflightThreadedRod.md +33 -35
  526. package/dist/docs/reference/model/radialPattern.md +15 -9
  527. package/dist/docs/reference/model/rectangle.md +14 -8
  528. package/dist/docs/reference/model/regularPolygon.md +10 -4
  529. package/dist/docs/reference/model/revolve.md +25 -17
  530. package/dist/docs/reference/model/solidFromMesh.md +16 -9
  531. package/dist/docs/reference/model/sphere.md +13 -6
  532. package/dist/docs/reference/model/star.md +17 -11
  533. package/dist/docs/reference/model/stroke.md +21 -15
  534. package/dist/docs/reference/model/svgPathSection.md +12 -6
  535. package/dist/docs/reference/model/svgSection.md +13 -7
  536. package/dist/docs/reference/model/sweep.md +29 -21
  537. package/dist/docs/reference/model/textSection.md +15 -9
  538. package/dist/docs/reference/model/threadRidge.md +21 -15
  539. package/dist/docs/reference/model/threadedNut.md +41 -38
  540. package/dist/docs/reference/model/threadedRod.md +31 -33
  541. package/dist/docs/reference/model/torus.md +20 -13
  542. package/dist/docs/reference/model/tube.md +13 -41
  543. package/dist/docs/reference/model/union.md +11 -4
  544. package/dist/docs/reference/model.md +11 -20
  545. package/dist/docs/reference/text/MAX_VECTOR_FONT_BYTES.md +8 -2
  546. package/dist/docs/reference/text/VectorFont.md +39 -33
  547. package/dist/docs/reference/text/VectorFontOptions.md +7 -1
  548. package/dist/docs/reference/text/categories/font-preparation.md +3 -15
  549. package/dist/docs/reference/text/prepareVectorFont.md +7 -1
  550. package/dist/docs/reference/text.md +4 -4
  551. package/dist/engine/execution.js +10 -6
  552. package/dist/engine/finalization.js +2 -74
  553. package/dist/engine/index.js +24 -30
  554. package/dist/engine/model-parts.js +8 -0
  555. package/dist/engine/model-summary.js +5 -5
  556. package/dist/engine/native/construction-mesh.js +41 -0
  557. package/dist/engine/native/index.js +1 -1
  558. package/dist/engine/native/material-components.js +5 -54
  559. package/dist/engine/native/mesh-observation.js +55 -0
  560. package/dist/engine/native/operations.js +0 -7
  561. package/dist/engine/native/regions.js +2 -1
  562. package/dist/engine/native/scoped-primitives.js +5 -4
  563. package/dist/engine/native/threads.js +14 -14
  564. package/dist/engine/{construction-operations.js → operations/construction.js} +25 -23
  565. package/dist/engine/{modeling-context.js → operations/context.js} +12 -10
  566. package/dist/engine/{operation-environment.js → operations/environment.js} +2 -2
  567. package/dist/engine/{extrusion-finishing.js → operations/extrusion-finishing.js} +23 -22
  568. package/dist/engine/{hole-cutter-operation.js → operations/hole-cutter.js} +3 -3
  569. package/dist/engine/{inspection-operations.js → operations/inspection.js} +6 -6
  570. package/dist/engine/operations/join-collar-profile.js +120 -0
  571. package/dist/engine/operations/join.js +508 -0
  572. package/dist/engine/{knuckle-hinge-operation.js → operations/knuckle-hinge.js} +4 -4
  573. package/dist/engine/{loft-operations.js → operations/loft.js} +13 -12
  574. package/dist/engine/{mechanical-operations.js → operations/mechanical.js} +2 -2
  575. package/dist/engine/{pattern-operations.js → operations/patterns.js} +4 -4
  576. package/dist/engine/{primitive-anchors.js → operations/primitives/anchors.js} +9 -4
  577. package/dist/engine/{primitive-operations.js → operations/primitives/construction.js} +18 -19
  578. package/dist/engine/{primitive-correspondence.js → operations/primitives/correspondence.js} +4 -4
  579. package/dist/engine/{profile-mesh.js → operations/primitives/profile-mesh.js} +12 -12
  580. package/dist/engine/{primitive-profiles.js → operations/primitives/profiles.js} +7 -7
  581. package/dist/engine/{section-operations.js → operations/sections.js} +8 -8
  582. package/dist/engine/{transform-operations.js → operations/transforms.js} +8 -8
  583. package/dist/engine/placement.js +3 -4
  584. package/dist/engine/recipe-realization.js +2 -2
  585. package/dist/engine/{deferred-context.js → session/deferred-context.js} +4 -4
  586. package/dist/engine/session/dependencies.js +93 -0
  587. package/dist/engine/session/graph.js +428 -0
  588. package/dist/engine/{session-native.js → session/native-cache.js} +2 -2
  589. package/dist/engine/{session.js → session/session.js} +20 -14
  590. package/dist/engine/{session-snapshot.js → session/snapshot-cache.js} +30 -60
  591. package/dist/export/3mf.js +190 -0
  592. package/dist/export/capture.js +178 -0
  593. package/dist/export/glb.js +209 -0
  594. package/dist/export/index.js +5 -0
  595. package/dist/export/limits.js +18 -0
  596. package/dist/export/stl.js +105 -0
  597. package/dist/export/types.js +1 -0
  598. package/dist/export/writer.js +54 -0
  599. package/dist/geometry/anchors.js +4 -11
  600. package/dist/geometry/bounds-value.js +22 -12
  601. package/dist/geometry/heightfield.js +10 -12
  602. package/dist/{model → geometry}/immutable-buffer.js +31 -12
  603. package/dist/geometry/index.js +16 -22
  604. package/dist/geometry/join-geometry.js +839 -0
  605. package/dist/geometry/loft/loft.js +11 -6
  606. package/dist/geometry/mechanical/index.js +5 -5
  607. package/dist/geometry/mechanical/threads/bevel.js +24 -0
  608. package/dist/geometry/mechanical/{threads.js → threads/fit.js} +4 -4
  609. package/dist/geometry/mechanical/{thread-helices.js → threads/helices.js} +3 -3
  610. package/dist/geometry/mechanical/{thread-mesh-plan.js → threads/mesh-plan.js} +38 -53
  611. package/dist/geometry/mechanical/{thread-mesh.js → threads/mesh.js} +9 -9
  612. package/dist/geometry/mechanical/{thread-profiles.js → threads/profiles.js} +3 -3
  613. package/dist/geometry/mechanical/{thread-solids.js → threads/solids.js} +58 -89
  614. package/dist/geometry/mechanical/{thread-surface.js → threads/surface.js} +7 -8
  615. package/dist/geometry/mesh/mesh-centroid.js +3 -2
  616. package/dist/geometry/mesh/mesh-planar.js +27 -8
  617. package/dist/geometry/mesh/mesh-quality.js +2 -1
  618. package/dist/geometry/mesh/mesh-render.js +205 -0
  619. package/dist/geometry/mesh/mesh-signature.js +7 -6
  620. package/dist/geometry/mesh/mesh-solid-intersections.js +43 -17
  621. package/dist/geometry/mesh/mesh-solid.js +8 -5
  622. package/dist/geometry/mesh/mesh-types.js +1 -0
  623. package/dist/geometry/mesh/mesh.js +13 -22
  624. package/dist/geometry/mesh-api.js +15 -0
  625. package/dist/geometry/primitive-resolvers.js +42 -14
  626. package/dist/geometry/profiles/primitives/circle.js +19 -0
  627. package/dist/geometry/profiles/{shapes.js → primitives/ellipse.js} +6 -10
  628. package/dist/geometry/profiles/{rectangle.js → primitives/rectangle.js} +14 -12
  629. package/dist/geometry/profiles/primitives/regular-polygon.js +33 -0
  630. package/dist/geometry/profiles/primitives/star.js +28 -0
  631. package/dist/geometry/region-offset.js +278 -0
  632. package/dist/geometry/regions.js +11 -1
  633. package/dist/geometry/revolve/revolve-mesh.js +1 -1
  634. package/dist/geometry/{svg-import.js → svg/import.js} +10 -10
  635. package/dist/geometry/sweeps/sweep-mesh.js +1 -1
  636. package/dist/geometry/transform3.js +29 -0
  637. package/dist/index.js +2 -1
  638. package/dist/model/diagnostic-path.js +26 -0
  639. package/dist/model/execution-binding.js +3 -3
  640. package/dist/model/generation.js +9 -3
  641. package/dist/model/geometry-recipes.js +1 -1
  642. package/dist/model/immutable-generation-data.js +45 -14
  643. package/dist/model/join.js +1 -0
  644. package/dist/model/operations.js +34 -144
  645. package/dist/model/recipe-declaration.js +7 -2
  646. package/dist/model/shape-handles.js +31 -7
  647. package/dist/text/index.js +1 -1
  648. package/package.json +38 -11
  649. package/dist/docs/reference/engine/Export3mfOptions.md +0 -29
  650. package/dist/docs/reference/engine/ExportMeshPart.md +0 -65
  651. package/dist/docs/reference/engine/ModelSnapshot.md +0 -184
  652. package/dist/docs/reference/engine/SnapshotPart.md +0 -133
  653. package/dist/docs/reference/engine/validateModel.md +0 -48
  654. package/dist/docs/reference/geometry/ThreadedNutBevel.md +0 -14
  655. package/dist/docs/reference/geometry/analyzeTriangleMesh.md +0 -61
  656. package/dist/docs/reference/geometry/analyzeTriangleMeshQuality.md +0 -56
  657. package/dist/docs/reference/geometry/computeTriangleMeshCentroid.md +0 -39
  658. package/dist/docs/reference/geometry/computeTriangleMeshSignature.md +0 -64
  659. package/dist/docs/reference/geometry/extrudeMesh.md +0 -77
  660. package/dist/docs/reference/geometry/heightfieldMesh.md +0 -52
  661. package/dist/docs/reference/geometry/helicalThreadRidgeMesh.md +0 -72
  662. package/dist/docs/reference/geometry/helicalThreadSolidMesh.md +0 -106
  663. package/dist/docs/reference/geometry/joinTriangleMeshes.md +0 -40
  664. package/dist/docs/reference/geometry/loftMesh.md +0 -77
  665. package/dist/docs/reference/geometry/meshBounds.md +0 -39
  666. package/dist/docs/reference/geometry/optimizePlanarPatches.md +0 -95
  667. package/dist/docs/reference/geometry/preflightHeightfield.md +0 -43
  668. package/dist/docs/reference/geometry/preflightHelicalThreadSolidMesh.md +0 -105
  669. package/dist/docs/reference/geometry/reverseTriangleMesh.md +0 -34
  670. package/dist/docs/reference/geometry/sweepMesh.md +0 -86
  671. package/dist/docs/reference/geometry/transformTriangleMesh.md +0 -46
  672. package/dist/docs/reference/geometry/validateTriangleMesh.md +0 -63
  673. package/dist/docs/reference/model/Anchor3.md +0 -55
  674. package/dist/docs/reference/model/AttachOptions.md +0 -69
  675. package/dist/docs/reference/model/Bounds2-type.md +0 -125
  676. package/dist/docs/reference/model/Bounds2Data.md +0 -44
  677. package/dist/docs/reference/model/Bounds2Input.md +0 -19
  678. package/dist/docs/reference/model/Bounds2Options.md +0 -70
  679. package/dist/docs/reference/model/Bounds3-type.md +0 -125
  680. package/dist/docs/reference/model/Bounds3Data.md +0 -44
  681. package/dist/docs/reference/model/Bounds3Input.md +0 -19
  682. package/dist/docs/reference/model/Bounds3Options.md +0 -70
  683. package/dist/docs/reference/model/BoxEdge.md +0 -15
  684. package/dist/docs/reference/model/BoxEdgeSelection.md +0 -19
  685. package/dist/docs/reference/model/BoxEdgeTreatments.md +0 -20
  686. package/dist/docs/reference/model/BoxOptions.md +0 -92
  687. package/dist/docs/reference/model/ChamferedEdgeTreatment.md +0 -35
  688. package/dist/docs/reference/model/CircleContourOptions.md +0 -21
  689. package/dist/docs/reference/model/CircularPrimitiveOptions.md +0 -64
  690. package/dist/docs/reference/model/Computed.md +0 -40
  691. package/dist/docs/reference/model/ComputedValue.md +0 -24
  692. package/dist/docs/reference/model/Contour.md +0 -24
  693. package/dist/docs/reference/model/CorrespondingComponent.md +0 -46
  694. package/dist/docs/reference/model/CorrespondingContour.md +0 -46
  695. package/dist/docs/reference/model/CorrespondingProfile.md +0 -22
  696. package/dist/docs/reference/model/CorrespondingProfileStation.md +0 -27
  697. package/dist/docs/reference/model/CylinderOptions.md +0 -58
  698. package/dist/docs/reference/model/EdgeTreatment.md +0 -22
  699. package/dist/docs/reference/model/EllipseContourOptions.md +0 -21
  700. package/dist/docs/reference/model/EndTreatments.md +0 -39
  701. package/dist/docs/reference/model/FinalizedModel.md +0 -131
  702. package/dist/docs/reference/model/FinalizedPart.md +0 -87
  703. package/dist/docs/reference/model/Frame3.md +0 -63
  704. package/dist/docs/reference/model/GeneratedPart.md +0 -97
  705. package/dist/docs/reference/model/GeometryResolution.md +0 -70
  706. package/dist/docs/reference/model/GeometrySamplingLimits.md +0 -62
  707. package/dist/docs/reference/model/GeometryToleranceOptions.md +0 -46
  708. package/dist/docs/reference/model/GridPatternOptions.md +0 -50
  709. package/dist/docs/reference/model/HeightfieldOptions.md +0 -67
  710. package/dist/docs/reference/model/HelicalThreadRidgeMeshOptions.md +0 -141
  711. package/dist/docs/reference/model/HelicalThreadSolidMeshPreflight.md +0 -59
  712. package/dist/docs/reference/model/ImmutableBuffer-type.md +0 -84
  713. package/dist/docs/reference/model/ImmutableTriangleMesh.md +0 -38
  714. package/dist/docs/reference/model/InternalThreadCutterOptions.md +0 -246
  715. package/dist/docs/reference/model/KnuckleHingeBaseSpec.md +0 -77
  716. package/dist/docs/reference/model/KnuckleHingeSamplingOptions.md +0 -47
  717. package/dist/docs/reference/model/KnuckleHingeSpec.md +0 -18
  718. package/dist/docs/reference/model/LinearPatternOptions.md +0 -39
  719. package/dist/docs/reference/model/LoftCorrespondence.md +0 -27
  720. package/dist/docs/reference/model/LoftOptions.md +0 -91
  721. package/dist/docs/reference/model/LoftPlacement.md +0 -73
  722. package/dist/docs/reference/model/MatchProfilesOptions.md +0 -35
  723. package/dist/docs/reference/model/ModelingLimits.md +0 -126
  724. package/dist/docs/reference/model/NumericArray.md +0 -14
  725. package/dist/docs/reference/model/Path2-type.md +0 -196
  726. package/dist/docs/reference/model/Path2Data.md +0 -50
  727. package/dist/docs/reference/model/Path2Input.md +0 -20
  728. package/dist/docs/reference/model/Path3-type.md +0 -196
  729. package/dist/docs/reference/model/Path3Data.md +0 -50
  730. package/dist/docs/reference/model/Path3Input.md +0 -20
  731. package/dist/docs/reference/model/PathLocation.md +0 -69
  732. package/dist/docs/reference/model/PathNormalGuide.md +0 -46
  733. package/dist/docs/reference/model/PathOptions.md +0 -38
  734. package/dist/docs/reference/model/PathPatternOptions.md +0 -48
  735. package/dist/docs/reference/model/PathResamplingOptions.md +0 -83
  736. package/dist/docs/reference/model/Pivot2Options.md +0 -28
  737. package/dist/docs/reference/model/Pivot3Options.md +0 -28
  738. package/dist/docs/reference/model/PolygonData.md +0 -44
  739. package/dist/docs/reference/model/PrimitiveAttachment.md +0 -41
  740. package/dist/docs/reference/model/PrimitiveAttachmentOptions.md +0 -110
  741. package/dist/docs/reference/model/PrintableThreadFit.md +0 -15
  742. package/dist/docs/reference/model/PrintableThreadFitPolicy.md +0 -51
  743. package/dist/docs/reference/model/ProfileComponent2.md +0 -46
  744. package/dist/docs/reference/model/ProfileContour2.md +0 -36
  745. package/dist/docs/reference/model/ProfileSpan2.md +0 -47
  746. package/dist/docs/reference/model/ProfiledEdgeTreatment.md +0 -41
  747. package/dist/docs/reference/model/RadialPatternOptions.md +0 -59
  748. package/dist/docs/reference/model/RadialSizing.md +0 -15
  749. package/dist/docs/reference/model/RadialSizingOptions.md +0 -40
  750. package/dist/docs/reference/model/RectangleContourOptions.md +0 -72
  751. package/dist/docs/reference/model/RectangleCornerTreatment.md +0 -40
  752. package/dist/docs/reference/model/RectangleCornerTreatments.md +0 -20
  753. package/dist/docs/reference/model/RegionData.md +0 -19
  754. package/dist/docs/reference/model/RevolveOptions.md +0 -94
  755. package/dist/docs/reference/model/RoundedEdgeTreatment.md +0 -96
  756. package/dist/docs/reference/model/SmoothEdgeTreatment.md +0 -76
  757. package/dist/docs/reference/model/SphereOptions.md +0 -20
  758. package/dist/docs/reference/model/StrokeCap.md +0 -16
  759. package/dist/docs/reference/model/StrokeJoin.md +0 -16
  760. package/dist/docs/reference/model/StrokeOptions.md +0 -91
  761. package/dist/docs/reference/model/SweepOptions.md +0 -116
  762. package/dist/docs/reference/model/SweepOrientation.md +0 -116
  763. package/dist/docs/reference/model/ThreadEndStyle.md +0 -15
  764. package/dist/docs/reference/model/ThreadEndTreatmentOptions.md +0 -118
  765. package/dist/docs/reference/model/ThreadHandedness.md +0 -15
  766. package/dist/docs/reference/model/ThreadLeadInEnvelope.md +0 -15
  767. package/dist/docs/reference/model/ThreadLeadInShape.md +0 -15
  768. package/dist/docs/reference/model/ThreadProfile.md +0 -87
  769. package/dist/docs/reference/model/ThreadRidgeOptions.md +0 -19
  770. package/dist/docs/reference/model/ThreadedNutBevel.md +0 -15
  771. package/dist/docs/reference/model/ThreadedNutOptions.md +0 -274
  772. package/dist/docs/reference/model/ThreadedNutPreflight.md +0 -99
  773. package/dist/docs/reference/model/ThreadedNutShape.md +0 -15
  774. package/dist/docs/reference/model/ThreadedRodOptions.md +0 -246
  775. package/dist/docs/reference/model/TorusOptions.md +0 -110
  776. package/dist/docs/reference/model/Transform2-type.md +0 -257
  777. package/dist/docs/reference/model/Transform2Data.md +0 -16
  778. package/dist/docs/reference/model/Transform2Input.md +0 -21
  779. package/dist/docs/reference/model/Transform3-type.md +0 -297
  780. package/dist/docs/reference/model/Transform3Data.md +0 -19
  781. package/dist/docs/reference/model/Transform3Input.md +0 -21
  782. package/dist/docs/reference/model/TriangleMesh.md +0 -42
  783. package/dist/docs/reference/model/TriangleMeshAnalysis.md +0 -123
  784. package/dist/docs/reference/model/TriangleMeshMeasurements.md +0 -79
  785. package/dist/docs/reference/model/TubeOptions.md +0 -143
  786. package/dist/docs/reference/model/Vector2-type.md +0 -271
  787. package/dist/docs/reference/model/Vector2Data.md +0 -15
  788. package/dist/docs/reference/model/Vector2Input.md +0 -21
  789. package/dist/docs/reference/model/Vector3-type.md +0 -283
  790. package/dist/docs/reference/model/Vector3Data.md +0 -15
  791. package/dist/docs/reference/model/Vector3Input.md +0 -21
  792. package/dist/docs/reference/model/VectorTextLayout.md +0 -40
  793. package/dist/docs/reference/model/VectorTextMetrics.md +0 -100
  794. package/dist/docs/reference/model/anchor.md +0 -47
  795. package/dist/docs/reference/model/bounds2.md +0 -37
  796. package/dist/docs/reference/model/bounds3.md +0 -37
  797. package/dist/docs/reference/model/castSegment.md +0 -40
  798. package/dist/docs/reference/model/categories/bounds.md +0 -38
  799. package/dist/docs/reference/model/categories/contracts.md +0 -18
  800. package/dist/docs/reference/model/categories/core-values-errors.md +0 -30
  801. package/dist/docs/reference/model/categories/inspection.md +0 -29
  802. package/dist/docs/reference/model/categories/paths.md +0 -41
  803. package/dist/docs/reference/model/categories/resolution.md +0 -20
  804. package/dist/docs/reference/model/components.md +0 -71
  805. package/dist/docs/reference/model/compose.md +0 -31
  806. package/dist/docs/reference/model/distance.md +0 -45
  807. package/dist/docs/reference/model/immutableMesh.md +0 -44
  808. package/dist/docs/reference/model/inspectSection.md +0 -38
  809. package/dist/docs/reference/model/inspectSolid.md +0 -38
  810. package/dist/docs/reference/model/isEmpty.md +0 -39
  811. package/dist/docs/reference/model/path2.md +0 -54
  812. package/dist/docs/reference/model/path3.md +0 -49
  813. package/dist/docs/reference/model/split.md +0 -54
  814. package/dist/docs/reference/model/splitByPlane.md +0 -66
  815. package/dist/docs/reference/model/transform2.md +0 -46
  816. package/dist/docs/reference/model/transform3.md +0 -48
  817. package/dist/docs/reference/model/vector2.md +0 -40
  818. package/dist/docs/reference/model/vector3.md +0 -47
  819. package/dist/docs/reference/text/Bounds2Data.md +0 -34
  820. package/dist/docs/reference/text/Vector2Data.md +0 -7
  821. package/dist/docs/reference/text/VectorTextArcBaseline.md +0 -53
  822. package/dist/docs/reference/text/VectorTextLayout.md +0 -34
  823. package/dist/docs/reference/text/VectorTextLayoutOptions.md +0 -111
  824. package/dist/docs/reference/text/VectorTextMetrics.md +0 -94
  825. package/dist/docs/reference/text/VectorTextOptions.md +0 -50
  826. package/dist/engine/export-3mf.js +0 -116
  827. package/dist/engine/model-dependencies.js +0 -46
  828. package/dist/engine/session-graph.js +0 -449
  829. package/dist/geometry/profiles/profiles.js +0 -71
  830. /package/dist/engine/{primitive-profile-types.js → operations/primitives/profile-types.js} +0 -0
  831. /package/dist/{engine → geometry/mesh}/mesh-view-cache.js +0 -0
  832. /package/dist/geometry/profiles/{matched.js → match-profiles.js} +0 -0
@@ -1,771 +1,35 @@
1
1
  # Modeling recipes
2
2
 
3
- Build plates, cups, routed tubes, lofts, repeated features, SVG shapes, and lettering with complete modeling examples.
4
-
5
- Choose a recipe, inspect its render, and copy the complete source into a Studio
6
- [code Project](https://metamesh.studio/docs/develop/code-projects). Each illustrated recipe renders that same source;
7
- open its interactive preview to orbit the result.
8
-
9
- | You want to make | Start here | Main decision |
10
- | ------------------------ | -------------------------------------------------------------- | --------------------------------------------------------- |
11
- | A flat part with holes | [Sections and extrusion](#section-hole-offset-and-extrusion) | Solve the filled outline before adding thickness |
12
- | A badge from artwork | [SVG extrusion](#svg-parameter-and-extrusion) | Set physical size and preserve holes |
13
- | A lathed cup or knob | [Revolution](#revolve-a-radial-profile) | Describe radius and height in one closed wall profile |
14
- | A hub with repeated arms | [Radial placement](#primitive-booleans-and-repeated-placement) | Position one feature before repeating it |
15
- | A routed strip or tube | [Path sweep](#rotation-minimizing-path-sweep) | Choose how the section is oriented along the path |
16
- | A transition or adapter | [Section loft](#matched-section-loft) | Keep corresponding landmarks between stations |
17
- | A relief tile | [Heightfield](#sample-a-heightfield) | Choose physical samples and triangle diagonals |
18
- | A pair of mating pieces | [Anchors](#named-anchors-and-custom-frames) | Define the mating datum rather than duplicate coordinates |
19
- | Raised lettering | [Prepared text](#text-from-a-font-parameter) | Cache the selected font layout during generation |
20
-
21
- All dimensions in these recipes are millimetres. MetaMesh uses a right-handed coordinate system
22
- with +Z up, degrees for angular arguments including `rotate`, and non-duplicated contour seams.
23
- The examples default-export a synchronous `generate` program. Use assertions for constraints
24
- and optional `computed` values to cache expensive shared calculations, geometry, or text layouts.
25
- [Define parameters and validation](https://metamesh.studio/docs/develop/parameters-and-validation) connects
26
- source values to controls.
27
-
28
- ## Section, hole, offset, and extrusion
29
-
30
-
31
-
32
- ```ts
33
- import { circle, rectangle } from "@metamesh/modeling";
34
- import { generate } from "@metamesh/project";
35
-
36
- export default generate(({ part }) => {
37
- const plate = rectangle({ size: [80, 45] });
38
- const hole = circle({ radius: 4 });
39
- // Positive offset expands material: the outer edge grows and the hole shrinks.
40
- const rimmedPlate = plate.subtract([hole]).offset(1.2);
41
- // Keep the plate centered about Z = 0 for later symmetric placement.
42
- return [part("model", rimmedPlate.extrude({ height: 5, center: true }))];
43
- });
44
- ```
45
-
46
- Subtract the opening in 2D, offset the filled material, then extrude it into one plate.
47
-
48
-
49
-
50
- `rectangle` and `circle` take object options and return filled Sections. `section.subtract(cutters)`,
51
- `union`, and `intersect` also support Solids; every operand in a call must have the same dimension.
52
- `section.offset(distance)` offsets the filled material. `section.extrude({ height })` preserves
53
- holes and places the bottom at zero unless `center: true` is requested.
54
-
55
- Positive offset grows material on every boundary: this example grows the outside by `1.2 mm` and
56
- reduces the hole radius from `4 mm` to `2.8 mm`. If the final bore must remain `8 mm` in diameter,
57
- offset the outside first and subtract the hole afterward. See
58
- [`Section.offset`](../reference/model/Section.md#offset) and [`Section.extrude`](../reference/model/Section.md#extrude).
59
-
60
- ## SVG parameter and extrusion
61
-
62
- Pass an SVG control's string value from `params` directly to `svgSection`. This example aliases
63
- `params` as `parameters`:
64
-
65
-
66
-
67
- ```ts
68
- import { svgSection } from "@metamesh/modeling";
69
- import { generate } from "@metamesh/project";
70
-
71
- export default generate(({ params: parameters, part }) => {
72
- const profile = svgSection(parameters.profile6);
73
- return [part("model", profile.extrude({ height: 3, center: true }))];
74
- });
75
- ```
76
-
77
-
78
-
79
- The property name matches the ID in **Model controls**: `profile6` in this example, or
80
- `parameters.logo` for a control with ID `logo`.
81
-
82
- `svgSection` also accepts literal SVG documents. Here two nested subpaths make a badge
83
- with a rectangular opening:
84
-
85
-
86
-
87
- ```ts
88
- import { inspectSection, svgSection } from "@metamesh/modeling";
89
- import { generate } from "@metamesh/project";
90
-
91
- export default generate(({ part }) => {
92
- // Physical root units make the imported artwork exactly 48 × 32 mm.
93
- // Even-odd filling turns the second closed subpath into an opening.
94
- const badge = svgSection(`
95
- <svg xmlns="http://www.w3.org/2000/svg" width="48mm" height="32mm" viewBox="0 0 48 32">
96
- <path
97
- fill-rule="evenodd"
98
- d="M 0 0 H 48 V 32 H 0 Z M 14 8 H 34 V 24 H 14 Z"
99
- />
100
- </svg>
101
- `);
102
- // Check the imported topology before using it in the manufacturing solid.
103
- const measurements = inspectSection(badge);
104
- if (measurements.componentCount !== 1 || measurements.contourCount !== 2) {
105
- throw new Error("Expected one badge with one rectangular opening.");
106
- }
107
- return [part("model", badge.extrude({ height: 4, center: true }))];
108
- });
109
- ```
110
-
111
- The 48 × 32 mm SVG document retains its physical size and even-odd opening after extrusion.
112
-
113
-
114
-
115
- `svgSection` imports painted geometry, not browser-rendered SVG. The even-odd fill rule makes the
116
- second subpath a hole regardless of winding. Complete documents honor supported physical root units
117
- and `viewBox`, convert SVG's Y-down coordinates to MetaMesh Y-up, and center the filled bounds by
118
- default. Use `svgPathSection` for path-data strings where one user unit should equal 1 mm, or pass
119
- its `scale` option to choose another millimetres-per-unit conversion.
120
-
121
- To choose the finished artwork size, pass `fit` with positioned XY bounds. Fitting preserves
122
- aspect ratio and centers the painted geometry inside the target; unused SVG canvas margins do
123
- not reserve space. Adaptive curve tolerance and edge spacing apply at the final millimetre size:
124
-
125
-
126
-
127
- ```ts
128
- import { bounds2, svgSection } from "@metamesh/modeling";
129
- import { generate } from "@metamesh/project";
130
-
131
- export default generate(({ part }) => {
132
- const artwork = svgSection('<svg><circle r="1"/></svg>', {
133
- fit: bounds2({ size: [30, 18] }),
134
- resolution: { maxChordError: 0.05 },
135
- });
136
- return part("artwork", artwork.extrude({ height: 0.8 }));
137
- });
138
- ```
139
-
140
-
141
-
142
- For pure preparation, `preflightSvgRegion` from `@metamesh/modeling/geometry` accepts the same
143
- fit target and returns its applied `fit` alongside the final region and review metrics. The
144
- scale and translation map the selected origin's SVG millimetres to model millimetres. Reuse
145
- them for registered layers imported with the same document coordinate system and origin.
146
- Exact circular segment counts retain precedence over adaptive sampling. Empty artwork cannot
147
- be fitted, and fitting rejects a requested resolution that exceeds the sampling limits.
148
-
149
- Visible fills and bounded strokes contribute geometry; editor metadata is ignored. Editor text is
150
- outlined to visible paths on Apply. Live `<text>`, images, `<use>`, external resources, class-based
151
- stylesheets, clipping, masks, filters, and percentage dimensions are rejected. To generate lettering
152
- directly, use the [text recipe](#text-from-a-font-parameter). SVG export, project assets, custom font
153
- uploads, text on paths, and general SVG layout are outside this API.
154
-
155
- ## Revolve a radial profile
156
-
157
- Use revolution when one side outline can describe the entire part around an axis. In the Section
158
- below, X is radius and Y is final Z height; radii must stay nonnegative. The closed loop includes
159
- the cup's floor, outside, rim, and inside, so the opening remains intentional.
160
-
161
-
162
-
163
- ```ts
164
- import { polygon } from "@metamesh/modeling";
165
- import { generate } from "@metamesh/project";
166
-
167
- export default generate(({ part }) => {
168
- // Here Section X means radius and Section Y becomes the final Z height.
169
- // Walk the filled wall counterclockwise, omitting a repeated closing point.
170
- const wall = polygon([
171
- [0, 0],
172
- [16, 0],
173
- [16, 4],
174
- [12, 4],
175
- [10, 28],
176
- [7, 28],
177
- [9, 4],
178
- [0, 4],
179
- ]);
180
- // A full revolution creates the floor, tapered wall, and open top together.
181
- return [part("model", wall.revolve())];
182
- });
183
- ```
184
-
185
- One radial wall profile revolved around +Z creates the floor and tapered cup wall.
186
-
187
-
188
-
189
- [`polygon`](../reference/model/polygon.md) fills the ordered contour.
190
- [`Section.revolve`](../reference/model/Section.md#revolve) defaults to a complete `360°` turn. Set
191
- `degrees: 270` for a capped partial turn that exposes the cross section. Keep the closed
192
- profile free of self-intersections and never repeat its first point at the end.
193
-
194
- For an open side outline, [`sampleSideProfile`](../reference/geometry/sampleSideProfile.md)
195
- returns physical `[radius, height]` points. [`closeToAxis`](../reference/geometry/closeToAxis.md)
196
- adds the horizontal bottom/top edges needed for a solid body. Fill the result with `polygon`,
197
- then revolve it. Hollow walls and mounting bores need their own closed material contour.
198
-
199
- ## Choose a primitive
200
-
201
- Start with the factory that most closely describes the shape. The first row below contains ready
202
- Solids; the second contains filled Sections extruded to `5 mm` thickness. Each result remains a
203
- separate named part so you can inspect it in the interactive preview.
204
-
205
-
206
-
207
- ```ts
208
- import { ellipse, regularPolygon, sphere, star, torus, tube } from "@metamesh/modeling";
209
- import { generate } from "@metamesh/project";
210
-
211
- export default generate(({ part }) => {
212
- // Solid primitives are ready for placement; filled Sections need depth first.
213
- // Place finished parts on two rows while keeping local geometry reusable.
214
- return [
215
- part("sphere", { geometry: sphere({ diameter: 14 }), position: [0, 0, 7], color: "#60a5fa" }),
216
- part("torus", {
217
- geometry: torus({ majorRadius: 7, minorRadius: 2 }),
218
- position: [24, 0, 2],
219
- color: "#34d399",
220
- }),
221
- part("tube", {
222
- geometry: tube({ outerRadius: 7, innerRadius: 4, height: 10, center: false }),
223
- position: [48, 0, 0],
224
- color: "#f59e0b",
225
- }),
226
- part("ellipse", {
227
- geometry: ellipse({ size: [18, 12] }).extrude({ height: 5 }),
228
- position: [0, 24, 0],
229
- color: "#c084fc",
230
- }),
231
- part("star", {
232
- geometry: star({ outerRadius: 9, innerRadius: 4.5, points: 5 }).extrude({ height: 5 }),
233
- position: [24, 24, 0],
234
- color: "#fb7185",
235
- }),
236
- part("hexagon", {
237
- geometry: regularPolygon({ radius: 7, sides: 6, sizing: "face" }).extrude({ height: 5 }),
238
- position: [48, 24, 0],
239
- color: "#22d3ee",
240
- }),
241
- ];
242
- });
243
- ```
244
-
245
- Sphere, torus, and tube are solid factories. Ellipse, star, and regular polygon create Sections that can be extruded.
246
-
247
-
248
-
249
- Use a [`tube`](../reference/model/tube.md) when the bore is concentric; it avoids a separate cutter.
250
- A [`torus`](../reference/model/torus.md) uses the distance to the circular profile's center as its
251
- major radius. [`regularPolygon`](../reference/model/regularPolygon.md) has an exact side count;
252
- `sizing: "face"` makes the specified radius reach the faces instead of the vertices. Keep physical
253
- curve tolerance for ordinary round shapes and use exact segment counts for deliberate faceting.
254
-
255
- ## Primitive booleans and repeated placement
256
-
257
-
258
-
259
- ```ts
260
- import { box, cylinder, radialPattern, union } from "@metamesh/modeling";
261
- import { generate } from "@metamesh/project";
262
-
263
- export default generate(({ part }) => {
264
- const hub = cylinder({ height: 12, radius: 14 });
265
- const arm = box({ size: [30, 6, 6] });
266
- // Translate first, then rotate the whole arm about the world origin.
267
- // Its inner end overlaps the hub so union creates one connected part.
268
- const arms = radialPattern(arm.translate([18, 0, 0]).rotate([0, 0, 30]), {
269
- count: 6,
270
- axis: [0, 0, 1],
271
- angle: 60,
272
- });
273
- // Both shapes are Z-centered; extra cutter height clears both hub faces.
274
- const bore = cylinder({ height: 16, radius: 4 });
275
- // Combine the repeated features once, then cut the common bore.
276
- return [part("model", union([hub, ...arms]).subtract([bore]))];
277
- });
278
- ```
279
-
280
- Position and rotate one arm, repeat it about +Z, union the overlaps, then cut a common bore.
281
-
282
-
283
-
284
- Transforms apply in written order: `arm.translate(...).rotate(...)` moves the arm first, then rotates
285
- its position about the origin. Reversing those calls rotates the arm locally before moving it.
286
- Keep a deliberate overlap between each arm and the hub so the result is one connected solid.
287
-
288
- Exact signatures: [`box`](../reference/model/box.md),
289
- [`cylinder`](../reference/model/cylinder.md), and
290
- [`radialPattern`](../reference/model/radialPattern.md).
291
-
292
- ## Reuse a 2D placement
293
-
294
- Build one [`transform2`](../reference/geometry/transform2.md) chain when the same placement applies
295
- to a Section and its plain point data. This placement rotates around `[2, 1]`, then translates:
296
-
297
-
298
-
299
- ```ts
300
- import { path2, pathPattern, polygon, rectangle, transform2, union } from "@metamesh/modeling";
301
-
302
- const planarPlacement = transform2()
303
- .rotate(90, { pivot: [2, 1] })
304
- .translate([10, 0]);
305
- const outline = [
306
- [0, 0],
307
- [4, 0],
308
- [0, 2],
309
- ] as const;
310
-
311
- // Shape construction and composition are pure; the host evaluates the finished body.
312
- export const placedBody = polygon({ outer: outline, holes: [] })
313
- .transform(planarPlacement)
314
- .extrude({ height: 8 });
315
-
316
- // Paths accept the same placement. Matrices and tuples remain available for interchange.
317
- export const sectionMatrix = planarPlacement.toData();
318
- export const placedContour = path2(outline, { closed: true }).transform(planarPlacement);
319
- ```
320
-
321
-
322
-
323
- Pass the placement directly to `section.transform(planarPlacement)` or `path.transform(planarPlacement)`.
324
- Fill the transformed closed path with `polygon(placedContour)` when you need material.
325
- [`transformRegionData`](../reference/geometry/transformRegionData.md) serves serialized filled data.
326
-
327
- A negative scale factor reflects the placement. Paths retain traversal order, including closed
328
- paths; filled Sections and serialized regions restore outer and hole winding. `andThen(next)`
329
- composes another placement in execution order;
330
- reuse the placement instead of building a chain inside each point iteration. `toData()` is
331
- available for matrix interchange.
332
-
333
- Section path patterns consume `Path2` values directly. Tangent orientation aligns the Section's
334
- local +X direction with the path while preserving its XY plane:
335
-
336
-
337
-
338
- ```ts
339
- const guide = path2([
340
- [0, 0],
341
- [12, 0],
342
- [12, 12],
343
- ]);
344
- const tabs = pathPattern(rectangle({ size: [4, 2] }), guide, {
345
- count: 5,
346
- orientation: "tangent",
347
- });
348
- export const patternedTabs = union(tabs).extrude({ height: 3 });
349
- ```
350
-
351
-
352
-
353
- Linear Section patterns use XY directions. Radial Section patterns rotate about an optional XY
354
- `pivot` using the implicit +Z axis; spatial Solid patterns retain their explicit rotation axis.
355
-
356
- ## Rotation-minimizing path sweep
357
-
358
-
359
-
360
- ```ts
361
- import { rectangle } from "@metamesh/modeling";
362
- import { generate } from "@metamesh/project";
363
-
364
- export default generate(({ part }) => {
365
- // An asymmetric section makes the frame orientation visible in the result.
366
- const section = rectangle({
367
- size: [8, 3],
368
- treatment: { kind: "round", radius: 0.8 },
369
- });
370
- const path = [
371
- [0, 0, 0],
372
- [15, 0, 8],
373
- [25, 10, 18],
374
- [25, 25, 24],
375
- ] as const;
376
- // The initial normal sets profile +X; transport carries it along the path.
377
- // The path is open, so the sweep closes both ends with caps.
378
- return [
379
- part(
380
- "model",
381
- section.sweep(path, { orientation: { kind: "transport", initialNormal: [0, 1, 0] } })
382
- ),
383
- ];
384
- });
385
- ```
386
-
387
- The asymmetric section makes its transported orientation visible as the path turns.
388
-
389
-
390
-
391
- `section.sweep(path, options)` transports a filled shape along a path:
392
-
393
- - `orientation: { kind: "transport", initialNormal: [0, 1, 0] }` chooses the starting profile-X
394
- direction. Fixed normals, directed normal guides, and discrete Frenet frames are alternatives;
395
- singular selected policies reject.
396
- - `twist` adds total rotation by physical path length. Set `twistBy: "stations"` to use the authored
397
- station schedule instead.
398
- - `scale` accepts a positive uniform size, an XY pair, or one XY pair per normalized station.
399
- - `closed: true` joins an implicitly closed path without repeated endpoints. Orientation, scales,
400
- and `seamProfileOffset` must describe a compatible closing seam.
401
-
402
- Start with the open path above, inspect the first cap and the turns, then replace the rectangle
403
- with a [`circle`](../reference/model/circle.md) for a round rod. A sweep follows the supplied path
404
- stations; it does not infer a smooth curve between them. Sample a curve with the
405
- [path helpers](../reference/geometry/categories/curves-paths.md) when you need a curved trajectory.
406
-
407
- ## Named anchors and custom frames
408
-
409
-
410
-
411
- ```ts
412
- import { anchor, box, cylinder } from "@metamesh/modeling";
413
- import { generate } from "@metamesh/project";
414
-
415
- export default generate(({ part }) => {
416
- const base = box({ size: [40, 24, 6], center: false });
417
- // Named anchors follow dimensions: no duplicated half-height calculation.
418
- // Mating bottom to top opposes the two outward normals automatically.
419
- const pin = cylinder({ diameter: 8, height: 12 }).attach("bottom", anchor(base, "top"), {
420
- gap: 0.2,
421
- });
422
- // Keep the gap and the two physical pieces instead of unioning the assembly.
423
- return [part("base", { geometry: base }), part("pin", { geometry: pin })];
424
- });
425
- ```
426
-
427
- The pin's bottom mates to the base's top with a 0.2 mm gap. They remain two named parts.
428
-
429
-
430
-
431
- Ordinary primitives know their named anchors, so `anchor(base, "top")` follows the box's dimensions
432
- and placement. `pin.attach("bottom", anchor(base, "top"))` mates opposed directions. Transforms and
433
- patterns carry those frames with the shape, with outward normals preserved under nonuniform scale
434
- and reflection. The axis names are `left/right` (−X/+X), `back/front` (−Y/+Y) and `bottom/top` (−Z/+Z).
435
-
436
- Use `shape.withAnchors({ mount: anchor3(position, direction, up) })` to define a custom datum
437
- on a new handle. Existing names remain unless replaced; definitions are copied and immutable.
438
- Boolean and other constructed shapes need explicit definitions because their surfaces may change.
439
- Anchor names use lowercase kebab-case, with at most 64 characters and 128 definitions per shape.
440
- Lookup realizes the required recipe in the active generation transaction. Returned frames are plain data.
441
-
442
- Primitive anchors describe nominal construction dimensions. Finishing and curve sampling do not
443
- move them. Tube and torus axial datums may lie over an opening; a cone has no cap anchor at its apex.
444
- Regular polygons and stars expose only `center`. Custom `Anchor3` frames, including pure
445
- `boxAnchor3` and `cylinderAnchor3` helpers, work wherever a source or target frame is required.
446
-
447
- Primitive `attachment` uses the same source/target anchor, `alignment`, `gap`, and `spin`
448
- options as `attach`, including a named `source`. It applies after local construction; Section
449
- attachment must preserve the XY plane.
450
-
451
- The `gap` here separates the two pieces along the target normal; it is a placement distance, not
452
- a radial fit clearance. Keep separate named parts for an assembly. For one fused part, remove the
453
- gap, add a small intended overlap, and [`union`](../reference/model/union.md) the solids.
454
-
455
- ## Printable threaded rod and nut
456
-
457
- Follow [Build printable threads](https://metamesh.studio/docs/develop/printable-threads) for a runnable rod-and-nut example
458
- and guidance on profiles, fit, lead, end treatments, resolution, and calibration.
459
-
460
- ## Treated boxes, frustums, and mirrored arrays
461
-
462
-
463
-
464
- ```ts
465
- import { box, cylinder, gridPattern } from "@metamesh/modeling";
466
- import { generate } from "@metamesh/project";
467
-
468
- export default generate(({ part }) => {
469
- const housing = box({
470
- size: [46, 30, 12],
471
- treatment: { kind: "round", radius: 3 },
472
- });
473
- const taperedBore = cylinder({
474
- // The centered cutter extends beyond both faces of the 12 mm housing.
475
- height: 16,
476
- // Tuples run from the bottom diameter to the top diameter along +Z.
477
- diameter: [8, 6],
478
- sizing: "face",
479
- ends: { top: { kind: "chamfer", distance: 0.8 } },
480
- });
481
- // Pattern the already-positioned tool; X varies fastest through the array.
482
- const perforations = gridPattern(taperedBore.translate([-13, -6, 0]), {
483
- count: [3, 2],
484
- spacing: [13, 12],
485
- });
486
- // Mirror the completed housing across the plane with normal +X.
487
- return [part("model", housing.subtract(perforations).mirror([1, 0, 0]))];
488
- });
489
- ```
490
-
491
- Six non-overlapping cutters share the same taper and rim treatment; the completed housing is mirrored.
492
-
493
-
494
-
495
- Paired cylinder radii or diameters are always `[bottom, top]` in +Z order. A zero endpoint makes a cone;
496
- chamfers under `ends.bottom` and `ends.top` may treat either nonzero end and follow the tapered side.
497
- Boxes and rectangles share `round`, `chamfer`, `smooth`, and explicit `profile` treatments. Boxes
498
- can select disjoint named edges or groups; rectangles can select each corner. `gridPattern` places
499
- the cutters on an XY grid, with X varying fastest.
500
- Zero rounding radius or zero chamfer/smooth setbacks disable that treatment, so an adjustable
501
- feature can remain in the options object when switched off.
502
-
503
- The bores use `diameter: [8, 6]` and `13 × 12 mm` spacing to leave material between them. Check
504
- the widest cutter diameter and the outer wall when changing either value. In this example the
505
- tool's top chamfer lies above the housing; it shapes the cutter end, not the finished hole's rim.
506
- Use an explicitly shaped cutting profile if the finished mouth needs a countersink.
507
-
508
- ## Matched-section loft
509
-
510
-
511
-
512
- ```ts
513
- import { loft, rectangle } from "@metamesh/modeling";
514
- import { generate } from "@metamesh/project";
515
-
516
- export default generate(({ part }) => {
517
- const base = rectangle({
518
- size: [24, 16],
519
- treatment: { kind: "round", radius: 3 },
520
- });
521
- // Transform the Section in its XY plane; loft supplies the station heights.
522
- // Keeping the original rectangle landmarks preserves corner correspondence.
523
- const top = base.scale([0.8, 1.2]).rotate(10).translate([3, 0]);
524
- return [
525
- part(
526
- "model",
527
- loft([
528
- {
529
- profile: base,
530
- z: 0,
531
- },
532
- {
533
- profile: top,
534
- z: 18,
535
- },
536
- ])
537
- ),
538
- ];
539
- });
540
- ```
541
-
542
- The two rounded rectangles retain matching corner identities while their size and pose change.
543
-
544
-
545
-
546
- This [`loft`](../reference/model/loft.md) example places a rounded rectangle at two heights. Use
547
- `scale`, `rotate` and `translate` to pose the top profile in XY; `rotate` takes degrees. Each
548
- station uses `z` for an ordinary horizontal plane. To tilt a station, pass
549
- `frame: anchorFrame3(anchor3(position, direction, up))` instead; the direction chooses its
550
- normal and a nonparallel `up` vector chooses its roll.
551
-
552
- The primitive retains its corner identities, so `loft` pairs corresponding landmarks without
553
- extra setup. The same approach works when corners become square or fully rounded. For a hollow
554
- adapter, loft the outer shape and bore separately, then subtract the bore.
555
-
556
- Custom hole topology or disconnected components can use an explicit
557
- [`Profile`](../reference/geometry/Profile.md) family with stable component, contour, and span IDs.
558
- Prepare [`matchProfiles`](../reference/geometry/matchProfiles.md) once and pass its
559
- [`CorrespondingProfile`](../reference/geometry/CorrespondingProfile.md) stations to the same `loft`
560
- function. Topology must remain constant across stations. Arbitrary Boolean Sections need deliberate
561
- `correspondence: "direct"`, `"reindex"`, `"fast-distance"`, or `"distance"`, or explicit profiles;
562
- contour order does not establish landmarks. Direct association preserves the supplied seams;
563
- reindex also chooses a cyclic phase, while distance methods optimize ordered connections. See
564
- [`LoftOptions`](../reference/model/LoftOptions.md) for sampling and work limits.
565
-
566
- ## Sample a heightfield
567
-
568
- Build a relief tile from absolute Z heights over a rectangular XY grid.
569
- [`heightfield`](../reference/model/heightfield.md) returns a Solid for Booleans and placement during
570
- generation. Pure [`heightfieldMesh`](../reference/geometry/heightfieldMesh.md) accepts the same options
571
- and returns an indexed mesh without an engine. Pass it directly as a mesh part, or wrap it in
572
- [`immutableMesh`](../reference/model/immutableMesh.md) when returning it from a cached computation.
573
-
574
-
575
-
576
- ```ts
577
- import { heightfield } from "@metamesh/modeling";
578
- import { generate } from "@metamesh/project";
579
-
580
- export default generate(({ part }) => {
581
- return [
582
- part(
583
- "model",
584
- heightfield({
585
- coordinates: {
586
- x: [-20, -18, -14, -8, 0, 8, 14, 18, 20],
587
- y: [-12, -10, -6, 0, 6, 10, 12],
588
- },
589
- triangulation: "min-edge",
590
- height: ([x, y]) => 3 + 0.8 * Math.cos(x / 6) * Math.cos(y / 5),
591
- })
592
- ),
593
- ];
594
- });
595
- ```
596
-
597
-
598
-
599
- The uneven axes place more samples near the border. Coordinates are absolute millimetres, strictly
600
- increasing, and must remain distinct in Float32 storage. For a uniform grid, replace `coordinates`
601
- with `size: [40, 24]` and `segments: [40, 24]`; this centers the footprint unless `origin` supplies
602
- its lower-left corner. Choose one sampling form per call.
603
-
604
- `baseZ` defaults to zero. Every height is an absolute Z coordinate strictly above that base;
605
- the builder preserves the sampled heights without rescaling them. It closes the top with shared
606
- boundary walls and a flat underside.
607
-
608
- | `triangulation` | Selection per top cell |
609
- | ---------------- | ---------------------------------------------------------------------------- |
610
- | `"fixed"` | The default lower-left to upper-right diagonal |
611
- | `"min-edge"` | The shorter 3D diagonal, using the existing corner heights |
612
- | `"center-error"` | The diagonal whose interpolated center is closest to one extra height sample |
613
-
614
- All choices keep two triangles per cell and the same vertices. Center matching evaluates one
615
- additional physical midpoint per cell. Both selection policies use the fixed diagonal for ties.
616
- Choose sample spacing for the surface detail you need: these policies do not adapt the grid or
617
- guarantee accuracy throughout each cell. Explicit axes let your model refine selected regions
618
- while keeping allocation bounded.
619
- [`preflightHeightfield`](../reference/geometry/preflightHeightfield.md) reports output counts and
620
- checks limits without evaluating heights.
621
-
622
- ## Text from a Font parameter
623
-
624
- Use this recipe for a label, plaque, or raised lettering whose font remains adjustable.
625
-
626
- 1. Open **Model controls**, add a **Font** control with ID `font`, and choose its default face and
627
- weight. Outfit and JetBrains Mono are bundled starter fonts.
628
- 2. Choose **Apply & return** and use the generation program below in `model.ts`.
629
- Studio prepares the selected font before the program lays out and extrudes its text.
630
- 3. To make the wording adjustable, add a **Text** control with ID `label` and a non-empty default,
631
- then replace the literal `"MetaMesh"` with `params.label`.
632
-
633
-
634
-
635
- ```ts
636
- import { textSection } from "@metamesh/modeling";
637
- import { generate } from "@metamesh/project";
638
-
639
- export default generate(({ params, services, part }) => {
640
- // The host has loaded the exact selected font before generation.
641
- const layout = services.text.layout("MetaMesh", {
642
- fontSize: 8,
643
- font: params.font,
644
- letterSpacing: 0.15,
645
- });
646
- // textSection preserves counters, such as the enclosed hole in the letter a.
647
- return [part("label", textSection(layout).extrude({ height: 1.2 }))];
648
- });
649
- ```
650
-
651
- The poster uses a pinned bundled Outfit face and preserves the counters inside each letter.
652
-
653
-
654
-
655
- `textSection(layout)` converts prepared vector curves into a filled section, preserving holes in
656
- letters. Extrude that section or combine it with other sections and solids. Use `layout.metrics`
657
- and its visible `bounds` to size a backing plate or reject text without visible outlines.
658
-
659
- Check a positioned label with [`bounds.containsBounds()`](../reference/geometry/bounds2.md),
660
- using [`bounds2({ size })`](../reference/geometry/bounds2.md) for the available rectangle.
661
- Horizontal `align: "center"` centers advance width; visible ink can remain asymmetric.
662
- To resize the ink uniformly and center it inside a target, use
663
- [`fitTextLayout`](../reference/geometry/fitTextLayout.md) before `textSection`. It transforms
664
- the retained vector paths before sampling, keeping curve tolerance in final millimetres.
665
- `maxScale: 1` permits shrinking without enlargement. Minimum readable letter height and
666
- parameter-specific error messages remain model decisions.
667
-
668
-
669
-
670
- ```ts
671
- import {
672
- bounds2,
673
- fitTextLayout,
674
- type FittedTextLayout,
675
- type VectorTextLayout,
676
- } from "@metamesh/modeling/geometry";
677
-
678
- export function labelFits(layout: VectorTextLayout): boolean {
679
- const ink = layout.metrics.bounds;
680
- return ink !== null && bounds2({ size: [40, 12] }).containsBounds(ink);
681
- }
682
-
683
- export function fitLabel(layout: VectorTextLayout): FittedTextLayout {
684
- // Fit visible ink while preserving proportions and preventing enlargement.
685
- return fitTextLayout(layout, bounds2({ size: [40, 12] }), { maxScale: 1 });
686
- }
687
- ```
688
-
689
-
690
-
691
- | Setting | Meaning |
692
- | --------------- | ------------------------------------------------------------------------------ |
693
- | `font` | The complete Font control value, including the exact face revision and weight |
694
- | `fontSize` | Em size in millimetres; visible capital height depends on the font |
695
- | `letterSpacing` | Extra millimetres between shaped glyph clusters |
696
- | `align` | Left, center, or right alignment using the text's advance |
697
- | `verticalAlign` | First-line baseline by default, or top, center, or bottom using visible bounds |
698
- | `lineHeight` | Baseline-spacing multiplier; omitted uses the font's natural line spacing |
699
-
700
- For a circular label, add a [`baseline`](../reference/text/VectorTextArcBaseline.md) with
701
- `kind: "arc"` and a positive `radius` in millimetres to the layout options. The baseline is centered
702
- at the XY origin; `centerAngle` chooses its alignment datum and `direction` chooses the
703
- reading direction. Each shaped glyph group rotates without bending. Circular text requires one
704
- line and baseline vertical alignment; its default horizontal alignment is centered. Arbitrary
705
- path text and automatic wrapping are outside this API.
706
-
707
- Text uses positive Y upward and supports line breaks, with at most 512 UTF-16 units and 16 lines.
708
- Empty or whitespace-only text can be measured but cannot create a section. Return a parameter error
709
- for that expected input; a missing glyph also requires different wording or a font that supports it.
710
- See [`TextSectionOptions`](../reference/model/TextSectionOptions.md) for exact options.
711
-
712
- Studio loads declared fonts before generation. Export uses the captured visible mesh. Saving a Project
713
- preserves the exact selection, including its revision, without embedding font bytes. Fonts beyond
714
- the bundled starters can require internet; ordinary browser caching does not guarantee them offline.
715
- If loading fails, Studio preserves the selection and last valid model so you can retry or choose a
716
- replacement. Studio does not support custom font uploads.
717
-
718
- ## Solid inspection
719
-
720
- Use `inspectSolid()` during generation to check bounds, volume, and component count:
721
-
722
-
723
-
724
- ```ts
725
- import { box, inspectSolid } from "@metamesh/modeling";
726
- import { generate } from "@metamesh/project";
727
-
728
- export default generate(({ part }) => {
729
- const result = box({ size: [40, 30, 5] });
730
- const measurements = inspectSolid(result);
731
-
732
- if (measurements.min[2] < -2.5 || measurements.componentCount !== 1) {
733
- throw new Error("Unexpected placement or disconnected result.");
734
- }
735
-
736
- return [part("model", result)];
737
- });
738
- ```
739
-
740
-
741
-
742
- Use [`layoutRow`](../reference/geometry/layoutRow.md) to arrange pieces along +X with an explicit
743
- gap and ground their minimum Y/Z at zero. Pass bounds after any intended rotation; the returned
744
- translations belong in `part` placement options so geometry remains reusable.
745
-
746
-
747
-
748
- ```ts
749
- import { box, generate, inspectSolid } from "@metamesh/modeling";
750
- import { layoutRow } from "@metamesh/modeling/geometry";
751
-
752
- export const rowModel = generate<Record<never, never>>(({ part }) => {
753
- const pieces = [box({ size: [20, 10, 6] }), box({ size: [12, 16, 8] })];
754
- const positions = layoutRow(pieces.map(inspectSolid), { gap: 4 });
755
- return pieces.map((geometry, index) =>
756
- part(`piece-${index}`, { geometry, position: positions[index]! })
757
- );
758
- });
759
- ```
760
-
761
-
762
-
763
- Inspection copies supported native facts. Manufacturing finalization checks finite, closed,
764
- oriented and reconstructable output before it becomes the preview or export snapshot. These
765
- checks do not certify manufacturability. Keep minimum walls, overhangs, fits, and parameter
766
- messages in your model's validation.
767
-
768
- After adapting a recipe, check its default, the largest and smallest supported dimensions, and
769
- every optional feature. Inspect the current result in Studio before exporting it. Continue with
770
- the [source and result contract](generation.md), or use the
771
- [Modeling API reference](../reference/model.md) for exact signatures and options.
3
+ Choose a worked modeling technique for profiles, sweeps, placement, joins, SVG, text, or inspection.
4
+
5
+ Choose the result you want to make, then open its worked guide. Illustrated examples pair a
6
+ rendered model with the source executed by the optional interactive preview.
7
+
8
+ Run the examples in a [Studio code Project](https://metamesh.studio/docs/develop/code-projects), where Studio supplies
9
+ controls and prepared services. For local execution, follow the
10
+ [standalone workflow](standalone-model.md) and use its host entry point.
11
+
12
+ ## Choose a technique
13
+
14
+ | You want to | Start with |
15
+ | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
16
+ | Choose between filled shapes, boundary points, and matching profiles | [Geometry values and representations](geometry-values.md) |
17
+ | Make a plate, gasket, cup, or treated housing | [Profiles, primitives, extrusion, and revolution](profiles-and-extrusion.md) |
18
+ | Route a tube, connect cross sections, or build a relief | [Sweeps, lofts, and heightfields](sweeps-and-lofts.md) |
19
+ | Place repeated features or align mating parts | [Transforms, patterns, and anchors](transforms-and-placement.md) |
20
+ | Blend or bevel a mounting feature into a base | [Solid joins](solid-joins.md) |
21
+ | Turn artwork or lettering into material | [SVG and exact-font text](svg-and-text.md) |
22
+ | Choose curve detail and check dimensions or topology | [Resolution and inspection](resolution-and-inspection.md) |
23
+ | Make a threaded rod and matching nut | [Printable threads](https://metamesh.studio/docs/develop/printable-threads) |
24
+ | Coordinate a pinion, wheel, or rack | [Gear geometry](https://metamesh.studio/docs/develop/gear-geometry) |
25
+
26
+ ## Adapt and check
27
+
28
+ All dimensions are millimetres, angles are degrees, and +Z is up. Begin with ordinary synchronous
29
+ generation, then add [memoization](generation.md#reuse-unchanged-work) when
30
+ expensive work can stay unchanged across parameter edits.
31
+
32
+ Connect the source to [controls and validation](https://metamesh.studio/docs/develop/parameters-and-validation). Check
33
+ the default, supported extremes, and optional features; inspect the latest result before
34
+ [exporting it](https://metamesh.studio/docs/use/export-3mf). For manufacturing fit, verify a representative part with
35
+ the material and process you intend to use.