HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Machining.FreeformRemover.html
2025-07-25 16:27:29 +08:00

1403 lines
43 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class FreeformRemover | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class FreeformRemover | HiAPI-C# 2025 ">
<meta name="description" content="Represents a freeform cutting tool that can be used in machining operations. This cutter type supports complex geometries for both the noble (upper) part and the shaper (cutting) part.">
<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.Machining.FreeformRemover">
<h1 id="Hi_Machining_FreeformRemover" data-uid="Hi.Machining.FreeformRemover" class="text-break">
Class FreeformRemover
</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>Represents a freeform cutting tool that can be used in machining operations.
This cutter type supports complex geometries for both the noble (upper) part and the shaper (cutting) part.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FreeformRemover : ICutter, IGetSweptable, IVolumeRemover, IAnchoredDisplayee, IDisplayee, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache, INameNote</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">FreeformRemover</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Machining.ICutter.html">ICutter</a></div>
<div><a class="xref" href="Hi.Machining.IGetSweptable.html">IGetSweptable</a></div>
<div><a class="xref" href="Hi.Machining.IVolumeRemover.html">IVolumeRemover</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a></div>
<div><a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</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.Collision.IAnchoredCollidableStem.html">IAnchoredCollidableStem</a></div>
<div><a class="xref" href="Hi.Collision.IAnchoredCollidableNode.html">IAnchoredCollidableNode</a></div>
<div><a class="xref" href="Hi.Collision.IAnchoredCollidableBased.html">IAnchoredCollidableBased</a></div>
<div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div>
<div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
<div><a class="xref" href="Hi.Common.IClearCache.html">IClearCache</a></div>
<div><a class="xref" href="Hi.Common.INameNote.html">INameNote</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&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.Milling.Cutters.CutterUtil.html#Hi_Milling_Cutters_CutterUtil_GetCutterBodyCoolingArea_mm2_Hi_Machining_ICutter_">CutterUtil.GetCutterBodyCoolingArea_mm2(ICutter)</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.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_Machining_FreeformRemover_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>The FreeformRemover class provides functionality for:</p>
<ul>
<li>Managing complex cutting tool geometries</li>
<li>Supporting both spinning and non-spinning cutting operations</li>
<li>Handling collision detection and display</li>
<li>Managing tool assembly and anchoring</li>
<li>Supporting XML serialization and deserialization</li>
</ul>
</div>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Machining_FreeformRemover__ctor_" data-uid="Hi.Machining.FreeformRemover.#ctor*"></a>
<h3 id="Hi_Machining_FreeformRemover__ctor" data-uid="Hi.Machining.FreeformRemover.#ctor">
FreeformRemover()
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FreeformRemover()</code></pre>
</div>
<h4 class="section" id="Hi_Machining_FreeformRemover__ctor_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This constructor initializes the cutter with default settings and creates the necessary anchors
and topology bricks for both the noble and shaper parts.</p>
</div>
<a id="Hi_Machining_FreeformRemover__ctor_" data-uid="Hi.Machining.FreeformRemover.#ctor*"></a>
<h3 id="Hi_Machining_FreeformRemover__ctor_System_Xml_Linq_XElement_System_String_System_String_System_Object___" data-uid="Hi.Machining.FreeformRemover.#ctor(System.Xml.Linq.XElement,System.String,System.String,System.Object[])">
FreeformRemover(XElement, string, string, params object[])
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FreeformRemover(XElement src, string baseDirectory, string relFile, params object[] res)</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 cutter data.</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 for resolving references.</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd><p>Additional resources for initialization.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Machining_FreeformRemover_AbstractNote_" data-uid="Hi.Machining.FreeformRemover.AbstractNote*"></a>
<h3 id="Hi_Machining_FreeformRemover_AbstractNote" data-uid="Hi.Machining.FreeformRemover.AbstractNote">
AbstractNote
</h3>
<div class="markdown level1 summary"><p>Gets a brief description of the cutter, including its height.</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>
<h4 class="section" id="Hi_Machining_FreeformRemover_AbstractNote_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The abstract note includes the cutter type and its height dimension,
formatted as &quot;Freeform-H{height}&quot;.</p>
</div>
<a id="Hi_Machining_FreeformRemover_CollidableName_" data-uid="Hi.Machining.FreeformRemover.CollidableName*"></a>
<h3 id="Hi_Machining_FreeformRemover_CollidableName" data-uid="Hi.Machining.FreeformRemover.CollidableName">
CollidableName
</h3>
<div class="markdown level1 summary"><p>Gets the name used for collision detection purposes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string CollidableName { 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_Machining_FreeformRemover_CutterTip_" data-uid="Hi.Machining.FreeformRemover.CutterTip*"></a>
<h3 id="Hi_Machining_FreeformRemover_CutterTip" data-uid="Hi.Machining.FreeformRemover.CutterTip">
CutterTip
</h3>
<div class="markdown level1 summary"><p>Gets the cutter tip anchor point.
On the same location of <a class="xref" href="Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_GeomAnchor">GeomAnchor</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor CutterTip { 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>
<h4 class="section" id="Hi_Machining_FreeformRemover_CutterTip_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The cutter tip represents the reference point for the cutting edge or surface.
This point is used for positioning and orientation calculations during machining operations.</p>
</div>
<a id="Hi_Machining_FreeformRemover_GeomAnchor_" data-uid="Hi.Machining.FreeformRemover.GeomAnchor*"></a>
<h3 id="Hi_Machining_FreeformRemover_GeomAnchor" data-uid="Hi.Machining.FreeformRemover.GeomAnchor">
GeomAnchor
</h3>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_StrutGeom">StrutGeom</a> and <a class="xref" href="Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_ShaperGeom">ShaperGeom</a> locate on this anchor.
On the same location of <a class="xref" href="Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_CutterTip">CutterTip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Anchor GeomAnchor { 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_Machining_FreeformRemover_GeomToHolderBranch_" data-uid="Hi.Machining.FreeformRemover.GeomToHolderBranch*"></a>
<h3 id="Hi_Machining_FreeformRemover_GeomToHolderBranch" data-uid="Hi.Machining.FreeformRemover.GeomToHolderBranch">
GeomToHolderBranch
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Branch GeomToHolderBranch { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Branch.html">Branch</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_FreeformRemover_GeomToHolderTransformer_" data-uid="Hi.Machining.FreeformRemover.GeomToHolderTransformer*"></a>
<h3 id="Hi_Machining_FreeformRemover_GeomToHolderTransformer" data-uid="Hi.Machining.FreeformRemover.GeomToHolderTransformer">
GeomToHolderTransformer
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ITransformer GeomToHolderTransformer { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_FreeformRemover_IsSpinningCutter_" data-uid="Hi.Machining.FreeformRemover.IsSpinningCutter*"></a>
<h3 id="Hi_Machining_FreeformRemover_IsSpinningCutter" data-uid="Hi.Machining.FreeformRemover.IsSpinningCutter">
IsSpinningCutter
</h3>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this is a spinning cutting tool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsSpinningCutter { 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.boolean">bool</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Machining_FreeformRemover_IsSpinningCutter_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This property affects how the cutter interacts with the workpiece during machining operations.
Spinning cutters typically perform rotary cutting operations, while non-spinning cutters may be used for other types of machining.</p>
</div>
<a id="Hi_Machining_FreeformRemover_KeepHolderBuckleOnTop_" data-uid="Hi.Machining.FreeformRemover.KeepHolderBuckleOnTop*"></a>
<h3 id="Hi_Machining_FreeformRemover_KeepHolderBuckleOnTop" data-uid="Hi.Machining.FreeformRemover.KeepHolderBuckleOnTop">
KeepHolderBuckleOnTop
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool KeepHolderBuckleOnTop { 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.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_FreeformRemover_Name_" data-uid="Hi.Machining.FreeformRemover.Name*"></a>
<h3 id="Hi_Machining_FreeformRemover_Name" data-uid="Hi.Machining.FreeformRemover.Name">
Name
</h3>
<div class="markdown level1 summary"><p>Name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { 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_Machining_FreeformRemover_Note_" data-uid="Hi.Machining.FreeformRemover.Note*"></a>
<h3 id="Hi_Machining_FreeformRemover_Note" data-uid="Hi.Machining.FreeformRemover.Note">
Note
</h3>
<div class="markdown level1 summary"><p>Note.</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_Machining_FreeformRemover_ShaperGeom_" data-uid="Hi.Machining.FreeformRemover.ShaperGeom*"></a>
<h3 id="Hi_Machining_FreeformRemover_ShaperGeom" data-uid="Hi.Machining.FreeformRemover.ShaperGeom">
ShaperGeom
</h3>
<div class="markdown level1 summary"><p>Gets or sets the shaper (cutting) part geometry of the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IGetStl ShaperGeom { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.IGetStl.html">IGetStl</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Machining_FreeformRemover_ShaperGeom_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The shaper geometry represents the cutting portion of the tool that directly
interacts with the workpiece during machining operations.</p>
</div>
<a id="Hi_Machining_FreeformRemover_ShaperTopoBrick_" data-uid="Hi.Machining.FreeformRemover.ShaperTopoBrick*"></a>
<h3 id="Hi_Machining_FreeformRemover_ShaperTopoBrick" data-uid="Hi.Machining.FreeformRemover.ShaperTopoBrick">
ShaperTopoBrick
</h3>
<div class="markdown level1 summary"><p>Gets the topology brick representing the shaper (cutting) part of the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ITopoBrick ShaperTopoBrick { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcMech.Topo.ITopoBrick.html">ITopoBrick</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_FreeformRemover_StrutGeom_" data-uid="Hi.Machining.FreeformRemover.StrutGeom*"></a>
<h3 id="Hi_Machining_FreeformRemover_StrutGeom" data-uid="Hi.Machining.FreeformRemover.StrutGeom">
StrutGeom
</h3>
<div class="markdown level1 summary"><p>Gets or sets the strut (upper) part geometry of the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IGetStl StrutGeom { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.IGetStl.html">IGetStl</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Machining_FreeformRemover_StrutGeom_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The noble geometry represents the non-cutting portion of the tool, typically including
the tool holder and shank. This geometry is important for collision checking and visualization.</p>
</div>
<a id="Hi_Machining_FreeformRemover_StrutTopoBrick_" data-uid="Hi.Machining.FreeformRemover.StrutTopoBrick*"></a>
<h3 id="Hi_Machining_FreeformRemover_StrutTopoBrick" data-uid="Hi.Machining.FreeformRemover.StrutTopoBrick">
StrutTopoBrick
</h3>
<div class="markdown level1 summary"><p>Gets the topology brick representing the upper (noble) part of the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ITopoBrick StrutTopoBrick { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcMech.Topo.ITopoBrick.html">ITopoBrick</a></dt>
<dd></dd>
</dl>
<a id="Hi_Machining_FreeformRemover_XName_" data-uid="Hi.Machining.FreeformRemover.XName*"></a>
<h3 id="Hi_Machining_FreeformRemover_XName" data-uid="Hi.Machining.FreeformRemover.XName">
XName
</h3>
<div class="markdown level1 summary"><p>Name for XML IO.</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_Machining_FreeformRemover_ClearCache_" data-uid="Hi.Machining.FreeformRemover.ClearCache*"></a>
<h3 id="Hi_Machining_FreeformRemover_ClearCache" data-uid="Hi.Machining.FreeformRemover.ClearCache">
ClearCache()
</h3>
<div class="markdown level1 summary"><p>Clears all cached data associated with the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ClearCache()</code></pre>
</div>
<h4 class="section" id="Hi_Machining_FreeformRemover_ClearCache_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This includes clearing the cached sweptable and solid representations of both
the noble and shaper parts of the cutter.</p>
</div>
<a id="Hi_Machining_FreeformRemover_Display_" data-uid="Hi.Machining.FreeformRemover.Display*"></a>
<h3 id="Hi_Machining_FreeformRemover_Display_Hi_Disp_Bind_" data-uid="Hi.Machining.FreeformRemover.Display(Hi.Disp.Bind)">
Display(Bind)
</h3>
<div class="markdown level1 summary"><p>Displays the cutter using the provided binding context.</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>The binding context for display operations.</p>
</dd>
</dl>
<a id="Hi_Machining_FreeformRemover_Dispose_" data-uid="Hi.Machining.FreeformRemover.Dispose*"></a>
<h3 id="Hi_Machining_FreeformRemover_Dispose" data-uid="Hi.Machining.FreeformRemover.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_Machining_FreeformRemover_Dispose_" data-uid="Hi.Machining.FreeformRemover.Dispose*"></a>
<h3 id="Hi_Machining_FreeformRemover_Dispose_System_Boolean_" data-uid="Hi.Machining.FreeformRemover.Dispose(System.Boolean)">
Dispose(bool)
</h3>
<div class="markdown level1 summary"><p>Releases the unmanaged resources and optionally releases the managed resources.</p>
</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><p>true to release both managed and unmanaged resources; false to release only unmanaged resources.</p>
</dd>
</dl>
<a id="Hi_Machining_FreeformRemover_Duplicate_" data-uid="Hi.Machining.FreeformRemover.Duplicate*"></a>
<h3 id="Hi_Machining_FreeformRemover_Duplicate_System_Object___" data-uid="Hi.Machining.FreeformRemover.Duplicate(System.Object[])">
Duplicate(params object[])
</h3>
<div class="markdown level1 summary"><p>Creates a deep copy of the current instance.</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>Additional resources for duplication.</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 with copied geometry data.</p>
</dd>
</dl>
<a id="Hi_Machining_FreeformRemover_ExpandToBox3d_" data-uid="Hi.Machining.FreeformRemover.ExpandToBox3d*"></a>
<h3 id="Hi_Machining_FreeformRemover_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.Machining.FreeformRemover.ExpandToBox3d(Hi.Geom.Box3d)">
ExpandToBox3d(Box3d)
</h3>
<div class="markdown level1 summary"><p>Expands the given bounding box to include the cutter's geometry.</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>The bounding box to expand.</p>
</dd>
</dl>
<a id="Hi_Machining_FreeformRemover_GetAnchor_" data-uid="Hi.Machining.FreeformRemover.GetAnchor*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetAnchor" data-uid="Hi.Machining.FreeformRemover.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_Machining_FreeformRemover_GetAnchoredCollidableNode_" data-uid="Hi.Machining.FreeformRemover.GetAnchoredCollidableNode*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetAnchoredCollidableNode" data-uid="Hi.Machining.FreeformRemover.GetAnchoredCollidableNode">
GetAnchoredCollidableNode()
</h3>
<div class="markdown level1 summary"><p>Gets the anchored collidable node associated with this object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IAnchoredCollidableNode GetAnchoredCollidableNode()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Collision.IAnchoredCollidableNode.html">IAnchoredCollidableNode</a></dt>
<dd><p>The anchored collidable node.</p>
</dd>
</dl>
<a id="Hi_Machining_FreeformRemover_GetAnchoredCollidables_" data-uid="Hi.Machining.FreeformRemover.GetAnchoredCollidables*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetAnchoredCollidables" data-uid="Hi.Machining.FreeformRemover.GetAnchoredCollidables">
GetAnchoredCollidables()
</h3>
<div class="markdown level1 summary"><p>Gets the list of anchored collidable nodes contained by this stem.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;IAnchoredCollidableNode&gt; GetAnchoredCollidables()</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.Collision.IAnchoredCollidableNode.html">IAnchoredCollidableNode</a>&gt;</dt>
<dd><p>A list of anchored collidable nodes.</p>
</dd>
</dl>
<a id="Hi_Machining_FreeformRemover_GetAnchoredDisplayeeList_" data-uid="Hi.Machining.FreeformRemover.GetAnchoredDisplayeeList*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetAnchoredDisplayeeList" data-uid="Hi.Machining.FreeformRemover.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_Machining_FreeformRemover_GetAsmb_" data-uid="Hi.Machining.FreeformRemover.GetAsmb*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetAsmb" data-uid="Hi.Machining.FreeformRemover.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_Machining_FreeformRemover_GetFletchBuckle_" data-uid="Hi.Machining.FreeformRemover.GetFletchBuckle*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetFletchBuckle" data-uid="Hi.Machining.FreeformRemover.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_Machining_FreeformRemover_GetShaperDisplayee_" data-uid="Hi.Machining.FreeformRemover.GetShaperDisplayee*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetShaperDisplayee" data-uid="Hi.Machining.FreeformRemover.GetShaperDisplayee">
GetShaperDisplayee()
</h3>
<div class="markdown level1 summary"><p>Gets the shaper displayee for visualization purposes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IAnchoredDisplayee GetShaperDisplayee()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a></dt>
<dd><p>An IAnchoredDisplayee representing the shaper (cutting) part of the cutter.</p>
</dd>
</dl>
<h4 class="section" id="Hi_Machining_FreeformRemover_GetShaperDisplayee_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This method creates a display representation of the shaper geometry, which can be either
the raw geometry if it implements IDisplayee, or the topology brick representation.</p>
</div>
<a id="Hi_Machining_FreeformRemover_GetStrutAnchoredDisplayee_" data-uid="Hi.Machining.FreeformRemover.GetStrutAnchoredDisplayee*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetStrutAnchoredDisplayee" data-uid="Hi.Machining.FreeformRemover.GetStrutAnchoredDisplayee">
GetStrutAnchoredDisplayee()
</h3>
<div class="markdown level1 summary"><p>Gets the noble (upper) part displayee for visualization purposes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AnchoredDisplayee GetStrutAnchoredDisplayee()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.AnchoredDisplayee.html">AnchoredDisplayee</a></dt>
<dd><p>An AnchoredDisplayee representing the noble part of the cutter with modified display properties.</p>
</dd>
</dl>
<h4 class="section" id="Hi_Machining_FreeformRemover_GetStrutAnchoredDisplayee_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This method creates a display representation of the noble geometry with slightly darker coloring
to distinguish it from the shaper part during visualization.</p>
</div>
<a id="Hi_Machining_FreeformRemover_GetSweptable_" data-uid="Hi.Machining.FreeformRemover.GetSweptable*"></a>
<h3 id="Hi_Machining_FreeformRemover_GetSweptable_System_Double_" data-uid="Hi.Machining.FreeformRemover.GetSweptable(System.Double)">
GetSweptable(double)
</h3>
<div class="markdown level1 summary"><p>Gets the sweptable representation of the cutter for swept volume calculations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Sweptable GetSweptable(double fractionTolerance)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>fractionTolerance</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>The tolerance value for swept volume calculations.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Machining.Sweptable.html">Sweptable</a></dt>
<dd><p>A Sweptable object representing the cutter's swept volume, or null if the shaper geometry is not available.</p>
</dd>
</dl>
<h4 class="section" id="Hi_Machining_FreeformRemover_GetSweptable_System_Double__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The sweptable representation is cached for performance. Use ClearCache to reset the cached data.</p>
</div>
<a id="Hi_Machining_FreeformRemover_MakeXmlSource_" data-uid="Hi.Machining.FreeformRemover.MakeXmlSource*"></a>
<h3 id="Hi_Machining_FreeformRemover_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Machining.FreeformRemover.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_Machining_FreeformRemover_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>