npm - brep-io-kernel - Versions diffs - 1.0.0 → 1.0.11 - Mend

brep-io-kernel 1.0.0 → 1.0.11

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 (134) hide show

package/dist-kernel/help/simplified-radial-dimensions.html DELETED Viewed

@@ -1,298 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-<meta charset="utf-8" />
-<meta name="viewport" content="width=device-width,initial-scale=1" />
-<title>Simplified Radial Dimension Interface - BREP</title>
-<style>
-:root{
-  --bg:#0b0f14; --panel:#0f141b; --text:#d7dde6; --muted:#9aa7b2;
-  --border:#1b2430; --accent:#5cc8ff; --chip:#121823;
-}
-*{box-sizing:border-box}
-html,body{margin:0;background:var(--bg);color:var(--text);font:14px/1.5 ui-monospace,SFMono-Regular,Menlo,Consolas,'Liberation Mono','Courier New',monospace}
-main{max-width:1100px;margin:0 auto;padding:28px}
-h1{margin:0 0 18px;font-size:22px;color:var(--accent);font-weight:700}
-.summary{color:var(--muted);margin-bottom:22px}
-.card{background:var(--panel);border:1px solid var(--border);border-radius:14px;padding:18px;margin:0 0 18px}
-.readme{padding:0}
-.readme .header{padding:16px 18px;border-bottom:1px solid var(--border)}
-.readme .content{padding:18px}
-.doc-card{padding:18px}
-.doc-nav{margin:0 0 18px;display:flex;gap:12px;flex-wrap:wrap;align-items:center;color:var(--muted)}
-.doc-nav-links{display:flex;gap:12px;flex-wrap:wrap;align-items:center}
-.doc-nav a{color:var(--accent);font-weight:600}
-.doc-list{list-style:none;margin:18px 0;padding:0}
-.doc-list li{margin:6px 0}
-.doc-list a{color:var(--accent)}
-.nav-search{margin-left:auto;position:relative;display:flex;align-items:center;gap:8px;flex-wrap:wrap;justify-content:flex-end;min-width:240px;max-width:520px}
-.search-title{font-weight:700;font-size:14px;margin-bottom:4px}
-.search-hint{color:var(--muted);font-size:12px;margin:0}
-.search-input-row{display:flex;gap:8px;align-items:center;width:100%}
-.search-input{flex:1;border:1px solid var(--border);border-radius:10px;background:var(--chip);color:var(--text);padding:10px 12px}
-.search-input:focus{outline:1px solid var(--accent);box-shadow:0 0 0 3px rgba(92,200,255,0.15)}
-.search-clear{border:1px solid var(--border);background:var(--panel);color:var(--muted);border-radius:10px;padding:9px 12px;cursor:pointer;font-weight:600}
-.search-clear:hover{border-color:var(--accent);color:var(--accent)}
-.search-status{color:var(--muted);font-size:12px;margin-top:4px;width:100%;text-align:right}
-.search-results{position:absolute;top:100%;right:0;margin-top:10px;border:1px solid var(--border);border-radius:12px;background:var(--panel);max-height:360px;overflow:auto;min-width:320px;max-width:520px;box-shadow:0 12px 30px rgba(0,0,0,0.35);z-index:25}
-.search-results ul{list-style:none;margin:0;padding:0}
-.search-item{padding:10px 12px;border-bottom:1px solid var(--border)}
-.search-item:last-child{border-bottom:none}
-.search-item a{display:block;color:var(--accent);font-weight:600}
-.search-snippet{color:var(--muted);font-size:13px;margin-top:4px}
-.search-results mark{background:rgba(92,200,255,0.2);color:var(--text);border-radius:4px;padding:0 2px}
-.prose h1{font-size:24px;margin:0 0 12px}
-.prose h2{font-size:18px;margin:18px 0 8px}
-.prose h3{font-size:16px;margin:14px 0 6px}
-.prose p{margin:0 0 10px}
-.prose ul,.prose ol{margin:0 0 10px 18px}
-.prose li{margin:4px 0}
-.prose code{background:#0d1520;border:1px solid var(--border);padding:1px 5px;border-radius:6px;font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,'Liberation Mono','Courier New',monospace;font-size:12px}
-.prose pre{background:#0d1520;border:1px solid var(--border);padding:12px;border-radius:12px;overflow:auto}
-.prose a{color:var(--accent)}
-.prose img{max-width:100%;height:auto;}
-.prose table{border-collapse:collapse;width:100%;margin:16px 0;background:var(--panel);border:1px solid var(--border);border-radius:8px;overflow:hidden}
-.prose th,.prose td{padding:8px 12px;text-align:left;border-bottom:1px solid var(--border)}
-.prose th{background:var(--chip);color:var(--text);font-weight:600;font-size:13px}
-.prose tr:last-child td{border-bottom:none}
-.prose tbody tr:hover{background:rgba(92,200,255,0.05)}
-.license{
-  background:var(--panel);border:1px solid var(--border);border-radius:14px;
-  padding:16px 16px 8px;margin:0 0 18px;
-}
-.license > h2{margin:0 0 10px;font-size:16px;font-weight:700}
-.pkg{
-  border-top:1px solid var(--border);padding:10px 0;
-  display:grid;grid-template-columns:1fr auto;gap:10px;align-items:center;
-}
-.pkg:first-of-type{border-top:none}
-.pkg .meta{display:flex;gap:10px;flex-wrap:wrap}
-.pkg .name{font-weight:600}
-.pkg .desc{color:var(--muted);margin-top:2px}
-a{color:var(--accent);text-decoration:none} a:hover{text-decoration:underline}
-.chip{background:var(--chip);border:1px solid var(--border);border-radius:999px;padding:2px 8px;font-size:12px;color:var(--muted)}
-.footer{margin-top:26px;color:var(--muted);font-size:12px}
-</style>
-</head>
-<body>
-<main>
-  <nav class="doc-nav">
-    <div class="doc-nav-links">
-      <a href="index.html">Help Home</a><span>&middot;</span><a href="/help/table-of-contents.html">Table of Contents</a><span>&middot;</span><a href="https://github.com/mmiscool/BREP" target="_blank" rel="noopener noreferrer">GitHub</a>
-    </div>
-    <div class="nav-search">
-      <div class="search-input-row">
-        <input type="search" id="doc-search" class="search-input" placeholder="Search docs... Type at least 2 characters to search" autocomplete="off" spellcheck="false" />
-        <button type="button" class="search-clear" id="doc-search-clear">Clear</button>
-      </div>
-      <div class="search-status" id="doc-search-status"></div>
-      <div class="search-results" id="doc-search-results" hidden>
-        <ul id="doc-search-list"></ul>
-      </div>
-    </div>
-  </nav>
-  <section class="card doc-card">
-    <div class="prose">
-<h1>Simplified Radial Dimension Interface</h1><p>The radial dimension interface has been significantly simplified to take advantage of embedded radius metadata in cylindrical faces. Users now only need to select the cylindrical face itself, rather than manually specifying center points and edges.</p><h2>New Interface</h2><h3>Required Input</h3><ul><li><strong>Cylindrical Face</strong>: Select any cylindrical face (from primitives, extrusions, etc.)</li></ul><h3>Optional Inputs</h3><ul><li><strong>Projection Plane</strong>: Optional face to define the drawing plane for the dimension</li><li><strong>Display Style</strong>: Choose between radius (R) or diameter (⌀) display</li><li><strong>Alignment</strong>: Control dimension orientation (view, XY, YZ, ZX)</li><li><strong>Offset</strong>: Adjust dimension line offset distance</li><li><strong>Decimals</strong>: Number of decimal places to display</li><li><strong>Reference</strong>: Mark as reference dimension (parentheses)</li></ul><h2>Usage Examples</h2><h3>Basic Cylindrical Face Selection</h3><p><pre><code>javascript
-// Create a radial dimension
-const radialDim = RadialDimension.create(pmiMode);
-// Simply select the cylindrical face - that&#39;s it!
-radialDim.cylindricalFaceRef = &#39;MyCylinder_S&#39;;
-radialDim.displayStyle = &#39;radius&#39;; // or &#39;diameter&#39;
-// The system automatically:
-// 1. Extracts radius from face metadata
-// 2. Determines cylinder center and axis
-// 3. Creates appropriate dimension geometry</code></pre></p><h3>With Projection Plane</h3><p><pre><code>javascript
-// For dimensions that need specific orientation
-radialDim.cylindricalFaceRef = &#39;MyCylinder_S&#39;;
-radialDim.planeRef = &#39;WorkPlane_XY&#39;; // Optional projection plane
-radialDim.displayStyle = &#39;diameter&#39;;</code></pre></p><h2>Benefits of the New Interface</h2><h3>1. <strong>Simplified Workflow</strong></h3><ul><li><strong>Before</strong>: Select center point → Select edge/arc → Configure alignment</li><li><strong>After</strong>: Select cylindrical face → Done!</li></ul><h3>2. <strong>Automatic Precision</strong></h3><ul><li>Uses exact radius values from original geometry</li><li>No approximation errors from triangle mesh sampling</li><li>Consistent measurements regardless of mesh resolution</li></ul><h3>3. <strong>Intelligent Detection</strong></h3><ul><li>Automatically works with:</li></ul><p>- Primitive cylinders (<code>BREP.Cylinder</code>) - Extruded circular sketches - Revolved circular profiles - Boolean operation results</p><h3>4. <strong>Robust Behavior</strong></h3><ul><li>Gracefully handles transformations (rotation, scaling, translation)</li><li>Preserves accuracy through boolean operations</li><li>Maintains metadata through complex modeling operations</li></ul><h2>Supported Cylindrical Sources</h2><h3>Primitive Cylinders</h3><p><pre><code>javascript
-const cylinder = new BREP.Cylinder({
-    radius: 5.0,
-    height: 10.0,
-    name: &#39;Pipe&#39;
-});
-// Side face &#39;Pipe_S&#39; automatically gets radius metadata</code></pre></p><h3>Extruded Circles</h3><p><pre><code>javascript
-const extruded = new BREP.ExtrudeSolid({
-    face: circularSketch, // Circle with radius 3.0
-    distance: 8.0
-});
-// Side wall gets cylindrical metadata with radius 3.0</code></pre></p><h3>Equal-Radius Cones</h3><p><pre><code>javascript
-const cylinder = new BREP.Cone({
-    r1: 4.0,
-    r2: 4.0, // Equal radii = cylindrical
-    h: 12.0
-});
-// Treated as cylindrical face with radius 4.0</code></pre></p><h2>Technical Implementation</h2><h3>Metadata Structure</h3><p>Cylindrical faces store this metadata: <pre><code>javascript
-{
-    type: &#39;cylindrical&#39;,
-    radius: 5.0,
-    height: 10.0,
-    axis: [0, 1, 0],      // Unit vector along cylinder axis
-    center: [0, 5.0, 0]   // Center point of cylinder axis
-}</code></pre></p><h3>Dimension Calculation</h3><ol><li><strong>Face Selection</strong>: User selects cylindrical face</li><li><strong>Metadata Lookup</strong>: System retrieves stored radius value</li><li><strong>Geometry Computation</strong>: Calculates center, axis, and surface points</li><li><strong>Projection</strong>: Applies any plane constraints or alignment rules</li><li><strong>Rendering</strong>: Draws dimension with exact radius value</li></ol><h3>Fallback Behavior</h3><p>If metadata is not available (legacy geometry), the system automatically falls back to geometric calculation from triangle mesh, ensuring backward compatibility.</p><h2>Migration from Old Interface</h2><h3>Old Schema (Deprecated)</h3><p><pre><code>javascript
-{
-    centerRef: &#39;CenterVertex&#39;,  // ❌ No longer needed
-    edgeRef: &#39;CircularEdge&#39;,    // ❌ No longer needed
-    planeRef: &#39;ProjectionFace&#39;, // ✓ Still optional
-    // ... other settings
-}</code></pre></p><h3>New Schema</h3><p><pre><code>javascript
-{
-    cylindricalFaceRef: &#39;Cylinder_S&#39;,  // ✓ Simple face selection
-    planeRef: &#39;ProjectionFace&#39;,        // ✓ Optional projection plane
-    // ... other settings (unchanged)
-}</code></pre></p><h2>Error Handling</h2><h3>Invalid Face Selection</h3><ul><li><strong>Non-cylindrical faces</strong>: Dimension creation fails gracefully</li><li><strong>Missing metadata</strong>: Falls back to geometric calculation</li><li><strong>Transformed geometry</strong>: Automatically applies transformations</li></ul><h3>Missing References</h3><ul><li><strong>No cylindrical face</strong>: Shows error message in UI</li><li><strong>Invalid plane reference</strong>: Uses view alignment as fallback</li><li><strong>Corrupted metadata</strong>: Attempts geometric reconstruction</li></ul><h2>Performance Benefits</h2><ul><li><strong>No geometric analysis</strong>: Direct metadata lookup vs mesh processing</li><li><strong>Reduced computation</strong>: Skip center/radius finding algorithms</li><li><strong>Faster updates</strong>: Dimension updates use cached metadata values</li><li><strong>Lower memory</strong>: No need to store intermediate geometric calculations</li></ul><h2>Future Enhancements</h2><p>This simplified interface enables future improvements:</p><ol><li><strong>Smart Face Detection</strong>: Auto-suggest cylindrical faces when tool is activated</li><li><strong>Multi-Radius Display</strong>: Show both inner/outer radii for thick cylinders</li><li><strong>Tolerance Integration</strong>: Display radius tolerances from design intent</li><li><strong>Parametric Updates</strong>: Dimensions update automatically when model changes</li></ol>
-    </div>
-  </section>
-</main>
-<script>
-(() => {
-  const searchInput = document.getElementById("doc-search");
-  const resultsBox = document.getElementById("doc-search-results");
-  const resultsList = document.getElementById("doc-search-list");
-  const statusEl = document.getElementById("doc-search-status");
-  const clearBtn = document.getElementById("doc-search-clear");
-  if (!searchInput || !resultsBox || !resultsList || !statusEl || !clearBtn) return;
-  const indexUrl = "./search-index.json";
-  let indexPromise = null;
-  let cachedEntries = null;
-  const escapeHtml = (text = "") =>
-    text
-      .replace(/&/g, "&amp;")
-      .replace(/</g, "&lt;")
-      .replace(/>/g, "&gt;");
-  const escapeRegExp = (text = "") => text.replace(/[.*+?^{}()|[]\$]/g, "\$&");
-  const highlight = (text, terms) => {
-    if (!terms.length) return escapeHtml(text);
-    const pattern = terms.map(escapeRegExp).join("|");
-    const regex = new RegExp(`(${pattern})`, "gi");
-    return escapeHtml(text).replace(regex, "<mark>$1</mark>");
-  };
-  const buildSnippet = (entry, terms) => {
-    const source = entry.content || entry.summary || "";
-    if (!source) return { plain: "", highlighted: "" };
-    let hit = source.length;
-    for (const term of terms) {
-      const idx = entry.contentLower.indexOf(term);
-      if (idx !== -1 && idx < hit) hit = idx;
-    }
-    if (!Number.isFinite(hit) || hit === source.length) hit = 0;
-    const start = Math.max(0, hit - 60);
-    const end = Math.min(source.length, hit + 140);
-    const snippet = source.slice(start, end);
-    return { plain: snippet, highlighted: highlight(snippet, terms) };
-  };
-  const updateStatus = (message) => {
-    statusEl.textContent = message;
-  };
-  const loadIndex = async () => {
-    if (cachedEntries) return cachedEntries;
-    if (!indexPromise) {
-      indexPromise = fetch(indexUrl, { cache: "no-store" })
-        .then((res) => {
-          if (!res.ok) throw new Error("Failed to load search index");
-          return res.json();
-        })
-        .then((json) => {
-          cachedEntries = Array.isArray(json)
-            ? json.map((entry) => ({
-                ...entry,
-                contentLower: (entry.content || "").toLowerCase(),
-                titleLower: (entry.title || "").toLowerCase(),
-              }))
-            : [];
-          return cachedEntries;
-        })
-        .catch((err) => {
-          console.error("Search index load failed", err);
-          cachedEntries = [];
-          throw err;
-        });
-    }
-    return indexPromise;
-  };
-  const renderResults = (entries, terms) => {
-    if (!terms.length) {
-      resultsBox.hidden = true;
-      return;
-    }
-    if (!entries.length) {
-      resultsList.innerHTML = '<li class="search-item"><div class="search-snippet">No matches found.</div></li>';
-      resultsBox.hidden = false;
-      return;
-    }
-    const rendered = entries
-      .slice(0, 30)
-      .map((entry) => {
-        const snippet = buildSnippet(entry, terms);
-        const title = highlight(entry.title || entry.href, terms);
-        const hasFragment = snippet.plain && snippet.plain.trim().length > 0;
-        const fragment = hasFragment ? `#:~:text=${encodeURIComponent(snippet.plain.trim())}` : "";
-        const hrefWithFragment = hasFragment
-          ? (entry.href.includes("#") ? `${entry.href}&:~:text=${encodeURIComponent(snippet.plain.trim())}` : `${entry.href}${fragment}`)
-          : entry.href;
-        const snippetHtml = snippet.highlighted ? `<div class="search-snippet">${snippet.highlighted}</div>` : "";
-        return `<li class="search-item"><a href="${hrefWithFragment}">${title}</a>${snippetHtml}</li>`;
-      })
-      .join("");
-    resultsList.innerHTML = rendered;
-    resultsBox.hidden = false;
-  };
-  const performSearch = async () => {
-    const rawQuery = searchInput.value.trim();
-    if (rawQuery.length < 2) {
-      updateStatus("Type at least 2 characters to search.");
-      resultsBox.hidden = true;
-      return;
-    }
-    const terms = rawQuery.toLowerCase().split(/\s+/).filter(Boolean);
-    updateStatus("Searching...");
-    try {
-      const entries = await loadIndex();
-      const matches = entries.filter((entry) =>
-        terms.every((term) => entry.contentLower.includes(term) || entry.titleLower.includes(term))
-      );
-      renderResults(matches, terms);
-      updateStatus(matches.length ? `${matches.length} result${matches.length === 1 ? "" : "s"} for "${rawQuery}"` : "No matches found.");
-    } catch (err) {
-      updateStatus("Search unavailable (could not load index).");
-    }
-  };
-  searchInput.addEventListener("input", performSearch);
-  searchInput.addEventListener("focus", () => {
-    if (!cachedEntries) {
-      loadIndex().catch(() => updateStatus("Search unavailable (could not load index)."));
-    }
-  });
-  clearBtn.addEventListener("click", () => {
-    searchInput.value = "";
-    resultsBox.hidden = true;
-    updateStatus("Type at least 2 characters to search.");
-    searchInput.focus();
-  });
-  document.addEventListener("keydown", (evt) => {
-    if (evt.key === "Escape" && document.activeElement === searchInput) {
-      searchInput.value = "";
-      resultsBox.hidden = true;
-      updateStatus("Type at least 2 characters to search.");
-    }
-  });
-})();
-</script>
-</body>
-</html>