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.CustomSpinningProfile.html
+73 -36
View File
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class CustomSpinningProfile | HiAPI-C# 2025 ">
<meta name="description" content="Represents a custom spinning profile for a milling cutter. This profile allows for custom geometry to be used as the cutter profile. Internal Use Only">
<meta name="description" content="Represents a custom spinning profile for a milling cutter. This profile allows for custom geometry to be used as the cutter profile.">
<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 CustomSpinningProfile
</div>
<div class="markdown summary"><p>Represents a custom spinning profile for a milling cutter.
This profile allows for custom geometry to be used as the cutter profile.
Internal Use Only</p>
This profile allows for custom geometry to be used as the cutter profile.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CustomSpinningProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache</code></pre>
<pre><code class="lang-csharp hljs">public class CustomSpinningProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache, IPolarResolution2dSourceProperty</code></pre>
</div>
@@ -124,10 +123,12 @@ 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.IClearCache.html">IClearCache</a></div>
<div><a class="xref" href="Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html">IPolarResolution2dSourceProperty</a></div>
</dd>
</dl>
@@ -200,8 +201,8 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor*"></a>
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_Hi_Milling_Cutters_MillingCutter_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor(Hi.Milling.Cutters.MillingCutter)">
CustomSpinningProfile(MillingCutter)
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_Hi_Geom_IGetStl_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor(Hi.Geom.IGetStl)">
CustomSpinningProfile(IGetStl)
</h3>
@@ -210,12 +211,12 @@ Internal Use Only</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CustomSpinningProfile(MillingCutter host)</code></pre>
<pre><code class="lang-csharp hljs">public CustomSpinningProfile(IGetStl geom)</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>
<dt><code>geom</code> <a class="xref" href="Hi.Geom.IGetStl.html">IGetStl</a></dt>
<dd></dd>
</dl>
@@ -232,8 +233,8 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor*"></a>
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_System_Xml_Linq_XElement_System_String_Hi_Milling_Cutters_MillingCutter_System_Object___" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor(System.Xml.Linq.XElement,System.String,Hi.Milling.Cutters.MillingCutter,System.Object[])">
CustomSpinningProfile(XElement, string, MillingCutter, params object[])
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile__ctor_System_Xml_Linq_XElement_System_String_System_Object___" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.#ctor(System.Xml.Linq.XElement,System.String,System.Object[])">
CustomSpinningProfile(XElement, string, params object[])
</h3>
@@ -242,7 +243,7 @@ Internal Use Only</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CustomSpinningProfile(XElement element, string baseDirectory, MillingCutter host, params object[] res)</code></pre>
<pre><code class="lang-csharp hljs">public CustomSpinningProfile(XElement element, string baseDirectory, params object[] res)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -252,9 +253,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 host milling cutter.</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd><p>Additional resolution parameters.</p>
@@ -283,8 +281,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets the abstract note describing the profile.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets the abstract note describing the profile.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -316,8 +313,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the geometry that defines the profile.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Gets or sets the geometry that defines the profile.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -342,20 +338,18 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_CustomSpinningProfile_Host_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.Host*"></a>
<a id="Hi_Milling_Cutters_CustomSpinningProfile_PolarResolution2dSource_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.PolarResolution2dSource*"></a>
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile_Host" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.Host">
Host
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile_PolarResolution2dSource" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.PolarResolution2dSource">
PolarResolution2dSource
</h3>
<div class="markdown level1 summary"><p>Gets or sets the associated milling cutter.
Internal Use Only</p>
</div>
<div class="markdown level1 summary"></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 Func&lt;IPolarResolution2d&gt; PolarResolution2dSource { get; set; }</code></pre>
</div>
@@ -364,7 +358,7 @@ 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.func-1">Func</a>&lt;<a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a>&gt;</dt>
<dd></dd>
</dl>
@@ -418,8 +412,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Clears any cached data.
Internal Use Only</p>
<div class="markdown level1 summary"><p>Clears any cached data.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -478,6 +471,44 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_CustomSpinningProfile_GenStl_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.GenStl*"></a>
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile_GenStl_Hi_Geom_Resolution_IPolarResolution2d_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.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_CustomSpinningProfile_GetStl_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.GetStl*"></a>
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile_GetStl" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.GetStl">
@@ -485,8 +516,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>
@@ -520,8 +550,7 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"><p>Gets the ZR contour list for the profile.
This method attempts to get the ZR list from various geometry types.
Internal Use Only</p>
This method attempts to get the ZR list from various geometry types.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -549,8 +578,8 @@ Internal Use Only</p>
<a id="Hi_Milling_Cutters_CustomSpinningProfile_MakeXmlSource_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.MakeXmlSource*"></a>
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile_MakeXmlSource_System_String_System_String_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.MakeXmlSource(System.String,System.String)">
MakeXmlSource(string, string)
<h3 id="Hi_Milling_Cutters_CustomSpinningProfile_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Milling.Cutters.CustomSpinningProfile.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
@@ -560,7 +589,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>
@@ -570,6 +599,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>
@@ -586,6 +618,11 @@ This method may also generate additional resources such as related files.</p>
<h4 class="section" id="Hi_Milling_Cutters_CustomSpinningProfile_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>