This commit is contained in:
2025-08-30 15:31:33 +08:00
parent 6e7d65b32a
commit 97aa5f3b30
766 changed files with 8238 additions and 1394 deletions
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AnchoredCollidabled | HiAPI-C# 2025 ">
<meta name="description" content="Represents a collidable object that is associated with an .">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class AnchoredCollidabled
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Represents a collidable object that is associated with an <a class="xref" href="Hi.Collisions.AnchoredCollidabled.html#Hi_Collisions_AnchoredCollidabled_Anchor">Anchor</a>.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -199,7 +200,8 @@ Class AnchoredCollidabled
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Collisions.AnchoredCollidabled.html">AnchoredCollidabled</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -225,7 +227,8 @@ Class AnchoredCollidabled
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Collisions.AnchoredCollidabled.html">AnchoredCollidabled</a> class with the specified anchor and collidable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -235,9 +238,11 @@ Class AnchoredCollidabled
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>anchor</code> <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
<dd><p>The anchor bound to the collidable.</p>
</dd>
<dt><code>collidable</code> <a class="xref" href="Hi.Collision.ICollidable.html">ICollidable</a></dt>
<dd></dd>
<dd><p>The collidable instance.</p>
</dd>
</dl>
@@ -262,7 +267,8 @@ Class AnchoredCollidabled
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the anchor associated with the collidable object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -293,7 +299,8 @@ Class AnchoredCollidabled
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the collidable instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -394,7 +401,8 @@ Class AnchoredCollidabled
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the anchor associated with the collidable object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -405,7 +413,8 @@ Class AnchoredCollidabled
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
<dd><p>The <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a> instance.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IAnchoredCollidabled | HiAPI-C# 2025 ">
<meta name="description" content="Defines a collidable object that has an associated .">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface IAnchoredCollidabled
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Defines a collidable object that has an associated <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a>.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -168,7 +169,8 @@ Interface IAnchoredCollidabled
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the anchor associated with the collidable object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -179,7 +181,8 @@ Interface IAnchoredCollidabled
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
<dd><p>The <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a> instance.</p>
</dd>
</dl>
@@ -96,14 +96,16 @@ Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Collisions.AnchoredCollidabled.html">AnchoredCollidabled</a></dt>
<dd></dd>
<dd><p>Represents a collidable object that is associated with an <a class="xref" href="Hi.Collisions.AnchoredCollidabled.html#Hi_Collisions_AnchoredCollidabled_Anchor">Anchor</a>.</p>
</dd>
</dl>
<h3 id="interfaces">
Interfaces
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Collisions.IAnchoredCollidabled.html">IAnchoredCollidabled</a></dt>
<dd></dd>
<dd><p>Defines a collidable object that has an associated <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a>.</p>
</dd>
</dl>
@@ -205,7 +205,8 @@ Class ExceptionUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Default handler invoked when an exception is shown.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -215,9 +216,11 @@ Class ExceptionUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>sender</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd></dd>
<dd><p>The source that raised the exception.</p>
</dd>
<dt><code>e</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
<dd></dd>
<dd><p>The exception instance.</p>
</dd>
</dl>
@@ -768,7 +768,7 @@ Since the folder can be moving with the configuration file.</p>
</h3>
<div class="markdown level1 summary"><p>Get the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a> to represent the object.</p>
<div class="markdown level1 summary"><p>Converts the current instance to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -780,7 +780,7 @@ Since the folder can be moving with the configuration file.</p>
<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><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a> to represent the object.</p>
<dd><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.xml.linq.xelement">XElement</a> representing this index.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class JsonUtil | HiAPI-C# 2025 ">
<meta name="description" content="Helper utilities for reading and writing JSON files.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class JsonUtil
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Helper utilities for reading and writing JSON files.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -159,7 +160,8 @@ Class JsonUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Writes a config object into a named section of a JSON file; merges when file exists and overwrites the same section name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -169,18 +171,22 @@ Class JsonUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>filePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>JSON file path</p>
</dd>
<dt><code>configName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>Section name to write</p>
</dd>
<dt><code>config</code> <span class="xref">TConfig</span></dt>
<dd></dd>
<dd><p>Section object to write</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TConfig</code></dt>
<dd></dd>
<dd><p>Type of the config object</p>
</dd>
</dl>
@@ -387,7 +387,8 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Adds a plain message to the default message kit.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -419,7 +420,8 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Adds a progress message to the default message kit.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -429,7 +431,8 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The message to write.</p>
</dd>
</dl>
@@ -483,7 +486,8 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Adds a warning message to the default message kit.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -557,7 +561,7 @@ Apply <a class="xref" href="Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a c
</h3>
<div class="markdown level1 summary"><p>Event triggered when a message is being added.</p>
<div class="markdown level1 summary"><p>Event triggered when a message is being added. Allows transforming or intercepting the entry before it is written.</p>
</div>
<div class="markdown level1 conceptual"></div>
+2 -1
View File
@@ -191,7 +191,8 @@ Used to indicate programming errors or unexpected states that require developer
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.JsonUtil.html">JsonUtil</a></dt>
<dd></dd>
<dd><p>Helper utilities for reading and writing JSON files.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.LooseRunner.html">LooseRunner</a></dt>
@@ -1286,6 +1286,37 @@ A value of -1 indicates that the display should follow the end of the strip.</p>
<h3 id="Hi_CutterLocations_ClStrips_ClStrip_MachiningStepSelected" data-uid="Hi.CutterLocations.ClStrips.ClStrip.MachiningStepSelected">
MachiningStepSelected
</h3>
<div class="markdown level1 summary"><p>The same effecting position as <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html#Hi_CutterLocations_ClStrips_ClStrip_PosSelected">PosSelected</a> but with more convenient arguments for the end-user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;MachiningStep&gt; MachiningStepSelected</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_CutterLocations_ClStrips_ClStrip_PosAdded" data-uid="Hi.CutterLocations.ClStrips.ClStrip.PosAdded">
PosAdded
@@ -247,20 +247,20 @@ Class ClStripPos
<a id="Hi_CutterLocations_ClStrips_ClStripPos_MillingStep_" data-uid="Hi.CutterLocations.ClStrips.ClStripPos.MillingStep*"></a>
<a id="Hi_CutterLocations_ClStrips_ClStripPos_MachiningStep_" data-uid="Hi.CutterLocations.ClStrips.ClStripPos.MachiningStep*"></a>
<h3 id="Hi_CutterLocations_ClStrips_ClStripPos_MillingStep" data-uid="Hi.CutterLocations.ClStrips.ClStripPos.MillingStep">
MillingStep
<h3 id="Hi_CutterLocations_ClStrips_ClStripPos_MachiningStep" data-uid="Hi.CutterLocations.ClStrips.ClStripPos.MachiningStep">
MachiningStep
</h3>
<div class="markdown level1 summary"><p>Gets or sets the milling step associated with this position.
This is a convenience property that casts the State to MillingStep.</p>
This is a convenience property that casts the State to MachiningStep.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningStep MillingStep { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public MachiningStep MachiningStep { get; set; }</code></pre>
</div>
@@ -1126,7 +1126,9 @@ If <code class="paramref">rgb</code> is null, ignore the <code class="paramref">
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Pushes a color onto the color stack by applying an RGB offset to the current color.
Ensures the resulting color stays within [0,1] by shifting or normalizing when needed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1136,7 +1138,8 @@ If <code class="paramref">rgb</code> is null, ignore the <code class="paramref">
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>rgbOffset</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
<dd></dd>
<dd><p>The RGB offset to add to the current color.</p>
</dd>
</dl>
@@ -1157,7 +1160,8 @@ If <code class="paramref">rgb</code> is null, ignore the <code class="paramref">
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Pushes a color onto the color stack by applying per-channel RGB offsets to the current color.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1167,11 +1171,14 @@ If <code class="paramref">rgb</code> is null, ignore the <code class="paramref">
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>rOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Offset applied to the red channel.</p>
</dd>
<dt><code>gOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Offset applied to the green channel.</p>
</dd>
<dt><code>bOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Offset applied to the blue channel.</p>
</dd>
</dl>
@@ -2359,7 +2359,8 @@ Where h is window height.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Rotate view 180 degrees around Z axis to switch to back view.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -239,7 +239,8 @@ Class DispUtil
</h3>
<div class="markdown level1 summary"><p>execute bind.models.Mul(src);</p>
<div class="markdown level1 summary"><p>Displays the given displayee with an additional model transform.
Internally pushes the transform to the model matrix stack, calls Display, then pops it.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -250,12 +251,14 @@ Class DispUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>displayee</code> <a class="xref" href="Hi.Disp.IDisplayee.html">IDisplayee</a></dt>
<dd></dd>
<dd><p>The displayee to render.</p>
</dd>
<dt><code>bind</code> <a class="xref" href="Hi.Disp.Bind.html">Bind</a></dt>
<dd><p>bind</p>
<dd><p>Rendering bind context.</p>
</dd>
<dt><code>mat</code> <a class="xref" href="Hi.Geom.Mat4d.html">Mat4d</a></dt>
<dd></dd>
<dd><p>The model transform to apply.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Segment3dDispUtil | HiAPI-C# 2025 ">
<meta name="description" content="Utilities for converting geometry segments to renderable drawings.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class Segment3dDispUtil
<dl><dt>Assembly</dt><dd>HiDisp.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Utilities for converting geometry segments to renderable drawings.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -159,7 +160,9 @@ Class Segment3dDispUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Converts a sequence of 3D segments to a line drawing.
Null endpoints are skipped. The resulting drawing uses GL_LINES with stamp <a class="xref" href="Hi.Disp.Stamp.html#Hi_Disp_Stamp_V">V</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -169,13 +172,15 @@ Class Segment3dDispUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>segments</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Geom.Segment3d.html">Segment3d</a>&gt;</dt>
<dd></dd>
<dd><p>Input segments to convert.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Disp.Drawing.html">Drawing</a></dt>
<dd></dd>
<dd><p>A drawing that renders the provided segments.</p>
</dd>
</dl>
+2 -1
View File
@@ -186,7 +186,8 @@ This function should be use with <a class="xref" href="Hi.Disp.PopModelMat.html"
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Disp.Segment3dDispUtil.html">Segment3dDispUtil</a></dt>
<dd></dd>
<dd><p>Utilities for converting geometry segments to renderable drawings.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Disp.ShowEventPickable.html">ShowEventPickable</a></dt>
@@ -350,7 +350,8 @@ The order of z values should be from small to large in general case.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Default polar resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -555,7 +556,7 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"><p>Generates a cylinder with the specified height, radius, and longitude number.</p>
<div class="markdown level1 summary"><p>Generates a cylinder with the specified height and radius.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -597,7 +598,7 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -608,13 +609,14 @@ This function is usually used to compute the bounding box of elements.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ExtendedCylinder | HiAPI-C# 2025 ">
<meta name="description" content="An extensible cylinder geometry that generates a corresponding by the start section and the total length.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class ExtendedCylinder
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>An extensible cylinder geometry that generates a corresponding <a class="xref" href="Hi.Geom.ExtendedCylinder.html#Hi_Geom_ExtendedCylinder_Cylindroid">Cylindroid</a> by the start section and the total length.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -219,7 +220,8 @@ Class ExtendedCylinder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -245,7 +247,8 @@ Class ExtendedCylinder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance with the specified total length and start section provider.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -255,9 +258,11 @@ Class ExtendedCylinder
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>fullLength</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Total length</p>
</dd>
<dt><code>beginPairZrSource</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="Hi.Geom.PairZr.html">PairZr</a>&gt;</dt>
<dd></dd>
<dd><p>Start section provider</p>
</dd>
</dl>
@@ -315,7 +320,8 @@ Class ExtendedCylinder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The provider of the starting ZR section.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -346,7 +352,8 @@ Class ExtendedCylinder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Returns a <a class="xref" href="Hi.Geom.ExtendedCylinder.html#Hi_Geom_ExtendedCylinder_Cylindroid">Cylindroid</a> view generated from current settings.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -377,7 +384,8 @@ Class ExtendedCylinder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The total length of the cylinder along the Z-axis.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -517,7 +525,7 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -528,13 +536,14 @@ This function is usually used to compute the bounding box of elements.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -216,7 +216,8 @@ The plane equation is: Ax + By + Cz + d = 0, where (A,B,C) is the normal vector
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Copy constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -226,7 +227,8 @@ The plane equation is: Ax + By + Cz + d = 0, where (A,B,C) is the normal vector
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.Geom.IFlat3d.html">IFlat3d</a></dt>
<dd></dd>
<dd><p>Source plane</p>
</dd>
</dl>
@@ -233,7 +233,8 @@ Class GeomCombination
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance with a set of STL sources.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -243,7 +244,8 @@ Class GeomCombination
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>stlSources</code> <a class="xref" href="Hi.Geom.IStlSource.html">IStlSource</a>[]</dt>
<dd></dd>
<dd><p>A set of STL sources</p>
</dd>
</dl>
@@ -438,7 +440,7 @@ Class GeomCombination
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -449,13 +451,14 @@ Class GeomCombination
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -160,7 +160,8 @@ Class GeomUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Expands the destination bounding box with the transformed bounding box of source under matrix <code class="paramref">mat</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -170,11 +171,14 @@ Class GeomUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></dt>
<dd></dd>
<dd><p>The source geometry</p>
</dd>
<dt><code>mat</code> <a class="xref" href="Hi.Geom.Mat4d.html">Mat4d</a></dt>
<dd></dd>
<dd><p>The transformation matrix</p>
</dd>
<dt><code>dst</code> <a class="xref" href="Hi.Geom.Box3d.html">Box3d</a></dt>
<dd></dd>
<dd><p>The destination bounding box</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IFlat3d | HiAPI-C# 2025 ">
<meta name="description" content="Interface for a 3D flat surface that provides location and normal vector.">
<meta name="description" content="Interface for a 3D plane that provides an anchor point and a normal vector.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,7 @@ Interface IFlat3d
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Interface for a 3D flat surface that provides location and normal vector.</p>
<div class="markdown summary"><p>Interface for a 3D plane that provides an anchor point and a normal vector.</p>
</div>
<div class="markdown conceptual"></div>
@@ -219,7 +219,8 @@ Interface IFlat3d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets an anchor point from a normal vector and signed distance to origin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -229,15 +230,18 @@ Interface IFlat3d
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>normal</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
<dd></dd>
<dd><p>The unit normal vector.</p>
</dd>
<dt><code>distanceToOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Signed distance to origin.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
<dd></dd>
<dd><p>The anchor point on the plane.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IGenStl | HiAPI-C# 2025 ">
<meta name="description" content="Interface for generating STL geometry with a resolution.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface IGenStl
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Interface for generating STL geometry with a resolution.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -152,7 +153,7 @@ Interface IGenStl
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -163,13 +164,14 @@ Interface IGenStl
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IZrListSourceProperty | HiAPI-C# 2025 ">
<meta name="description" content="Provides a source for obtaining an .">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface IZrListSourceProperty
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Provides a source for obtaining an <a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a>.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -152,7 +153,8 @@ Interface IZrListSourceProperty
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The provider for <a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IPolarResolution2dSourceProperty | HiAPI-C# 2025 ">
<meta name="description" content="Provides a property for the source of polar resolution.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface IPolarResolution2dSourceProperty
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Provides a property for the source of polar resolution.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -152,7 +153,8 @@ Interface IPolarResolution2dSourceProperty
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The provider of <a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PolarResolution2d | HiAPI-C# 2025 ">
<meta name="description" content="Polar resolution for generating geometry in polar coordinate.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class PolarResolution2d
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Polar resolution for generating geometry in polar coordinate.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -201,7 +202,8 @@ Class PolarResolution2d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.Resolution.PolarResolution2d.html">PolarResolution2d</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -227,7 +229,8 @@ Class PolarResolution2d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.Resolution.PolarResolution2d.html">PolarResolution2d</a> class with values.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -237,9 +240,11 @@ Class PolarResolution2d
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>linearResolution_mm</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Linear resolution in millimeters</p>
</dd>
<dt><code>angleResolution_rad</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Angular resolution in radians</p>
</dd>
</dl>
@@ -96,7 +96,8 @@ Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.Resolution.PolarResolution2d.html">PolarResolution2d</a></dt>
<dd></dd>
<dd><p>Polar resolution for generating geometry in polar coordinate.</p>
</dd>
</dl>
<h3 id="interfaces">
Interfaces
@@ -108,7 +109,8 @@ Interfaces
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html">IPolarResolution2dSourceProperty</a></dt>
<dd></dd>
<dd><p>Provides a property for the source of polar resolution.</p>
</dd>
</dl>
@@ -211,7 +211,8 @@ Class Segment3d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.Segment3d.html">Segment3d</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -237,7 +238,8 @@ Class Segment3d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.Segment3d.html">Segment3d</a> class with endpoints.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -247,9 +249,11 @@ Class Segment3d
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>begin</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
<dd></dd>
<dd><p>Start point</p>
</dd>
<dt><code>end</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a></dt>
<dd></dd>
<dd><p>End point</p>
</dd>
</dl>
@@ -306,7 +310,8 @@ Class Segment3d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The starting point of the segment.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -369,7 +374,8 @@ Class Segment3d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The ending point of the segment.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -432,7 +438,8 @@ Class Segment3d
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The squared length of the segment.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -756,7 +763,8 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Swaps the begin and end points of the segment.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -274,7 +274,9 @@ Class StlFile
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance with the specified file path and optional base directory.
If base directory is provided, the STL will be loaded immediately.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -284,9 +286,11 @@ Class StlFile
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>filePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>STL file path</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>Base directory to load file from</p>
</dd>
</dl>
@@ -504,7 +504,7 @@ If the geometry or its STL representation is null, no expansion occurs.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -515,13 +515,14 @@ If the geometry or its STL representation is null, no expansion occurs.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
+7 -4
View File
@@ -140,7 +140,8 @@ The data contains in a <a class="xref" href="Hi.Geom.Box3d.html">Box3d</a> is <a
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a></dt>
<dd></dd>
<dd><p>An extensible cylinder geometry that generates a corresponding <a class="xref" href="Hi.Geom.ExtendedCylinder.html#Hi_Geom_ExtendedCylinder_Cylindroid">Cylindroid</a> by the start section and the total length.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.Flat3d.html">Flat3d</a></dt>
@@ -286,12 +287,13 @@ Interfaces
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.IFlat3d.html">IFlat3d</a></dt>
<dd><p>Interface for a 3D flat surface that provides location and normal vector.</p>
<dd><p>Interface for a 3D plane that provides an anchor point and a normal vector.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.IGenStl.html">IGenStl</a></dt>
<dd></dd>
<dd><p>Interface for generating STL geometry with a resolution.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.IGeomProperty.html">IGeomProperty</a></dt>
@@ -330,7 +332,8 @@ Interfaces
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Geom.IZrListSourceProperty.html">IZrListSourceProperty</a></dt>
<dd></dd>
<dd><p>Provides a source for obtaining an <a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a>.</p>
</dd>
</dl>
<h3 id="enums">
Enums
@@ -0,0 +1,650 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class AppConfig | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AppConfig | HiAPI-C# 2025 ">
<meta name="description" content="Application/Environment Configuration">
<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.HiNcKits.AppConfig">
<h1 id="Hi_HiNcKits_AppConfig" data-uid="Hi.HiNcKits.AppConfig" class="text-break">
Class AppConfig
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.HiNcKits.html">HiNcKits</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"><p>Application/Environment Configuration</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AppConfig : IMakeXmlSource</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">AppConfig</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</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.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_HiNcKits_AppConfig__ctor_" data-uid="Hi.HiNcKits.AppConfig.#ctor*"></a>
<h3 id="Hi_HiNcKits_AppConfig__ctor" data-uid="Hi.HiNcKits.AppConfig.#ctor">
AppConfig()
</h3>
<div class="markdown level1 summary"><p>Default constructor</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppConfig()</code></pre>
</div>
<a id="Hi_HiNcKits_AppConfig__ctor_" data-uid="Hi.HiNcKits.AppConfig.#ctor*"></a>
<h3 id="Hi_HiNcKits_AppConfig__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.HiNcKits.AppConfig.#ctor(System.Xml.Linq.XElement,System.String)">
AppConfig(XElement, string)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a> class from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppConfig(XElement src, string baseDirectory)</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>XML element containing configuration data</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Base directory for resolving relative paths</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_HiNcKits_AppConfig_DisplayedStepPresentKeyList_" data-uid="Hi.HiNcKits.AppConfig.DisplayedStepPresentKeyList*"></a>
<h3 id="Hi_HiNcKits_AppConfig_DisplayedStepPresentKeyList" data-uid="Hi.HiNcKits.AppConfig.DisplayedStepPresentKeyList">
DisplayedStepPresentKeyList
</h3>
<div class="markdown level1 summary"><p>Step infomation key list to show.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;string&gt; DisplayedStepPresentKeyList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppConfig_EnableFullControl_" data-uid="Hi.HiNcKits.AppConfig.EnableFullControl*"></a>
<h3 id="Hi_HiNcKits_AppConfig_EnableFullControl" data-uid="Hi.HiNcKits.AppConfig.EnableFullControl">
EnableFullControl
</h3>
<div class="markdown level1 summary"><p>Enable Full control of the application.
Eanble System.Diagnostics.Process in GUI Script Command.
Not used yet.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnableFullControl { 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_HiNcKits_AppConfig_EquipmentWorkpieceSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.AppConfig.EquipmentWorkpieceSetupDisplayeeConfig*"></a>
<h3 id="Hi_HiNcKits_AppConfig_EquipmentWorkpieceSetupDisplayeeConfig" data-uid="Hi.HiNcKits.AppConfig.EquipmentWorkpieceSetupDisplayeeConfig">
EquipmentWorkpieceSetupDisplayeeConfig
</h3>
<div class="markdown level1 summary"><p>Configuration for EquipmentWorkpieceSetupDisplayee</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public WorkpieceEditorDisplayeeConfig EquipmentWorkpieceSetupDisplayeeConfig { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html">WorkpieceEditorDisplayeeConfig</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppConfig_FixtureSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.AppConfig.FixtureSetupDisplayeeConfig*"></a>
<h3 id="Hi_HiNcKits_AppConfig_FixtureSetupDisplayeeConfig" data-uid="Hi.HiNcKits.AppConfig.FixtureSetupDisplayeeConfig">
FixtureSetupDisplayeeConfig
</h3>
<div class="markdown level1 summary"><p>Configuration for FixtureSetupDisplayee</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FixtureEditorDisplayeeConfig FixtureSetupDisplayeeConfig { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppConfig_GraphicCacheLowerLimitMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheLowerLimitMb*"></a>
<h3 id="Hi_HiNcKits_AppConfig_GraphicCacheLowerLimitMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheLowerLimitMb">
GraphicCacheLowerLimitMb
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GraphicCacheLowerLimitMb { 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_HiNcKits_AppConfig_GraphicCacheMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheMb*"></a>
<h3 id="Hi_HiNcKits_AppConfig_GraphicCacheMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheMb">
GraphicCacheMb
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long GraphicCacheMb { 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.int64">long</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppConfig_GraphicCacheUpperLimitMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheUpperLimitMb*"></a>
<h3 id="Hi_HiNcKits_AppConfig_GraphicCacheUpperLimitMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheUpperLimitMb">
GraphicCacheUpperLimitMb
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double GraphicCacheUpperLimitMb { 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_HiNcKits_AppConfig_LanguageCode_" data-uid="Hi.HiNcKits.AppConfig.LanguageCode*"></a>
<h3 id="Hi_HiNcKits_AppConfig_LanguageCode" data-uid="Hi.HiNcKits.AppConfig.LanguageCode">
LanguageCode
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string LanguageCode { 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_HiNcKits_AppConfig_ShowPhysicsOptions_" data-uid="Hi.HiNcKits.AppConfig.ShowPhysicsOptions*"></a>
<h3 id="Hi_HiNcKits_AppConfig_ShowPhysicsOptions" data-uid="Hi.HiNcKits.AppConfig.ShowPhysicsOptions">
ShowPhysicsOptions
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ShowPhysicsOptions { 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_HiNcKits_AppConfig_XName_" data-uid="Hi.HiNcKits.AppConfig.XName*"></a>
<h3 id="Hi_HiNcKits_AppConfig_XName" data-uid="Hi.HiNcKits.AppConfig.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_HiNcKits_AppConfig_MakeXmlSource_" data-uid="Hi.HiNcKits.AppConfig.MakeXmlSource*"></a>
<h3 id="Hi_HiNcKits_AppConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.HiNcKits.AppConfig.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_HiNcKits_AppConfig_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>
@@ -0,0 +1,671 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class AppService | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class AppService | HiAPI-C# 2025 ">
<meta name="description" content="Application/Environment Service.">
<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.HiNcKits.AppService">
<h1 id="Hi_HiNcKits_AppService" data-uid="Hi.HiNcKits.AppService" class="text-break">
Class AppService
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.HiNcKits.html">HiNcKits</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"><p>Application/Environment Service.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AppService : IDisposable</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">AppService</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</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.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_HiNcKits_AppService__ctor_" data-uid="Hi.HiNcKits.AppService.#ctor*"></a>
<h3 id="Hi_HiNcKits_AppService__ctor" data-uid="Hi.HiNcKits.AppService.#ctor">
AppService()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppService()</code></pre>
</div>
<a id="Hi_HiNcKits_AppService__ctor_" data-uid="Hi.HiNcKits.AppService.#ctor*"></a>
<h3 id="Hi_HiNcKits_AppService__ctor_Hi_HiNcKits_AppConfig_" data-uid="Hi.HiNcKits.AppService.#ctor(Hi.HiNcKits.AppConfig)">
AppService(AppConfig)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppService(AppConfig userConfig)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>userConfig</code> <a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_HiNcKits_AppService_AdditionalStepPresentAccess_" data-uid="Hi.HiNcKits.AppService.AdditionalStepPresentAccess*"></a>
<h3 id="Hi_HiNcKits_AppService_AdditionalStepPresentAccess" data-uid="Hi.HiNcKits.AppService.AdditionalStepPresentAccess">
AdditionalStepPresentAccess
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, PresentAccess&gt; AdditionalStepPresentAccess { 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.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.MachiningSteps.PresentAccess.html">PresentAccess</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppService_AppConfig_" data-uid="Hi.HiNcKits.AppService.AppConfig*"></a>
<h3 id="Hi_HiNcKits_AppService_AppConfig" data-uid="Hi.HiNcKits.AppService.AppConfig">
AppConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppConfig AppConfig { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppService_AppConfigPath_" data-uid="Hi.HiNcKits.AppService.AppConfigPath*"></a>
<h3 id="Hi_HiNcKits_AppService_AppConfigPath" data-uid="Hi.HiNcKits.AppService.AppConfigPath">
AppConfigPath
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AppConfigPath { 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_HiNcKits_AppService_CandidateStepPresentKeyList_" data-uid="Hi.HiNcKits.AppService.CandidateStepPresentKeyList*"></a>
<h3 id="Hi_HiNcKits_AppService_CandidateStepPresentKeyList" data-uid="Hi.HiNcKits.AppService.CandidateStepPresentKeyList">
CandidateStepPresentKeyList
</h3>
<div class="markdown level1 summary"><p>Candidate Step Present Key List for display.
Read only.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;string&gt; CandidateStepPresentKeyList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppService_DisplayedStepPresentAccessList_" data-uid="Hi.HiNcKits.AppService.DisplayedStepPresentAccessList*"></a>
<h3 id="Hi_HiNcKits_AppService_DisplayedStepPresentAccessList" data-uid="Hi.HiNcKits.AppService.DisplayedStepPresentAccessList">
DisplayedStepPresentAccessList
</h3>
<div class="markdown level1 summary"><p>StepPresentAccessList for display.
Read only.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;KeyValuePair&lt;string, PresentAccess&gt;&gt; DisplayedStepPresentAccessList { 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.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.keyvaluepair-2">KeyValuePair</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.MachiningSteps.PresentAccess.html">PresentAccess</a>&gt;&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppService_EnablePhysics_" data-uid="Hi.HiNcKits.AppService.EnablePhysics*"></a>
<h3 id="Hi_HiNcKits_AppService_EnablePhysics" data-uid="Hi.HiNcKits.AppService.EnablePhysics">
EnablePhysics
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnablePhysics { 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.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppService_IsPhysicsLicensed_" data-uid="Hi.HiNcKits.AppService.IsPhysicsLicensed*"></a>
<h3 id="Hi_HiNcKits_AppService_IsPhysicsLicensed" data-uid="Hi.HiNcKits.AppService.IsPhysicsLicensed">
IsPhysicsLicensed
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsPhysicsLicensed { 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.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppService_SelectedItem_" data-uid="Hi.HiNcKits.AppService.SelectedItem*"></a>
<h3 id="Hi_HiNcKits_AppService_SelectedItem" data-uid="Hi.HiNcKits.AppService.SelectedItem">
SelectedItem
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object SelectedItem { 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.object">object</a></dt>
<dd></dd>
</dl>
<a id="Hi_HiNcKits_AppService_StepPresentAccessDictionary_" data-uid="Hi.HiNcKits.AppService.StepPresentAccessDictionary*"></a>
<h3 id="Hi_HiNcKits_AppService_StepPresentAccessDictionary" data-uid="Hi.HiNcKits.AppService.StepPresentAccessDictionary">
StepPresentAccessDictionary
</h3>
<div class="markdown level1 summary"><p>StepPresentAccessDictionary.
Read only.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, PresentAccess&gt; StepPresentAccessDictionary { 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.collections.generic.dictionary-2">Dictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.MachiningSteps.PresentAccess.html">PresentAccess</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_HiNcKits_AppService_Dispose_" data-uid="Hi.HiNcKits.AppService.Dispose*"></a>
<h3 id="Hi_HiNcKits_AppService_Dispose" data-uid="Hi.HiNcKits.AppService.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_HiNcKits_AppService_Dispose_" data-uid="Hi.HiNcKits.AppService.Dispose*"></a>
<h3 id="Hi_HiNcKits_AppService_Dispose_System_Boolean_" data-uid="Hi.HiNcKits.AppService.Dispose(System.Boolean)">
Dispose(bool)
</h3>
<div class="markdown level1 summary"></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></dd>
</dl>
<a id="Hi_HiNcKits_AppService_LooseSaveUserConfig_" data-uid="Hi.HiNcKits.AppService.LooseSaveUserConfig*"></a>
<h3 id="Hi_HiNcKits_AppService_LooseSaveUserConfig" data-uid="Hi.HiNcKits.AppService.LooseSaveUserConfig">
LooseSaveUserConfig()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void LooseSaveUserConfig()</code></pre>
</div>
<a id="Hi_HiNcKits_AppService_SaveUserConfig_" data-uid="Hi.HiNcKits.AppService.SaveUserConfig*"></a>
<h3 id="Hi_HiNcKits_AppService_SaveUserConfig" data-uid="Hi.HiNcKits.AppService.SaveUserConfig">
SaveUserConfig()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SaveUserConfig()</code></pre>
</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>
@@ -247,10 +247,10 @@ Class LocalApp
<a id="Hi_HiNcKits_LocalApp_UserConfig_" data-uid="Hi.HiNcKits.LocalApp.UserConfig*"></a>
<a id="Hi_HiNcKits_LocalApp_UserConfig_" data-uid="Hi.HiNcKits.LocalApp.AppConfig*"></a>
<h3 id="Hi_HiNcKits_LocalApp_UserConfig" data-uid="Hi.HiNcKits.LocalApp.UserConfig">
UserConfig
<h3 id="Hi_HiNcKits_LocalApp_UserConfig" data-uid="Hi.HiNcKits.LocalApp.AppConfig">
AppConfig
</h3>
@@ -258,7 +258,7 @@ Class LocalApp
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UserConfig UserConfig { get; }</code></pre>
<pre><code class="lang-csharp hljs">public static AppConfig AppConfig { get; }</code></pre>
</div>
@@ -267,7 +267,7 @@ Class LocalApp
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a></dt>
<dt><a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd></dd>
</dl>
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Class UserConfig | HiAPI-C# 2025 </title>
<title>Class AppConfig | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class UserConfig | HiAPI-C# 2025 ">
<meta name="title" content="Class AppConfig | HiAPI-C# 2025 ">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,12 +84,12 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.HiNcKits.UserConfig">
<article data-uid="Hi.HiNcKits.AppConfig">
<h1 id="Hi_HiNcKits_UserConfig" data-uid="Hi.HiNcKits.UserConfig" class="text-break">
Class UserConfig
<h1 id="Hi_HiNcKits_UserConfig" data-uid="Hi.HiNcKits.AppConfig" class="text-break">
Class AppConfig
</h1>
<div class="facts text-secondary">
@@ -101,7 +101,7 @@ Class UserConfig
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class UserConfig : IMakeXmlSource</code></pre>
<pre><code class="lang-csharp hljs">public class AppConfig : IMakeXmlSource</code></pre>
</div>
@@ -111,7 +111,7 @@ Class UserConfig
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">UserConfig</span></div>
<div><span class="xref">AppConfig</span></div>
</dd>
</dl>
@@ -183,10 +183,10 @@ Class UserConfig
</h2>
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.UserConfig.#ctor*"></a>
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.AppConfig.#ctor*"></a>
<h3 id="Hi_HiNcKits_UserConfig__ctor" data-uid="Hi.HiNcKits.UserConfig.#ctor">
UserConfig()
<h3 id="Hi_HiNcKits_UserConfig__ctor" data-uid="Hi.HiNcKits.AppConfig.#ctor">
AppConfig()
</h3>
@@ -195,7 +195,7 @@ Class UserConfig
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UserConfig()</code></pre>
<pre><code class="lang-csharp hljs">public AppConfig()</code></pre>
</div>
@@ -210,19 +210,19 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.UserConfig.#ctor*"></a>
<a id="Hi_HiNcKits_UserConfig__ctor_" data-uid="Hi.HiNcKits.AppConfig.#ctor*"></a>
<h3 id="Hi_HiNcKits_UserConfig__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.HiNcKits.UserConfig.#ctor(System.Xml.Linq.XElement,System.String)">
UserConfig(XElement, string)
<h3 id="Hi_HiNcKits_UserConfig__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.HiNcKits.AppConfig.#ctor(System.Xml.Linq.XElement,System.String)">
AppConfig(XElement, string)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a> class from XML data.</p>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a> class from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UserConfig(XElement src, string baseDirectory)</code></pre>
<pre><code class="lang-csharp hljs">public AppConfig(XElement src, string baseDirectory)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -250,9 +250,9 @@ Class UserConfig
</h2>
<a id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList_" data-uid="Hi.HiNcKits.UserConfig.DisplayedStepPresentKeyList*"></a>
<a id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList_" data-uid="Hi.HiNcKits.AppConfig.DisplayedStepPresentKeyList*"></a>
<h3 id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList" data-uid="Hi.HiNcKits.UserConfig.DisplayedStepPresentKeyList">
<h3 id="Hi_HiNcKits_UserConfig_DisplayedStepPresentKeyList" data-uid="Hi.HiNcKits.AppConfig.DisplayedStepPresentKeyList">
DisplayedStepPresentKeyList
</h3>
@@ -282,9 +282,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.UserConfig.EquipmentWorkpieceSetupDisplayeeConfig*"></a>
<a id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.AppConfig.EquipmentWorkpieceSetupDisplayeeConfig*"></a>
<h3 id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig" data-uid="Hi.HiNcKits.UserConfig.EquipmentWorkpieceSetupDisplayeeConfig">
<h3 id="Hi_HiNcKits_UserConfig_EquipmentWorkpieceSetupDisplayeeConfig" data-uid="Hi.HiNcKits.AppConfig.EquipmentWorkpieceSetupDisplayeeConfig">
EquipmentWorkpieceSetupDisplayeeConfig
</h3>
@@ -314,9 +314,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.UserConfig.FixtureSetupDisplayeeConfig*"></a>
<a id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig_" data-uid="Hi.HiNcKits.AppConfig.FixtureSetupDisplayeeConfig*"></a>
<h3 id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig" data-uid="Hi.HiNcKits.UserConfig.FixtureSetupDisplayeeConfig">
<h3 id="Hi_HiNcKits_UserConfig_FixtureSetupDisplayeeConfig" data-uid="Hi.HiNcKits.AppConfig.FixtureSetupDisplayeeConfig">
FixtureSetupDisplayeeConfig
</h3>
@@ -346,9 +346,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb_" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheLowerLimitMb*"></a>
<a id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheLowerLimitMb*"></a>
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheLowerLimitMb">
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheLowerLimitMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheLowerLimitMb">
GraphicCacheLowerLimitMb
</h3>
@@ -377,9 +377,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_GraphicCacheMb_" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheMb*"></a>
<a id="Hi_HiNcKits_UserConfig_GraphicCacheMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheMb*"></a>
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheMb" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheMb">
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheMb">
GraphicCacheMb
</h3>
@@ -408,9 +408,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb_" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheUpperLimitMb*"></a>
<a id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb_" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheUpperLimitMb*"></a>
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb" data-uid="Hi.HiNcKits.UserConfig.GraphicCacheUpperLimitMb">
<h3 id="Hi_HiNcKits_UserConfig_GraphicCacheUpperLimitMb" data-uid="Hi.HiNcKits.AppConfig.GraphicCacheUpperLimitMb">
GraphicCacheUpperLimitMb
</h3>
@@ -439,9 +439,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_LanguageCode_" data-uid="Hi.HiNcKits.UserConfig.LanguageCode*"></a>
<a id="Hi_HiNcKits_UserConfig_LanguageCode_" data-uid="Hi.HiNcKits.AppConfig.LanguageCode*"></a>
<h3 id="Hi_HiNcKits_UserConfig_LanguageCode" data-uid="Hi.HiNcKits.UserConfig.LanguageCode">
<h3 id="Hi_HiNcKits_UserConfig_LanguageCode" data-uid="Hi.HiNcKits.AppConfig.LanguageCode">
LanguageCode
</h3>
@@ -470,9 +470,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions_" data-uid="Hi.HiNcKits.UserConfig.ShowPhysicsOptions*"></a>
<a id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions_" data-uid="Hi.HiNcKits.AppConfig.ShowPhysicsOptions*"></a>
<h3 id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions" data-uid="Hi.HiNcKits.UserConfig.ShowPhysicsOptions">
<h3 id="Hi_HiNcKits_UserConfig_ShowPhysicsOptions" data-uid="Hi.HiNcKits.AppConfig.ShowPhysicsOptions">
ShowPhysicsOptions
</h3>
@@ -501,9 +501,9 @@ Class UserConfig
<a id="Hi_HiNcKits_UserConfig_XName_" data-uid="Hi.HiNcKits.UserConfig.XName*"></a>
<a id="Hi_HiNcKits_UserConfig_XName_" data-uid="Hi.HiNcKits.AppConfig.XName*"></a>
<h3 id="Hi_HiNcKits_UserConfig_XName" data-uid="Hi.HiNcKits.UserConfig.XName">
<h3 id="Hi_HiNcKits_UserConfig_XName" data-uid="Hi.HiNcKits.AppConfig.XName">
XName
</h3>
@@ -537,9 +537,9 @@ Class UserConfig
</h2>
<a id="Hi_HiNcKits_UserConfig_MakeXmlSource_" data-uid="Hi.HiNcKits.UserConfig.MakeXmlSource*"></a>
<a id="Hi_HiNcKits_UserConfig_MakeXmlSource_" data-uid="Hi.HiNcKits.AppConfig.MakeXmlSource*"></a>
<h3 id="Hi_HiNcKits_UserConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.HiNcKits.UserConfig.MakeXmlSource(System.String,System.String,System.Boolean)">
<h3 id="Hi_HiNcKits_UserConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.HiNcKits.AppConfig.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
@@ -401,10 +401,10 @@ Read only.</p>
<a id="Hi_HiNcKits_UserEnv_UserConfig_" data-uid="Hi.HiNcKits.UserEnv.UserConfig*"></a>
<a id="Hi_HiNcKits_UserEnv_UserConfig_" data-uid="Hi.HiNcKits.UserEnv.AppConfig*"></a>
<h3 id="Hi_HiNcKits_UserEnv_UserConfig" data-uid="Hi.HiNcKits.UserEnv.UserConfig">
UserConfig
<h3 id="Hi_HiNcKits_UserEnv_UserConfig" data-uid="Hi.HiNcKits.UserEnv.AppConfig">
AppConfig
</h3>
@@ -412,7 +412,7 @@ Read only.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UserConfig UserConfig { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public AppConfig AppConfig { get; set; }</code></pre>
</div>
@@ -421,7 +421,7 @@ Read only.</p>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a></dt>
<dt><a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd></dd>
</dl>
@@ -109,7 +109,7 @@ Host class for HiNC functionality that provides project management, path resolut
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.UserConfig.html">UserConfig</a></dt>
<dt><a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
@@ -340,7 +340,7 @@ and topology bricks for both the noble and shaper parts.</p>
<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>
formatted as &quot;Freeform-H{this.GetBox3d().Dim.Z}&quot;.</p>
</div>
@@ -455,7 +455,8 @@ On the same location of <a class="xref" href="Hi.Machining.FreeformRemover.html#
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the branch that transforms from <a class="xref" href="Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_GeomAnchor">GeomAnchor</a> to <span class="xref">Hi.Machining.FreeformRemover.HolderBuckle</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -486,7 +487,8 @@ On the same location of <a class="xref" href="Hi.Machining.FreeformRemover.html#
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the transformer from <a class="xref" href="Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_GeomAnchor">GeomAnchor</a> to <span class="xref">Hi.Machining.FreeformRemover.HolderBuckle</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -553,7 +555,8 @@ Spinning cutters typically perform rotary cutting operations, while non-spinning
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>When true, automatically translates the holder buckle to be above the highest geometry point.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -226,7 +226,8 @@ Interface ICutter
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The default theme color for cutter body visualization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -328,7 +329,8 @@ calculations during machining operations.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The default theme color for shank visualization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -0,0 +1,181 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IProjectService | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IProjectService | HiAPI-C# 2025 ">
<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.MachiningProcs.IProjectService">
<h1 id="Hi_MachiningProcs_IProjectService" data-uid="Hi.MachiningProcs.IProjectService" class="text-break">
Interface IProjectService
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IProjectService : IMachiningProjectGetter, IPathedMachiningProjectHost, IMachiningProjectHost</code></pre>
</div>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="Hi.MachiningProcs.IMachiningProjectGetter.html#Hi_MachiningProcs_IMachiningProjectGetter_GetMachiningProject">IMachiningProjectGetter.GetMachiningProject()</a>
</div>
<div>
<a class="xref" href="Hi.MachiningProcs.IPathedMachiningProjectHost.html#Hi_MachiningProcs_IPathedMachiningProjectHost_MachiningProjectPath">IPathedMachiningProjectHost.MachiningProjectPath</a>
</div>
<div>
<a class="xref" href="Hi.MachiningProcs.IMachiningProjectHost.html#Hi_MachiningProcs_IMachiningProjectHost_MachiningProject">IMachiningProjectHost.MachiningProject</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<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>
</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>
@@ -0,0 +1,175 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Delegate LocalProjectService.MachiningProjectChangedDelegate | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Delegate LocalProjectService.MachiningProjectChangedDelegate | HiAPI-C# 2025 ">
<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.MachiningProcs.LocalProjectService.MachiningProjectChangedDelegate">
<h1 id="Hi_MachiningProcs_LocalProjectService_MachiningProjectChangedDelegate" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectChangedDelegate" class="text-break">
Delegate LocalProjectService.MachiningProjectChangedDelegate
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public delegate void LocalProjectService.MachiningProjectChangedDelegate(MachiningProject project, string projectPath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>project</code> <a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
<dd></dd>
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<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>
</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>
@@ -0,0 +1,701 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class LocalProjectService | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class LocalProjectService | HiAPI-C# 2025 ">
<meta name="description" content="Root(Local) project service. Apply absolute file path.">
<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.MachiningProcs.LocalProjectService">
<h1 id="Hi_MachiningProcs_LocalProjectService" data-uid="Hi.MachiningProcs.LocalProjectService" class="text-break">
Class LocalProjectService
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningProcs.html">MachiningProcs</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"><p>Root(Local) project service.
Apply absolute file path.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class LocalProjectService : IProjectService, IMachiningProjectGetter, IPathedMachiningProjectHost, IMachiningProjectHost</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">LocalProjectService</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="Hi.MachiningProcs.IProjectService.html">IProjectService</a></div>
<div><a class="xref" href="Hi.MachiningProcs.IMachiningProjectGetter.html">IMachiningProjectGetter</a></div>
<div><a class="xref" href="Hi.MachiningProcs.IPathedMachiningProjectHost.html">IPathedMachiningProjectHost</a></div>
<div><a class="xref" href="Hi.MachiningProcs.IMachiningProjectHost.html">IMachiningProjectHost</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.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_MachiningProcs_LocalProjectService__ctor_" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService__ctor" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor">
LocalProjectService()
</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 LocalProjectService()</code></pre>
</div>
<a id="Hi_MachiningProcs_LocalProjectService__ctor_" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService__ctor_Hi_HiNcKits_AppService_Microsoft_Extensions_Logging_ILogger_Hi_MachiningProcs_LocalProjectService__" data-uid="Hi.MachiningProcs.LocalProjectService.#ctor(Hi.HiNcKits.AppService,Microsoft.Extensions.Logging.ILogger{Hi.MachiningProcs.LocalProjectService})">
LocalProjectService(AppService, ILogger&lt;LocalProjectService&gt;)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LocalProjectService(AppService userService, ILogger&lt;LocalProjectService&gt; logger)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>userService</code> <a class="xref" href="Hi.HiNcKits.AppService.html">AppService</a></dt>
<dd></dd>
<dt><code>logger</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1">ILogger</a>&lt;<a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_MachiningProcs_LocalProjectService_Logger_" data-uid="Hi.MachiningProcs.LocalProjectService.Logger*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_Logger" data-uid="Hi.MachiningProcs.LocalProjectService.Logger">
Logger
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ILogger&lt;LocalProjectService&gt; Logger { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.ilogger-1">ILogger</a>&lt;<a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_MachiningProject_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningProject" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProject">
MachiningProject
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningProject MachiningProject { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_MachiningProjectPath_" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectPath*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningProjectPath" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectPath">
MachiningProjectPath
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string MachiningProjectPath { 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_MachiningProcs_LocalProjectService_ProjectDirectory_" data-uid="Hi.MachiningProcs.LocalProjectService.ProjectDirectory*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_ProjectDirectory" data-uid="Hi.MachiningProcs.LocalProjectService.ProjectDirectory">
ProjectDirectory
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ProjectDirectory { 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_MachiningProcs_LocalProjectService_UserService_" data-uid="Hi.MachiningProcs.LocalProjectService.UserService*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_UserService" data-uid="Hi.MachiningProcs.LocalProjectService.UserService">
UserService
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppService UserService { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.HiNcKits.AppService.html">AppService</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_MachiningProcs_LocalProjectService_CloseProject_" data-uid="Hi.MachiningProcs.LocalProjectService.CloseProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_CloseProject" data-uid="Hi.MachiningProcs.LocalProjectService.CloseProject">
CloseProject()
</h3>
<div class="markdown level1 summary"><p>Closes the current project.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task CloseProject()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task representing the asynchronous operation</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_GetMachiningProject_" data-uid="Hi.MachiningProcs.LocalProjectService.GetMachiningProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_GetMachiningProject" data-uid="Hi.MachiningProcs.LocalProjectService.GetMachiningProject">
GetMachiningProject()
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningProject GetMachiningProject()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_LoadProject_" data-uid="Hi.MachiningProcs.LocalProjectService.LoadProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_LoadProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.LoadProject(System.String)">
LoadProject(string)
</h3>
<div class="markdown level1 summary"><p>Loads a project by file path relative to the admin directory.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task LoadProject(string projectPath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The absolute file path</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task representing the asynchronous operation</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_NewProject_" data-uid="Hi.MachiningProcs.LocalProjectService.NewProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_NewProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.NewProject(System.String)">
NewProject(string)
</h3>
<div class="markdown level1 summary"><p>Creates a new project by file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void NewProject(string projectPath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The absolute file path</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_ReloadProject_" data-uid="Hi.MachiningProcs.LocalProjectService.ReloadProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_ReloadProject" data-uid="Hi.MachiningProcs.LocalProjectService.ReloadProject">
ReloadProject()
</h3>
<div class="markdown level1 summary"><p>Reloads the current project.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task ReloadProject()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt>
<dd><p>A task representing the asynchronous operation</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_SaveAsProject_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveAsProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_SaveAsProject_System_String_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveAsProject(System.String)">
SaveAsProject(string)
</h3>
<div class="markdown level1 summary"><p>Saves the current project to a specified relative file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SaveAsProject(string projectPath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The absolute file path</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_LocalProjectService_SaveProject_" data-uid="Hi.MachiningProcs.LocalProjectService.SaveProject*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_SaveProject" data-uid="Hi.MachiningProcs.LocalProjectService.SaveProject">
SaveProject()
</h3>
<div class="markdown level1 summary"><p>Save project by ProjectPathRoute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SaveProject()</code></pre>
</div>
<h2 class="section" id="events">Events
</h2>
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningProjectChanged" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectChanged">
MachiningProjectChanged
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event LocalProjectService.MachiningProjectChangedDelegate MachiningProjectChanged</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a>.<a class="xref" href="Hi.MachiningProcs.LocalProjectService.MachiningProjectChangedDelegate.html">MachiningProjectChangedDelegate</a></dt>
<dd></dd>
</dl>
</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>
@@ -660,38 +660,6 @@ This is for internal use only.</p>
<a id="Hi_MachiningProcs_MachiningActRunner_ShellApi_" data-uid="Hi.MachiningProcs.MachiningActRunner.ShellApi*"></a>
<h3 id="Hi_MachiningProcs_MachiningActRunner_ShellApi" data-uid="Hi.MachiningProcs.MachiningActRunner.ShellApi">
ShellApi
</h3>
<div class="markdown level1 summary"><p>Gets the C# script API for the milling session.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ICsScriptApi ShellApi { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.ScriptApiUtils.ICsScriptApi.html">ICsScriptApi</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningActRunner_StepPreferredCubeWidth_" data-uid="Hi.MachiningProcs.MachiningActRunner.StepPreferredCubeWidth*"></a>
<h3 id="Hi_MachiningProcs_MachiningActRunner_StepPreferredCubeWidth" data-uid="Hi.MachiningProcs.MachiningActRunner.StepPreferredCubeWidth">
@@ -731,7 +699,8 @@ This is for internal use only.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the XYZABC kinematic chain if the current machining chain supports it; otherwise null.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -665,7 +665,7 @@ Only take effect if the <a class="xref" href="Hi.MachiningProcs.MachiningProject
</h3>
<div class="markdown level1 summary"><p>global variable for <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_RuntimeController">RuntimeController</a>.
<div class="markdown level1 summary"><p>global variable for <a class="xref" href="Hi.MachiningProcs.MachiningProject.html#Hi_MachiningProcs_MachiningProject_RuntimeApi">RuntimeApi</a>.
Not save on XML.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1235,19 +1235,19 @@ Updates related components when changed.</p>
<a id="Hi_MachiningProcs_MachiningProject_RuntimeController_" data-uid="Hi.MachiningProcs.MachiningProject.RuntimeController*"></a>
<a id="Hi_MachiningProcs_MachiningProject_RuntimeApi_" data-uid="Hi.MachiningProcs.MachiningProject.RuntimeApi*"></a>
<h3 id="Hi_MachiningProcs_MachiningProject_RuntimeController" data-uid="Hi.MachiningProcs.MachiningProject.RuntimeController">
RuntimeController
<h3 id="Hi_MachiningProcs_MachiningProject_RuntimeApi" data-uid="Hi.MachiningProcs.MachiningProject.RuntimeApi">
RuntimeApi
</h3>
<div class="markdown level1 summary"><p>Gets the shell API for interacting with this machining process.</p>
<div class="markdown level1 summary"><p>Gets the shell API for interacting with this machining process.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RuntimeController RuntimeController { get; }</code></pre>
<pre><code class="lang-csharp hljs">public RuntimeApi RuntimeApi { get; }</code></pre>
</div>
@@ -1256,7 +1256,7 @@ Updates related components when changed.</p>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
<dd></dd>
</dl>
File diff suppressed because it is too large Load Diff
@@ -1969,6 +1969,37 @@ public int ParaTemplateDimension { get; set; }</code></pre>
<a id="Hi_MachiningProcs_RuntimeController_RuntimeApi_" data-uid="Hi.MachiningProcs.RuntimeController.RuntimeApi*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_RuntimeApi" data-uid="Hi.MachiningProcs.RuntimeController.RuntimeApi">
RuntimeApi
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RuntimeApi RuntimeApi { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeController_ScriptOptions_" data-uid="Hi.MachiningProcs.RuntimeController.ScriptOptions*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_ScriptOptions" data-uid="Hi.MachiningProcs.RuntimeController.ScriptOptions">
@@ -2001,6 +2032,38 @@ public int ParaTemplateDimension { get; set; }</code></pre>
<a id="Hi_MachiningProcs_RuntimeController_SessionMessageHost_" data-uid="Hi.MachiningProcs.RuntimeController.SessionMessageHost*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_SessionMessageHost" data-uid="Hi.MachiningProcs.RuntimeController.SessionMessageHost">
SessionMessageHost
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce]
public SessionMessageHost SessionMessageHost { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.SessionMessageHost.html">SessionMessageHost</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeController_StepCount_" data-uid="Hi.MachiningProcs.RuntimeController.StepCount*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_StepCount" data-uid="Hi.MachiningProcs.RuntimeController.StepCount">
@@ -2566,6 +2629,7 @@ public MachiningStep GetMillingStep(int stepIndex)</code></pre>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;GetStickMachiningToolObservationHeight_mm($1toolId)&quot;)]
[HttpGet]
public double GetStickMachiningToolObservationHeight_mm(int toolId)</code></pre>
</div>
@@ -2838,6 +2902,7 @@ public void Pace()</code></pre>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Pause Player&quot;)]
[HttpPost]
public void Pause()</code></pre>
</div>
@@ -3157,6 +3222,7 @@ public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;ReadCsvByTimeInterpolation($1\&quot;csvFile\&quot;)&quot;)]
[HttpPost]
public void ReadCsvByTimeInterpolation(string csvFile)</code></pre>
</div>
@@ -3302,6 +3368,7 @@ public void RemoveFlyPiece()</code></pre>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(DocContentHtml = &quot;Reset Player&quot;)]
[HttpPost]
public void Reset()</code></pre>
</div>
@@ -3537,6 +3604,7 @@ public void SetNcResolutionFixed(double linearResolution_mm, double rotaryResolu
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;SetStickMachiningToolObservationHeight_mm($1toolId,$2height_mm)&quot;)]
[HttpPost]
public void SetStickMachiningToolObservationHeight_mm(int toolId, double height)</code></pre>
</div>
@@ -3840,7 +3908,8 @@ public void WriteRuntimeGeomToStl(string relFile, double resolution_mm = 0)</cod
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate)</code></pre>
<pre><code class="lang-csharp hljs">[HttpPost]
public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum SessionMessageHost.FilterFlag | HiAPI-C# 2025 ">
<meta name="description" content="Filtering flags for querying messages.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -98,7 +98,8 @@ Enum SessionMessageHost.FilterFlag
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Filtering flags for querying messages.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -147,16 +148,20 @@ public enum SessionMessageHost.FilterFlag</code></pre>
<dl class="parameters">
<dt id="Hi_MachiningProcs_SessionMessageHost_FilterFlag_Error"><code>Error = 8</code></dt>
<dd></dd>
<dd><p>Include error, warning, or exception messages.</p>
</dd>
<dt id="Hi_MachiningProcs_SessionMessageHost_FilterFlag_NC"><code>NC = 2</code></dt>
<dd></dd>
<dd><p>Include NC text messages.</p>
</dd>
<dt id="Hi_MachiningProcs_SessionMessageHost_FilterFlag_Progress"><code>Progress = 4</code></dt>
<dd></dd>
<dd><p>Include progress messages.</p>
</dd>
<dt id="Hi_MachiningProcs_SessionMessageHost_FilterFlag_Step"><code>Step = 1</code></dt>
<dd></dd>
<dd><p>Include machining step messages.</p>
</dd>
</dl>
@@ -327,7 +327,8 @@ The term stable means it is thread safe to access range from 0 to StableIndex(ex
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a filtered list of session messages.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -337,15 +338,18 @@ The term stable means it is thread safe to access range from 0 to StableIndex(ex
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>flags</code> <a class="xref" href="Hi.MachiningProcs.SessionMessageHost.html">SessionMessageHost</a>.<a class="xref" href="Hi.MachiningProcs.SessionMessageHost.FilterFlag.html">FilterFlag</a></dt>
<dd></dd>
<dd><p>Filtering flags that determine which message categories are included.</p>
</dd>
<dt><code>filterText</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>Optional text to filter by; case-insensitive contains match.</p>
</dd>
</dl>
<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.MachiningProcs.SessionMessage.html">SessionMessage</a>&gt;</dt>
<dd></dd>
<dd><p>A list of messages that match the specified filters.</p>
</dd>
</dl>
@@ -97,6 +97,12 @@ Classes
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html">DynamicMachiningProjectDisplayee</a></dt>
<dd><p>Provides display capabilities for a milling course.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a></dt>
<dd><p>Root(Local) project service.
Apply absolute file path.</p>
</dd>
</dl>
<dl class="jumplist">
@@ -148,6 +154,10 @@ Provides settings for physics simulation, evaluation, and temperature control.</
<dd><p>Provides utility methods for milling calculations and operations.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
<dd><p>Provides a C# scripting API for controlling and manipulating the milling course.
@@ -189,6 +199,10 @@ Interfaces
<dt><a class="xref" href="Hi.MachiningProcs.IPathedMachiningProjectHost.html">IPathedMachiningProjectHost</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.IProjectService.html">IProjectService</a></dt>
<dd></dd>
</dl>
<h3 id="enums">
Enums
</h3>
@@ -199,7 +213,8 @@ Enums
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.SessionMessageHost.FilterFlag.html">SessionMessageHost.FilterFlag</a></dt>
<dd></dd>
<dd><p>Filtering flags for querying messages.</p>
</dd>
</dl>
<h3 id="delegates">
Delegates
@@ -209,6 +224,10 @@ Delegates
<dd><p>Delegate for configuring a milling step with additional arguments.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.LocalProjectService.MachiningProjectChangedDelegate.html">LocalProjectService.MachiningProjectChangedDelegate</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html">MachiningActRunner.MachiningStepBuiltDelegate</a></dt>
<dd><p>Delegate for configuring a step with previous and current step information.</p>
@@ -0,0 +1,311 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class MachiningStep.CollidedKeyPair | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MachiningStep.CollidedKeyPair | HiAPI-C# 2025 ">
<meta name="description" content="A pair of collided keys that indicates two entities are in collision.">
<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.MachiningSteps.MachiningStep.CollidedKeyPair">
<h1 id="Hi_MachiningSteps_MachiningStep_CollidedKeyPair" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPair" class="text-break">
Class MachiningStep.CollidedKeyPair
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MachiningSteps.html">MachiningSteps</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>A pair of collided keys that indicates two entities are in collision.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public record MachiningStep.CollidedKeyPair : IEquatable&lt;MachiningStep.CollidedKeyPair&gt;</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">MachiningStep.CollidedKeyPair</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>.<a class="xref" href="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.html">CollidedKeyPair</a>&gt;</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.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_MachiningSteps_MachiningStep_CollidedKeyPair__ctor_" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.#ctor*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_CollidedKeyPair__ctor_System_String_System_String_" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.#ctor(System.String,System.String)">
CollidedKeyPair(string, string)
</h3>
<div class="markdown level1 summary"><p>A pair of collided keys that indicates two entities are in collision.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CollidedKeyPair(string KeyA, string KeyB)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>KeyA</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>KeyB</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_MachiningSteps_MachiningStep_CollidedKeyPair_KeyA_" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.KeyA*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_CollidedKeyPair_KeyA" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.KeyA">
KeyA
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string KeyA { get; init; }</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_MachiningSteps_MachiningStep_CollidedKeyPair_KeyB_" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.KeyB*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_CollidedKeyPair_KeyB" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.KeyB">
KeyB
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string KeyB { get; init; }</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>
</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>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MachiningStep | HiAPI-C# 2025 ">
<meta name="description" content="Represents a machining step enriched with physics, mapping and source metadata.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class MachiningStep
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Represents a machining step enriched with physics, mapping and source metadata.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -198,17 +199,17 @@ Class MachiningStep
<a id="Hi_MachiningSteps_MachiningStep__ctor_" data-uid="Hi.MachiningSteps.MachiningStep.#ctor*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep__ctor_Hi_MachiningSteps_IMachiningStepHost_System_Int32_Hi_MachiningSteps_ISourceCommand_Hi_MachiningSteps_MachineMotionStep_Hi_MillingSteps_MillingPhysicsStep_" data-uid="Hi.MachiningSteps.MachiningStep.#ctor(Hi.MachiningSteps.IMachiningStepHost,System.Int32,Hi.MachiningSteps.ISourceCommand,Hi.MachiningSteps.MachineMotionStep,Hi.MillingSteps.MillingPhysicsStep)">
MachiningStep(IMachiningStepHost, int, ISourceCommand, MachineMotionStep, MillingPhysicsStep)
<h3 id="Hi_MachiningSteps_MachiningStep__ctor_Hi_MachiningSteps_IMachiningStepHost_System_Int32_Hi_MachiningSteps_ISourceCommand_Hi_MachiningSteps_MachineMotionStep_Hi_MillingSteps_MillingPhysicsStep_Hi_MachiningSteps_MachiningStep_CollidedKeyPair___" data-uid="Hi.MachiningSteps.MachiningStep.#ctor(Hi.MachiningSteps.IMachiningStepHost,System.Int32,Hi.MachiningSteps.ISourceCommand,Hi.MachiningSteps.MachineMotionStep,Hi.MillingSteps.MillingPhysicsStep,Hi.MachiningSteps.MachiningStep.CollidedKeyPair[])">
MachiningStep(IMachiningStepHost, int, ISourceCommand, MachineMotionStep, MillingPhysicsStep, CollidedKeyPair[])
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the MillingStep class.</p>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningStep(IMachiningStepHost host, int stepIndex, ISourceCommand sourceCommand, MachineMotionStep machiningStep, MillingPhysicsStep millingPhysicsStep)</code></pre>
<pre><code class="lang-csharp hljs">public MachiningStep(IMachiningStepHost host, int stepIndex, ISourceCommand sourceCommand, MachineMotionStep machiningStep, MillingPhysicsStep millingPhysicsStep, MachiningStep.CollidedKeyPair[] collidedKeyPairs)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -223,10 +224,13 @@ Class MachiningStep
<dd><p>The source command.</p>
</dd>
<dt><code>machiningStep</code> <a class="xref" href="Hi.MachiningSteps.MachineMotionStep.html">MachineMotionStep</a></dt>
<dd><p>The machining step.</p>
<dd><p>The machine motion step parameters.</p>
</dd>
<dt><code>millingPhysicsStep</code> <a class="xref" href="Hi.MillingSteps.MillingPhysicsStep.html">MillingPhysicsStep</a></dt>
<dd><p>The milling physics step.</p>
<dd><p>The physics result for the step.</p>
</dd>
<dt><code>collidedKeyPairs</code> <a class="xref" href="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.html">CollidedKeyPair</a>[]</dt>
<dd><p>The collided key pairs detected in this step.</p>
</dd>
</dl>
@@ -1327,6 +1331,73 @@ public DVec3d Cl { get; }</code></pre>
<a id="Hi_MachiningSteps_MachiningStep_CollidedKeyPairs_" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPairs*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_CollidedKeyPairs" data-uid="Hi.MachiningSteps.MachiningStep.CollidedKeyPairs">
CollidedKeyPairs
</h3>
<div class="markdown level1 summary"><p>Gets or sets the collided key pairs if a collision was detected for this step.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningStep.CollidedKeyPair[] CollidedKeyPairs { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.html">CollidedKeyPair</a>[]</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningSteps_MachiningStep_CollisionText_" data-uid="Hi.MachiningSteps.MachiningStep.CollisionText*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_CollisionText" data-uid="Hi.MachiningSteps.MachiningStep.CollisionText">
CollisionText
</h3>
<div class="markdown level1 summary"><p>A formatted text representing collided key pairs, e.g. &quot;(A,B);(C,D)&quot;.
Returns null when there is no collision.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Present]
[JsAce(ClassExt = &quot;MachiningStep&quot;)]
public string CollisionText { 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_MachiningSteps_MachiningStep_CutterBodyTemperature_C_" data-uid="Hi.MachiningSteps.MachiningStep.CutterBodyTemperature_C*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_CutterBodyTemperature_C" data-uid="Hi.MachiningSteps.MachiningStep.CutterBodyTemperature_C">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PresentAccess | HiAPI-C# 2025 ">
<meta name="description" content="Provides a value accessor bound with its metadata.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class PresentAccess
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Provides a value accessor bound with its <a class="xref" href="Hi.MachiningSteps.PresentAttribute.html">PresentAttribute</a> metadata.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -184,7 +185,8 @@ Class PresentAccess
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningSteps.PresentAccess.html">PresentAccess</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -194,9 +196,11 @@ Class PresentAccess
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>present</code> <a class="xref" href="Hi.MachiningSteps.PresentAttribute.html">PresentAttribute</a></dt>
<dd></dd>
<dd><p>The presentation metadata.</p>
</dd>
<dt><code>getFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dd><p>The accessor delegate that retrieves the value.</p>
</dd>
</dl>
@@ -221,7 +225,8 @@ Class PresentAccess
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the accessor delegate used to retrieve the value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -252,7 +257,8 @@ Class PresentAccess
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the presentation metadata.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -102,7 +102,13 @@ Note that the spindle information is only for milling behavior.</p>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a></dt>
<dd></dd>
<dd><p>Represents a machining step enriched with physics, mapping and source metadata.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.html">MachiningStep.CollidedKeyPair</a></dt>
<dd><p>A pair of collided keys that indicates two entities are in collision.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningSteps.MachiningStepUtil.html">MachiningStepUtil</a></dt>
@@ -111,7 +117,8 @@ Note that the spindle information is only for milling behavior.</p>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningSteps.PresentAccess.html">PresentAccess</a></dt>
<dd></dd>
<dd><p>Provides a value accessor bound with its <a class="xref" href="Hi.MachiningSteps.PresentAttribute.html">PresentAttribute</a> metadata.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningSteps.PresentAttribute.html">PresentAttribute</a></dt>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface ITopoDisplayee | HiAPI-C# 2025 ">
<meta name="description" content="Represents a topology object that can be displayed and has an anchor.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface ITopoDisplayee
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Represents a topology object that can be displayed and has an anchor.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class TransformerUtil | HiAPI-C# 2025 ">
<meta name="description" content="Utility for">
<meta name="description" content="Utility for .">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,7 @@ Class TransformerUtil
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Utility for <a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></p>
<div class="markdown summary"><p>Utility for <a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a>.</p>
</div>
<div class="markdown conceptual"></div>
@@ -207,7 +207,7 @@ in form of <a class="xref" href="Hi.Disp.Flag.CoordinateDrawing.html">Coordinate
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Mech.Topo.TransformerUtil.html">TransformerUtil</a></dt>
<dd><p>Utility for <a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></p>
<dd><p>Utility for <a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a>.</p>
</dd>
</dl>
<h3 id="interfaces">
@@ -270,7 +270,8 @@ Interfaces
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Mech.Topo.ITopoDisplayee.html">ITopoDisplayee</a></dt>
<dd></dd>
<dd><p>Represents a topology object that can be displayed and has an anchor.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
@@ -651,7 +651,7 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -662,13 +662,14 @@ This function is usually used to compute the bounding box of elements.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -917,7 +917,7 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -934,7 +934,7 @@ This function is usually used to compute the bounding box of elements.</p>
<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><p>A newly created STL.</p>
</dd>
</dl>
@@ -439,7 +439,8 @@ This profile uses APT definitions to describe the cutter geometry.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The provider of <a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -632,7 +633,7 @@ This profile uses APT definitions to describe the cutter geometry.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -643,13 +644,14 @@ This profile uses APT definitions to describe the cutter geometry.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -505,7 +505,7 @@ Runtime property.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -516,13 +516,14 @@ Runtime property.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -206,7 +206,7 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
</h3>
<div class="markdown level1 summary"><p>Ctor</p>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Milling.Cutters.CustomSpinningProfile.html">CustomSpinningProfile</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -217,7 +217,8 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>geom</code> <a class="xref" href="Hi.Geom.IGetStl.html">IGetStl</a></dt>
<dd></dd>
<dd><p>The geometry that defines the profile.</p>
</dd>
</dl>
@@ -345,7 +346,8 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The provider of <a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -478,7 +480,7 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -489,13 +491,14 @@ This profile allows for custom geometry to be used as the cutter profile.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -306,7 +306,8 @@ This profile determines the ratio between inner and outer radii based on the num
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets a delegate that returns the current flute number.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -504,7 +505,7 @@ Runtime property.</p>
</h3>
<div class="markdown level1 summary"><p>Generate a new Stl.</p>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -515,13 +516,14 @@ Runtime property.</p>
<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>
<dd><p>Polar resolution</p>
</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><p>A newly created STL.</p>
</dd>
</dl>
@@ -1617,7 +1617,8 @@ the part triggers collision to workpiece if overlapped.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the provider for upper beam polar resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum MillingCutterEditorDisplayee.ShapeModeEnum | HiAPI-C# 2025 ">
<meta name="description" content="Display shape mode for the cutter.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -98,7 +98,8 @@ Enum MillingCutterEditorDisplayee.ShapeModeEnum
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Display shape mode for the cutter.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -146,10 +147,12 @@ Enum MillingCutterEditorDisplayee.ShapeModeEnum
<dl class="parameters">
<dt id="Hi_Milling_Cutters_MillingCutterEditorDisplayee_ShapeModeEnum_DetailPhysicsShape"><code>DetailPhysicsShape = 1</code></dt>
<dd></dd>
<dd><p>Render detailed physics-related shapes.</p>
</dd>
<dt id="Hi_Milling_Cutters_MillingCutterEditorDisplayee_ShapeModeEnum_SolidBoundingShape"><code>SolidBoundingShape = 0</code></dt>
<dd></dd>
<dd><p>Render only a simplified solid bounding shape.</p>
</dd>
</dl>
@@ -304,7 +304,8 @@ Internal Use Only</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the current display shape mode.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -165,7 +165,8 @@ Enums
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html">MillingCutterEditorDisplayee.ShapeModeEnum</a></dt>
<dd></dd>
<dd><p>Display shape mode for the cutter.</p>
</dd>
</dl>
@@ -153,7 +153,8 @@ Interface IFluteNumSourceProperty
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets a delegate that returns the current flute number.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IGetFluteNum | HiAPI-C# 2025 ">
<meta name="description" content="Provides a method to get the number of flutes.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface IGetFluteNum
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Provides a method to get the number of flutes.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -165,7 +165,8 @@ Interfaces
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Milling.FluteContours.IGetFluteNum.html">IGetFluteNum</a></dt>
<dd></dd>
<dd><p>Provides a method to get the number of flutes.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Milling.FluteContours.ISideContour.html">ISideContour</a></dt>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MillingToolEditorDisplayee | HiAPI-C# 2025 ">
<meta name="description" content="Display host for a milling tool composed of a cutter and a holder.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class MillingToolEditorDisplayee
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Display host for a milling tool composed of a cutter and a holder.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -214,7 +215,8 @@ Class MillingToolEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the displayee for the holder.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -245,7 +247,8 @@ Class MillingToolEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the displayee for the milling cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -276,7 +279,8 @@ Class MillingToolEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the current <a class="xref" href="Hi.Milling.MillingTools.MillingToolEditorDisplayee.html#Hi_Milling_MillingTools_MillingToolEditorDisplayee_MillingTool">MillingTool</a> instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -307,7 +311,8 @@ Class MillingToolEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the delegate that provides the <a class="xref" href="Hi.Milling.MillingTools.MillingToolEditorDisplayee.html#Hi_Milling_MillingTools_MillingToolEditorDisplayee_MillingTool">MillingTool</a> instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -338,7 +343,8 @@ Class MillingToolEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the cutter.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -369,7 +375,8 @@ Class MillingToolEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the holder.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -101,7 +101,8 @@ Classes
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Milling.MillingTools.MillingToolEditorDisplayee.html">MillingToolEditorDisplayee</a></dt>
<dd></dd>
<dd><p>Display host for a milling tool composed of a cutter and a holder.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Milling.MillingTools.MillingToolUtil.html">MillingToolUtil</a></dt>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IRakeFaceCuttingPara | HiAPI-C# 2025 ">
<meta name="description" content="Defines cutting parameters on the rake face for force modeling, supporting XML IO and duplication.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface IRakeFaceCuttingPara
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Defines cutting parameters on the rake face for force modeling, supporting XML IO and duplication.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -129,7 +129,8 @@ Interfaces
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html">IRakeFaceCuttingPara</a></dt>
<dd></dd>
<dd><p>Defines cutting parameters on the rake face for force modeling, supporting XML IO and duplication.</p>
</dd>
</dl>
@@ -449,7 +449,8 @@ Delegate by <a class="xref" href="Hi.NcMech.Fixtures.Fixture.html#Hi_NcMech_Fixt
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Anchor that represents the geometry origin of the fixture.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -480,7 +481,8 @@ Delegate by <a class="xref" href="Hi.NcMech.Fixtures.Fixture.html#Hi_NcMech_Fixt
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Branch that transforms from geometry origin to table origin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -543,7 +545,8 @@ Delegate by <a class="xref" href="Hi.NcMech.Fixtures.Fixture.html#Hi_NcMech_Fixt
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Branch that transforms from geometry origin to workpiece origin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -672,7 +675,8 @@ Solid anchor.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Default theme color used when rendering the fixture.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class FixtureEditorDisplayee | HiAPI-C# 2025 ">
<meta name="description" content="Displayee for fixture visualization and editor overlays.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class FixtureEditorDisplayee
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Displayee for fixture visualization and editor overlays.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -203,7 +204,8 @@ Class FixtureEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the visualization configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -234,7 +236,8 @@ Class FixtureEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the current <a class="xref" href="Hi.NcMech.Fixtures.FixtureEditorDisplayee.html#Hi_NcMech_Fixtures_FixtureEditorDisplayee_Fixture">Fixture</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -265,7 +268,8 @@ Class FixtureEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the delegate that provides the current <a class="xref" href="Hi.NcMech.Fixtures.FixtureEditorDisplayee.html#Hi_NcMech_Fixtures_FixtureEditorDisplayee_Fixture">Fixture</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -296,7 +300,8 @@ Class FixtureEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the rendering mode for the underlying solid.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -327,7 +332,8 @@ Class FixtureEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the geometry anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -358,7 +364,8 @@ Class FixtureEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the table buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -389,7 +396,8 @@ Class FixtureEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the workpiece buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class FixtureEditorDisplayeeConfig | HiAPI-C# 2025 ">
<meta name="description" content="Configuration settings for FixtureSetupDisplayee">
<meta name="description" content="Configuration settings for fixture editor display features.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,7 @@ Class FixtureEditorDisplayeeConfig
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Configuration settings for FixtureSetupDisplayee</p>
<div class="markdown summary"><p>Configuration settings for fixture editor display features.</p>
</div>
<div class="markdown conceptual"></div>
@@ -191,7 +191,8 @@ Class FixtureEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -217,7 +218,7 @@ Class FixtureEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"><p>Constructor for XML deserialization</p>
<div class="markdown level1 summary"><p>Initializes a new instance from XML.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -253,7 +254,8 @@ Class FixtureEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the rendering mode of the solid.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -284,7 +286,8 @@ Class FixtureEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the geometry anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -315,7 +318,8 @@ Class FixtureEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the table buckle.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -346,7 +350,8 @@ Class FixtureEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the workpiece buckle.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -101,11 +101,12 @@ Classes
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcMech.Fixtures.FixtureEditorDisplayee.html">FixtureEditorDisplayee</a></dt>
<dd></dd>
<dd><p>Displayee for fixture visualization and editor overlays.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a></dt>
<dd><p>Configuration settings for FixtureSetupDisplayee</p>
<dd><p>Configuration settings for fixture editor display features.</p>
</dd>
</dl>
@@ -497,7 +497,8 @@ Class CylindroidHolder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the cutter buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -656,7 +657,8 @@ Class CylindroidHolder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the polar resolution used for STL generation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -687,7 +689,8 @@ Class CylindroidHolder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the spindle buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1078,7 +1081,8 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the anchor associated with the collidable object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1089,7 +1093,8 @@ This function is usually used to compute the bounding box of elements.</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
<dd><p>The <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a> instance.</p>
</dd>
</dl>
@@ -1209,7 +1214,7 @@ the anchor that generally connect to fixed part such as ground and triggering(mo
</h3>
<div class="markdown level1 summary"><p>Cutter Buckle. Generally locate on free-end-side.</p>
<div class="markdown level1 summary"><p>Gets the cutter buckle anchor, generally located on the free-end side.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -1180,7 +1180,8 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the anchor associated with the collidable object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1191,7 +1192,8 @@ This function is usually used to compute the bounding box of elements.</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a></dt>
<dd></dd>
<dd><p>The <a class="xref" href="Hi.Mech.Topo.Anchor.html">Anchor</a> instance.</p>
</dd>
</dl>
@@ -1311,7 +1313,7 @@ the anchor that generally connect to fixed part such as ground and triggering(mo
</h3>
<div class="markdown level1 summary"><p>Cutter Buckle. Generally locate on free-end-side.</p>
<div class="markdown level1 summary"><p>Gets the cutter buckle anchor, generally located on the free-end side.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class HolderEditorDisplayee | HiAPI-C# 2025 ">
<meta name="description" content="Displayee for holder editor that provides visualization functionality">
<meta name="description" content="Displayee for holder editor that provides visualization functionality.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,7 @@ Class HolderEditorDisplayee
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Displayee for holder editor that provides visualization functionality</p>
<div class="markdown summary"><p>Displayee for holder editor that provides visualization functionality.</p>
</div>
<div class="markdown conceptual"></div>
@@ -301,7 +301,8 @@ Class HolderEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the rendering mode for the holder solid.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -332,7 +333,8 @@ Class HolderEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the cutter buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -363,7 +365,8 @@ Class HolderEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the geometry anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -394,7 +397,8 @@ Class HolderEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show the spindle buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -220,7 +220,8 @@ Interface IHolder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the cutter buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -251,7 +252,8 @@ Interface IHolder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the geometry anchor of the holder.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -282,7 +284,8 @@ Interface IHolder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the spindle buckle anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -313,7 +316,8 @@ Interface IHolder
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Default theme color for holder visualization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -348,7 +352,7 @@ Interface IHolder
</h3>
<div class="markdown level1 summary"><p>Cutter Buckle. Generally locate on free-end-side.</p>
<div class="markdown level1 summary"><p>Gets the cutter buckle anchor, generally located on the free-end side.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -106,7 +106,7 @@ Classes
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcMech.Holders.HolderEditorDisplayee.html">HolderEditorDisplayee</a></dt>
<dd><p>Displayee for holder editor that provides visualization functionality</p>
<dd><p>Displayee for holder editor that provides visualization functionality.</p>
</dd>
</dl>
<h3 id="interfaces">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum Solid.RenderingModeEnum | HiAPI-C# 2025 ">
<meta name="description" content="Rendering mode for solids.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -98,7 +98,8 @@ Enum Solid.RenderingModeEnum
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Rendering mode for solids.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -146,13 +147,16 @@ Enum Solid.RenderingModeEnum
<dl class="parameters">
<dt id="Hi_NcMech_Solids_Solid_RenderingModeEnum_Edge"><code>Edge = 1</code></dt>
<dd></dd>
<dd><p>Render only feature edges.</p>
</dd>
<dt id="Hi_NcMech_Solids_Solid_RenderingModeEnum_Hide"><code>Hide = 2</code></dt>
<dd></dd>
<dd><p>Hidden (do not render).</p>
</dd>
<dt id="Hi_NcMech_Solids_Solid_RenderingModeEnum_Solid"><code>Solid = 0</code></dt>
<dd></dd>
<dd><p>Render full solid surfaces.</p>
</dd>
</dl>
@@ -479,7 +479,8 @@ The data is created from the STL representation when first accessed.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The provider of <a class="xref" href="Hi.Geom.Resolution.IPolarResolution2d.html">IPolarResolution2d</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -675,7 +676,8 @@ The cache determines the behavior of the <a class="xref" href="Hi.NcMech.Solids.
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Displays the solid according to the specified rendering mode.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -685,9 +687,11 @@ The cache determines the behavior of the <a class="xref" href="Hi.NcMech.Solids.
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>bind</code> <a class="xref" href="Hi.Disp.Bind.html">Bind</a></dt>
<dd></dd>
<dd><p>Display binding context.</p>
</dd>
<dt><code>renderingMode</code> <a class="xref" href="Hi.NcMech.Solids.Solid.html">Solid</a>.<a class="xref" href="Hi.NcMech.Solids.Solid.RenderingModeEnum.html">RenderingModeEnum</a></dt>
<dd></dd>
<dd><p>Rendering mode.</p>
</dd>
</dl>
@@ -708,7 +712,8 @@ The cache determines the behavior of the <a class="xref" href="Hi.NcMech.Solids.
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Displays the feature edges of the solid.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -718,7 +723,8 @@ The cache determines the behavior of the <a class="xref" href="Hi.NcMech.Solids.
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>bind</code> <a class="xref" href="Hi.Disp.Bind.html">Bind</a></dt>
<dd></dd>
<dd><p>Display binding context.</p>
</dd>
</dl>
@@ -120,7 +120,8 @@ Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcMech.Solids.Solid.RenderingModeEnum.html">Solid.RenderingModeEnum</a></dt>
<dd></dd>
<dd><p>Rendering mode for solids.</p>
</dd>
</dl>
@@ -1729,7 +1729,8 @@ Since the folder can be moving with the configuration file.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Sets the runtime geometry instance and rebuilds its attachments.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1739,7 +1740,8 @@ Since the folder can be moving with the configuration file.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>runtimeGeom_</code> <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a></dt>
<dd></dd>
<dd><p>The runtime cube tree geometry.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class WorkpieceEditorDisplayee | HiAPI-C# 2025 ">
<meta name="description" content="Displayee for visualizing workpiece raw/ideal/runtime geometry and anchors.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class WorkpieceEditorDisplayee
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Displayee for visualizing workpiece raw/ideal/runtime geometry and anchors.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -194,7 +195,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the configuration for visualization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -225,7 +227,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the rendering mode for fixture.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -256,7 +259,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the rendering mode for ideal geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -287,7 +291,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the delegate that provides <span class="xref">Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.MachiningEquipment</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -318,7 +323,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the rendering mode for raw geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -349,7 +355,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show runtime geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -384,7 +391,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Clears the ideal geometry cache on workpiece.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -410,7 +418,8 @@ Class WorkpieceEditorDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Clears the raw geometry cache on workpiece.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class WorkpieceEditorDisplayeeConfig | HiAPI-C# 2025 ">
<meta name="description" content="Configuration settings for EquipmentWorkpieceSetupDispalyee">
<meta name="description" content="Configuration settings for workpiece editor display.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,7 @@ Class WorkpieceEditorDisplayeeConfig
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Configuration settings for EquipmentWorkpieceSetupDispalyee</p>
<div class="markdown summary"><p>Configuration settings for workpiece editor display.</p>
</div>
<div class="markdown conceptual"></div>
@@ -191,7 +191,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html">WorkpieceEditorDisplayeeConfig</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -217,7 +218,7 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"><p>Constructor for XML deserialization</p>
<div class="markdown level1 summary"><p>Initializes a new instance from XML.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -253,7 +254,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Rendering mode for fixture geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -284,7 +286,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Rendering mode for ideal geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -315,7 +318,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Rendering mode for raw geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -346,7 +350,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Whether to show fixture buckle.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -377,7 +382,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Whether to show geometry anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -408,7 +414,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Whether to show program zero anchor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -439,7 +446,8 @@ Class WorkpieceEditorDisplayeeConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Whether to show runtime geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -101,11 +101,12 @@ Classes
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a></dt>
<dd></dd>
<dd><p>Displayee for visualizing workpiece raw/ideal/runtime geometry and anchors.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html">WorkpieceEditorDisplayeeConfig</a></dt>
<dd><p>Configuration settings for EquipmentWorkpieceSetupDispalyee</p>
<dd><p>Configuration settings for workpiece editor display.</p>
</dd>
</dl>
@@ -207,7 +207,8 @@ Class ActClArc
<dd><p>The circle arc path.</p>
</dd>
<dt><code>duration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd></dd>
<dd><p>The total duration of the arc action.</p>
</dd>
</dl>
@@ -342,7 +343,8 @@ Class ActClArc
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a sequence of steps split from this movement under the specified NC resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -352,13 +354,15 @@ Class ActClArc
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncResolution</code> <a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html">IMachiningMotionResolution</a></dt>
<dd></dd>
<dd><p>The machining motion resolution.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>&gt;</dt>
<dd></dd>
<dd><p>A sequence of <a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>.</p>
</dd>
</dl>
@@ -207,7 +207,8 @@ Class ActClLinear
<dd><p>The linear cutter location path.</p>
</dd>
<dt><code>duration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a>?</dt>
<dd></dd>
<dd><p>Optional total duration of the linear action.</p>
</dd>
</dl>
@@ -228,7 +229,8 @@ Class ActClLinear
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Numerical.Acts.ActClLinear.html">ActClLinear</a> class with begin and end cutter locations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -238,11 +240,14 @@ Class ActClLinear
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>beginCl</code> <a class="xref" href="Hi.Geom.DVec3d.html">DVec3d</a></dt>
<dd></dd>
<dd><p>The begin cutter location.</p>
</dd>
<dt><code>endCl</code> <a class="xref" href="Hi.Geom.DVec3d.html">DVec3d</a></dt>
<dd></dd>
<dd><p>The end cutter location.</p>
</dd>
<dt><code>duration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a>?</dt>
<dd></dd>
<dd><p>Optional total duration of the linear action.</p>
</dd>
</dl>
@@ -377,7 +382,8 @@ Class ActClLinear
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a sequence of steps split from this movement under the specified NC resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -387,13 +393,15 @@ Class ActClLinear
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncResolution</code> <a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html">IMachiningMotionResolution</a></dt>
<dd></dd>
<dd><p>The machining motion resolution.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>&gt;</dt>
<dd></dd>
<dd><p>A sequence of <a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ActClStep | HiAPI-C# 2025 ">
<meta name="description" content="Represents a single cutter-location step with optional duration.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class ActClStep
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Represents a single cutter-location step with optional duration.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -203,7 +204,8 @@ Class ActClStep
<dd><p>The cutter location vector.</p>
</dd>
<dt><code>timeSpan</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a>?</dt>
<dd></dd>
<dd><p>Optional duration of this step.</p>
</dd>
</dl>
@@ -203,7 +203,8 @@ Class ActClTeleport
<dd><p>The cutter location vector.</p>
</dd>
<dt><code>timeSpan</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a>?</dt>
<dd></dd>
<dd><p>Optional duration of this action.</p>
</dd>
</dl>
@@ -160,7 +160,8 @@ Class ActUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Splits a cutter location movement into a sequence of steps according to the NC resolution and desired step count.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -170,17 +171,21 @@ Class ActUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>actClMove</code> <a class="xref" href="Hi.Numerical.Acts.IActClMove.html">IActClMove</a></dt>
<dd></dd>
<dd><p>The cutter location movement action.</p>
</dd>
<dt><code>stepNum</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The number of steps to split into.</p>
</dd>
<dt><code>ncResolution</code> <a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html">IMachiningMotionResolution</a></dt>
<dd></dd>
<dd><p>The machining motion resolution.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>&gt;</dt>
<dd></dd>
<dd><p>An enumerable sequence of <a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>.</p>
</dd>
</dl>
@@ -221,7 +221,8 @@ This interface defines the contract for tool path movements in machining operati
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets a sequence of steps split from this movement under the specified NC resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -231,13 +232,15 @@ This interface defines the contract for tool path movements in machining operati
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncResolution</code> <a class="xref" href="Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html">IMachiningMotionResolution</a></dt>
<dd></dd>
<dd><p>The machining motion resolution.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>&gt;</dt>
<dd></dd>
<dd><p>A sequence of <a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a>.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IActTooling | HiAPI-C# 2025 ">
<meta name="description" content="Represents a tooling action that changes or selects a tool.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Interface IActTooling
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Represents a tooling action that changes or selects a tool.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -152,7 +153,8 @@ Interface IActTooling
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the target tool identifier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -106,7 +106,8 @@ Classes
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.Acts.ActClStep.html">ActClStep</a></dt>
<dd></dd>
<dd><p>Represents a single cutter-location step with optional duration.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.Acts.ActClTeleport.html">ActClTeleport</a></dt>
@@ -272,7 +273,8 @@ Acts as a marker interface to identify actions that should not be executed.</p>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.Acts.IActTooling.html">IActTooling</a></dt>
<dd></dd>
<dd><p>Represents a tooling action that changes or selects a tool.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.Acts.IWorkTimeAttrib.html">IWorkTimeAttrib</a></dt>
@@ -438,8 +438,8 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_ShellCommands_EnablingWrapper_Run_" data-uid="Hi.ShellCommands.EnablingWrapper.Run*"></a>
<h3 id="Hi_ShellCommands_EnablingWrapper_Run_Hi_MachiningProcs_RuntimeController_" data-uid="Hi.ShellCommands.EnablingWrapper.Run(Hi.MachiningProcs.RuntimeController)">
Run(RuntimeController)
<h3 id="Hi_ShellCommands_EnablingWrapper_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.EnablingWrapper.Run(Hi.MachiningProcs.RuntimeApi)">
Run(RuntimeApi)
</h3>
@@ -448,12 +448,12 @@ Since the folder can be moving with the configuration file.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;Action&gt; Run(RuntimeController scriptApi)</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;Action&gt; Run(RuntimeApi scriptApi)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
<dd><p>Script API for executing milling commands.</p>
</dd>
</dl>
@@ -408,8 +408,8 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_ShellCommands_GeomDiffCommand_Run_" data-uid="Hi.ShellCommands.GeomDiffCommand.Run*"></a>
<h3 id="Hi_ShellCommands_GeomDiffCommand_Run_Hi_MachiningProcs_RuntimeController_" data-uid="Hi.ShellCommands.GeomDiffCommand.Run(Hi.MachiningProcs.RuntimeController)">
Run(RuntimeController)
<h3 id="Hi_ShellCommands_GeomDiffCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.GeomDiffCommand.Run(Hi.MachiningProcs.RuntimeApi)">
Run(RuntimeApi)
</h3>
@@ -418,12 +418,12 @@ Since the folder can be moving with the configuration file.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;Action&gt; Run(RuntimeController scriptApi)</code></pre>
<pre><code class="lang-csharp hljs">public IEnumerable&lt;Action&gt; Run(RuntimeApi scriptApi)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
<dd><p>Script API for executing milling commands.</p>
</dd>
</dl>
@@ -155,8 +155,8 @@ Interface IShellCommand
<a id="Hi_ShellCommands_IShellCommand_Run_" data-uid="Hi.ShellCommands.IShellCommand.Run*"></a>
<h3 id="Hi_ShellCommands_IShellCommand_Run_Hi_MachiningProcs_RuntimeController_" data-uid="Hi.ShellCommands.IShellCommand.Run(Hi.MachiningProcs.RuntimeController)">
Run(RuntimeController)
<h3 id="Hi_ShellCommands_IShellCommand_Run_Hi_MachiningProcs_RuntimeApi_" data-uid="Hi.ShellCommands.IShellCommand.Run(Hi.MachiningProcs.RuntimeApi)">
Run(RuntimeApi)
</h3>
@@ -165,12 +165,12 @@ Interface IShellCommand
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IEnumerable&lt;Action&gt; Run(RuntimeController scriptApi)</code></pre>
<pre><code class="lang-csharp hljs">IEnumerable&lt;Action&gt; Run(RuntimeApi scriptApi)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
<dt><code>scriptApi</code> <a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
<dd><p>Script API for executing milling commands.</p>
</dd>
</dl>
@@ -115,7 +115,7 @@ Interface ITitleCommand
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="Hi.ShellCommands.IShellCommand.html#Hi_ShellCommands_IShellCommand_Run_Hi_MachiningProcs_RuntimeController_">IShellCommand.Run(RuntimeController)</a>
<a class="xref" href="Hi.ShellCommands.IShellCommand.html#Hi_ShellCommands_IShellCommand_Run_Hi_MachiningProcs_RuntimeApi_">IShellCommand.Run(RuntimeApi)</a>
</div>
<div>
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a>

Some files were not shown because too many files have changed in this diff Show More