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

brep-io-kernel 1.0.0 → 1.0.12

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/extruded-sketch-radius-embedding.html DELETED Viewed

@@ -1,336 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-<meta charset="utf-8" />
-<meta name="viewport" content="width=device-width,initial-scale=1" />
-<title>Radius Metadata for Extruded Sketches - 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>Radius Metadata for Extruded Sketches</h1><p>This document details how radius metadata is automatically embedded when extruding circular or arc-based sketch elements.</p><h2>How It Works</h2><h3>Automatic Detection</h3><p>When extruding a sketch face, the system automatically scans all edges in the sketch for circular geometry:</p><ol><li><strong>Circle Detection</strong>: Edges with <code>sketchGeomType: &#39;circle&#39;</code> and radius/center data</li><li><strong>Arc Detection</strong>: Edges with <code>sketchGeomType: &#39;arc&#39;</code> and radius/center data (any arc angle)</li><li><strong>Metadata Application</strong>: Cylindrical face metadata is applied to the resulting side walls</li></ol><h3>Edge Data Requirements</h3><p>For automatic detection, sketch edges need this <code>userData</code> structure:</p><h4>Circles</h4><p><pre><code>javascript
-edge.userData = {
-    sketchGeomType: &#39;circle&#39;,
-    circleCenter: [x, y, z],     // Center point in local coordinates
-    circleRadius: number         // Radius value
-}</code></pre></p><h4>Arcs</h4><p><pre><code>javascript
-edge.userData = {
-    sketchGeomType: &#39;arc&#39;,
-    arcCenter: [x, y, z],        // Center point in local coordinates
-    arcRadius: number,           // Radius value
-    arcAngle: number            // Arc angle in radians (any value)
-}</code></pre></p><h2>Generated Metadata</h2><h3>Cylindrical Face Metadata Structure</h3><p><pre><code>javascript
-{
-    type: &#39;cylindrical&#39;,
-    radius: 6.5,                    // Original radius from sketch
-    height: 12.0,                   // Extrusion distance
-    axis: [0, 1, 0],               // Extrusion direction (normalized)
-    center: [0, 6.0, 0]            // Center point along cylinder axis
-}</code></pre></p><h3>Face Naming Convention</h3><p>Side walls are named using the pattern: <code>${featureName}:${edgeName}_SW</code></p><p>Examples:</p><ul><li><code>ExtrudedPart:CircleEdge1_SW</code></li><li><code>HousingExtrude:OuterCircle_SW</code></li><li><code>EXTRUDE_001:ArcEdge_SW</code></li></ul><h2>Coordinate Transformations</h2><h3>Local to World Conversion</h3><p>The system properly handles coordinate transformations:</p><ol><li><strong>Edge Transforms</strong>: If the edge has a <code>matrixWorld</code>, center points are transformed</li><li><strong>Extrusion Direction</strong>: Direction vectors are transformed through the edge matrix</li><li><strong>Final Positioning</strong>: Center points are positioned along the extrusion axis</li></ol><h3>Example Transformation</h3><p><pre><code>javascript
-// Original sketch data (local coordinates)
-circleCenter: [5, 0, 3]
-circleRadius: 2.5
-// After transformation and extrusion
-metadata: {
-    center: [5, 6.0, 3],  // Moved to mid-height of extrusion
-    radius: 2.5,          // Preserved original radius
-    height: 12.0,         // Total extrusion distance
-    axis: [0, 1, 0]       // Normalized extrusion direction
-}</code></pre></p><h2>Supported Sketch Configurations</h2><h3>Single Circle</h3><p><pre><code>javascript
-// Sketch with one circular edge
-edges: [
-    {
-        userData: {
-            sketchGeomType: &#39;circle&#39;,
-            circleCenter: [0, 0, 0],
-            circleRadius: 5.0
-        }
-    }
-]
-// Results in one cylindrical face with radius 5.0</code></pre></p><h3>Multiple Circles (Ring/Tube)</h3><p><pre><code>javascript
-// Sketch with outer and inner circles
-edges: [
-    { userData: { sketchGeomType: &#39;circle&#39;, circleRadius: 10.0 } }, // Outer
-    { userData: { sketchGeomType: &#39;circle&#39;, circleRadius: 6.0 } }   // Inner
-]
-// Results in two cylindrical faces with different radii</code></pre></p><h3>Arc Segments</h3><p><pre><code>javascript
-// Sketch with arc edges
-edges: [
-    { userData: { sketchGeomType: &#39;arc&#39;, arcRadius: 8.0, arcAngle: Math.PI } }
-]
-// Results in cylindrical face with radius 8.0 (angle doesn&#39;t matter for extrusion)</code></pre></p><h3>Mixed Geometry</h3><p><pre><code>javascript
-// Sketch with circles, arcs, and lines
-edges: [
-    { userData: { sketchGeomType: &#39;circle&#39;, circleRadius: 4.0 } },
-    { userData: { sketchGeomType: &#39;arc&#39;, arcRadius: 7.0 } },
-    { userData: { sketchGeomType: &#39;line&#39; } }  // Ignored - not circular
-]
-// Results in two cylindrical faces (4.0 and 7.0 radius)</code></pre></p><h2>Integration with PMI Dimensions</h2><h3>Automatic Radius Detection</h3><p>When creating radial dimensions:</p><ol><li><strong>Face Selection</strong>: User selects any extruded cylindrical face</li><li><strong>Metadata Lookup</strong>: System finds embedded radius from original sketch</li><li><strong>Precise Measurement</strong>: Uses exact radius value instead of geometric approximation</li></ol><h3>Example Usage</h3><p><pre><code>javascript
-// Create radial dimension
-const radialDim = RadialDimension.create(pmiMode);
-radialDim.cylindricalFaceRef = &#39;ExtrudedCircle:OuterRing_SW&#39;;
-// System automatically uses radius: 7.5 from original sketch geometry
-// No need to specify center points or edge references</code></pre></p><h2>Error Handling</h2><h3>Missing or Invalid Data</h3><ul><li><strong>No sketch geometry</strong>: Falls back to geometric calculation from mesh</li><li><strong>Invalid radius values</strong>: Skips metadata embedding for that edge</li><li><strong>Transform errors</strong>: Uses identity transform as fallback</li><li><strong>Duplicate edges</strong>: Each edge gets its own metadata entry</li></ul><h3>Graceful Degradation</h3><p><pre><code>javascript
-try {
-    // Attempt metadata embedding
-    this.setFaceMetadata(faceName, metadata);
-} catch (err) {
-    // Silently continue - dimension system will fall back to geometric calculation
-}</code></pre></p><h2>Performance Benefits</h2><h3>Computational Efficiency</h3><ul><li><strong>Direct Lookup</strong>: O(1) metadata retrieval vs O(n) mesh analysis</li><li><strong>No Approximation</strong>: Exact values from design intent</li><li><strong>Cached Results</strong>: Metadata persists through boolean operations</li></ul><h3>Memory Usage</h3><ul><li><strong>Minimal Overhead</strong>: Small metadata objects per cylindrical face</li><li><strong>Selective Storage</strong>: Only circular/arc edges generate metadata</li><li><strong>Automatic Cleanup</strong>: Metadata removed when faces are deleted</li></ul><h2>Future Enhancements</h2><h3>Additional Geometry Types</h3><ul><li><strong>Elliptical Arcs</strong>: Store major/minor axis information</li><li><strong>Spline Curves</strong>: Store control point and knot data</li><li><strong>Complex Profiles</strong>: Multi-radius and transitional curves</li></ul><h3>Enhanced Metadata</h3><p><pre><code>javascript
-// Future expanded metadata structure
-{
-    type: &#39;cylindrical&#39;,
-    radius: 5.0,
-    height: 10.0,
-    axis: [0, 1, 0],
-    center: [0, 5.0, 0],
-    // Enhanced information
-    sourceSketch: &#39;Sketch001&#39;,
-    sourceEdge: &#39;Circle1&#39;,
-    tolerance: {
-        radius: ±0.1,
-        position: ±0.05
-    },
-    materialThickness: 2.0,
-    surfaceFinish: &#39;machined&#39;
-}</code></pre></p><p>This system provides exact radius information for dimensioning while maintaining backward compatibility with existing geometric calculation methods.</p>
-    </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>