This repository has been archived on 2026-10-11. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnmanagedSubstraction.html
T

640 lines
19 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class UnmanagedSubstraction | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class UnmanagedSubstraction | HiAPI-C# 2025 ">
<meta name="description" content="Data about the removing behavior of .">
<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 &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<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.Cbtr.UnmanagedSubstraction">
<h1 id="Hi_Cbtr_UnmanagedSubstraction" data-uid="Hi.Cbtr.UnmanagedSubstraction" class="text-break">
Class UnmanagedSubstraction
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Cbtr.html">Cbtr</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiCbtr.dll</dd></dl>
</div>
<div class="markdown summary"><p>Data about the removing behavior of <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class UnmanagedSubstraction : IDisplayee, IExpandToBox3d, IDisposable</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">UnmanagedSubstraction</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a></div>
<div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</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.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(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&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<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.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 class="section" id="fields">Fields
</h2>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_preserveCount" data-uid="Hi.Cbtr.UnmanagedSubstraction.preserveCount">
preserveCount
</h3>
<div class="markdown level1 summary"><p>The count of preservations to prevent disposal.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int preserveCount</code></pre>
</div>
<h4 class="section">Field 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="properties">Properties
</h2>
<a id="Hi_Cbtr_UnmanagedSubstraction_ContactContours_" data-uid="Hi.Cbtr.UnmanagedSubstraction.ContactContours*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_ContactContours" data-uid="Hi.Cbtr.UnmanagedSubstraction.ContactContours">
ContactContours
</h3>
<div class="markdown level1 summary"><p>Contact contours.</p>
<p>Each contour is composed by 3~12 points.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;List&lt;Vec3d&gt;&gt; ContactContours { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a>&gt;&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_Cbtr_UnmanagedSubstraction_ContactContoursArea_" data-uid="Hi.Cbtr.UnmanagedSubstraction.ContactContoursArea*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_ContactContoursArea" data-uid="Hi.Cbtr.UnmanagedSubstraction.ContactContoursArea">
ContactContoursArea
</h3>
<div class="markdown level1 summary"><p>Gets the area of the contact contours.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double ContactContoursArea { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Cbtr_UnmanagedSubstraction_IsTouched_" data-uid="Hi.Cbtr.UnmanagedSubstraction.IsTouched*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_IsTouched" data-uid="Hi.Cbtr.UnmanagedSubstraction.IsTouched">
IsTouched
</h3>
<div class="markdown level1 summary"><p>Is the cutter and workpiece touched.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsTouched { 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_Cbtr_UnmanagedSubstraction_SubstractionPtr_" data-uid="Hi.Cbtr.UnmanagedSubstraction.SubstractionPtr*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_SubstractionPtr" data-uid="Hi.Cbtr.UnmanagedSubstraction.SubstractionPtr">
SubstractionPtr
</h3>
<div class="markdown level1 summary"><p>Internal Use Only.
The native pointer to the substraction object. HiMech reads it to build
the milling engagement natively at the substraction completion point,
without copying contours through the managed heap.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public nint SubstractionPtr { 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>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Cbtr_UnmanagedSubstraction_Display_" data-uid="Hi.Cbtr.UnmanagedSubstraction.Display*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_Display_Hi_Disp_Bind_" data-uid="Hi.Cbtr.UnmanagedSubstraction.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_Cbtr_UnmanagedSubstraction_DisplayContours_" data-uid="Hi.Cbtr.UnmanagedSubstraction.DisplayContours*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_DisplayContours_Hi_Disp_Bind_" data-uid="Hi.Cbtr.UnmanagedSubstraction.DisplayContours(Hi.Disp.Bind)">
DisplayContours(Bind)
</h3>
<div class="markdown level1 summary"><p>Display <a class="xref" href="Hi.Cbtr.UnmanagedSubstraction.html#Hi_Cbtr_UnmanagedSubstraction_ContactContours">ContactContours</a> by lines.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void DisplayContours(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</p>
</dd>
</dl>
<a id="Hi_Cbtr_UnmanagedSubstraction_Dispose_" data-uid="Hi.Cbtr.UnmanagedSubstraction.Dispose*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_Dispose" data-uid="Hi.Cbtr.UnmanagedSubstraction.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_Cbtr_UnmanagedSubstraction_Dispose_" data-uid="Hi.Cbtr.UnmanagedSubstraction.Dispose*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_Dispose_System_Boolean_" data-uid="Hi.Cbtr.UnmanagedSubstraction.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_Cbtr_UnmanagedSubstraction_ExpandToBox3d_" data-uid="Hi.Cbtr.UnmanagedSubstraction.ExpandToBox3d*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.Cbtr.UnmanagedSubstraction.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_Cbtr_UnmanagedSubstraction_Finalize_" data-uid="Hi.Cbtr.UnmanagedSubstraction.Finalize*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_Finalize" data-uid="Hi.Cbtr.UnmanagedSubstraction.Finalize">
~UnmanagedSubstraction()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected ~UnmanagedSubstraction()</code></pre>
</div>
<a id="Hi_Cbtr_UnmanagedSubstraction_PreserveBegin_" data-uid="Hi.Cbtr.UnmanagedSubstraction.PreserveBegin*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_PreserveBegin" data-uid="Hi.Cbtr.UnmanagedSubstraction.PreserveBegin">
PreserveBegin()
</h3>
<div class="markdown level1 summary"><p>Preserve the object from arising <a class="xref" href="Hi.Cbtr.UnmanagedSubstraction.html#Hi_Cbtr_UnmanagedSubstraction_Dispose">Dispose()</a>.
Add preserve count for 1.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void PreserveBegin()</code></pre>
</div>
<dl class="typelist seealso">
<dt>See Also</dt>
<dd>
<div><a class="xref" href="Hi.Cbtr.UnmanagedSubstraction.html#Hi_Cbtr_UnmanagedSubstraction_PreserveEnd">PreserveEnd()</a></div>
</dd>
</dl>
<a id="Hi_Cbtr_UnmanagedSubstraction_PreserveEnd_" data-uid="Hi.Cbtr.UnmanagedSubstraction.PreserveEnd*"></a>
<h3 id="Hi_Cbtr_UnmanagedSubstraction_PreserveEnd" data-uid="Hi.Cbtr.UnmanagedSubstraction.PreserveEnd">
PreserveEnd()
</h3>
<div class="markdown level1 summary"><p>Minus preserve count for 1.
If preserve count is eqaul or lower than 0, call <a class="xref" href="Hi.Cbtr.UnmanagedSubstraction.html#Hi_Cbtr_UnmanagedSubstraction_Dispose">Dispose()</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void PreserveEnd()</code></pre>
</div>
<dl class="typelist seealso">
<dt>See Also</dt>
<dd>
<div><a class="xref" href="Hi.Cbtr.UnmanagedSubstraction.html#Hi_Cbtr_UnmanagedSubstraction_PreserveBegin">PreserveBegin()</a></div>
</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>