HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Engagements.BitwiseMillingEngagement.html
2025-07-18 15:38:28 +08:00

501 lines
18 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class BitwiseMillingEngagement | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class BitwiseMillingEngagement | HiAPI-C# 2025 ">
<meta name="description" content="Represents a bitwise milling engagement that uses bit arrays to efficiently store engagement information.">
<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.Milling.Engagements.BitwiseMillingEngagement">
<h1 id="Hi_Milling_Engagements_BitwiseMillingEngagement" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement" class="text-break">
Class BitwiseMillingEngagement
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Milling.html">Milling</a>.<a class="xref" href="Hi.Milling.Engagements.html">Engagements</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents a bitwise milling engagement that uses bit arrays to efficiently store engagement information.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BitwiseMillingEngagement</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">BitwiseMillingEngagement</span></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.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="constructors">Constructors
</h2>
<a id="Hi_Milling_Engagements_BitwiseMillingEngagement__ctor_" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.#ctor*"></a>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement__ctor_System_Collections_Generic_List_Hi_Geom_PairZr__System_Collections_Generic_List_System_Collections_Generic_List_Hi_Geom_Vec3d___Hi_Common_SeqPair_Hi_Geom_Mat4d__System_Double_System_Double_" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.#ctor(System.Collections.Generic.List{Hi.Geom.PairZr},System.Collections.Generic.List{System.Collections.Generic.List{Hi.Geom.Vec3d}},Hi.Common.SeqPair{Hi.Geom.Mat4d},System.Double,System.Double)">
BitwiseMillingEngagement(List&lt;PairZr&gt;, List&lt;List&lt;Vec3d&gt;&gt;, SeqPair&lt;Mat4d&gt;, double, double)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Milling.Engagements.BitwiseMillingEngagement.html">BitwiseMillingEngagement</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BitwiseMillingEngagement(List&lt;PairZr&gt; fluteZrContour, List&lt;List&lt;Vec3d&gt;&gt; orthodoxForwardContours, SeqPair&lt;Mat4d&gt; seqOnToolRunningCoordinate, double zInterval, double rInterval)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>fluteZrContour</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="Hi.Geom.PairZr.html">PairZr</a>&gt;</dt>
<dd><p>The flute Z-R contour.</p>
</dd>
<dt><code>orthodoxForwardContours</code> <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><p>The orthodox forward contours.</p>
</dd>
<dt><code>seqOnToolRunningCoordinate</code> <a class="xref" href="Hi.Common.SeqPair-1.html">SeqPair</a>&lt;<a class="xref" href="Hi.Geom.Mat4d.html">Mat4d</a>&gt;</dt>
<dd><p>The sequence on tool running coordinate.</p>
</dd>
<dt><code>zInterval</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The Z interval.</p>
</dd>
<dt><code>rInterval</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The R interval.</p>
</dd>
</dl>
<h2 class="section" id="fields">Fields
</h2>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement_angleIntervalNum" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.angleIntervalNum">
angleIntervalNum
</h3>
<div class="markdown level1 summary"><p>Number of angle interval.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const int angleIntervalNum = 64</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>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement_angleInterval_rad" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.angleInterval_rad">
angleInterval_rad
</h3>
<div class="markdown level1 summary"><p>angle interval in radian.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const double angleInterval_rad = 0.09817477042468103</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Milling_Engagements_BitwiseMillingEngagement_BottomBits_" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.BottomBits*"></a>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement_BottomBits" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.BottomBits">
BottomBits
</h3>
<div class="markdown level1 summary"><p>Gets or sets the bottom bits representing bottom engagement.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;ulong&gt; BottomBits { get; set; }</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.uint64">ulong</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_Milling_Engagements_BitwiseMillingEngagement_SideBits_" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.SideBits*"></a>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement_SideBits" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.SideBits">
SideBits
</h3>
<div class="markdown level1 summary"><p>Gets or sets the side bits representing side engagement.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;ulong&gt; SideBits { get; set; }</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.uint64">ulong</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Milling_Engagements_BitwiseMillingEngagement_Delta_" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.Delta*"></a>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement_Delta_Hi_Milling_Engagements_BitwiseMillingEngagement_Hi_Milling_Engagements_BitwiseMillingEngagement_System_Int32__" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.Delta(Hi.Milling.Engagements.BitwiseMillingEngagement,Hi.Milling.Engagements.BitwiseMillingEngagement,System.Int32@)">
Delta(BitwiseMillingEngagement, BitwiseMillingEngagement, out int)
</h3>
<div class="markdown level1 summary"><p>Contact area difference from <code class="paramref">engagement1</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static int Delta(BitwiseMillingEngagement engagement0, BitwiseMillingEngagement engagement1, out int deltaIncreaseNum)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>engagement0</code> <a class="xref" href="Hi.Milling.Engagements.BitwiseMillingEngagement.html">BitwiseMillingEngagement</a></dt>
<dd><p>previous engagement on time line. Null value is accepted.</p>
</dd>
<dt><code>engagement1</code> <a class="xref" href="Hi.Milling.Engagements.BitwiseMillingEngagement.html">BitwiseMillingEngagement</a></dt>
<dd><p>current engagement on time line. Null value is accepted.</p>
</dd>
<dt><code>deltaIncreaseNum</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The relative increase number of contact area from <code class="paramref">engagement0</code> to <code class="paramref">engagement1</code>.
Negative value means the contact area decreased.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>Contact area difference</p>
</dd>
</dl>
<a id="Hi_Milling_Engagements_BitwiseMillingEngagement_ToBottomBitString_" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.ToBottomBitString*"></a>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement_ToBottomBitString" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.ToBottomBitString">
ToBottomBitString()
</h3>
<div class="markdown level1 summary"><p>Converts the bottom bits to a string representation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ToBottomBitString()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>A string representation of the bottom bits.</p>
</dd>
</dl>
<a id="Hi_Milling_Engagements_BitwiseMillingEngagement_ToSideBitString_" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.ToSideBitString*"></a>
<h3 id="Hi_Milling_Engagements_BitwiseMillingEngagement_ToSideBitString" data-uid="Hi.Milling.Engagements.BitwiseMillingEngagement.ToSideBitString">
ToSideBitString()
</h3>
<div class="markdown level1 summary"><p>Converts the side bits to a string representation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ToSideBitString()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>A string representation of the side bits.</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>