brep-io-kernel 1.0.184 → 1.0.186
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/README.md +1 -0
- package/dist/about.html +1 -1
- package/dist/help/configurator-editor.png +0 -0
- package/dist/help/configurator-field-types.png +0 -0
- package/dist/help/developer-index.html +1 -1
- package/dist/help/dialog-screenshots.html +1 -1
- package/dist/help/expressions-panel.png +0 -0
- package/dist/help/expressions.html +723 -0
- package/dist/help/index.html +2 -1
- package/dist/help/input-params-schema.html +54 -2
- package/dist/help/modes__modeling.html +1 -1
- package/dist/help/part-history.html +81 -2
- package/dist/help/search-index.json +14 -8
- package/dist/help/table-of-contents.html +1 -0
- package/dist-kernel/help/configurator-editor.png +0 -0
- package/dist-kernel/help/configurator-field-types.png +0 -0
- package/dist-kernel/help/developer-index.html +1 -1
- package/dist-kernel/help/dialog-screenshots.html +1 -1
- package/dist-kernel/help/expressions-panel.png +0 -0
- package/dist-kernel/help/expressions.html +723 -0
- package/dist-kernel/help/index.html +2 -1
- package/dist-kernel/help/input-params-schema.html +54 -2
- package/dist-kernel/help/modes__modeling.html +1 -1
- package/dist-kernel/help/part-history.html +81 -2
- package/dist-kernel/help/search-index.json +14 -8
- package/dist-kernel/help/table-of-contents.html +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -46,6 +46,7 @@ Core APIs:
|
|
|
46
46
|
- [BREP API Export Map](docs/brep-api.md)
|
|
47
47
|
- [BREP Kernel Reference](docs/brep-kernel.md)
|
|
48
48
|
- [Solid Methods](docs/solid-methods.md)
|
|
49
|
+
- [Expressions and Configurator](docs/expressions.md)
|
|
49
50
|
- [Part History](docs/part-history.md)
|
|
50
51
|
- [2D Sketch Solver](docs/sketch-solver-2d.md)
|
|
51
52
|
- [Embeddable CAD (`CadEmbed`)](docs/cad-embed.md)
|
package/dist/about.html
CHANGED
|
@@ -125,7 +125,7 @@ a{color:var(--accent);text-decoration:none} a:hover{text-decoration:underline}
|
|
|
125
125
|
<main>
|
|
126
126
|
<section class="card readme">
|
|
127
127
|
<div class="header"><h1>Project Overview</h1></div>
|
|
128
|
-
<div class="content prose"><h1><a href="https://BREP.io">BREP.io</a></h1><h1><a href="https://github.com/mmiscool/BREP">Source <a href="https://github.com/mmiscool/BREP" target="_blank" rel="noopener noreferrer">https://github.com/mmiscool/BREP</a></a></h1><ul><li><a href="https://www.npmjs.com/package/brep-io-kernel">NPM package: <code>brep-io-kernel</code> <a href="https://www.npmjs.com/package/brep-io-kernel" target="_blank" rel="noopener noreferrer">https://www.npmjs.com/package/brep-io-kernel</a></a></li><li><a href="https://BREP.io/apiExamples/index.html">Live API examples <a href="https://BREP.io/apiExamples/index.html" target="_blank" rel="noopener noreferrer">https://BREP.io/apiExamples/index.html</a></a></li><li><a href="https://discord.gg/R5KNAKrQ">Developer Discord <a href="https://discord.gg/R5KNAKrQ" target="_blank" rel="noopener noreferrer">https://discord.gg/R5KNAKrQ</a></a></li></ul><p>BREP.io is a browser-based CAD application and JavaScript kernel for feature-based solid modeling. At its core is a BREP-style modeler with explicit geometry/topology objects such as <code>Solid</code>, <code>Face</code>, <code>Edge</code>, and <code>Vertex</code>, paired with an editable feature-history pipeline. It also includes sketch workflows powered by a standalone 2D constraint solver, plus robust manifold booleans (<a href="https://github.com/elalish/manifold">manifold-3d</a>), mesh repair/import tooling, assembly constraints, PMI annotations, and embeddable CAD/sketcher APIs.</p><p>This project is in active development and APIs may continue to evolve.</p><h2>Workbenches</h2><ul><li><a href="docs__workbenches__modeling.html">Modeling Workbench</a></li><li><a href="docs__workbenches__import.html">Import Workbench</a></li><li><a href="docs__workbenches__surfacing.html">Surfacing Workbench</a></li><li><a href="docs__workbenches__sheet-metal.html">Sheet Metal Workbench</a></li><li><a href="docs__workbenches__assemblies.html">Assemblies Workbench</a></li><li><a href="docs__workbenches__wire-harness.html">Wire Harness Workbench</a></li><li><a href="docs__workbenches__pmi.html">PMI Workbench</a></li><li><a href="docs__workbenches__all.html">All Workbench</a></li></ul><h2>Screenshots</h2><p><img src="docs__HOME.png" alt="Home" width="280" loading="lazy" /> <a href="docs__modes__modeling.html"><img src="docs__MODELING.png" alt="Modeling Mode" width="280" loading="lazy" /></a> <a href="docs__modes__sketch.html"><img src="docs__SKETCH.png" alt="Sketch Mode" width="280" loading="lazy" /></a> <a href="docs__modes__pmi.html"><img src="docs__PMI.png" alt="PMI Mode" width="280" loading="lazy" /></a> <a href="docs__modes__sheets.html"><img src="docs__SHEETS.png" alt="2D Sheets Mode" width="280" loading="lazy" /></a> <a href="docs__features__image-to-face.html"><img src="docs__features__image-to-face-2D_dialog.png" alt="Image to Face 2D" width="280" loading="lazy" /></a> <a href="docs__features__image-to-face.html"><img src="docs__features__image-to-face-3D_dialog.png" alt="Image to Face 3D" width="280" loading="lazy" /></a></p><h2>Documentation Index</h2><p>General:</p><ul><li><a href="docs__getting-started.html">Getting Started</a></li><li><a href="docs__developer-index.html">Developer Docs Index</a></li><li><a href="docs__bug-reporting.html">Bug Reporting and Repro Test Cases</a></li><li><a href="docs__highlights.html">Highlights</a></li><li><a href="docs__whats-new.html">What's New</a></li><li><a href="docs__api-examples.html">API Examples</a></li></ul><p>Core APIs:</p><ul><li><a href="docs__brep-api.html">BREP API Export Map</a></li><li><a href="docs__brep-kernel.html">BREP Kernel Reference</a></li><li><a href="docs__solid-methods.html">Solid Methods</a></li><li><a href="docs__part-history.html">Part History</a></li><li><a href="docs__sketch-solver-2d.html">2D Sketch Solver</a></li><li><a href="docs__cad-embed.html">Embeddable CAD (<code>CadEmbed</code>)</a></li><li><a href="docs__sketcher2d-embed.html">Embeddable Sketcher (<code>Sketcher2DEmbed</code>)</a></li></ul><p>System docs:</p><ul><li><a href="docs__history-systems.html">History Systems</a></li><li><a href="docs__input-params-schema.html">Input Params Schema</a></li><li><a href="docs__file-formats.html">File Formats: Import and Export</a></li><li><a href="docs__plugins.html">Plugins and Examples</a></li><li><a href="docs__inspector.html">Inspector</a></li><li><a href="docs__inspector-improvements.html">Inspector Improvements</a></li></ul><p>Mode guides:</p><ul><li><a href="docs__modes__modeling.html">Modeling Mode</a></li><li><a href="docs__modes__sketch.html">Sketch Mode</a></li><li><a href="docs__modes__pmi.html">PMI Mode</a></li><li><a href="docs__modes__sheets.html">2D Sheets Mode</a></li></ul><h2>Modeling Feature Docs</h2><p>Feature index:</p><ul><li><a href="docs__features__index.html">All Feature Docs</a></li></ul><p>Primitives and setup:</p><ul><li><a href="docs__features__primitive-cube.html">Primitive Cube</a></li><li><a href="docs__features__primitive-cylinder.html">Primitive Cylinder</a></li><li><a href="docs__features__primitive-cone.html">Primitive Cone</a></li><li><a href="docs__features__primitive-sphere.html">Primitive Sphere</a></li><li><a href="docs__features__primitive-torus.html">Primitive Torus</a></li><li><a href="docs__features__primitive-pyramid.html">Primitive Pyramid</a></li><li><a href="docs__features__plane.html">Plane</a></li><li><a href="docs__features__datum.html">Datum</a></li><li><a href="docs__features__datium.html">Datium</a></li><li><a href="docs__features__sketch.html">Sketch</a></li><li><a href="docs__features__spline.html">Spline</a></li><li><a href="docs__features__helix.html">Helix</a></li></ul><p>Solid operations:</p><ul><li><a href="docs__features__extrude.html">Extrude</a></li><li><a href="docs__features__sweep.html">Sweep</a></li><li><a href="docs__features__tube.html">Tube</a></li><li><a href="docs__features__loft.html">Loft</a></li><li><a href="docs__features__revolve.html">Revolve</a></li><li><a href="docs__features__mirror.html">Mirror</a></li><li><a href="docs__features__boolean.html">Boolean</a></li><li><a href="docs__features__fillet.html">Fillet</a></li><li><a href="docs__features__chamfer.html">Chamfer</a></li><li><a href="docs__features__hole.html">Hole</a></li><li><a href="docs__features__offset-shell.html">Offset Shell</a></li><li><a href="docs__features__remesh.html">Remesh</a></li><li><a href="docs__features__transform.html">Transform</a></li></ul><p>Pattern, import, and generation:</p><ul><li><a href="docs__features__pattern.html">Pattern (Legacy Combined)</a></li><li><a href="docs__features__pattern-linear.html">Pattern Linear</a></li><li><a href="docs__features__pattern-radial.html">Pattern Radial</a></li><li><a href="docs__features__import-3d-model.html">Import 3D Model</a></li><li><a href="docs__features__image-heightmap-solid.html">Image Heightmap Solid</a></li><li><a href="docs__features__image-to-face.html">Image to Face</a></li><li><a href="docs__features__text-to-face.html">Text to Face</a></li></ul><p>Assembly and sheet metal:</p><ul><li><a href="docs__features__assembly-component.html">Assembly Component</a></li><li><a href="docs__features__sheet-metal-tab.html">Sheet Metal Tab</a></li><li><a href="docs__features__sheet-metal-contour-flange.html">Sheet Metal Contour Flange</a></li><li><a href="docs__features__sheet-metal-flange.html">Sheet Metal Flange</a></li></ul><p>Additional implemented features in the codebase include collapse edge, edge smooth, offset face, overlap cleanup, sheet metal hem, and sheet metal cutout.</p><h2>Assembly Constraints</h2><ul><li><a href="docs__assembly-constraints__solver.html">Assembly Constraint Solver</a></li><li><a href="docs__assembly-constraints__coincident-constraint.html">Coincident</a></li><li><a href="docs__assembly-constraints__distance-constraint.html">Distance</a></li><li><a href="docs__assembly-constraints__angle-constraint.html">Angle</a></li><li><a href="docs__assembly-constraints__parallel-constraint.html">Parallel</a></li><li><a href="docs__assembly-constraints__touch-align-constraint.html">Touch Align</a></li><li><a href="docs__assembly-constraints__fixed-constraint.html">Fixed</a></li></ul><h2>PMI Annotation Docs</h2><ul><li><a href="docs__pmi-annotations__index.html">PMI Annotations Index</a></li><li><a href="docs__pmi-annotations__linear-dimension.html">Linear Dimension</a></li><li><a href="docs__pmi-annotations__radial-dimension.html">Radial Dimension</a></li><li><a href="docs__pmi-annotations__angle-dimension.html">Angle Dimension</a></li><li><a href="docs__pmi-annotations__leader.html">Leader</a></li><li><a href="docs__pmi-annotations__note.html">Note</a></li><li><a href="docs__pmi-annotations__hole-callout.html">Hole Callout</a></li><li><a href="docs__pmi-annotations__explode-body.html">Explode Body</a></li></ul><h2>Quick Start</h2><p>Prerequisites:</p><ul><li>Node.js 18+</li><li><code>pnpm</code></li><li><code>git submodule update --init --recursive</code></li><li>Emscripten SDK (<code>emcmake</code>/<code>emcc</code> on <code>PATH</code>, or EMSDK installed at <code>$HOME/emsdk</code>)</li></ul><p>Install and run locally:</p><div class="doc-codeblock" data-code-language="bash">
|
|
128
|
+
<div class="content prose"><h1><a href="https://BREP.io">BREP.io</a></h1><h1><a href="https://github.com/mmiscool/BREP">Source <a href="https://github.com/mmiscool/BREP" target="_blank" rel="noopener noreferrer">https://github.com/mmiscool/BREP</a></a></h1><ul><li><a href="https://www.npmjs.com/package/brep-io-kernel">NPM package: <code>brep-io-kernel</code> <a href="https://www.npmjs.com/package/brep-io-kernel" target="_blank" rel="noopener noreferrer">https://www.npmjs.com/package/brep-io-kernel</a></a></li><li><a href="https://BREP.io/apiExamples/index.html">Live API examples <a href="https://BREP.io/apiExamples/index.html" target="_blank" rel="noopener noreferrer">https://BREP.io/apiExamples/index.html</a></a></li><li><a href="https://discord.gg/R5KNAKrQ">Developer Discord <a href="https://discord.gg/R5KNAKrQ" target="_blank" rel="noopener noreferrer">https://discord.gg/R5KNAKrQ</a></a></li></ul><p>BREP.io is a browser-based CAD application and JavaScript kernel for feature-based solid modeling. At its core is a BREP-style modeler with explicit geometry/topology objects such as <code>Solid</code>, <code>Face</code>, <code>Edge</code>, and <code>Vertex</code>, paired with an editable feature-history pipeline. It also includes sketch workflows powered by a standalone 2D constraint solver, plus robust manifold booleans (<a href="https://github.com/elalish/manifold">manifold-3d</a>), mesh repair/import tooling, assembly constraints, PMI annotations, and embeddable CAD/sketcher APIs.</p><p>This project is in active development and APIs may continue to evolve.</p><h2>Workbenches</h2><ul><li><a href="docs__workbenches__modeling.html">Modeling Workbench</a></li><li><a href="docs__workbenches__import.html">Import Workbench</a></li><li><a href="docs__workbenches__surfacing.html">Surfacing Workbench</a></li><li><a href="docs__workbenches__sheet-metal.html">Sheet Metal Workbench</a></li><li><a href="docs__workbenches__assemblies.html">Assemblies Workbench</a></li><li><a href="docs__workbenches__wire-harness.html">Wire Harness Workbench</a></li><li><a href="docs__workbenches__pmi.html">PMI Workbench</a></li><li><a href="docs__workbenches__all.html">All Workbench</a></li></ul><h2>Screenshots</h2><p><img src="docs__HOME.png" alt="Home" width="280" loading="lazy" /> <a href="docs__modes__modeling.html"><img src="docs__MODELING.png" alt="Modeling Mode" width="280" loading="lazy" /></a> <a href="docs__modes__sketch.html"><img src="docs__SKETCH.png" alt="Sketch Mode" width="280" loading="lazy" /></a> <a href="docs__modes__pmi.html"><img src="docs__PMI.png" alt="PMI Mode" width="280" loading="lazy" /></a> <a href="docs__modes__sheets.html"><img src="docs__SHEETS.png" alt="2D Sheets Mode" width="280" loading="lazy" /></a> <a href="docs__features__image-to-face.html"><img src="docs__features__image-to-face-2D_dialog.png" alt="Image to Face 2D" width="280" loading="lazy" /></a> <a href="docs__features__image-to-face.html"><img src="docs__features__image-to-face-3D_dialog.png" alt="Image to Face 3D" width="280" loading="lazy" /></a></p><h2>Documentation Index</h2><p>General:</p><ul><li><a href="docs__getting-started.html">Getting Started</a></li><li><a href="docs__developer-index.html">Developer Docs Index</a></li><li><a href="docs__bug-reporting.html">Bug Reporting and Repro Test Cases</a></li><li><a href="docs__highlights.html">Highlights</a></li><li><a href="docs__whats-new.html">What's New</a></li><li><a href="docs__api-examples.html">API Examples</a></li></ul><p>Core APIs:</p><ul><li><a href="docs__brep-api.html">BREP API Export Map</a></li><li><a href="docs__brep-kernel.html">BREP Kernel Reference</a></li><li><a href="docs__solid-methods.html">Solid Methods</a></li><li><a href="docs__expressions.html">Expressions and Configurator</a></li><li><a href="docs__part-history.html">Part History</a></li><li><a href="docs__sketch-solver-2d.html">2D Sketch Solver</a></li><li><a href="docs__cad-embed.html">Embeddable CAD (<code>CadEmbed</code>)</a></li><li><a href="docs__sketcher2d-embed.html">Embeddable Sketcher (<code>Sketcher2DEmbed</code>)</a></li></ul><p>System docs:</p><ul><li><a href="docs__history-systems.html">History Systems</a></li><li><a href="docs__input-params-schema.html">Input Params Schema</a></li><li><a href="docs__file-formats.html">File Formats: Import and Export</a></li><li><a href="docs__plugins.html">Plugins and Examples</a></li><li><a href="docs__inspector.html">Inspector</a></li><li><a href="docs__inspector-improvements.html">Inspector Improvements</a></li></ul><p>Mode guides:</p><ul><li><a href="docs__modes__modeling.html">Modeling Mode</a></li><li><a href="docs__modes__sketch.html">Sketch Mode</a></li><li><a href="docs__modes__pmi.html">PMI Mode</a></li><li><a href="docs__modes__sheets.html">2D Sheets Mode</a></li></ul><h2>Modeling Feature Docs</h2><p>Feature index:</p><ul><li><a href="docs__features__index.html">All Feature Docs</a></li></ul><p>Primitives and setup:</p><ul><li><a href="docs__features__primitive-cube.html">Primitive Cube</a></li><li><a href="docs__features__primitive-cylinder.html">Primitive Cylinder</a></li><li><a href="docs__features__primitive-cone.html">Primitive Cone</a></li><li><a href="docs__features__primitive-sphere.html">Primitive Sphere</a></li><li><a href="docs__features__primitive-torus.html">Primitive Torus</a></li><li><a href="docs__features__primitive-pyramid.html">Primitive Pyramid</a></li><li><a href="docs__features__plane.html">Plane</a></li><li><a href="docs__features__datum.html">Datum</a></li><li><a href="docs__features__datium.html">Datium</a></li><li><a href="docs__features__sketch.html">Sketch</a></li><li><a href="docs__features__spline.html">Spline</a></li><li><a href="docs__features__helix.html">Helix</a></li></ul><p>Solid operations:</p><ul><li><a href="docs__features__extrude.html">Extrude</a></li><li><a href="docs__features__sweep.html">Sweep</a></li><li><a href="docs__features__tube.html">Tube</a></li><li><a href="docs__features__loft.html">Loft</a></li><li><a href="docs__features__revolve.html">Revolve</a></li><li><a href="docs__features__mirror.html">Mirror</a></li><li><a href="docs__features__boolean.html">Boolean</a></li><li><a href="docs__features__fillet.html">Fillet</a></li><li><a href="docs__features__chamfer.html">Chamfer</a></li><li><a href="docs__features__hole.html">Hole</a></li><li><a href="docs__features__offset-shell.html">Offset Shell</a></li><li><a href="docs__features__remesh.html">Remesh</a></li><li><a href="docs__features__transform.html">Transform</a></li></ul><p>Pattern, import, and generation:</p><ul><li><a href="docs__features__pattern.html">Pattern (Legacy Combined)</a></li><li><a href="docs__features__pattern-linear.html">Pattern Linear</a></li><li><a href="docs__features__pattern-radial.html">Pattern Radial</a></li><li><a href="docs__features__import-3d-model.html">Import 3D Model</a></li><li><a href="docs__features__image-heightmap-solid.html">Image Heightmap Solid</a></li><li><a href="docs__features__image-to-face.html">Image to Face</a></li><li><a href="docs__features__text-to-face.html">Text to Face</a></li></ul><p>Assembly and sheet metal:</p><ul><li><a href="docs__features__assembly-component.html">Assembly Component</a></li><li><a href="docs__features__sheet-metal-tab.html">Sheet Metal Tab</a></li><li><a href="docs__features__sheet-metal-contour-flange.html">Sheet Metal Contour Flange</a></li><li><a href="docs__features__sheet-metal-flange.html">Sheet Metal Flange</a></li></ul><p>Additional implemented features in the codebase include collapse edge, edge smooth, offset face, overlap cleanup, sheet metal hem, and sheet metal cutout.</p><h2>Assembly Constraints</h2><ul><li><a href="docs__assembly-constraints__solver.html">Assembly Constraint Solver</a></li><li><a href="docs__assembly-constraints__coincident-constraint.html">Coincident</a></li><li><a href="docs__assembly-constraints__distance-constraint.html">Distance</a></li><li><a href="docs__assembly-constraints__angle-constraint.html">Angle</a></li><li><a href="docs__assembly-constraints__parallel-constraint.html">Parallel</a></li><li><a href="docs__assembly-constraints__touch-align-constraint.html">Touch Align</a></li><li><a href="docs__assembly-constraints__fixed-constraint.html">Fixed</a></li></ul><h2>PMI Annotation Docs</h2><ul><li><a href="docs__pmi-annotations__index.html">PMI Annotations Index</a></li><li><a href="docs__pmi-annotations__linear-dimension.html">Linear Dimension</a></li><li><a href="docs__pmi-annotations__radial-dimension.html">Radial Dimension</a></li><li><a href="docs__pmi-annotations__angle-dimension.html">Angle Dimension</a></li><li><a href="docs__pmi-annotations__leader.html">Leader</a></li><li><a href="docs__pmi-annotations__note.html">Note</a></li><li><a href="docs__pmi-annotations__hole-callout.html">Hole Callout</a></li><li><a href="docs__pmi-annotations__explode-body.html">Explode Body</a></li></ul><h2>Quick Start</h2><p>Prerequisites:</p><ul><li>Node.js 18+</li><li><code>pnpm</code></li><li><code>git submodule update --init --recursive</code></li><li>Emscripten SDK (<code>emcmake</code>/<code>emcc</code> on <code>PATH</code>, or EMSDK installed at <code>$HOME/emsdk</code>)</li></ul><p>Install and run locally:</p><div class="doc-codeblock" data-code-language="bash">
|
|
129
129
|
<div class="doc-codeblock-header">
|
|
130
130
|
<span class="doc-codeblock-lang">bash</span>
|
|
131
131
|
<button type="button" class="doc-codeblock-copy" data-copy-code aria-label="Copy code" title="Copy code">
|
|
Binary file
|
|
Binary file
|
|
@@ -141,7 +141,7 @@ a{color:var(--accent);text-decoration:none} a:hover{text-decoration:underline}
|
|
|
141
141
|
<section class="card doc-card">
|
|
142
142
|
|
|
143
143
|
<div class="prose">
|
|
144
|
-
<h1>Developer Docs Index</h1><p>This page is a quick entry point for implementation and integration docs.</p><h2>Embedding Quick Links</h2><ul><li><a href="cad-embed.html">CAD Embedding Guide (CadEmbed)</a></li><li><a href="sketcher2d-embed.html">2D Sketcher Embedding Guide</a></li></ul><h2>Start Here</h2><ul><li><a href="getting-started.html">Getting Started</a></li><li><a href="bug-reporting.html">Bug Reporting and Repro Test Cases</a></li><li><a href="https://discord.gg/R5KNAKrQ">Developer Discord</a></li><li><a href="api-examples.html">API Examples (Live Demos)</a></li><li><a href="brep-api.html">BREP API (BREP.js exports)</a></li><li><a href="brep-kernel.html">BREP Kernel (core classes & helpers)</a></li><li><a href="brep-model.html">BREP Model and Classes</a></li><li><a href="part-history.html">PartHistory Reference</a></li><li><a href="how-it-works.html">How It Works</a></li><li><a href="whats-new.html">What's New</a></li><li><a href="highlights.html">Highlights</a></li></ul><h2>Live API Example Pages</h2><ul><li><a href="https://BREP.io/apiExamples/index.html">Examples Index</a></li><li><a href="https://BREP.io/apiExamples/BREP_Booleans.html">BREP Booleans</a></li><li><a href="https://BREP.io/apiExamples/BREP_Primitives.html">BREP Primitives</a></li><li><a href="https://BREP.io/apiExamples/BREP_Transforms.html">BREP Transforms</a></li><li><a href="https://BREP.io/apiExamples/BREP_Export.html">BREP Export</a></li><li><a href="https://BREP.io/apiExamples/Embeded_2D_Sketcher.html">Embeded 2D Sketcher</a></li><li><a href="https://BREP.io/apiExamples/Embeded_CAD.html">Embeded CAD</a></li><li><a href="https://BREP.io/apiExamples/Embeded_CAD_Integration_Test.html">Embeded CAD Integration Test</a></li></ul><h2>Sketch and Geometry APIs</h2><ul><li><a href="sketch-solver-2d.html">2D Sketch Solver (standalone)</a></li><li><a href="sketcher2d-embed.html">Embeddable 2D Sketcher</a></li><li><a href="cad-embed.html">Embeddable CAD App</a></li><li><a href="extruded-sketch-radius-embedding.html">Radius Metadata for Extruded Sketches</a></li><li><a href="cylindrical-face-radius-embedding.html">Cylindrical Face Radius Embedding</a></li><li><a href="topological-face-tracking.html">Topological Face Naming and Triangle Ownership</a></li><li><a href="solid-methods.html">Solid Methods</a></li><li><a href="simplified-radial-dimensions.html">Simplified Radial Dimensions</a></li></ul><h2>Application and UI Architecture</h2><ul><li><a href="history-systems.html">History Systems</a></li><li><a href="feature-dimension-gizmos.html">Feature Dimension Gizmos (Developer)</a></li><li><a href="input-params-schema.html">Input Params Schema</a></li><li><a href="ui-overview.html">UI Overview (Browser)</a></li><li><a href="plugins.html">Plugins and Examples</a></li><li><a href="inspector.html">Inspector</a></li><li><a href="inspector-improvements.html">Inspector Improvements</a></li><li><a href="dialog-screenshots.html">Dialog Screenshots</a></li></ul><h2>Data and File IO</h2><ul><li><a href="file-formats.html">File Formats: Import and Export</a></li><li><a href="github-repo-storage.html">GitHub Repo Storage</a></li></ul><h2>Assembly Constraints</h2><ul><li><a href="assembly-constraints__solver.html">Constraint Solver</a></li><li><a href="assembly-constraints__angle-constraint.html">Angle Constraint</a></li><li><a href="assembly-constraints__coincident-constraint.html">Coincident Constraint</a></li><li><a href="assembly-constraints__distance-constraint.html">Distance Constraint</a></li><li><a href="assembly-constraints__fixed-constraint.html">Fixed Constraint</a></li><li><a href="assembly-constraints__parallel-constraint.html">Parallel Constraint</a></li><li><a href="assembly-constraints__touch-align-constraint.html">Touch Align Constraint</a></li></ul><h2>Feature and Mode Docs</h2><ul><li><a href="features__index.html">Features Index</a></li><li><a href="modes__modeling.html">Modeling Mode</a></li><li><a href="modes__sketch.html">Sketch Mode</a></li><li><a href="modes__pmi.html">PMI Mode</a></li><li><a href="modes__sheets.html">2D Sheets Mode</a></li></ul><h2>Feature Docs (Detailed)</h2><ul><li><a href="features__assembly-component.html">Assembly Component</a></li><li><a href="features__boolean.html">Boolean</a></li><li><a href="features__chamfer.html">Chamfer</a></li><li><a href="features__datium.html">Datium</a></li><li><a href="features__datum.html">Datum</a></li><li><a href="features__extrude.html">Extrude</a></li><li><a href="features__fillet.html">Fillet</a></li><li><a href="features__helix.html">Helix</a></li><li><a href="features__hole.html">Hole</a></li><li><a href="features__image-heightmap-solid.html">Image Heightmap Solid</a></li><li><a href="features__image-to-face.html">Image To Face</a></li><li><a href="features__import-3d-model.html">Import 3D Model</a></li><li><a href="features__loft.html">Loft</a></li><li><a href="features__mirror.html">Mirror</a></li><li><a href="features__offset-shell.html">Offset Shell</a></li><li><a href="features__pattern.html">Pattern</a></li><li><a href="features__pattern-linear.html">Pattern Linear</a></li><li><a href="features__pattern-radial.html">Pattern Radial</a></li><li><a href="features__plane.html">Plane</a></li><li><a href="features__polygon-solid.html">Polygon Solid</a></li><li><a href="features__primitive-cone.html">Primitive Cone</a></li><li><a href="features__primitive-cube.html">Primitive Cube</a></li><li><a href="features__primitive-cylinder.html">Primitive Cylinder</a></li><li><a href="features__primitive-pyramid.html">Primitive Pyramid</a></li><li><a href="features__primitive-sphere.html">Primitive Sphere</a></li><li><a href="features__primitive-torus.html">Primitive Torus</a></li><li><a href="features__remesh.html">Remesh</a></li><li><a href="features__revolve.html">Revolve</a></li><li><a href="features__sheet-metal-contour-flange.html">Sheet Metal Contour Flange</a></li><li><a href="features__sheet-metal-flange.html">Sheet Metal Flange</a></li><li><a href="features__sheet-metal-tab.html">Sheet Metal Tab</a></li><li><a href="features__sketch.html">Sketch</a></li><li><a href="features__smooth-with-subdivision.html">Smooth With Subdivision</a></li><li><a href="features__spline.html">Spline</a></li><li><a href="features__sweep.html">Sweep</a></li><li><a href="features__text-to-face.html">Text To Face</a></li><li><a href="features__transform.html">Transform</a></li><li><a href="features__tube.html">Tube</a></li></ul><h2>PMI Annotation Docs</h2><ul><li><a href="pmi-annotations__index.html">PMI Annotations Index</a></li><li><a href="pmi-annotations__angle-dimension.html">Angle Dimension</a></li><li><a href="pmi-annotations__explode-body.html">Explode Body</a></li><li><a href="pmi-annotations__hole-callout.html">Hole Callout</a></li><li><a href="pmi-annotations__leader.html">Leader</a></li><li><a href="pmi-annotations__linear-dimension.html">Linear Dimension</a></li><li><a href="pmi-annotations__note.html">Note</a></li><li><a href="pmi-annotations__radial-dimension.html">Radial Dimension</a></li></ul><h2>License Docs</h2><ul><li><a href="fonts-licenses.html">Font Licenses</a></li></ul>
|
|
144
|
+
<h1>Developer Docs Index</h1><p>This page is a quick entry point for implementation and integration docs.</p><h2>Embedding Quick Links</h2><ul><li><a href="cad-embed.html">CAD Embedding Guide (CadEmbed)</a></li><li><a href="sketcher2d-embed.html">2D Sketcher Embedding Guide</a></li></ul><h2>Start Here</h2><ul><li><a href="getting-started.html">Getting Started</a></li><li><a href="bug-reporting.html">Bug Reporting and Repro Test Cases</a></li><li><a href="https://discord.gg/R5KNAKrQ">Developer Discord</a></li><li><a href="api-examples.html">API Examples (Live Demos)</a></li><li><a href="brep-api.html">BREP API (BREP.js exports)</a></li><li><a href="brep-kernel.html">BREP Kernel (core classes & helpers)</a></li><li><a href="brep-model.html">BREP Model and Classes</a></li><li><a href="expressions.html">Expressions and Configurator</a></li><li><a href="part-history.html">PartHistory Reference</a></li><li><a href="how-it-works.html">How It Works</a></li><li><a href="whats-new.html">What's New</a></li><li><a href="highlights.html">Highlights</a></li></ul><h2>Live API Example Pages</h2><ul><li><a href="https://BREP.io/apiExamples/index.html">Examples Index</a></li><li><a href="https://BREP.io/apiExamples/BREP_Booleans.html">BREP Booleans</a></li><li><a href="https://BREP.io/apiExamples/BREP_Primitives.html">BREP Primitives</a></li><li><a href="https://BREP.io/apiExamples/BREP_Transforms.html">BREP Transforms</a></li><li><a href="https://BREP.io/apiExamples/BREP_Export.html">BREP Export</a></li><li><a href="https://BREP.io/apiExamples/Embeded_2D_Sketcher.html">Embeded 2D Sketcher</a></li><li><a href="https://BREP.io/apiExamples/Embeded_CAD.html">Embeded CAD</a></li><li><a href="https://BREP.io/apiExamples/Embeded_CAD_Integration_Test.html">Embeded CAD Integration Test</a></li></ul><h2>Sketch and Geometry APIs</h2><ul><li><a href="sketch-solver-2d.html">2D Sketch Solver (standalone)</a></li><li><a href="sketcher2d-embed.html">Embeddable 2D Sketcher</a></li><li><a href="cad-embed.html">Embeddable CAD App</a></li><li><a href="extruded-sketch-radius-embedding.html">Radius Metadata for Extruded Sketches</a></li><li><a href="cylindrical-face-radius-embedding.html">Cylindrical Face Radius Embedding</a></li><li><a href="topological-face-tracking.html">Topological Face Naming and Triangle Ownership</a></li><li><a href="solid-methods.html">Solid Methods</a></li><li><a href="simplified-radial-dimensions.html">Simplified Radial Dimensions</a></li></ul><h2>Application and UI Architecture</h2><ul><li><a href="history-systems.html">History Systems</a></li><li><a href="expressions.html">Expressions and Configurator</a></li><li><a href="feature-dimension-gizmos.html">Feature Dimension Gizmos (Developer)</a></li><li><a href="input-params-schema.html">Input Params Schema</a></li><li><a href="ui-overview.html">UI Overview (Browser)</a></li><li><a href="plugins.html">Plugins and Examples</a></li><li><a href="inspector.html">Inspector</a></li><li><a href="inspector-improvements.html">Inspector Improvements</a></li><li><a href="dialog-screenshots.html">Dialog Screenshots</a></li></ul><h2>Data and File IO</h2><ul><li><a href="file-formats.html">File Formats: Import and Export</a></li><li><a href="github-repo-storage.html">GitHub Repo Storage</a></li></ul><h2>Assembly Constraints</h2><ul><li><a href="assembly-constraints__solver.html">Constraint Solver</a></li><li><a href="assembly-constraints__angle-constraint.html">Angle Constraint</a></li><li><a href="assembly-constraints__coincident-constraint.html">Coincident Constraint</a></li><li><a href="assembly-constraints__distance-constraint.html">Distance Constraint</a></li><li><a href="assembly-constraints__fixed-constraint.html">Fixed Constraint</a></li><li><a href="assembly-constraints__parallel-constraint.html">Parallel Constraint</a></li><li><a href="assembly-constraints__touch-align-constraint.html">Touch Align Constraint</a></li></ul><h2>Feature and Mode Docs</h2><ul><li><a href="features__index.html">Features Index</a></li><li><a href="modes__modeling.html">Modeling Mode</a></li><li><a href="modes__sketch.html">Sketch Mode</a></li><li><a href="modes__pmi.html">PMI Mode</a></li><li><a href="modes__sheets.html">2D Sheets Mode</a></li></ul><h2>Feature Docs (Detailed)</h2><ul><li><a href="features__assembly-component.html">Assembly Component</a></li><li><a href="features__boolean.html">Boolean</a></li><li><a href="features__chamfer.html">Chamfer</a></li><li><a href="features__datium.html">Datium</a></li><li><a href="features__datum.html">Datum</a></li><li><a href="features__extrude.html">Extrude</a></li><li><a href="features__fillet.html">Fillet</a></li><li><a href="features__helix.html">Helix</a></li><li><a href="features__hole.html">Hole</a></li><li><a href="features__image-heightmap-solid.html">Image Heightmap Solid</a></li><li><a href="features__image-to-face.html">Image To Face</a></li><li><a href="features__import-3d-model.html">Import 3D Model</a></li><li><a href="features__loft.html">Loft</a></li><li><a href="features__mirror.html">Mirror</a></li><li><a href="features__offset-shell.html">Offset Shell</a></li><li><a href="features__pattern.html">Pattern</a></li><li><a href="features__pattern-linear.html">Pattern Linear</a></li><li><a href="features__pattern-radial.html">Pattern Radial</a></li><li><a href="features__plane.html">Plane</a></li><li><a href="features__polygon-solid.html">Polygon Solid</a></li><li><a href="features__primitive-cone.html">Primitive Cone</a></li><li><a href="features__primitive-cube.html">Primitive Cube</a></li><li><a href="features__primitive-cylinder.html">Primitive Cylinder</a></li><li><a href="features__primitive-pyramid.html">Primitive Pyramid</a></li><li><a href="features__primitive-sphere.html">Primitive Sphere</a></li><li><a href="features__primitive-torus.html">Primitive Torus</a></li><li><a href="features__remesh.html">Remesh</a></li><li><a href="features__revolve.html">Revolve</a></li><li><a href="features__sheet-metal-contour-flange.html">Sheet Metal Contour Flange</a></li><li><a href="features__sheet-metal-flange.html">Sheet Metal Flange</a></li><li><a href="features__sheet-metal-tab.html">Sheet Metal Tab</a></li><li><a href="features__sketch.html">Sketch</a></li><li><a href="features__smooth-with-subdivision.html">Smooth With Subdivision</a></li><li><a href="features__spline.html">Spline</a></li><li><a href="features__sweep.html">Sweep</a></li><li><a href="features__text-to-face.html">Text To Face</a></li><li><a href="features__transform.html">Transform</a></li><li><a href="features__tube.html">Tube</a></li></ul><h2>PMI Annotation Docs</h2><ul><li><a href="pmi-annotations__index.html">PMI Annotations Index</a></li><li><a href="pmi-annotations__angle-dimension.html">Angle Dimension</a></li><li><a href="pmi-annotations__explode-body.html">Explode Body</a></li><li><a href="pmi-annotations__hole-callout.html">Hole Callout</a></li><li><a href="pmi-annotations__leader.html">Leader</a></li><li><a href="pmi-annotations__linear-dimension.html">Linear Dimension</a></li><li><a href="pmi-annotations__note.html">Note</a></li><li><a href="pmi-annotations__radial-dimension.html">Radial Dimension</a></li></ul><h2>License Docs</h2><ul><li><a href="fonts-licenses.html">Font Licenses</a></li></ul>
|
|
145
145
|
</div>
|
|
146
146
|
</section>
|
|
147
147
|
</main>
|
|
@@ -141,7 +141,7 @@ a{color:var(--accent);text-decoration:none} a:hover{text-decoration:underline}
|
|
|
141
141
|
<section class="card doc-card">
|
|
142
142
|
|
|
143
143
|
<div class="prose">
|
|
144
|
-
<h1>Documentation Screenshots</h1><ol><li>Run <code>pnpm dev</code> and open at least one of the capture helper pages:</li><p>- <code><a href="http://127.0.0.1:5173/feature-dialog-capture.html" target="_blank" rel="noopener noreferrer">http://127.0.0.1:5173/feature-dialog-capture.html</a></code> - <code><a href="http://127.0.0.1:5173/pmi-dialog-capture.html" target="_blank" rel="noopener noreferrer">http://127.0.0.1:5173/pmi-dialog-capture.html</a></code> - <code><a href="http://127.0.0.1:5173/assembly-constraint-capture.html" target="_blank" rel="noopener noreferrer">http://127.0.0.1:5173/assembly-constraint-capture.html</a></code></p><li>With the dev server running, execute <code>pnpm capture</code> to export screenshots. Outputs land in:</li></ol><p>- <code>docs/features</code> (feature dialogs) - <code>docs/pmi-annotations</code> (PMI annotations) - <code>docs/assembly-constraints</code> (assembly constraints) - <code>docs/MODELING.png</code>, <code>docs/SKETCH.png</code>, <code>docs/PMI.png</code> - <code>docs/features/image-to-face-2D_dialog.png</code>, <code>docs/features/image-to-face-3D_dialog.png</code> - <code>docs/features/NURBS_Face_Solid_cage_editor.png</code> - Full-page documentation captures use a fixed viewport (<code>1200x760</code>) for consistent, smaller image size.</p><p>For the schema that drives these dialogs (field types, defaults, and selection filters), see <a href="input-params-schema.html">Input Params Schema</a>.</p><h2>Configuration</h2><p>Customize the automation with environment variables:</p><ul><li><code>CAPTURE_SCOPE=features,pmi,assembly,docs</code> limits which capture helpers are processed.</li><li><code>CAPTURE_BASE_URL=http://127.0.0.1:5174</code> points to a dev server running on a different host/port.</li><li><code>CAPTURE_URL</code> + <code>CAPTURE_OUTPUT</code> run a one-off capture against any URL.</li><li><code>CAPTURE_HEADLESS=true</code> runs without showing the browser window (default is headed so you can watch captures live).</li><li><code>CAPTURE_KEEP_OPEN=false</code> closes the browser immediately after capture (default keeps it open in headed mode; press <code>Ctrl+C</code> to exit).</li><li><code>CAPTURE_SKIP_HISTORY_DIALOGS=true</code> skips any dialog whose name includes <code>History</code>.</li><p>- Equivalent pnpm flag: <code>pnpm capture --capture-skip-history=true</code></p><li><code>CAPTURE_DEVICE_SCALE_FACTOR=1</code> (default <code>2</code>) controls the browser’s device pixel ratio for sharper or softer renders.</li><li><code>CAPTURE_OUTPUT_SCALE=device</code> keeps the full hi-DPI image size instead of downscaling back to CSS pixels (default <code>css</code> keeps the files small while retaining clarity).</li></ul>
|
|
144
|
+
<h1>Documentation Screenshots</h1><ol><li>Run <code>pnpm dev</code> and open at least one of the capture helper pages:</li><p>- <code><a href="http://127.0.0.1:5173/feature-dialog-capture.html" target="_blank" rel="noopener noreferrer">http://127.0.0.1:5173/feature-dialog-capture.html</a></code> - <code><a href="http://127.0.0.1:5173/pmi-dialog-capture.html" target="_blank" rel="noopener noreferrer">http://127.0.0.1:5173/pmi-dialog-capture.html</a></code> - <code><a href="http://127.0.0.1:5173/assembly-constraint-capture.html" target="_blank" rel="noopener noreferrer">http://127.0.0.1:5173/assembly-constraint-capture.html</a></code></p><li>With the dev server running, execute <code>pnpm capture</code> to export screenshots. Outputs land in:</li></ol><p>- <code>docs/features</code> (feature dialogs) - <code>docs/pmi-annotations</code> (PMI annotations) - <code>docs/assembly-constraints</code> (assembly constraints) - <code>docs/MODELING.png</code>, <code>docs/SKETCH.png</code>, <code>docs/PMI.png</code> - <code>docs/expressions-panel.png</code>, <code>docs/configurator-editor.png</code>, <code>docs/configurator-field-types.png</code> - <code>docs/features/image-to-face-2D_dialog.png</code>, <code>docs/features/image-to-face-3D_dialog.png</code> - <code>docs/features/NURBS_Face_Solid_cage_editor.png</code> - Full-page documentation captures use a fixed viewport (<code>1200x760</code>) for consistent, smaller image size.</p><p>For the schema that drives these dialogs (field types, defaults, and selection filters), see <a href="input-params-schema.html">Input Params Schema</a>.</p><h2>Configuration</h2><p>Customize the automation with environment variables:</p><ul><li><code>CAPTURE_SCOPE=features,pmi,assembly,docs</code> limits which capture helpers are processed.</li><li><code>CAPTURE_BASE_URL=http://127.0.0.1:5174</code> points to a dev server running on a different host/port.</li><li><code>CAPTURE_URL</code> + <code>CAPTURE_OUTPUT</code> run a one-off capture against any URL.</li><li><code>CAPTURE_HEADLESS=true</code> runs without showing the browser window (default is headed so you can watch captures live).</li><li><code>CAPTURE_KEEP_OPEN=false</code> closes the browser immediately after capture (default keeps it open in headed mode; press <code>Ctrl+C</code> to exit).</li><li><code>CAPTURE_SKIP_HISTORY_DIALOGS=true</code> skips any dialog whose name includes <code>History</code>.</li><p>- Equivalent pnpm flag: <code>pnpm capture --capture-skip-history=true</code></p><li><code>CAPTURE_DEVICE_SCALE_FACTOR=1</code> (default <code>2</code>) controls the browser’s device pixel ratio for sharper or softer renders.</li><li><code>CAPTURE_OUTPUT_SCALE=device</code> keeps the full hi-DPI image size instead of downscaling back to CSS pixels (default <code>css</code> keeps the files small while retaining clarity).</li></ul>
|
|
145
145
|
</div>
|
|
146
146
|
</section>
|
|
147
147
|
</main>
|
|
Binary file
|