tune
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ConstRatioProfile | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="Represents a constant ratio profile for a milling cutter. This profile maintains a constant ratio between inner and outer radii. Internal Use Only">
|
||||
<meta name="description" content="Represents a constant ratio profile for a milling cutter. This profile maintains a constant ratio between inner and outer radii.">
|
||||
<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 ConstRatioProfile
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Represents a constant ratio profile for a milling cutter.
|
||||
This profile maintains a constant ratio between inner and outer radii.
|
||||
Internal Use Only</p>
|
||||
This profile maintains a constant ratio between inner and outer radii.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class ConstRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class ConstRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGetStl, IDuplicate, IClearCache, IGenStl, IZrListSourceProperty</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.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.IGenStl.html">IGenStl</a></div>
|
||||
<div><a class="xref" href="Hi.Geom.IZrListSourceProperty.html">IZrListSourceProperty</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -200,26 +201,19 @@ Internal Use Only</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile__ctor_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile__ctor_Hi_Milling_Cutters_MillingCutter_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor(Hi.Milling.Cutters.MillingCutter)">
|
||||
ConstRatioProfile(MillingCutter)
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile__ctor" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor">
|
||||
ConstRatioProfile()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the ConstRatioProfile class.
|
||||
Internal Use Only</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the ConstRatioProfile class.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConstRatioProfile(MillingCutter millingCutter)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ConstRatioProfile()</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>millingCutter</code> <a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
|
||||
<dd><p>The associated milling cutter</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
@@ -234,25 +228,21 @@ Internal Use Only</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile__ctor_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile__ctor_Hi_Milling_Cutters_MillingCutter_System_Double_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor(Hi.Milling.Cutters.MillingCutter,System.Double)">
|
||||
ConstRatioProfile(MillingCutter, double)
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile__ctor_System_Double_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor(System.Double)">
|
||||
ConstRatioProfile(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the ConstRatioProfile class with a specified radius ratio.
|
||||
Internal Use Only</p>
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the ConstRatioProfile class with a specified radius ratio.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConstRatioProfile(MillingCutter millingCutter, double innerRadiusRatio)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ConstRatioProfile(double innerRadiusRatio)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>millingCutter</code> <a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
|
||||
<dd><p>The associated milling cutter</p>
|
||||
</dd>
|
||||
<dt><code>innerRadiusRatio</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The ratio between inner and outer radii</p>
|
||||
</dd>
|
||||
@@ -271,8 +261,8 @@ Internal Use Only</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile__ctor_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile__ctor_System_Xml_Linq_XElement_System_String_Hi_Milling_Cutters_MillingCutter_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor(System.Xml.Linq.XElement,System.String,Hi.Milling.Cutters.MillingCutter)">
|
||||
ConstRatioProfile(XElement, string, MillingCutter)
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.#ctor(System.Xml.Linq.XElement,System.String)">
|
||||
ConstRatioProfile(XElement, string)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -281,7 +271,7 @@ Internal Use Only</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ConstRatioProfile(XElement element, string baseDirectory, MillingCutter host)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public ConstRatioProfile(XElement element, string baseDirectory)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
@@ -291,9 +281,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>
|
||||
</dl>
|
||||
|
||||
@@ -319,8 +306,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>
|
||||
|
||||
@@ -345,39 +331,6 @@ Internal Use Only</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile_MillingCutter_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.MillingCutter*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile_MillingCutter" data-uid="Hi.Milling.Cutters.ConstRatioProfile.MillingCutter">
|
||||
MillingCutter
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the associated milling cutter.
|
||||
Internal Use Only</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public MillingCutter MillingCutter { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile_RadiusRatio_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.RadiusRatio*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile_RadiusRatio" data-uid="Hi.Milling.Cutters.ConstRatioProfile.RadiusRatio">
|
||||
@@ -385,8 +338,7 @@ Internal Use Only</p>
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the ratio between inner and outer radii.
|
||||
Internal Use Only</p>
|
||||
<div class="markdown level1 summary"><p>Gets or sets the ratio between inner and outer radii.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -443,6 +395,39 @@ Internal Use Only</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile_ZrListSource_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.ZrListSource*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile_ZrListSource" data-uid="Hi.Milling.Cutters.ConstRatioProfile.ZrListSource">
|
||||
ZrListSource
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Get base geometry source.
|
||||
Runtime property.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Func<IGetZrList> ZrListSource { 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><<a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a>></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
@@ -513,6 +498,44 @@ Internal Use Only</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile_GenStl_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.GenStl*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile_GenStl_Hi_Geom_Resolution_IPolarResolution2d_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.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_ConstRatioProfile_GetStl_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.GetStl*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile_GetStl" data-uid="Hi.Milling.Cutters.ConstRatioProfile.GetStl">
|
||||
@@ -581,8 +604,8 @@ Internal Use Only</p>
|
||||
|
||||
<a id="Hi_Milling_Cutters_ConstRatioProfile_MakeXmlSource_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.MakeXmlSource*"></a>
|
||||
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile_MakeXmlSource_System_String_System_String_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.MakeXmlSource(System.String,System.String)">
|
||||
MakeXmlSource(string, string)
|
||||
<h3 id="Hi_Milling_Cutters_ConstRatioProfile_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.Milling.Cutters.ConstRatioProfile.MakeXmlSource(System.String,System.String,System.Boolean)">
|
||||
MakeXmlSource(string, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -592,7 +615,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>
|
||||
@@ -602,6 +625,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>
|
||||
|
||||
@@ -618,6 +644,11 @@ This method may also generate additional resources such as related files.</p>
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="Hi_Milling_Cutters_ConstRatioProfile_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>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user