forgecad 0.10.4 → 0.10.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/{AdminPage-B3L3W1Uo.js → AdminPage-raksfnNA.js} +1 -1
- package/dist/assets/{BenchmarkPage-DXKVXMrJ.js → BenchmarkPage-DP3RxhPs.js} +2 -2
- package/dist/assets/{BlogPage-B7BWxOCg.js → BlogPage-D7Dos-vl.js} +1 -1
- package/dist/assets/{DocsPage-BPGGwht1.js → DocsPage-DO1kvBns.js} +7 -1
- package/dist/assets/{EditorApp-BWUGCdD5.js → EditorApp-DQJmcmRT.js} +9 -8
- package/dist/assets/{EmbedViewer-DygByZS2.js → EmbedViewer-DFDUhOma.js} +2 -2
- package/dist/assets/{LandingPageProofDriven-BoVE7JGY.js → LandingPageProofDriven-DbE_tp8-.js} +2 -2
- package/dist/assets/{LegalPage-Din8wv8d.js → LegalPage-CominSso.js} +2 -2
- package/dist/assets/{PricingPage-C2PMzmDc.js → PricingPage-CcVIN9yj.js} +2 -2
- package/dist/assets/{SettingsPage-BlJDCRe8.js → SettingsPage-DLWcP289.js} +1 -1
- package/dist/assets/{app-BsRYSfxY.js → app-xW3hOdq9.js} +1135 -320
- package/dist/assets/{backendInit-6C0DLgH0.js → backendInit-mDHk97u7.js} +6630 -2493
- package/dist/assets/cli/{render-XXol_ET7.js → render--SIU27W_.js} +1263 -112
- package/dist/assets/{constructionHistoryWorker-cTHWRJEi.js → constructionHistoryWorker-uEe_Q7Kg.js} +1861 -610
- package/dist/assets/{evalWorker-BssDYW9u.js → evalWorker-BqyDHDcI.js} +6254 -2177
- package/dist/assets/{forgecad_geometry-CZ_IfuvA.js → forgecad_geometry-D8rWX7nQ.js} +1 -1
- package/dist/assets/{forgecad_geometry_bg-C3rQHfwg.wasm → forgecad_geometry_bg-ObqfqjJT.wasm} +0 -0
- package/dist/assets/{inspectWorker-ymhBV4Ll.js → inspectWorker-UXMxlcR8.js} +2738 -742
- package/dist/assets/{jointPose-B0blBj9A.js → jointPose-bYMlwU3v.js} +1 -1
- package/dist/assets/{landing-proof-driven-Cpf-MIbI.css → landing-proof-driven-_u4v_xQb.css} +2 -2
- package/dist/assets/{manifold-B_7QXpGB.js → manifold-BR7UYI4P.js} +1 -1
- package/dist/assets/{manifold-CYlIm-M6.js → manifold-CyOV5B9S.js} +2 -2
- package/dist/assets/{manifold-CNShmpEJ.js → manifold-D4d5NQst.js} +1 -1
- package/dist/assets/{reportWorker-Cb5eyM7D.js → reportWorker-DsaICZsn.js} +6010 -2032
- package/dist/cli/render.html +1 -1
- package/dist/docs/index.html +2 -2
- package/dist/docs-raw/CLI.md +4 -2
- package/dist/docs-raw/generated/assembly.md +76 -3
- package/dist/docs-raw/generated/concepts.md +31 -4
- package/dist/docs-raw/generated/core.md +159 -21
- package/dist/docs-raw/generated/curves.md +344 -6
- package/dist/docs-raw/generated/runtime-names.md +12 -12
- package/dist/docs-raw/generated/sketch.md +16 -3
- package/dist/docs-raw/guides/inspection-bundles.md +4 -2
- package/dist/docs-raw/guides/structural-fea.md +224 -0
- package/dist/docs-raw/skills/forgecad.md +1 -0
- package/dist/index.html +1 -1
- package/dist/sitemap.xml +15 -15
- package/dist-cli/{check-compiler-4RPB6SB5.js → check-compiler-7YAHVXYM.js} +1 -1
- package/dist-cli/{check-query-propagation-KN3DFQTX.js → check-query-propagation-ZRR6IOJW.js} +1 -1
- package/dist-cli/{chunk-UHBRMYA6.js → chunk-VNM67DIV.js} +6489 -2333
- package/dist-cli/forgecad.js +5258 -717
- package/dist-cli/forgecad_geometry_bg.wasm +0 -0
- package/dist-skill/CONTEXT.md +827 -45
- package/dist-skill/SKILL.md +1 -0
- package/dist-skill/docs/CLI.md +4 -2
- package/dist-skill/docs/generated/assembly.md +73 -3
- package/dist-skill/docs/generated/core.md +159 -21
- package/dist-skill/docs/generated/curves.md +343 -6
- package/dist-skill/docs/generated/runtime-names.md +12 -12
- package/dist-skill/docs/generated/sketch.md +16 -3
- package/dist-skill/docs/guides/inspection-bundles.md +4 -2
- package/dist-skill/docs/guides/structural-fea.md +224 -0
- package/dist-skill/website/skills/forgecad.md +1 -0
- package/examples/analysis/structural-stress-fea.forge.js +19 -0
- package/examples/api/blend-full-round.forge.js +37 -0
- package/examples/api/blend-variable-radius.forge.js +51 -0
- package/examples/api/curve-project-and-intersect.forge.js +59 -0
- package/examples/api/extrude-up-to-face.forge.js +47 -0
- package/examples/api/spoon-full-tang-handle.forge.js +148 -0
- package/examples/api/surface-boundarynet-dished-bowl.forge.js +63 -0
- package/examples/api/surface-fill-interior-constraints.forge.js +59 -0
- package/package.json +4 -1
- /package/dist/assets/{landing-proof-driven-BxZZh5r5.js → landing-proof-driven-DNPRKL_p.js} +0 -0
package/dist/docs-raw/CLI.md
CHANGED
|
@@ -136,7 +136,8 @@ Inspect a model by asking for one explicit kind of evidence.
|
|
|
136
136
|
- `inspect surface zebra|roughness` — surface continuity and roughness evidence
|
|
137
137
|
- `inspect physical components|floating|gaps` — physical component graph evidence
|
|
138
138
|
- `inspect fit interference` — positive-volume overlap evidence
|
|
139
|
-
- `inspect manufacture thickness` — wall-thickness evidence
|
|
139
|
+
- `inspect manufacture thickness|through-thickness` — wall-thickness and minimum solid span evidence
|
|
140
|
+
- `inspect structural stress` — solver-produced structural stress scalar-field evidence
|
|
140
141
|
- `inspect compare overlay` — candidate-vs-reference visual mismatch evidence
|
|
141
142
|
- `inspect sections at|stack|sample` — exact section evidence for precise cuts, dense scans, or sparse samples
|
|
142
143
|
- `inspect mechanical-integrity` — model-focused integrity audit for generated assemblies
|
|
@@ -292,6 +293,7 @@ Export to every format you need.
|
|
|
292
293
|
| `export svg` | SVG | 2D vector output from sketches |
|
|
293
294
|
| `export sketch-pdf` **\[Production\]** | PDF | Sketch with dimensions and constraints |
|
|
294
295
|
| `export step` **\[Production\]** | STEP | CAD interchange (exact geometry) |
|
|
296
|
+
| `export fea` **\[Production\]** | FEA package | Exact STEP plus authored structural load-case metadata |
|
|
295
297
|
| `export brep` **\[Production\]** | BREP | Boundary representation |
|
|
296
298
|
| `export 3mf` | 3MF | 3D printing (color, multi-part) |
|
|
297
299
|
| `export stl` | STL | 3D printing |
|
|
@@ -543,7 +545,7 @@ The CLI is free for personal non-commercial use. Pro covers human-operated comme
|
|
|
543
545
|
|
|
544
546
|
| Free | Production outputs | Pro | Enterprise |
|
|
545
547
|
|------|--------------------|-----|------------|
|
|
546
|
-
| `run`, `dev`, `studio`, `render 3d`, `export stl`, `export 3mf`, `export svg`, `compare 3d`, `check print`, `inspect fit interference`, `inspect mechanical-integrity` for personal non-commercial use | `cut-list`, `export sketch-pdf`, `export step`, `export brep`, `export gcode`, `export implicit`, `export sdf`, `export mjcf`, `export urdf`, `export usd`, `export report`, `export cutting-layout` are free to run for personal non-commercial use; Pro covers human-operated commercial CAD work | `render hq`, `capture gif`, `capture mp4` plus commercial coverage for client/customer work | Backend, hosted, embedded, or application workflows that call ForgeCAD automatically |
|
|
548
|
+
| `run`, `dev`, `studio`, `render 3d`, `export stl`, `export 3mf`, `export svg`, `compare 3d`, `check print`, `inspect fit interference`, `inspect mechanical-integrity` for personal non-commercial use | `cut-list`, `export sketch-pdf`, `export step`, `export fea`, `export brep`, `export gcode`, `export implicit`, `export sdf`, `export mjcf`, `export urdf`, `export usd`, `export report`, `export cutting-layout` are free to run for personal non-commercial use; Pro covers human-operated commercial CAD work | `render hq`, `capture gif`, `capture mp4` plus commercial coverage for client/customer work | Backend, hosted, embedded, or application workflows that call ForgeCAD automatically |
|
|
547
549
|
|
|
548
550
|
```bash
|
|
549
551
|
forgecad license # Check local license status
|
|
@@ -27,12 +27,14 @@ Assembly-owned links, constraints, connectors, solved poses, and source-level si
|
|
|
27
27
|
|
|
28
28
|
#### `Sim.body(options: SimBodyOptions): SimBodyDef` — Describe one assembly part as a physical body with mass/density, material, collider intent, and optional contact surfaces.
|
|
29
29
|
|
|
30
|
-
**`SimBodyOptions`**: `massKg?: number`, `densityKgM3?: number`, `material?: SimMaterialDef`, `collider?: SimColliderDef`, `contacts?: Record<string, SimContactDef
|
|
30
|
+
**`SimBodyOptions`**: `massKg?: number`, `densityKgM3?: number`, `material?: SimMaterialDef`, `collider?: SimColliderDef`, `contacts?: Record<string, SimContactDef>`, `motion?: SimMotionDef`
|
|
31
31
|
|
|
32
|
-
`SimColliderDef`: `{ kind: "collider", mode: SimColliderMode, reason?: string }`
|
|
32
|
+
`SimColliderDef`: `{ kind: "collider", mode: SimColliderMode, reason?: string, sdfResolution?: number }`
|
|
33
33
|
|
|
34
34
|
`SimContactDef`: `{ kind: "wheelSurface" | "gripperSurface", connectorName: string }`
|
|
35
35
|
|
|
36
|
+
`SimMotionDef`: `{ kind: "motion", mode: SimMotionMode }`
|
|
37
|
+
|
|
36
38
|
|
|
37
39
|
`SimBodyDef`: `{ kind: "body" }`
|
|
38
40
|
|
|
@@ -41,8 +43,15 @@ Assembly-owned links, constraints, connectors, solved poses, and source-level si
|
|
|
41
43
|
- `Sim.collider.convexHull(): SimColliderDef` — Use a generated collision mesh for the part. This is the default fast rigid-body collider for irregular parts.
|
|
42
44
|
- `Sim.collider.boundingBox(): SimColliderDef` — Use the part bounding box as the collision geometry. This is fastest and works well for chassis and simple blocks.
|
|
43
45
|
- `Sim.collider.visualMesh(): SimColliderDef` — Use the visual mesh as collision geometry. This is exact but usually slower in physics engines.
|
|
46
|
+
- `Sim.collider.sdfMesh: (options?: { resolution?: number` — Use an SDF mesh collider for complex concave contact geometry. Exporters warn when their target cannot encode it.
|
|
44
47
|
- `Sim.collider.none(reason: string): SimColliderDef` — Disable collision for a part with an explicit reason, such as a sensor-only or decorative object.
|
|
45
48
|
|
|
49
|
+
#### `Sim.motion` — Body motion-state intent for simulation export. Dynamic is the default when omitted.
|
|
50
|
+
|
|
51
|
+
- `Sim.motion.dynamic(): SimMotionDef` — Simulate this body as a normal dynamic rigid body with mass and inertia.
|
|
52
|
+
- `Sim.motion.kinematic(): SimMotionDef` — Simulate this body as kinematic: moved by the simulator/user, but not force-integrated.
|
|
53
|
+
- `Sim.motion.static(): SimMotionDef` — Keep this body fixed in the world as a static collision/environment body.
|
|
54
|
+
|
|
46
55
|
#### `Sim.drive` — Joint-drive intent constructors for passive or powered assembly joints.
|
|
47
56
|
|
|
48
57
|
- `Sim.drive.passive(options?: SimPassiveDriveOptions): SimDriveDef` — Mark a joint as passive while preserving damping and friction metadata for simulation export.
|
|
@@ -75,6 +84,60 @@ Assembly-owned links, constraints, connectors, solved poses, and source-level si
|
|
|
75
84
|
|
|
76
85
|
`SimDiffDriveControllerDef`: `{ kind: "diffDrive" }`
|
|
77
86
|
|
|
87
|
+
#### `Fea.material(name: string, options: FeaMaterialOptions): FeaMaterialDef` — Create a named linear-elastic structural material for static stress studies.
|
|
88
|
+
|
|
89
|
+
#### `Fea.body(options: FeaBodyOptions): FeaBodyDef` — Mark one assembly part as a structural body with a `Fea.material(...)` value.
|
|
90
|
+
|
|
91
|
+
#### `Fea.region` — Stable explicit region references for solver package manifests.
|
|
92
|
+
|
|
93
|
+
- `Fea.region.face(partName: string, faceName: string): FeaPartFaceRegionRef` — Reference a named face on a named assembly part without relying on object identity.
|
|
94
|
+
- `Fea.region.plane(partName: string, faceName: string, options: FeaPlaneRegionOptions): FeaPartPlaneRegionRef` — Reference a planar face by a point on the face and its outward normal in part-local coordinates.
|
|
95
|
+
|
|
96
|
+
`FeaPartFaceRegionRef`: `{ kind: "fea-region-face", partName: string, faceName: string }`
|
|
97
|
+
|
|
98
|
+
`FeaPlaneRegionOptions`: `{ center: Vec3, normal: Vec3 }`
|
|
99
|
+
|
|
100
|
+
`FeaPartPlaneRegionRef`: `{ kind: "fea-region-plane", partName: string, faceName: string, center: Vec3, normal: Vec3 }`
|
|
101
|
+
|
|
102
|
+
#### `Fea.fix` — Fixture constructors over authored face/region references.
|
|
103
|
+
|
|
104
|
+
- `Fea.fix.fixed(region: FeaRegionRef): FeaFixedFixtureDef` — Fully fix all translational degrees of freedom on a face/region.
|
|
105
|
+
|
|
106
|
+
`FeaFixedFixtureDef`: `{ kind: "fixed", region: FeaRegionRef }`
|
|
107
|
+
|
|
108
|
+
#### `Fea.load` — Load constructors over authored face/region references.
|
|
109
|
+
|
|
110
|
+
- `Fea.load.force(region: FeaRegionRef, options: FeaForceLoadOptions): FeaForceLoadDef` — Apply a force with magnitude in newtons along the given direction vector.
|
|
111
|
+
|
|
112
|
+
`FeaForceLoadOptions`: `{ newtons: number, direction: Vec3 }`
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
`FeaForceLoadDef`: `{ kind: "force", region: FeaRegionRef }`
|
|
116
|
+
|
|
117
|
+
#### `Fea.target` — Study target constructors used by feedback and pass/fail gates.
|
|
118
|
+
|
|
119
|
+
- `Fea.target.minSafetyFactor(value: number): FeaMinSafetyFactorTargetDef` — Require the solved minimum safety factor to be at least `value`.
|
|
120
|
+
|
|
121
|
+
`FeaMinSafetyFactorTargetDef`: `{ kind: "minSafetyFactor", value: number }`
|
|
122
|
+
|
|
123
|
+
#### `Fea.mesh` — Volume mesh intent. V1 structural stress uses second-order tetrahedra only.
|
|
124
|
+
|
|
125
|
+
- `Fea.mesh.quadraticTets(options: FeaQuadraticTetMeshOptions): FeaQuadraticTetMeshDef` — Request quadratic tetrahedral C3D10 elements with a maximum size in mm.
|
|
126
|
+
|
|
127
|
+
`FeaQuadraticTetMeshOptions`: `{ maxSizeMm: number, minQuality?: number }`
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
`FeaQuadraticTetMeshDef`: `{ kind: "quadraticTets", order: 2, element: "C3D10" }`
|
|
131
|
+
|
|
132
|
+
#### `Fea.study` — Study constructors.
|
|
133
|
+
|
|
134
|
+
- `Fea.study.staticStress(name: string, options: FeaStaticStressStudyOptions): FeaStaticStressStudyDef` — Create a linear static structural stress study.
|
|
135
|
+
|
|
136
|
+
`FeaStaticStressStudyOptions`: `{ fixtures: FeaFixtureDef[], loads: FeaLoadDef[], target?: FeaTargetDef, mesh: FeaMeshDef }`
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
`FeaStaticStressStudyDef`: `{ kind: "staticStress", name: string }`
|
|
140
|
+
|
|
78
141
|
#### `assembly(name?: string): Assembly` — Create an assembly container with named parts, connectors, and kinematic links.
|
|
79
142
|
|
|
80
143
|
**Use this from iteration 1 for any model with moving parts.** Do not build one static pose and retrofit motion later.
|
|
@@ -208,7 +271,7 @@ const housing = group(
|
|
|
208
271
|
assembly.addPart("Base Assembly", housing);
|
|
209
272
|
```
|
|
210
273
|
|
|
211
|
-
**`PartOptions`**: `transform?: TransformInput`, `metadata?: PartMetadata`, `sim?: SimBodyDef`, `mate?: AssemblyPartMateInput | AssemblyPartMateInput[]`, `bindToFrame?: string`
|
|
274
|
+
**`PartOptions`**: `transform?: TransformInput`, `metadata?: PartMetadata`, `sim?: SimBodyDef`, `fea?: FeaBodyDef`, `mate?: AssemblyPartMateInput | AssemblyPartMateInput[]`, `bindToFrame?: string`
|
|
212
275
|
|
|
213
276
|
**`PartMetadata`**
|
|
214
277
|
|
|
@@ -218,6 +281,12 @@ assembly.addPart("Base Assembly", housing);
|
|
|
218
281
|
|
|
219
282
|
Also: `material?: string`, `process?: string`, `tolerance?: string`, `qty?: number`, `notes?: string`, `densityKgM3?: number`, `massKg?: number`.
|
|
220
283
|
|
|
284
|
+
`FeaBodyDef`: `{ kind: "fea-body", material: FeaMaterialDef }`
|
|
285
|
+
|
|
286
|
+
`FeaMaterialOptions`: `{ densityKgM3: number, youngsModulusMPa: number, poissonRatio: number, yieldStrengthMPa: number }`
|
|
287
|
+
|
|
288
|
+
`FeaMaterialDef`: `{ kind: "fea-material", name: string }`
|
|
289
|
+
|
|
221
290
|
**`AssemblyPartMateInput`**
|
|
222
291
|
- `connector: string` — Name of a connector declared on the part (via `withConnectors()`).
|
|
223
292
|
- `toLink: string` — Name of the link this connector's origin is pinned to.
|
|
@@ -377,6 +446,10 @@ Use this after adding physical parts and joints. Robot-body profiles require `ro
|
|
|
377
446
|
|
|
378
447
|
`SimAssemblySimulationOptions`: `{ profile: SimProfileDef, rootPart?: string, controllers?: SimControllerDef[] }`
|
|
379
448
|
|
|
449
|
+
#### `withFeaStudy(study: FeaStudyDef): Assembly` — Attach a structural FEA study to this assembly.
|
|
450
|
+
|
|
451
|
+
The study is authored with `Fea.study.staticStress(...)` and consumed by `forgecad export fea`. This records load-case intent only; ForgeCAD refuses to invent fixtures, loads, mesh order, or region tags during export.
|
|
452
|
+
|
|
380
453
|
#### `edgeBetweenFrames(a: string, b: string, options?: AssemblyFrameEdgeOptions): Assembly` — Add a visual skeleton edge between two rig frame origins.
|
|
381
454
|
|
|
382
455
|
Frame edges follow the solved frame poses produced by `fixedJoint()`, `revoluteJoint()`, and `prismaticJoint()`. They do not add constraints, degrees of freedom, parts, or geometry; use them to make a frame-only rig readable in the Motion/rig inspection overlay.
|
|
@@ -7,13 +7,13 @@ Every public API function belongs to one of 16 fundamental concepts. This is an
|
|
|
7
7
|
- **[C1: Primitive Construction](#c1-primitive-construction)** — Create geometry from parameters — no input geometry required. *(66 functions)*
|
|
8
8
|
- **[C2: Boolean Combination](#c2-boolean-combination)** — Combine same-dimension geometry using CSG set operations. *(6 functions)*
|
|
9
9
|
- **[C3: Rigid Transform](#c3-rigid-transform)** — Reposition or reorient geometry without changing its shape. *(0 functions)*
|
|
10
|
-
- **[C4: Dimensional Promotion](#c4-dimensional-promotion)** — Convert a 2D profile into a 3D solid (extrude, revolve, loft, sweep). *(
|
|
10
|
+
- **[C4: Dimensional Promotion](#c4-dimensional-promotion)** — Convert a 2D profile into a 3D solid (extrude, revolve, loft, sweep). *(64 functions)*
|
|
11
11
|
- **[C5: Topology Query](#c5-topology-query)** — Select or inspect named faces and edges on a shape. *(3 functions)*
|
|
12
12
|
- **[C6: Edge Feature](#c6-edge-feature)** — Modify edges of a solid — fillets, chamfers, draft, offset. *(4 functions)*
|
|
13
13
|
- **[C7: Pattern Replication](#c7-pattern-replication)** — Duplicate geometry in regular arrangements (linear, circular, mirror). *(6 functions)*
|
|
14
14
|
- **[C8: Constraint Solving](#c8-constraint-solving)** — Define geometry by relationships and let a solver find positions. *(1 functions)*
|
|
15
15
|
- **[C9: Spatial Placement](#c9-spatial-placement)** — Position geometry relative to other geometry using semantic anchors. *(6 functions)*
|
|
16
|
-
- **[C10: Assembly & Kinematics](#c10-assembly-kinematics)** — Compose parts with joints for kinematic simulation. *(
|
|
16
|
+
- **[C10: Assembly & Kinematics](#c10-assembly-kinematics)** — Compose parts with joints for kinematic simulation. *(28 functions)*
|
|
17
17
|
- **[C11: Parameterization & UI](#c11-parameterization-ui)** — Declare user-facing controls that drive model geometry. *(6 functions)*
|
|
18
18
|
- **[C12: Dimensional Demotion](#c12-dimensional-demotion)** — Extract 2D geometry from a 3D solid (section, projection). *(3 functions)*
|
|
19
19
|
- **[C13: Export & Output](#c13-export-output)** — Convert geometry to external formats (STL, 3MF, SVG, DXF, G-code, PDF). *(14 functions)*
|
|
@@ -123,12 +123,21 @@ Convert a 2D profile into a 3D solid (extrude, revolve, loft, sweep).
|
|
|
123
123
|
|
|
124
124
|
- `Curve.Blend(start, end)` — Create an exact G1 blend curve between two directed endpoints. → [curves](/docs/curves#curve)
|
|
125
125
|
- `Curve.BlendG2(start, end)` — Create an exact G2 blend curve between two directed endpoints. → [curves](/docs/curves#curve)
|
|
126
|
+
- `Curve.Bridge(options)` — Bridge two existing curve endpoints with inferred tangent or curvature continuity. → [curves](/docs/curves#curve)
|
|
126
127
|
- `Curve.Arc(options)` — Create an exact circular 3D arc from start, end, and start tangent. → [curves](/docs/curves#curve)
|
|
127
128
|
- `Curve.Line(start, end)` — Create an exact straight 3D NURBS line segment. → [curves](/docs/curves#curve)
|
|
128
129
|
- `Curve.Nurbs(points, options?)` — Create an exact NURBS 3D curve from control points, weights, knots, and degree. → [curves](/docs/curves#curve)
|
|
129
130
|
- `Curve.Fit(points, options?)` — Fit a non-rational NURBS curve that interpolates every input point. → [curves](/docs/curves#curve)
|
|
131
|
+
- `Curve.ProjectOnSurface(curve, sheet, options?)` — Project a curve onto a `Sheet` along the surface normal and return the exact NURBS foot curve. → [curves](/docs/curves#curve)
|
|
132
|
+
- `Curve.Intersect(sheetA, sheetB, options?)` — Intersect two `Sheet` surfaces and return the exact NURBS intersection branches. → [curves](/docs/curves#curve)
|
|
130
133
|
- `Curve.Trim(curve, start, end)` — Extract an exact curve segment from normalized parameter `start` to `end`. → [curves](/docs/curves#curve)
|
|
131
134
|
- `Curve.Reverse(curve)` — Reverse an exact curve without changing its geometry. → [curves](/docs/curves#curve)
|
|
135
|
+
- `Curve.closestParameter(curve, point, options?)` — Find the normalized parameter on an exact curve closest to a world point. → [curves](/docs/curves#curve)
|
|
136
|
+
- `Curve.join(curves, options?)` — Join touching curve segments into one sampled sweep path. → [curves](/docs/curves#curve)
|
|
137
|
+
- `Curve.placeOnXY(path, z?, options?)` — Place a 2D path onto the XY plane at world Z. → [curves](/docs/curves#curve)
|
|
138
|
+
- `Curve.placeOnXZ(path, y?, options?)` — Place a 2D path onto the XZ plane at world Y. → [curves](/docs/curves#curve)
|
|
139
|
+
- `Curve.placeOnYZ(path, x?, options?)` — Place a 2D path onto the YZ plane at world X. → [curves](/docs/curves#curve)
|
|
140
|
+
- `Curve.placeOnPlane(path, options)` — Place a 2D path onto an arbitrary world plane. → [curves](/docs/curves#curve)
|
|
132
141
|
- `Curve.Route` — Build analytic 3D line/arc routes for sweeps. → [curves](/docs/curves#curve)
|
|
133
142
|
- `Curve.Helix(options)` — Build helical paths and swept coils. → [curves](/docs/curves#curve)
|
|
134
143
|
- `Loft.station(profile, position)` — Create a loft station from a 2D profile and an axis position. → [curves](/docs/curves#curves-surfacing)
|
|
@@ -148,19 +157,23 @@ Convert a 2D profile into a 3D solid (extrude, revolve, loft, sweep).
|
|
|
148
157
|
- `Analysis.CurvatureComb(input, options?)` → [curves](/docs/curves#analysis)
|
|
149
158
|
- `Analysis.SurfaceHealth(shape, options?)` → [curves](/docs/curves#analysis)
|
|
150
159
|
- `Analysis.BRepValidity(shape, options?)` — Validate B-rep/shell/solid structure and return closedness, manifoldness, orientation, and issue diagnostics. → [curves](/docs/curves#analysis)
|
|
151
|
-
- `Blend.Edge(options)` → [curves](/docs/curves#blend)
|
|
160
|
+
- `Blend.Edge(options)` — Fillet one or more edges with constant or variable radius. → [curves](/docs/curves#blend)
|
|
152
161
|
- `Blend.Surface(options)` → [curves](/docs/curves#blend)
|
|
153
162
|
- `Blend.Bridge(edgeA, edgeB)` — Build a transition strip between two `Surface.Net` sheet edges. → [curves](/docs/curves#blend)
|
|
163
|
+
- `Blend.Face(options)` — Fillet every edge SHARED by a pair of faces — a "face fillet". → [curves](/docs/curves#blend)
|
|
164
|
+
- `Blend.FullRound(options)` — Full round — roll a blend over a narrow center face so it is consumed and its two neighbouring faces meet tangentially (classic 3-face full round). → [curves](/docs/curves#blend)
|
|
154
165
|
- `Surface.Plane(options)` — Create a finite analytic plane sheet that can be trimmed, sewn, thickened, or used as a low-level face. → [curves](/docs/curves#surface)
|
|
155
166
|
- `Surface.Cylinder(options)` — Create a finite analytic cylindrical sheet, optionally bounded by start/end angles. → [curves](/docs/curves#surface)
|
|
156
167
|
- `Surface.Cone(options)` — Create a finite analytic conical or frustum sheet, optionally bounded by start/end angles. → [curves](/docs/curves#surface)
|
|
157
168
|
- `Surface.Sphere(options)` — Create a finite analytic spherical sheet bounded by longitude and latitude ranges. → [curves](/docs/curves#surface)
|
|
158
169
|
- `Surface.Torus(options)` — Create a finite analytic torus sheet bounded by major and tube angle ranges. → [curves](/docs/curves#surface)
|
|
170
|
+
- `Surface.Sweep(profile, spine, options?)` — Sweep an open 2D profile path along a 3D spine to create an open surface sheet. → [curves](/docs/curves#surface)
|
|
171
|
+
- `Surface.Loft(input)` — Loft an open surface sheet through ordered profile stations. → [curves](/docs/curves#surface)
|
|
159
172
|
- `Surface.Nurbs(controlGrid, options?)` — Create an exact NURBS surface from a grid of control points. → [curves](/docs/curves#surface)
|
|
160
173
|
- `Surface.Ruled(curveA, curveB, options?)` → [curves](/docs/curves#surface)
|
|
161
174
|
- `Surface.Patch(curves, options?)` — Create a smooth open surface sheet from 4 boundary curves (Coons patch). → [curves](/docs/curves#surface)
|
|
162
175
|
- `Surface.Boundary(input)` → [curves](/docs/curves#surface)
|
|
163
|
-
- `Surface.Fill(input)` → [curves](/docs/curves#surface)
|
|
176
|
+
- `Surface.Fill(input)` — Create an n-sided open surface sheet from 3 or more boundary curves (energy-minimizing constrained fill). → [curves](/docs/curves#surface)
|
|
164
177
|
- `Surface.Sew(shapes, options?)` → [curves](/docs/curves#surface)
|
|
165
178
|
- `Surface.Solid(input, options?)` — Sew surface faces or consume an existing sewn shell and make a solid B-rep. → [curves](/docs/curves#surface)
|
|
166
179
|
- `Surface.Extend(shape, options)` → [curves](/docs/curves#surface)
|
|
@@ -168,6 +181,7 @@ Convert a 2D profile into a 3D solid (extrude, revolve, loft, sweep).
|
|
|
168
181
|
- `Surface.Split(shape, tool)` → [curves](/docs/curves#surface)
|
|
169
182
|
- `Surface.Match(shape, options)` → [curves](/docs/curves#surface)
|
|
170
183
|
- `Surface.Net()` — Begin a curve-network (Gordon) surface — the class-A keystone. → [curves](/docs/curves#surface)
|
|
184
|
+
- `Surface.BoundaryNet()` — Begin a **Boundary Surface** — the canonical class-A surfacing primitive (SolidWorks "Boundary Boss/Base", Onshape "Boundary surface", Rhino NetworkSrf). → [curves](/docs/curves#surface)
|
|
171
185
|
- `loft(profiles, heights, options?)` — Loft between multiple sketches along Z stations. → [curves](/docs/curves#loft)
|
|
172
186
|
- `sweep(profile, path, options?)` → [curves](/docs/curves#sweep)
|
|
173
187
|
- `variableSweep(spine, sections, options?)` — Sweep a variable cross-section along a 3D spine curve. → [curves](/docs/curves#variablesweep)
|
|
@@ -233,12 +247,25 @@ Position geometry relative to other geometry using semantic anchors.
|
|
|
233
247
|
|
|
234
248
|
Compose parts with joints for kinematic simulation.
|
|
235
249
|
|
|
250
|
+
- `Fea.material(name, options)` — Create a named linear-elastic structural material for static stress studies. → [assembly](/docs/assembly#assembly-joints)
|
|
251
|
+
- `Fea.body(options)` — Mark one assembly part as a structural body with a `Fea.material(...)` value. → [assembly](/docs/assembly#assembly-joints)
|
|
252
|
+
- `Fea.region.face(partName, faceName)` — Reference a named face on a named assembly part without relying on object identity. → [assembly](/docs/assembly#assembly-joints)
|
|
253
|
+
- `Fea.region.plane(partName, faceName, options)` — Reference a planar face by a point on the face and its outward normal in part-local coordinates. → [assembly](/docs/assembly#assembly-joints)
|
|
254
|
+
- `Fea.fix.fixed(region)` — Fully fix all translational degrees of freedom on a face/region. → [assembly](/docs/assembly#assembly-joints)
|
|
255
|
+
- `Fea.load.force(region, options)` — Apply a force with magnitude in newtons along the given direction vector. → [assembly](/docs/assembly#assembly-joints)
|
|
256
|
+
- `Fea.target.minSafetyFactor(value)` — Require the solved minimum safety factor to be at least `value`. → [assembly](/docs/assembly#assembly-joints)
|
|
257
|
+
- `Fea.mesh.quadraticTets(options)` — Request quadratic tetrahedral C3D10 elements with a maximum size in mm. → [assembly](/docs/assembly#assembly-joints)
|
|
258
|
+
- `Fea.study.staticStress(name, options)` — Create a linear static structural stress study. → [assembly](/docs/assembly#assembly-joints)
|
|
236
259
|
- `Sim.material(name, options?)` — Create a named physical material with density and contact coefficients for simulation export and checks. → [assembly](/docs/assembly#assembly-joints)
|
|
237
260
|
- `Sim.body(options)` — Describe one assembly part as a physical body with mass/density, material, collider intent, and optional contact surfaces. → [assembly](/docs/assembly#assembly-joints)
|
|
238
261
|
- `Sim.collider.convexHull()` — Use a generated collision mesh for the part. → [assembly](/docs/assembly#assembly-joints)
|
|
239
262
|
- `Sim.collider.boundingBox()` — Use the part bounding box as the collision geometry. → [assembly](/docs/assembly#assembly-joints)
|
|
240
263
|
- `Sim.collider.visualMesh()` — Use the visual mesh as collision geometry. → [assembly](/docs/assembly#assembly-joints)
|
|
264
|
+
- `Sim.collider.sdfMesh` — Use an SDF mesh collider for complex concave contact geometry. → [assembly](/docs/assembly#assembly-joints)
|
|
241
265
|
- `Sim.collider.none(reason)` — Disable collision for a part with an explicit reason, such as a sensor-only or decorative object. → [assembly](/docs/assembly#assembly-joints)
|
|
266
|
+
- `Sim.motion.dynamic()` — Simulate this body as a normal dynamic rigid body with mass and inertia. → [assembly](/docs/assembly#assembly-joints)
|
|
267
|
+
- `Sim.motion.kinematic()` — Simulate this body as kinematic: moved by the simulator/user, but not force-integrated. → [assembly](/docs/assembly#assembly-joints)
|
|
268
|
+
- `Sim.motion.static()` — Keep this body fixed in the world as a static collision/environment body. → [assembly](/docs/assembly#assembly-joints)
|
|
242
269
|
- `Sim.drive.passive(options?)` — Mark a joint as passive while preserving damping and friction metadata for simulation export. → [assembly](/docs/assembly#assembly-joints)
|
|
243
270
|
- `Sim.drive.velocity(options)` — Mark a revolute joint as velocity-driven with torque and speed limits. → [assembly](/docs/assembly#assembly-joints)
|
|
244
271
|
- `Sim.contact.wheelSurface(connectorName)` — Mark a connector as the wheel tread contact surface for offline checks and downstream simulation metadata. → [assembly](/docs/assembly#assembly-joints)
|
|
@@ -18,13 +18,12 @@ skill-order: 100
|
|
|
18
18
|
- [Grouping & Local Coordinates](#grouping-local-coordinates)
|
|
19
19
|
- [Section & Projection](#section-projection)
|
|
20
20
|
- [Verification](#verification)
|
|
21
|
-
- [Shape](#shape) — Appearance, Face Topology, Edge Topology, Transforms, Booleans & Cutting, Features, Placement, Connectors, References, Measurement
|
|
21
|
+
- [Shape](#shape) — Freeform Construction, Appearance, Face Topology, Edge Topology, Transforms, Booleans & Cutting, Features, Placement, Connectors, References, Measurement
|
|
22
22
|
- [Transform](#transform)
|
|
23
23
|
- [ShapeGroup](#shapegroup) — Children, Transforms, Placement, Connectors, References
|
|
24
24
|
- [SurfacePattern](#surfacepattern)
|
|
25
25
|
- [Pattern2D](#pattern2d)
|
|
26
26
|
- [Pattern2DBuilder](#pattern2dbuilder)
|
|
27
|
-
- [Sheet](#sheet)
|
|
28
27
|
- [CurveNetBuilder](#curvenetbuilder)
|
|
29
28
|
- [MatchEdgeBuilder](#matchedgebuilder)
|
|
30
29
|
- [BridgeBuilder](#bridgebuilder)
|
|
@@ -705,6 +704,96 @@ Supports transforms (translate, rotate, scale, mirror, transform, rotateAround,
|
|
|
705
704
|
|----------|------|-------------|
|
|
706
705
|
| `materialProps` | `ShapeMaterialProps \| undefined` | — |
|
|
707
706
|
|
|
707
|
+
**Freeform Construction**
|
|
708
|
+
|
|
709
|
+
#### `slicePerpendicularToX(x: number, profile: Sketch, options?: FromSlicesAxisSliceOptions): FromSlicesSlice` — Create a slice descriptor perpendicular to the X axis.
|
|
710
|
+
|
|
711
|
+
The profile is drawn in the YZ plane. `options.center` is `[y, z]`, so authors can place changing section centers without manually translating sketches in ForgeCAD's internal plane axes.
|
|
712
|
+
|
|
713
|
+
```js
|
|
714
|
+
Shape.fromSlices([
|
|
715
|
+
Shape.slicePerpendicularToX(-20, ellipse(10, 2), { center: [0, 3] }),
|
|
716
|
+
Shape.slicePerpendicularToX(20, ellipse(8, 1.5), { center: [0, 6] }),
|
|
717
|
+
]);
|
|
718
|
+
```
|
|
719
|
+
|
|
720
|
+
**`FromSlicesAxisSliceOptions`**
|
|
721
|
+
- `center?: FromSlicesVec2` — Plane-local profile center. XY uses [x, y], XZ uses [x, z], YZ uses [y, z].
|
|
722
|
+
|
|
723
|
+
#### `slicePerpendicularToY(y: number, profile: Sketch, options?: FromSlicesAxisSliceOptions): FromSlicesSlice` — Create a slice descriptor perpendicular to the Y axis.
|
|
724
|
+
|
|
725
|
+
The profile is drawn in the XZ plane. `options.center` is `[x, z]`.
|
|
726
|
+
|
|
727
|
+
#### `slicePerpendicularToZ(z: number, profile: Sketch, options?: FromSlicesAxisSliceOptions): FromSlicesSlice` — Create a slice descriptor perpendicular to the Z axis.
|
|
728
|
+
|
|
729
|
+
The profile is drawn in the XY plane. `options.center` is `[x, y]`.
|
|
730
|
+
|
|
731
|
+
#### `sliceThrough(center: FromSlicesVec3, normal: FromSlicesVec3, profile: Sketch): FromSlicesSlice` — Create a slice descriptor through a world point with an arbitrary plane normal.
|
|
732
|
+
|
|
733
|
+
The profile origin lands at `center`. Use this when the section plane is not one of the world XY/XZ/YZ planes.
|
|
734
|
+
|
|
735
|
+
#### `sliceOnFrame(frame: FromSlicesFrameInput, profile: Sketch): FromSlicesSlice` — Create a slice descriptor on a full 3D work frame.
|
|
736
|
+
|
|
737
|
+
Sheet frame helpers return the right shape for `frame`. Use `Sheet.frameAt()` for tangent construction planes, or `Sheet.framePerpendicularToU()` / `Sheet.framePerpendicularToV()` for cross-sections normal to a surface path. On the Manifold backend, framed slices are lofted in input order when every slice comes from a frame.
|
|
738
|
+
|
|
739
|
+
**`FromSlicesFrameInput`**
|
|
740
|
+
|
|
741
|
+
| Option | Type | Description |
|
|
742
|
+
|--------|------|-------------|
|
|
743
|
+
| `point?` | `FromSlicesVec3` | World-space frame origin. Sheet frame helpers return this as `point`. |
|
|
744
|
+
| `origin?` | `FromSlicesVec3` | Alias for `point` when using generic CAD frame terminology. |
|
|
745
|
+
| `normal` | `FromSlicesVec3` | World-space frame normal. |
|
|
746
|
+
| `tangentU?` | `FromSlicesVec3` | World-space direction for the profile's local X axis. Sheet frame helpers return this as `tangentU`. |
|
|
747
|
+
| `tangentV?` | `FromSlicesVec3` | Optional world-space direction for the profile's local Y axis. Sheet frame helpers return this as `tangentV`. |
|
|
748
|
+
| `xAxis?` | `FromSlicesVec3` | Alias for `tangentU`. |
|
|
749
|
+
| `yAxis?` | `FromSlicesVec3` | Alias for `tangentV`. |
|
|
750
|
+
|
|
751
|
+
#### `fromSlices(slices: FromSlicesSlice[], options?: FromSlicesOptions): Shape` — Construct a 3D shape from cross-section slices on one or more planes.
|
|
752
|
+
|
|
753
|
+
On the Manifold backend, slices created with `Shape.sliceOnFrame()` are lofted in their input order while preserving each full 3D frame. Other slices with the same normal direction are lofted together. Slices with different normals are combined via smooth radial blending — each silhouette constrains the shape's extent, producing smooth ellipsoidal cross-sections.
|
|
754
|
+
|
|
755
|
+
```js
|
|
756
|
+
// Egg from two orthogonal silhouettes
|
|
757
|
+
const eggProfile = ellipse(15, 25);
|
|
758
|
+
return Shape.fromSlices([
|
|
759
|
+
{ on: 'xz', at: 0, profile: eggProfile },
|
|
760
|
+
{ on: 'yz', at: 0, profile: eggProfile },
|
|
761
|
+
]);
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
```js
|
|
765
|
+
// Vase with cross-section transitions
|
|
766
|
+
return Shape.fromSlices([
|
|
767
|
+
Shape.slicePerpendicularToZ(0, circle2d(20)),
|
|
768
|
+
Shape.slicePerpendicularToZ(40, rect(25, 25)),
|
|
769
|
+
Shape.slicePerpendicularToZ(80, circle2d(8)),
|
|
770
|
+
Shape.slicePerpendicularToY(0, vaseOutline),
|
|
771
|
+
]);
|
|
772
|
+
```
|
|
773
|
+
|
|
774
|
+
**`FromSlicesSlice`**
|
|
775
|
+
|
|
776
|
+
| Option | Type | Description |
|
|
777
|
+
|--------|------|-------------|
|
|
778
|
+
| `on` | `SlicePlane` | Plane normal: axis name or arbitrary unit vector. |
|
|
779
|
+
| `at?` | `number` | Signed offset along the normal from the origin. Omit when `center` defines the plane. |
|
|
780
|
+
| `center?` | `FromSlicesVec3` | World-space point where the 2D profile origin should land on the slice plane. |
|
|
781
|
+
| `profile` | `Sketch` | 2D cross-section profile on that plane. |
|
|
782
|
+
| `frame?` | `FromSlicesFramePlacement` | Full 3D section frame, preserved for ordered lofts through rotating planes. |
|
|
783
|
+
|
|
784
|
+
**`FromSlicesFramePlacement`**
|
|
785
|
+
|
|
786
|
+
| Option | Type | Description |
|
|
787
|
+
|--------|------|-------------|
|
|
788
|
+
| `point` | `FromSlicesVec3` | World-space frame origin. |
|
|
789
|
+
| `normal` | `FromSlicesVec3` | World-space section normal. |
|
|
790
|
+
| `tangentU` | `FromSlicesVec3` | World-space direction for the profile's local X axis. |
|
|
791
|
+
| `tangentV` | `FromSlicesVec3` | World-space direction for the profile's local Y axis. |
|
|
792
|
+
|
|
793
|
+
**`FromSlicesOptions`**
|
|
794
|
+
- `edgeLength?: number` — Marching-grid edge length for level-set meshing (Manifold only).
|
|
795
|
+
- `boundsPadding?: number` — Extra bounding-box padding (Manifold only).
|
|
796
|
+
|
|
708
797
|
**Appearance**
|
|
709
798
|
|
|
710
799
|
#### `color(value: string | undefined): Shape` — Set the color of this shape (hex string, e.g. "#ff0000"). Returns a new Shape with the color applied.
|
|
@@ -1355,57 +1444,106 @@ const bracket = group(
|
|
|
1355
1444
|
| `depth?` | `number` | Thread groove depth in millimeters. Default: 0.8. |
|
|
1356
1445
|
| `underScale?` | `number` | Relative height of the under-crossing thread. Default: 0.15. |
|
|
1357
1446
|
|
|
1358
|
-
### `
|
|
1447
|
+
### `CurveNetBuilder`
|
|
1359
1448
|
|
|
1360
|
-
|
|
1449
|
+
#### `alongRails(railA: CurveInput, railB: CurveInput): this` — Use two lengthwise boundary curves as guide rails.
|
|
1361
1450
|
|
|
1362
|
-
|
|
1451
|
+
Chain `.sections(...)` to create a bi-rail surface: the rails define the sheet edges while each section curve shapes the cross-span at its station.
|
|
1363
1452
|
|
|
1364
|
-
|
|
1365
|
-
|----------|------|-------------|
|
|
1366
|
-
| `surface` | `BSplineSurface` | — |
|
|
1453
|
+
#### `sections(...curves: CurveInput[]): this` — Add crosswise section curves.
|
|
1367
1454
|
|
|
1368
|
-
|
|
1455
|
+
By itself this skins the sections into a surface. After `.alongRails(...)`, the sections are fitted between the two rails so the surface follows both the boundary guide curves and the section profiles.
|
|
1369
1456
|
|
|
1370
|
-
#### `
|
|
1457
|
+
#### `resolution(samples: number): this` — Set the sampling resolution used to build curve-family surface grids.
|
|
1371
1458
|
|
|
1372
|
-
|
|
1459
|
+
This affects `.lengthwise(...)`, `.crosswise(...)`, and `.alongRails(...).sections(...)` surfaces. It does not resample explicit `.cage(grid)` input because the cage already is the authored control net.
|
|
1373
1460
|
|
|
1374
|
-
#### `
|
|
1461
|
+
#### `matchStartU(condition: BoundaryCondition): this` — Enforce a continuity condition on the `u = 0` (left) boundary.
|
|
1462
|
+
|
|
1463
|
+
Pass `{ edge }` to match an adjacent sheet's tangent (G1) or curvature (G2), or `{ tangent }` to impose an explicit cross-boundary direction. See `BoundaryCondition`.
|
|
1464
|
+
|
|
1465
|
+
**`BoundaryCondition`**
|
|
1466
|
+
|
|
1467
|
+
| Option | Type | Description |
|
|
1468
|
+
|--------|------|-------------|
|
|
1469
|
+
| `edge?` | `SheetEdge` | Match the tangent (G1) and curvature (G2) of an existing sheet edge across this boundary. |
|
|
1470
|
+
| `tangent?` | `Vec3` | Or impose an explicit cross-boundary tangent direction in world space (auto-normalized). |
|
|
1471
|
+
| `tangentScale?` | `number` | Scalar magnitude for the imposed `tangent` ramp, in model units. Ignored when `edge` is given. Default: the local cross-boundary control-span length (chord-scaled), so the imposed tangent has the same strength as the surface already carries — no magic number. |
|
|
1472
|
+
| `continuity?` | `0 \| 1 \| 2` | Continuity order to enforce on this side. Default inferred: 1 if a tangent or edge is given, else 0. G2 (curvature) requires an `edge` to copy the neighbor's second difference. |
|
|
1375
1473
|
|
|
1376
1474
|
**`SheetEdge`**
|
|
1377
1475
|
- `fixed: "u" | "v"` — Which parameter is held fixed along this edge.
|
|
1378
1476
|
- `value: 0 | 1` — The fixed value (0 or 1).
|
|
1379
1477
|
- Also: `sheet: Sheet`.
|
|
1380
1478
|
|
|
1381
|
-
|
|
1382
|
-
- `get leftEdge(): SheetEdge`
|
|
1383
|
-
- `get rightEdge(): SheetEdge`
|
|
1384
|
-
- `pointAt(u: number, v: number): Vec3`
|
|
1385
|
-
- `normalAt(u: number, v: number): Vec3`
|
|
1386
|
-
- `curvatureAt(u: number, v: number): SurfaceCurvature`
|
|
1479
|
+
#### `matchEndU(condition: BoundaryCondition): this` — Enforce a continuity condition on the `u = 1` (right) boundary. See `matchStartU`.
|
|
1387
1480
|
|
|
1388
|
-
|
|
1481
|
+
#### `matchStartV(condition: BoundaryCondition): this` — Enforce a continuity condition on the `v = 0` (front) boundary. See `matchStartU`.
|
|
1482
|
+
|
|
1483
|
+
#### `matchEndV(condition: BoundaryCondition): this` — Enforce a continuity condition on the `v = 1` (rear) boundary. See `matchStartU`.
|
|
1484
|
+
|
|
1485
|
+
#### `closedU(): this` — Weld the two ends of the U direction into a tangent-continuous periodic loop, so the `u = 0` and `u = 1` boundaries coincide with NO G0 kink (a closed tube/ring in U — e.g. a bowl's around-rim seam). The cage's first and last U rows must already be coincident (the loop must close in position).
|
|
1486
|
+
|
|
1487
|
+
#### `closedV(): this` — Weld the two ends of the V direction into a tangent-continuous periodic loop. See `closedU`.
|
|
1389
1488
|
|
|
1390
1489
|
#### `toSheet(): Sheet` — Build (once) and return the Sheet.
|
|
1391
1490
|
|
|
1392
1491
|
- `lengthwise(...curves: CurveInput[]): this`
|
|
1393
1492
|
- `crosswise(...curves: CurveInput[]): this`
|
|
1394
|
-
- `alongRails(railA: CurveInput, railB: CurveInput): this`
|
|
1395
|
-
- `sections(...curves: CurveInput[]): this`
|
|
1396
1493
|
- `cage(grid: Vec3[][]): this`
|
|
1397
1494
|
- `degree(u: number, v: number): this`
|
|
1398
1495
|
- `get frontEdge(): SheetEdge`
|
|
1399
1496
|
- `get rearEdge(): SheetEdge`
|
|
1400
1497
|
- `get leftEdge(): SheetEdge`
|
|
1401
1498
|
- `get rightEdge(): SheetEdge`
|
|
1499
|
+
- `get frontCurve(): NurbsCurve3D`
|
|
1500
|
+
- `get rearCurve(): NurbsCurve3D`
|
|
1501
|
+
- `get leftCurve(): NurbsCurve3D`
|
|
1502
|
+
- `get rightCurve(): NurbsCurve3D`
|
|
1402
1503
|
- `get surface(): BSplineSurface`
|
|
1403
1504
|
- `pointAt(u: number, v: number): Vec3`
|
|
1404
1505
|
- `normalAt(u: number, v: number): Vec3`
|
|
1506
|
+
- `frameAt(u: number, v: number, options?: SheetFrameOptions): SheetFrame`
|
|
1507
|
+
- `framePerpendicularToU(u: number, v: number, options?: SheetFrameOptions): SheetFrame`
|
|
1508
|
+
- `framePerpendicularToV(u: number, v: number, options?: SheetFrameOptions): SheetFrame`
|
|
1405
1509
|
- `curvatureAt(u: number, v: number): SurfaceCurvature`
|
|
1510
|
+
- `curveAlong(edge: SheetEdge): NurbsCurve3D`
|
|
1511
|
+
- `curveAlongU(v: number): NurbsCurve3D`
|
|
1512
|
+
- `curveAlongV(u: number): NurbsCurve3D`
|
|
1513
|
+
- `pathAlong(edge: SheetEdge, options?: SheetPathAlongOptions): Vec3[]`
|
|
1514
|
+
- `pathAlongBoundary(spans: SheetBoundaryPathSpan[], options?: SheetBoundaryPathOptions): Vec3[]`
|
|
1515
|
+
- `pathAlongU(v: number, options?: SheetPathAlongOptions): Vec3[]`
|
|
1516
|
+
- `pathAlongV(u: number, options?: SheetPathAlongOptions): Vec3[]`
|
|
1406
1517
|
- `thicken(wall: number, options?: { resolution?: number; }): Shape`
|
|
1407
1518
|
- `matchEdge(edge: SheetEdge): MatchEdgeBuilder`
|
|
1408
1519
|
|
|
1520
|
+
**`SheetFrameOptions`**
|
|
1521
|
+
- `normalOffset?: number` — Offset the frame origin along the analytic surface normal. Default 0.
|
|
1522
|
+
|
|
1523
|
+
**`SheetPathAlongOptions`**
|
|
1524
|
+
|
|
1525
|
+
| Option | Type | Description |
|
|
1526
|
+
|--------|------|-------------|
|
|
1527
|
+
| `samples?` | `number` | Samples along the path span. Default 32. |
|
|
1528
|
+
| `start?` | `number` | Normalized start parameter along the path. Default 0. |
|
|
1529
|
+
| `end?` | `number` | Normalized end parameter along the path. Default 1. |
|
|
1530
|
+
| `reverse?` | `boolean` | Return points from end to start after sampling the span. Default false. |
|
|
1531
|
+
| `normalOffset?` | `number` | Offset each path point along the analytic surface normal. Default 0. |
|
|
1532
|
+
|
|
1533
|
+
**`SheetBoundaryPathSpan`**
|
|
1534
|
+
|
|
1535
|
+
| Option | Type | Description |
|
|
1536
|
+
|--------|------|-------------|
|
|
1537
|
+
| `edge` | `SheetEdge` | Boundary edge to sample for this span. |
|
|
1538
|
+
| `start?` | `SheetPathParameter` | Normalized edge parameter or world point projected to the closest edge parameter. Default 0. |
|
|
1539
|
+
| `end?` | `SheetPathParameter` | Normalized edge parameter or world point projected to the closest edge parameter. Default 1. |
|
|
1540
|
+
| `samples?` | `number` | Samples along this edge span. Defaults to options.samplesPerEdge or 32. |
|
|
1541
|
+
|
|
1542
|
+
**`SheetBoundaryPathOptions`**
|
|
1543
|
+
- `samplesPerEdge?: number` — Samples for spans that do not specify their own count. Default 32.
|
|
1544
|
+
- `normalOffset?: number` — Offset each path point along the analytic surface normal. Default 0.
|
|
1545
|
+
- `tolerance?: number` — Maximum allowed gap between adjacent sampled spans. Default 1e-6.
|
|
1546
|
+
|
|
1409
1547
|
### `MatchEdgeBuilder`
|
|
1410
1548
|
|
|
1411
1549
|
- `toG0(neighbor: SheetEdge): Sheet`
|