442 lines
16 KiB
HTML
442 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class MachiningVolumeRemovalProc | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class MachiningVolumeRemovalProc | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="Handles the machining volume removal process and related operations.">
|
|
<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.Machining.MachiningVolumeRemovalProc">
|
|
|
|
|
|
|
|
<h1 id="Hi_Machining_MachiningVolumeRemovalProc" data-uid="Hi.Machining.MachiningVolumeRemovalProc" class="text-break">
|
|
Class MachiningVolumeRemovalProc
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Machining.html">Machining</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Handles the machining volume removal process and related operations.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class MachiningVolumeRemovalProc</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">MachiningVolumeRemovalProc</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<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 class="section" id="constructors">Constructors
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Machining_MachiningVolumeRemovalProc__ctor_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.#ctor*"></a>
|
|
|
|
<h3 id="Hi_Machining_MachiningVolumeRemovalProc__ctor_System_Func_Hi_Machining_MachiningEquipmentUtils_MachiningEquipment__" data-uid="Hi.Machining.MachiningVolumeRemovalProc.#ctor(System.Func{Hi.Machining.MachiningEquipmentUtils.MachiningEquipment})">
|
|
MachiningVolumeRemovalProc(Func<MachiningEquipment>)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Machining.MachiningVolumeRemovalProc.html">MachiningVolumeRemovalProc</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public MachiningVolumeRemovalProc(Func<MachiningEquipment> machiningEquipmentGetter)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>machiningEquipmentGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html">MachiningEquipment</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Machining_MachiningVolumeRemovalProc_ClMachiningValve_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.ClMachiningValve*"></a>
|
|
|
|
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_ClMachiningValve" data-uid="Hi.Machining.MachiningVolumeRemovalProc.ClMachiningValve">
|
|
ClMachiningValve
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets the CL machining valve used to control the machining process.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ClMachiningValve ClMachiningValve { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Motion.MatValves.ClMachiningValve.html">ClMachiningValve</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Machining_MachiningVolumeRemovalProc_ClearCache_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.ClearCache*"></a>
|
|
|
|
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_ClearCache" data-uid="Hi.Machining.MachiningVolumeRemovalProc.ClearCache">
|
|
ClearCache()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Clears the internal cache, including the CL machining valve state and step-related caches.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ClearCache()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Machining_MachiningVolumeRemovalProc_StepAssignDummyAttach_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepAssignDummyAttach*"></a>
|
|
|
|
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepAssignDummyAttach_Hi_NcMech_Workpieces_Workpiece_Hi_CutterLocations_ClStrips_ClStrip_Hi_Geom_DVec3d_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepAssignDummyAttach(Hi.NcMech.Workpieces.Workpiece,Hi.CutterLocations.ClStrips.ClStrip,Hi.Geom.DVec3d)">
|
|
StepAssignDummyAttach(Workpiece, ClStrip, DVec3d)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Creates a dummy attachment point in the CL strip.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClStripPos StepAssignDummyAttach(Workpiece workpiece, ClStrip clStrip, DVec3d programCl)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>workpiece</code> <a class="xref" href="Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a></dt>
|
|
<dd><p>The workpiece to attach to.</p>
|
|
</dd>
|
|
<dt><code>clStrip</code> <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
|
|
<dd><p>The CL strip to add the attachment to.</p>
|
|
</dd>
|
|
<dt><code>programCl</code> <a class="xref" href="Hi.Geom.DVec3d.html">DVec3d</a></dt>
|
|
<dd><p>The program CL point for the attachment.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.CutterLocations.ClStrips.ClStripPos.html">ClStripPos</a></dt>
|
|
<dd><p>The created CL strip position.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Hi_Machining_MachiningVolumeRemovalProc_StepGetGeomBoolCache_" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepGetGeomBoolCache*"></a>
|
|
|
|
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_StepGetGeomBoolCache_Hi_Machining_ICutter_System_Double_Hi_Common_SeqPair_Hi_Geom_Mat4d__System_Boolean_System_Nullable_System_Boolean__" data-uid="Hi.Machining.MachiningVolumeRemovalProc.StepGetGeomBoolCache(Hi.Machining.ICutter,System.Double,Hi.Common.SeqPair{Hi.Geom.Mat4d},System.Boolean,System.Nullable{System.Boolean})">
|
|
StepGetGeomBoolCache(ICutter, double, SeqPair<Mat4d>, bool, bool?)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Gets a geometric boolean cache for the current step based on cutter and motion parameters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static GeomBoolCache StepGetGeomBoolCache(ICutter cutter, double stepPreferredCubeWidth, SeqPair<Mat4d> seq, bool enableSweeping, bool? isFluteTouchingWorkpiece)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>cutter</code> <a class="xref" href="Hi.Machining.ICutter.html">ICutter</a></dt>
|
|
<dd><p>The cutter to use for the operation.</p>
|
|
</dd>
|
|
<dt><code>stepPreferredCubeWidth</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
|
<dd><p>The preferred cube width for discretization.</p>
|
|
</dd>
|
|
<dt><code>seq</code> <a class="xref" href="Hi.Common.SeqPair-1.html">SeqPair</a><<a class="xref" href="Hi.Geom.Mat4d.html">Mat4d</a>></dt>
|
|
<dd><p>The sequence pair of transformation matrices.</p>
|
|
</dd>
|
|
<dt><code>enableSweeping</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd><p>Whether to enable sweeping operation.</p>
|
|
</dd>
|
|
<dt><code>isFluteTouchingWorkpiece</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>?</dt>
|
|
<dd><p>Optional flag indicating if the flute is touching the workpiece.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="Hi.Cbtr.GeomBoolCache.html">GeomBoolCache</a></dt>
|
|
<dd><p>A geometric boolean cache containing the operation data.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section" id="Hi_Machining_MachiningVolumeRemovalProc_StepGetGeomBoolCache_Hi_Machining_ICutter_System_Double_Hi_Common_SeqPair_Hi_Geom_Mat4d__System_Boolean_System_Nullable_System_Boolean___remarks">Remarks</h4>
|
|
<div class="markdown level1 remarks"><p>Note that it is hard to know if flute is touching the workpiece by sweeping without making sweeping volume.
|
|
Checking by non-sweeping geometry may miss the touching part of the sweeping volume.
|
|
Hence <code class="paramref">isFluteTouchingWorkpiece</code> should be kept null and be considered obsolete.
|
|
There is no performance gain from that parameter.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="events">Events
|
|
</h2>
|
|
|
|
|
|
|
|
<h3 id="Hi_Machining_MachiningVolumeRemovalProc_CutterChanged" data-uid="Hi.Machining.MachiningVolumeRemovalProc.CutterChanged">
|
|
CutterChanged
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Event that is triggered when the cutter is changed, providing the previous and current cutter.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action<SeqPair<ICutter>> CutterChanged</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Event Type</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Hi.Common.SeqPair-1.html">SeqPair</a><<a class="xref" href="Hi.Machining.ICutter.html">ICutter</a>>></dt>
|
|
<dd></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>
|