Archived
922 lines
28 KiB
HTML
922 lines
28 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class CarveStl | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class CarveStl | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="A triangle mesh that can be carved: an exact-fraction topology graph with an incrementally maintained spatial index, mutated in place by exact boolean steps ( / ). Unlike (build-once sweeping input), this object is long-lived and accumulates cut geometry step after step; sharp edges and exact planar faces survive the booleans exactly. Not thread-safe.">
|
|
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../public/main.css">
|
|
<meta name="docfx:navrel" content="../toc.html">
|
|
<meta name="docfx:tocrel" content="toc.html">
|
|
|
|
<meta name="docfx:rel" content="../">
|
|
|
|
|
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
|
|
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="Hi.Geom.Topo.CarveStl">
|
|
|
|
|
|
|
|
<h1 id="Hi_Geom_Topo_CarveStl" data-uid="Hi.Geom.Topo.CarveStl" class="text-break">
|
|
Class CarveStl
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Geom.html">Geom</a>.<a class="xref" href="Hi.Geom.Topo.html">Topo</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiDisp.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>A triangle mesh that can be carved: an exact-fraction topology graph with
|
|
an incrementally maintained spatial index, mutated in place by exact
|
|
boolean steps (<a class="xref" href="Hi.Geom.Topo.CarveStl.html#Hi_Geom_Topo_CarveStl_SubstractVolume_Hi_Geom_Stl_System_Double_">SubstractVolume(Stl, double)</a> /
|
|
<a class="xref" href="Hi.Geom.Topo.CarveStl.html#Hi_Geom_Topo_CarveStl_AddVolume_Hi_Geom_Stl_System_Double_">AddVolume(Stl, double)</a>). Unlike
|
|
<a class="xref" href="Hi.Geom.Topo.NativeTopoStl3wfr.html">NativeTopoStl3wfr</a> (build-once sweeping input), this object is
|
|
long-lived and accumulates cut geometry step after step; sharp edges and
|
|
exact planar faces survive the booleans exactly. Not thread-safe.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class CarveStl : IDisposable, IDisplayee, IExpandToBox3d</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="typelist inheritance">
|
|
<dt>Inheritance</dt>
|
|
<dd>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
|
<div><span class="xref">CarveStl</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
|
<div><a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a></div>
|
|
<div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<dl class="typelist inheritedMembers">
|
|
<dt>Inherited Members</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="typelist extensionMethods">
|
|
<dt>Extension Methods</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="Hi.Disp.DispUtil.html#Hi_Disp_DispUtil_Display_Hi_Disp_IDisplayee_Hi_Disp_Bind_Hi_Geom_Mat4d_">DispUtil.Display(IDisplayee, Bind, Mat4d)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
|
|
|
|
<h2 id="Hi_Geom_Topo_CarveStl_remarks">Remarks</h2>
|
|
<div class="markdown level0 remarks"><p>Conversion loss, by source:</p>
|
|
<ul><li><a class="xref" href="Hi.Geom.Topo.NativeTopoStl3wfr.html">NativeTopoStl3wfr</a> and another
|
|
<a class="xref" href="Hi.Geom.Topo.CarveStl.html">CarveStl</a> are already exact fractions, so those overloads copy
|
|
coordinates verbatim and take no tolerance — the only lossless inbound
|
|
paths.</li><li><a class="xref" href="Hi.Geom.Stl.html">Stl</a> and <a class="xref" href="Hi.Geom.Topo.NativeTopoStl3d.html">NativeTopoStl3d</a> hold
|
|
doubles, which have no small-denominator exact form, so those overloads
|
|
convert at <code>fractionTolerance</code>. The loss is inherent to the source
|
|
type, not to the route: converting such a mesh by any other path costs the
|
|
same.</li><li>Outbound, <a class="xref" href="Hi.Geom.Topo.CarveStl.html#Hi_Geom_Topo_CarveStl_GenStl">GenStl()</a> evaluates to double, so a
|
|
carved result round-tripped through it loses the compound coordinates the
|
|
booleans produced. Keep the <a class="xref" href="Hi.Geom.Topo.CarveStl.html">CarveStl</a> itself, or pass it
|
|
directly as a tool, when the exact surface is the deliverable.</li></ul>
|
|
</div>
|
|
|
|
|
|
<h2 class="section" id="constructors">Constructors
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl__ctor_" data-uid="Hi.Geom.Topo.CarveStl.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl__ctor_Hi_Geom_Stl_System_Double_" data-uid="Hi.Geom.Topo.CarveStl.#ctor(Hi.Geom.Stl,System.Double)">
|
|
CarveStl(Stl, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes the container from an STL model. The triangles are
|
|
converted to exact fractions at <code class="paramref">fractionTolerance</code>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveStl(Stl stl, double fractionTolerance)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>stl</code> <a class="xref" href="Hi.Geom.Stl.html">Stl</a></dt>
|
|
<dd><p>The initial workpiece mesh (a closed shell).</p>
|
|
</dd>
|
|
<dt><code>fractionTolerance</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The tolerance for fraction conversion.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl__ctor_" data-uid="Hi.Geom.Topo.CarveStl.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl__ctor_Hi_Geom_Topo_CarveStl_" data-uid="Hi.Geom.Topo.CarveStl.#ctor(Hi.Geom.Topo.CarveStl)">
|
|
CarveStl(CarveStl)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes the container as an exact copy of another
|
|
<a class="xref" href="Hi.Geom.Topo.CarveStl.html">CarveStl</a> — a snapshot that later boolean steps on either
|
|
object leave untouched. Lossless.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveStl(CarveStl src)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Geom.Topo.CarveStl.html">CarveStl</a></dt>
|
|
<dd><p>The container to copy.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl__ctor_" data-uid="Hi.Geom.Topo.CarveStl.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl__ctor_Hi_Geom_Topo_NativeTopoStl3d_System_Double_" data-uid="Hi.Geom.Topo.CarveStl.#ctor(Hi.Geom.Topo.NativeTopoStl3d,System.Double)">
|
|
CarveStl(NativeTopoStl3d, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes the container from a double-precision topology graph. The
|
|
triangles are converted to exact fractions at
|
|
<code class="paramref">fractionTolerance</code> — the source holds doubles, so
|
|
this is inherently the lossy path.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveStl(NativeTopoStl3d src, double fractionTolerance)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Geom.Topo.NativeTopoStl3d.html">NativeTopoStl3d</a></dt>
|
|
<dd><p>The source mesh (a closed shell).</p>
|
|
</dd>
|
|
<dt><code>fractionTolerance</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The tolerance for fraction conversion.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl__ctor_" data-uid="Hi.Geom.Topo.CarveStl.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl__ctor_Hi_Geom_Topo_NativeTopoStl3wfr_" data-uid="Hi.Geom.Topo.CarveStl.#ctor(Hi.Geom.Topo.NativeTopoStl3wfr)">
|
|
CarveStl(NativeTopoStl3wfr)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes the container from an exact-fraction topology graph,
|
|
copying every coordinate verbatim. Lossless, hence no tolerance: the
|
|
source is already the same numeric type. The source is only read.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveStl(NativeTopoStl3wfr src)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>src</code> <a class="xref" href="Hi.Geom.Topo.NativeTopoStl3wfr.html">NativeTopoStl3wfr</a></dt>
|
|
<dd><p>The source mesh (a closed shell).</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_CarvePtr_" data-uid="Hi.Geom.Topo.CarveStl.CarvePtr*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_CarvePtr" data-uid="Hi.Geom.Topo.CarveStl.CarvePtr">
|
|
CarvePtr
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the pointer to the native container.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public nint CarvePtr { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.intptr">nint</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_IsSeamless_" data-uid="Hi.Geom.Topo.CarveStl.IsSeamless*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_IsSeamless" data-uid="Hi.Geom.Topo.CarveStl.IsSeamless">
|
|
IsSeamless
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets whether every directed edge is paired with an owned reverse (the
|
|
manifold invariant the booleans maintain).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsSeamless { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_Size_" data-uid="Hi.Geom.Topo.CarveStl.Size*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_Size" data-uid="Hi.Geom.Topo.CarveStl.Size">
|
|
Size
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the number of triangles currently in the container.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public int Size { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_AddVolume_" data-uid="Hi.Geom.Topo.CarveStl.AddVolume*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_AddVolume_Hi_Geom_Stl_System_Double_" data-uid="Hi.Geom.Topo.CarveStl.AddVolume(Hi.Geom.Stl,System.Double)">
|
|
AddVolume(Stl, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Exact in-place union: merges the tool volume into the container.
|
|
Same calling contract as <a class="xref" href="Hi.Geom.Topo.CarveStl.html#Hi_Geom_Topo_CarveStl_SubstractVolume_Hi_Geom_Stl_System_Double_">SubstractVolume(Stl, double)</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveBooleanResult AddVolume(Stl tool, double fractionTolerance)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>tool</code> <a class="xref" href="Hi.Geom.Stl.html">Stl</a></dt>
|
|
<dd><p>The tool mesh (a closed shell).</p>
|
|
</dd>
|
|
<dt><code>fractionTolerance</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The tolerance for the tool's fraction conversion.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Topo.CarveBooleanResult.html">CarveBooleanResult</a></dt>
|
|
<dd><p>The step result; on failure the container is untouched.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_AddVolume_" data-uid="Hi.Geom.Topo.CarveStl.AddVolume*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_AddVolume_Hi_Geom_Topo_CarveStl_" data-uid="Hi.Geom.Topo.CarveStl.AddVolume(Hi.Geom.Topo.CarveStl)">
|
|
AddVolume(CarveStl)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Exact in-place union with another container's current state.
|
|
Lossless; <code class="paramref">tool</code> is only read.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveBooleanResult AddVolume(CarveStl tool)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>tool</code> <a class="xref" href="Hi.Geom.Topo.CarveStl.html">CarveStl</a></dt>
|
|
<dd><p>The container whose volume is merged in.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Topo.CarveBooleanResult.html">CarveBooleanResult</a></dt>
|
|
<dd><p>The step result; on failure this container is untouched.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_AddVolume_" data-uid="Hi.Geom.Topo.CarveStl.AddVolume*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_AddVolume_Hi_Geom_Topo_NativeTopoStl3wfr_" data-uid="Hi.Geom.Topo.CarveStl.AddVolume(Hi.Geom.Topo.NativeTopoStl3wfr)">
|
|
AddVolume(NativeTopoStl3wfr)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Exact in-place union with an exact-fraction tool — the lossless tool
|
|
path, hence no tolerance. The tool mesh is copied natively before the
|
|
surgery consumes it, so <code class="paramref">tool</code> survives the call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveBooleanResult AddVolume(NativeTopoStl3wfr tool)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>tool</code> <a class="xref" href="Hi.Geom.Topo.NativeTopoStl3wfr.html">NativeTopoStl3wfr</a></dt>
|
|
<dd><p>The tool mesh (a closed shell).</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Topo.CarveBooleanResult.html">CarveBooleanResult</a></dt>
|
|
<dd><p>The step result; on failure the container is untouched.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_Display_" data-uid="Hi.Geom.Topo.CarveStl.Display*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_Display_Hi_Disp_Bind_" data-uid="Hi.Geom.Topo.CarveStl.Display(Hi.Disp.Bind)">
|
|
Display(Bind)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Display function called in <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a> rendering loop.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Display(Bind bind)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>bind</code> <a class="xref" href="Hi.Disp.Bind.html">Bind</a></dt>
|
|
<dd><p>Bind with <a class="xref" href="Hi.Disp.DispEngine.html">DispEngine</a>. See <a class="xref" href="Hi.Disp.Bind.html">Bind</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_Dispose_" data-uid="Hi.Geom.Topo.CarveStl.Dispose*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_Dispose" data-uid="Hi.Geom.Topo.CarveStl.Dispose">
|
|
Dispose()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_Dispose_" data-uid="Hi.Geom.Topo.CarveStl.Dispose*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_Dispose_System_Boolean_" data-uid="Hi.Geom.Topo.CarveStl.Dispose(System.Boolean)">
|
|
Dispose(bool)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>disposing</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_ExpandToBox3d_" data-uid="Hi.Geom.Topo.CarveStl.ExpandToBox3d*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.Geom.Topo.CarveStl.ExpandToBox3d(Hi.Geom.Box3d)">
|
|
ExpandToBox3d(Box3d)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Expands the destination box.
|
|
This function is usually used to compute the bounding box of elements.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ExpandToBox3d(Box3d dst)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>dst</code> <a class="xref" href="Hi.Geom.Box3d.html">Box3d</a></dt>
|
|
<dd><p>Destination box</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_Finalize_" data-uid="Hi.Geom.Topo.CarveStl.Finalize*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_Finalize" data-uid="Hi.Geom.Topo.CarveStl.Finalize">
|
|
~CarveStl()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected ~CarveStl()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_GenStl_" data-uid="Hi.Geom.Topo.CarveStl.GenStl*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_GenStl" data-uid="Hi.Geom.Topo.CarveStl.GenStl">
|
|
GenStl()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Generates an STL model from the container's current state.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Stl GenStl()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Stl.html">Stl</a></dt>
|
|
<dd><p>A new STL model.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_SubstractVolume_" data-uid="Hi.Geom.Topo.CarveStl.SubstractVolume*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_SubstractVolume_Hi_Geom_Stl_System_Double_" data-uid="Hi.Geom.Topo.CarveStl.SubstractVolume(Hi.Geom.Stl,System.Double)">
|
|
SubstractVolume(Stl, double)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Exact in-place difference: carves the tool volume out of the
|
|
container. The tool triangles are consumed natively per call, so the
|
|
same <a class="xref" href="Hi.Geom.Stl.html">Stl</a> may be reused for further steps.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveBooleanResult SubstractVolume(Stl tool, double fractionTolerance)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>tool</code> <a class="xref" href="Hi.Geom.Stl.html">Stl</a></dt>
|
|
<dd><p>The tool mesh (a closed shell).</p>
|
|
</dd>
|
|
<dt><code>fractionTolerance</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The tolerance for the tool's fraction conversion.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Topo.CarveBooleanResult.html">CarveBooleanResult</a></dt>
|
|
<dd><p>The step result; on failure the container is untouched.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_SubstractVolume_" data-uid="Hi.Geom.Topo.CarveStl.SubstractVolume*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_SubstractVolume_Hi_Geom_Topo_CarveStl_" data-uid="Hi.Geom.Topo.CarveStl.SubstractVolume(Hi.Geom.Topo.CarveStl)">
|
|
SubstractVolume(CarveStl)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Exact in-place difference using another container's current state as
|
|
the tool. Lossless; <code class="paramref">tool</code> is only read.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveBooleanResult SubstractVolume(CarveStl tool)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>tool</code> <a class="xref" href="Hi.Geom.Topo.CarveStl.html">CarveStl</a></dt>
|
|
<dd><p>The container whose volume is carved away.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Topo.CarveBooleanResult.html">CarveBooleanResult</a></dt>
|
|
<dd><p>The step result; on failure this container is untouched.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Geom_Topo_CarveStl_SubstractVolume_" data-uid="Hi.Geom.Topo.CarveStl.SubstractVolume*"></a>
|
|
|
|
<h3 id="Hi_Geom_Topo_CarveStl_SubstractVolume_Hi_Geom_Topo_NativeTopoStl3wfr_" data-uid="Hi.Geom.Topo.CarveStl.SubstractVolume(Hi.Geom.Topo.NativeTopoStl3wfr)">
|
|
SubstractVolume(NativeTopoStl3wfr)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Exact in-place difference with an exact-fraction tool — the lossless
|
|
tool path, hence no tolerance. The tool mesh is copied natively before
|
|
the surgery consumes it, so <code class="paramref">tool</code> survives the call
|
|
and may be reused for further steps.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public CarveBooleanResult SubstractVolume(NativeTopoStl3wfr tool)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>tool</code> <a class="xref" href="Hi.Geom.Topo.NativeTopoStl3wfr.html">NativeTopoStl3wfr</a></dt>
|
|
<dd><p>The tool mesh (a closed shell).</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Geom.Topo.CarveBooleanResult.html">CarveBooleanResult</a></dt>
|
|
<dd><p>The step result; on failure the container is untouched.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|