HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tune

Browse Source
This commit is contained in:
iamboss
2025-07-25 16:27:29 +08:00
parent 38b27cd481
commit b5cad3c171
1114 changed files with 68009 additions and 23981 deletions
Download Patch File Download Diff File Expand all files Collapse all files
App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.AptProfile.html
+143 -56
View File
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AptProfile | HiAPI-C# 2025 ">
<meta name="description" content="Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. This profile uses APT definitions to describe the cutter geometry. Internal Use Only">
<meta name="description" content="Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. This profile uses APT definitions to describe the cutter geometry.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -98,13 +98,12 @@ Class AptProfile
</div>
<div class="markdown summary"><p>Represents an APT (Automatically Programmed Tool) based profile for a milling cutter.
This profile uses APT definitions to describe the cutter geometry.
Internal Use Only</p>
This profile uses APT definitions to describe the cutter geometry.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AptProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IGetSelectionName, IGetInitStickConvex, IVolumeRemover, IDisposable, IUpdateByContent, IClearCache</code></pre>
<pre><code class="lang-csharp hljs">public class AptProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IGetSelectionName, IGetInitStickConvex, IVolumeRemover, IDisposable, IUpdateByContent, IClearCache, IPolarResolution2dSourceProperty</code></pre>
</div>
@@ -124,8 +123,9 @@ Internal Use Only</p>
<div><a class="xref" href="Hi.Milling.Cutters.IShaperProfile.html">IShaperProfile</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.Geom.IGetStl.html">IGetStl</a></div>
<div><a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a></div>
<div><a class="xref" href="Hi.Geom.IGenStl.html">IGenStl</a></div>
<div><a class="xref" href="Hi.Geom.IGetStl.html">IGetStl</a></div>
<div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div>
<div><a class="xref" href="Hi.Common.IGetSelectionName.html">IGetSelectionName</a></div>
<div><a class="xref" href="Hi.Cbtr.IGetInitStickConvex.html">IGetInitStickConvex</a></div>
@@ -133,6 +133,7 @@ Internal Use Only</p>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
<div><a class="xref" href="Hi.Common.IUpdateByContent.html">IUpdateByContent</a></div>
<div><a class="xref" href="Hi.Common.IClearCache.html">IClearCache</a></div>
<div><a class="xref" href="Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html">IPolarResolution2dSourceProperty</a></div>
</dd>
</dl>
@@ -205,8 +206,8 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_AptProfile__ctor_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile__ctor_Hi_Milling_Cutters_MillingCutter_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor(Hi.Milling.Cutters.MillingCutter)">
AptProfile(MillingCutter)
<h3 id="Hi_Milling_Cutters_AptProfile__ctor" data-uid="Hi.Milling.Cutters.AptProfile.#ctor">
AptProfile()
</h3>
@@ -215,15 +216,9 @@ Internal Use Only</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AptProfile(MillingCutter host)</code></pre>
<pre><code class="lang-csharp hljs">public AptProfile()</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
<dd><p>The milling cutter that hosts this profile.</p>
</dd>
</dl>
@@ -238,8 +233,8 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_AptProfile__ctor_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile__ctor_Hi_Milling_Cutters_MillingCutter_Hi_Milling_Apts_IAptBased_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor(Hi.Milling.Cutters.MillingCutter,Hi.Milling.Apts.IAptBased)">
AptProfile(MillingCutter, IAptBased)
<h3 id="Hi_Milling_Cutters_AptProfile__ctor_Hi_Milling_Apts_IAptBased_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor(Hi.Milling.Apts.IAptBased)">
AptProfile(IAptBased)
</h3>
@@ -248,14 +243,11 @@ Internal Use Only</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AptProfile(MillingCutter host, IAptBased apt)</code></pre>
<pre><code class="lang-csharp hljs">public AptProfile(IAptBased apt)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>host</code> <a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
<dd><p>The milling cutter that hosts this profile.</p>
</dd>
<dt><code>apt</code> <a class="xref" href="Hi.Milling.Apts.IAptBased.html">IAptBased</a></dt>
<dd><p>The APT-based object.</p>
</dd>
@@ -274,8 +266,8 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_AptProfile__ctor_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile__ctor_System_Xml_Linq_XElement_System_String_Hi_Milling_Cutters_MillingCutter_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor(System.Xml.Linq.XElement,System.String,Hi.Milling.Cutters.MillingCutter)">
AptProfile(XElement, string, MillingCutter)
<h3 id="Hi_Milling_Cutters_AptProfile__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Milling.Cutters.AptProfile.#ctor(System.Xml.Linq.XElement,System.String)">
AptProfile(XElement, string)
</h3>
@@ -284,7 +276,7 @@ Internal Use Only</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AptProfile(XElement src, string baseDirectory, MillingCutter host)</code></pre>
<pre><code class="lang-csharp hljs">public AptProfile(XElement src, string baseDirectory)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -294,9 +286,6 @@ Internal Use Only</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>host</code> <a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
<dd><p>The milling cutter that hosts this profile.</p>
</dd>
</dl>
@@ -322,8 +311,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets the abstract note from the APT definition.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets the abstract note from the APT definition.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -355,8 +343,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the APT-based definition for the profile.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets or sets the APT-based definition for the profile.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -381,20 +368,19 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_AptProfile_Host_" data-uid="Hi.Milling.Cutters.AptProfile.Host*"></a>
<a id="Hi_Milling_Cutters_AptProfile_DefaultAngleResolution_rad_" data-uid="Hi.Milling.Cutters.AptProfile.DefaultAngleResolution_rad*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile_Host" data-uid="Hi.Milling.Cutters.AptProfile.Host">
Host
<h3 id="Hi_Milling_Cutters_AptProfile_DefaultAngleResolution_rad" data-uid="Hi.Milling.Cutters.AptProfile.DefaultAngleResolution_rad">
DefaultAngleResolution_rad
</h3>
<div class="markdown level1 summary"><p>Gets or sets the associated milling cutter.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets or sets the default angle resolution in radians.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MillingCutter Host { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public static double DefaultAngleResolution_rad { get; set; }</code></pre>
</div>
@@ -403,7 +389,70 @@ Internal Use Only</p>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Milling_Cutters_AptProfile_DefaultLinearResolution_mm_" data-uid="Hi.Milling.Cutters.AptProfile.DefaultLinearResolution_mm*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile_DefaultLinearResolution_mm" data-uid="Hi.Milling.Cutters.AptProfile.DefaultLinearResolution_mm">
DefaultLinearResolution_mm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the default linear resolution in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static double DefaultLinearResolution_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_Cutters_AptProfile_PolarResolution2dSource_" data-uid="Hi.Milling.Cutters.AptProfile.PolarResolution2dSource*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile_PolarResolution2dSource" data-uid="Hi.Milling.Cutters.AptProfile.PolarResolution2dSource">
PolarResolution2dSource
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Func&lt;IPolarResolution2d&gt; PolarResolution2dSource { 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.func-1">Func</a>&lt;<a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a>&gt;</dt>
<dd></dd>
</dl>
@@ -457,8 +506,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Clears all cached data.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Clears all cached data.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -485,8 +533,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Disposes of all resources.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Disposes of all resources.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -513,8 +560,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Disposes of unmanaged resources.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Disposes of unmanaged resources.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -579,6 +625,44 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_AptProfile_GenStl_" data-uid="Hi.Milling.Cutters.AptProfile.GenStl*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile_GenStl_Hi_Geom_Resolution_IPolarResolution2d_" data-uid="Hi.Milling.Cutters.AptProfile.GenStl(Hi.Geom.Resolution.IPolarResolution2d)">
GenStl(IPolarResolution2d)
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Stl GenStl(IPolarResolution2d resolution)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>resolution</code> <a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Stl.html">Stl</a></dt>
<dd><p>newly created Stl</p>
</dd>
</dl>
<a id="Hi_Milling_Cutters_AptProfile_GetInitStickConvex_" data-uid="Hi.Milling.Cutters.AptProfile.GetInitStickConvex*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile_GetInitStickConvex" data-uid="Hi.Milling.Cutters.AptProfile.GetInitStickConvex">
@@ -586,8 +670,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets the initial stick convex representation of the profile.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets the initial stick convex representation of the profile.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -620,8 +703,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets the display name for selection.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets the display name for selection.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -654,8 +736,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets the STL mesh representation of the profile.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets the STL mesh representation of the profile.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -688,8 +769,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets the ZR contour list for the profile.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets the ZR contour list for the profile.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -717,8 +797,8 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_AptProfile_MakeXmlSource_" data-uid="Hi.Milling.Cutters.AptProfile.MakeXmlSource*"></a>
<h3 id="Hi_Milling_Cutters_AptProfile_MakeXmlSource_System_String_System_String_" data-uid="Hi.Milling.Cutters.AptProfile.MakeXmlSource(System.String,System.String)">
MakeXmlSource(string, string)
<h3 id="Hi_Milling_Cutters_AptProfile_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Milling.Cutters.AptProfile.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
@@ -728,7 +808,7 @@ This method may also generate additional resources such as related files.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile)</code></pre>
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -738,6 +818,9 @@ This method may also generate additional resources such as related files.</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>
@@ -754,6 +837,11 @@ This method may also generate additional resources such as related files.</p>
<h4 class="section" id="Hi_Milling_Cutters_AptProfile_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>
@@ -765,8 +853,7 @@ This method may also generate additional resources such as related files.</p>
</h3>
<div class="markdown level1 summary"><p>Updates the profile based on content changes.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Updates the profile based on content changes.</p>
</div>
<div class="markdown level1 conceptual"></div>