HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingTool.html
iambossTC b5cad3c171 tune
2025-07-25 16:27:29 +08:00

1337 lines
39 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class MillingTool | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MillingTool | HiAPI-C# 2025 ">
<meta name="description" content="Represents a central stick milling tool that combines a holder and a cutter.">
<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.MillingTools.MillingTool">
<h1 id="Hi_Milling_MillingTools_MillingTool" data-uid="Hi.Milling.MillingTools.MillingTool" class="text-break">
Class MillingTool
</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.MillingTools.html">MillingTools</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents a central stick milling tool that combines a holder and a cutter.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class MillingTool : IMachiningTool, IDisplayee, IExpandToBox3d, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache, IGetFluteNum</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">MillingTool</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Machining.IMachiningTool.html">IMachiningTool</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>
<div><a class="xref" href="Hi.Mech.Topo.ITopo.html">ITopo</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetAsmb.html">IGetAsmb</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetAnchor.html">IGetAnchor</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetTopoIndex.html">IGetTopoIndex</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetAnchoredDisplayeeList.html">IGetAnchoredDisplayeeList</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetFletchBuckle.html">IGetFletchBuckle</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Common.IAbstractNote.html">IAbstractNote</a></div>
<div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div>
<div><a class="xref" href="Hi.Common.IClearCache.html">IClearCache</a></div>
<div><a class="xref" href="Hi.Milling.FluteContours.IGetFluteNum.html">IGetFluteNum</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.Milling.MillingTools.MillingToolUtil.html#Hi_Milling_MillingTools_MillingToolUtil_GetFullH_Hi_Machining_IMachiningTool_">MillingToolUtil.GetFullH(IMachiningTool)</a>
</div>
<div>
<a class="xref" href="Hi.Mech.Topo.TopoUtil.html#Hi_Mech_Topo_TopoUtil_Display_Hi_Mech_Topo_IGetAnchor_Hi_Disp_Bind_System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__">TopoUtil.Display(IGetAnchor, Bind, Dictionary&lt;Anchor, Mat4d&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Mech.Topo.TopoUtil.html#Hi_Mech_Topo_TopoUtil_ExpandToBox3d_Hi_Mech_Topo_IGetAnchor_Hi_Geom_Box3d_System_Collections_Generic_Dictionary_Hi_Mech_Topo_Anchor_Hi_Geom_Mat4d__">TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary&lt;Anchor, Mat4d&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Mech.Topo.TopoDisplayeeUtil.html#Hi_Mech_Topo_TopoDisplayeeUtil_Display_Hi_Mech_Topo_ITopo_Hi_Disp_Bind_">TopoDisplayeeUtil.Display(ITopo, Bind)</a>
</div>
<div>
<a class="xref" href="Hi.Mech.Topo.TopoDisplayeeUtil.html#Hi_Mech_Topo_TopoDisplayeeUtil_ExpandToBox3d_Hi_Mech_Topo_ITopo_Hi_Geom_Box3d_">TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d)</a>
</div>
<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_MillingTools_MillingTool__ctor_" data-uid="Hi.Milling.MillingTools.MillingTool.#ctor*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool__ctor" data-uid="Hi.Milling.MillingTools.MillingTool.#ctor">
MillingTool()
</h3>
<div class="markdown level1 summary"><p>Ctor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MillingTool()</code></pre>
</div>
<a id="Hi_Milling_MillingTools_MillingTool__ctor_" data-uid="Hi.Milling.MillingTools.MillingTool.#ctor*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool__ctor_System_Xml_Linq_XElement_System_String_System_String_" data-uid="Hi.Milling.MillingTools.MillingTool.#ctor(System.Xml.Linq.XElement,System.String,System.String)">
MillingTool(XElement, string, string)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Milling.MillingTools.MillingTool.html">MillingTool</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MillingTool(XElement src, string baseDirectory, string relFile)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>The XML element containing the tool configuration.</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths.</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Milling_MillingTools_MillingTool_AbstractNote_" data-uid="Hi.Milling.MillingTools.MillingTool.AbstractNote*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_AbstractNote" data-uid="Hi.Milling.MillingTools.MillingTool.AbstractNote">
AbstractNote
</h3>
<div class="markdown level1 summary"><p>Gets an abstract note describing the tool's dimensions and cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AbstractNote { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_Asmb_" data-uid="Hi.Milling.MillingTools.MillingTool.Asmb*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_Asmb" data-uid="Hi.Milling.MillingTools.MillingTool.Asmb">
Asmb
</h3>
<div class="markdown level1 summary"><p>Gets the assembly containing the tool components.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Asmb Asmb { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Asmb.html">Asmb</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_Cutter_" data-uid="Hi.Milling.MillingTools.MillingTool.Cutter*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_Cutter" data-uid="Hi.Milling.MillingTools.MillingTool.Cutter">
Cutter
</h3>
<div class="markdown level1 summary"><p>Gets the cutting tool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ICutter Cutter { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Machining.ICutter.html">ICutter</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_CutterFile_" data-uid="Hi.Milling.MillingTools.MillingTool.CutterFile*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_CutterFile" data-uid="Hi.Milling.MillingTools.MillingTool.CutterFile">
CutterFile
</h3>
<div class="markdown level1 summary"><p>Gets or sets the file path of the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string CutterFile { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_ExposedCutterBendingPara_umdN_" data-uid="Hi.Milling.MillingTools.MillingTool.ExposedCutterBendingPara_umdN*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ExposedCutterBendingPara_umdN" data-uid="Hi.Milling.MillingTools.MillingTool.ExposedCutterBendingPara_umdN">
ExposedCutterBendingPara_umdN
</h3>
<div class="markdown level1 summary"><p>Gets or sets the parameter for exposed cutter bending in micrometers per Newton.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double ExposedCutterBendingPara_umdN { 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_Milling_MillingTools_MillingTool_ExposedCutterHeight_mm_" data-uid="Hi.Milling.MillingTools.MillingTool.ExposedCutterHeight_mm*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ExposedCutterHeight_mm" data-uid="Hi.Milling.MillingTools.MillingTool.ExposedCutterHeight_mm">
ExposedCutterHeight_mm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the exposed cutter height in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double ExposedCutterHeight_mm { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_ExposedCutterZDeflectionPara_umdN_" data-uid="Hi.Milling.MillingTools.MillingTool.ExposedCutterZDeflectionPara_umdN*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ExposedCutterZDeflectionPara_umdN" data-uid="Hi.Milling.MillingTools.MillingTool.ExposedCutterZDeflectionPara_umdN">
ExposedCutterZDeflectionPara_umdN
</h3>
<div class="markdown level1 summary"><p>Gets or sets the parameter for exposed cutter Z-axis deflection in micrometers per Newton.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double ExposedCutterZDeflectionPara_umdN { 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_Milling_MillingTools_MillingTool_Holder_" data-uid="Hi.Milling.MillingTools.MillingTool.Holder*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_Holder" data-uid="Hi.Milling.MillingTools.MillingTool.Holder">
Holder
</h3>
<div class="markdown level1 summary"><p>Gets or sets the tool holder.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IHolder Holder { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcMech.Holders.IHolder.html">IHolder</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_HolderFile_" data-uid="Hi.Milling.MillingTools.MillingTool.HolderFile*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_HolderFile" data-uid="Hi.Milling.MillingTools.MillingTool.HolderFile">
HolderFile
</h3>
<div class="markdown level1 summary"><p>Gets or sets the holder file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string HolderFile { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_Note_" data-uid="Hi.Milling.MillingTools.MillingTool.Note*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_Note" data-uid="Hi.Milling.MillingTools.MillingTool.Note">
Note
</h3>
<div class="markdown level1 summary"><p>Gets or sets a note for this machining tool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Note { 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.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_ObservationAnchor_" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationAnchor*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ObservationAnchor" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationAnchor">
ObservationAnchor
</h3>
<div class="markdown level1 summary"><p>Gets the tool anchor reference point.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor ObservationAnchor { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_ObservationAnchorReference_" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationAnchorReference*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ObservationAnchorReference" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationAnchorReference">
ObservationAnchorReference
</h3>
<div class="markdown level1 summary"><p>Gets the tool observation anchor reference point.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MillingToolAnchorReference ObservationAnchorReference { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Milling.MillingTools.MillingToolAnchorReference.html">MillingToolAnchorReference</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_ObservationHeightFromToolTip_" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationHeightFromToolTip*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ObservationHeightFromToolTip" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationHeightFromToolTip">
ObservationHeightFromToolTip
</h3>
<div class="markdown level1 summary"><p>Gets the tool observation point relative to the reference.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double ObservationHeightFromToolTip { 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_Milling_MillingTools_MillingTool_ObservationRingRadius_mm_" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationRingRadius_mm*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ObservationRingRadius_mm" data-uid="Hi.Milling.MillingTools.MillingTool.ObservationRingRadius_mm">
ObservationRingRadius_mm
</h3>
<div class="markdown level1 summary"><p>Obsoleted.
Gets the tool observation reference point.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double ObservationRingRadius_mm { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_PreservedDistanceBetweenFluteAndSpindleNose_mm_" data-uid="Hi.Milling.MillingTools.MillingTool.PreservedDistanceBetweenFluteAndSpindleNose_mm*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_PreservedDistanceBetweenFluteAndSpindleNose_mm" data-uid="Hi.Milling.MillingTools.MillingTool.PreservedDistanceBetweenFluteAndSpindleNose_mm">
PreservedDistanceBetweenFluteAndSpindleNose_mm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the preserved distance between flute and clamp in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double PreservedDistanceBetweenFluteAndSpindleNose_mm { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_RelativeHeightFromObservationAnchor_mm_" data-uid="Hi.Milling.MillingTools.MillingTool.RelativeHeightFromObservationAnchor_mm*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_RelativeHeightFromObservationAnchor_mm" data-uid="Hi.Milling.MillingTools.MillingTool.RelativeHeightFromObservationAnchor_mm">
RelativeHeightFromObservationAnchor_mm
</h3>
<div class="markdown level1 summary"><p>Gets the tool observation point relative to the reference.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double RelativeHeightFromObservationAnchor_mm { 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.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_SpindleBuckle_" data-uid="Hi.Milling.MillingTools.MillingTool.SpindleBuckle*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_SpindleBuckle" data-uid="Hi.Milling.MillingTools.MillingTool.SpindleBuckle">
SpindleBuckle
</h3>
<div class="markdown level1 summary"><p>Gets the motor-side buckle.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor SpindleBuckle { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_SpindleBuckleToToolTipLength_" data-uid="Hi.Milling.MillingTools.MillingTool.SpindleBuckleToToolTipLength*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_SpindleBuckleToToolTipLength" data-uid="Hi.Milling.MillingTools.MillingTool.SpindleBuckleToToolTipLength">
SpindleBuckleToToolTipLength
</h3>
<div class="markdown level1 summary"><p>Height For NC Compensation table and step number computation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double SpindleBuckleToToolTipLength { 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_Milling_MillingTools_MillingTool_ToolTip_" data-uid="Hi.Milling.MillingTools.MillingTool.ToolTip*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ToolTip" data-uid="Hi.Milling.MillingTools.MillingTool.ToolTip">
ToolTip
</h3>
<div class="markdown level1 summary"><p>Gets the tool tip anchor point from the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor ToolTip { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_XName_" data-uid="Hi.Milling.MillingTools.MillingTool.XName*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_XName" data-uid="Hi.Milling.MillingTools.MillingTool.XName">
XName
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the StickMachiningTool class from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string XName { 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.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Milling_MillingTools_MillingTool_AlignAnchorByExposedCutterHeight_" data-uid="Hi.Milling.MillingTools.MillingTool.AlignAnchorByExposedCutterHeight*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_AlignAnchorByExposedCutterHeight" data-uid="Hi.Milling.MillingTools.MillingTool.AlignAnchorByExposedCutterHeight">
AlignAnchorByExposedCutterHeight()
</h3>
<div class="markdown level1 summary"><p>Aligns the anchor by the exposed cutter height.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void AlignAnchorByExposedCutterHeight()</code></pre>
</div>
<a id="Hi_Milling_MillingTools_MillingTool_ClearCache_" data-uid="Hi.Milling.MillingTools.MillingTool.ClearCache*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ClearCache" data-uid="Hi.Milling.MillingTools.MillingTool.ClearCache">
ClearCache()
</h3>
<div class="markdown level1 summary"><p>Clears any cached data held by the implementing object.</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_Milling_MillingTools_MillingTool_Display_" data-uid="Hi.Milling.MillingTools.MillingTool.Display*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_Display_Hi_Disp_Bind_" data-uid="Hi.Milling.MillingTools.MillingTool.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_Milling_MillingTools_MillingTool_Duplicate_" data-uid="Hi.Milling.MillingTools.MillingTool.Duplicate*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_Duplicate_System_Object___" data-uid="Hi.Milling.MillingTools.MillingTool.Duplicate(System.Object[])">
Duplicate(params object[])
</h3>
<div class="markdown level1 summary"><p>Creates a deep copy of the object, excluding any source file references.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object Duplicate(params object[] res)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd><p>Optional parameters that may be needed during the duplication process</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>A new instance that is a deep copy of the original object</p>
</dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_ExpandToBox3d_" data-uid="Hi.Milling.MillingTools.MillingTool.ExpandToBox3d*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.Milling.MillingTools.MillingTool.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>
<h4 class="section" id="Hi_Milling_MillingTools_MillingTool_ExpandToBox3d_Hi_Geom_Box3d__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For display</p>
</div>
<a id="Hi_Milling_MillingTools_MillingTool_GetAnchor_" data-uid="Hi.Milling.MillingTools.MillingTool.GetAnchor*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_GetAnchor" data-uid="Hi.Milling.MillingTools.MillingTool.GetAnchor">
GetAnchor()
</h3>
<div class="markdown level1 summary"><p>Get key anchor. (i.e. root anchor)</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor GetAnchor()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd><p>key anchor</p>
</dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_GetAnchoredDisplayeeList_" data-uid="Hi.Milling.MillingTools.MillingTool.GetAnchoredDisplayeeList*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_GetAnchoredDisplayeeList" data-uid="Hi.Milling.MillingTools.MillingTool.GetAnchoredDisplayeeList">
GetAnchoredDisplayeeList()
</h3>
<div class="markdown level1 summary"><p>Gets a list of anchored displayable objects.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;IAnchoredDisplayee&gt; GetAnchoredDisplayeeList()</code></pre>
</div>
<h4 class="section">Returns</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="Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a>&gt;</dt>
<dd><p>A list of <a class="xref" href="Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a> objects</p>
</dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_GetAsmb_" data-uid="Hi.Milling.MillingTools.MillingTool.GetAsmb*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_GetAsmb" data-uid="Hi.Milling.MillingTools.MillingTool.GetAsmb">
GetAsmb()
</h3>
<div class="markdown level1 summary"><p>Gets the key asmb.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Asmb GetAsmb()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Asmb.html">Asmb</a></dt>
<dd><p>The key asmb.</p>
</dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_GetFletchBuckle_" data-uid="Hi.Milling.MillingTools.MillingTool.GetFletchBuckle*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_GetFletchBuckle" data-uid="Hi.Milling.MillingTools.MillingTool.GetFletchBuckle">
GetFletchBuckle()
</h3>
<div class="markdown level1 summary"><p>Get fletch buckle anchor.
the anchor that generally connect to fixed part such as ground and triggering(motor)-side.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor GetFletchBuckle()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd><p>buckle anchor</p>
</dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_GetFluteNum_" data-uid="Hi.Milling.MillingTools.MillingTool.GetFluteNum*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_GetFluteNum" data-uid="Hi.Milling.MillingTools.MillingTool.GetFluteNum">
GetFluteNum()
</h3>
<div class="markdown level1 summary"><p>Gets the number of flutes in the contour tray.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int GetFluteNum()</code></pre>
</div>
<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></dd>
</dl>
<a id="Hi_Milling_MillingTools_MillingTool_MakeXmlSource_" data-uid="Hi.Milling.MillingTools.MillingTool.MakeXmlSource*"></a>
<h3 id="Hi_Milling_MillingTools_MillingTool_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Milling.MillingTools.MillingTool.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
<div class="markdown level1 summary"><p>Creates an XML representation of the object.
This method may also generate additional resources such as related files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for the XML source</p>
</dd>
<dt><code>exhibitionOnly</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>if true, the extended file creation is suppressed.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a></dt>
<dd><p>An XML element representing the object's state</p>
</dd>
</dl>
<h4 class="section" id="Hi_Milling_MillingTools_MillingTool_MakeXmlSource_System_String_System_String_System_Boolean__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The <code class="paramref">baseDirectory</code> is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.</p>
</div>
</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>
Reference in New Issue View Git Blame Copy Permalink