This commit is contained in:
2025-09-06 21:25:33 +08:00
parent f6dd232ef8
commit 878475acf8
108 changed files with 5919 additions and 4961 deletions
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ManualUtil | HiAPI-C# 2025 ">
<meta name="description" content="Utility class for handling manual and documentation files with culture support.">
<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 ManualUtil
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Utility class for handling manual and documentation files with culture support.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -158,7 +159,8 @@ Class ManualUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Keyword placeholder for culture in URL templates.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -193,7 +195,8 @@ Class ManualUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the best available deployment URL by removing the wwwroot prefix from the source URL.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -203,13 +206,15 @@ Class ManualUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>urlTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>URL template containing culture placeholder.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The best matching deployment URL for the current culture.</p>
</dd>
</dl>
@@ -229,7 +234,8 @@ Class ManualUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the best available source URL by matching the current culture or falling back to defaults.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -239,13 +245,15 @@ Class ManualUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>urlTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>URL template containing culture placeholder.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The best matching source URL for the current culture.</p>
</dd>
</dl>
@@ -265,7 +273,8 @@ Class ManualUtil
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Extracts the title from an HTML file by looking for the first h1 tag or title tag.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -275,13 +284,15 @@ Class ManualUtil
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>urlTemplate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>URL template containing culture placeholder.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The extracted title or empty string if not found.</p>
</dd>
</dl>
+2 -1
View File
@@ -202,7 +202,8 @@ Only the most recent action is executed and previous pending actions are discard
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.ManualUtil.html">ManualUtil</a></dt>
<dd></dd>
<dd><p>Utility class for handling manual and documentation files with culture support.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.MaskUtil.html">MaskUtil</a></dt>
@@ -988,6 +988,33 @@ Where view matrix is in MVP convention.</p>
</h2>
<a id="Hi_Disp_DispEngine_ClearCache_" data-uid="Hi.Disp.DispEngine.ClearCache*"></a>
<h3 id="Hi_Disp_DispEngine_ClearCache" data-uid="Hi.Disp.DispEngine.ClearCache">
ClearCache()
</h3>
<div class="markdown level1 summary"><p>Clears the display engine cache.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void ClearCache()</code></pre>
</div>
<a id="Hi_Disp_DispEngine_DeleteDispContext_" data-uid="Hi.Disp.DispEngine.DeleteDispContext*"></a>
<h3 id="Hi_Disp_DispEngine_DeleteDispContext" data-uid="Hi.Disp.DispEngine.DeleteDispContext">
@@ -388,7 +388,8 @@ Not used yet.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the lower limit of graphic cache in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -419,7 +420,8 @@ Not used yet.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the graphic cache size in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -450,7 +452,8 @@ Not used yet.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the upper limit of graphic cache in megabytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -481,7 +484,8 @@ Not used yet.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the language code for the application UI.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -512,7 +516,8 @@ Not used yet.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show physics options in the UI.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -191,7 +191,8 @@ Class AppService
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.AppService.html">AppService</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -217,17 +218,19 @@ Class AppService
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.AppService.html">AppService</a> class with the specified configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppService(AppConfig userConfig)</code></pre>
<pre><code class="lang-csharp hljs">public AppService(AppConfig appConfig)</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>
<dt><code>appConfig</code> <a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd><p>The application configuration.</p>
</dd>
</dl>
@@ -252,7 +255,8 @@ Class AppService
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets additional step presentation access configurations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -283,7 +287,8 @@ Class AppService
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the application configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -314,7 +319,8 @@ Class AppService
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the path to the application configuration file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -411,7 +417,8 @@ Read only.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets whether physics features are enabled based on configuration and license.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -442,7 +449,8 @@ Read only.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets whether advanced physics features are licensed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -473,7 +481,8 @@ Read only.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the currently selected item in the application.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -599,7 +608,8 @@ Read only.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Schedules a loose save of the user configuration using a LooseRunner.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -625,7 +635,8 @@ Read only.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Saves the user configuration to the file specified by <a class="xref" href="Hi.HiNcKits.AppService.html#Hi_HiNcKits_AppService_AppConfigPath">AppConfigPath</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 HostConfig | HiAPI-C# 2025 ">
<meta name="description" content="Configuration for host-related settings.">
<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 HostConfig
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Configuration for host-related settings.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -184,7 +185,8 @@ Class HostConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.HostConfig.html">HostConfig</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -250,7 +252,8 @@ Class HostConfig
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the MongoDB port 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="Class LocalApp | HiAPI-C# 2025 ">
<meta name="description" content="Local application initialization and cleanup utilities.">
<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 LocalApp
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Local application initialization and cleanup utilities.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -158,7 +159,8 @@ Class LocalApp
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Path to the host configuration file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -182,36 +184,6 @@ Class LocalApp
<h3 id="Hi_HiNcKits_LocalApp_UserConfigPath" data-uid="Hi.HiNcKits.LocalApp.UserConfigPath">
UserConfigPath
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string UserConfigPath = &quot;hinc-user-config.xml&quot;</code></pre>
</div>
<h4 class="section">Field 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="properties">Properties
</h2>
@@ -223,7 +195,8 @@ Class LocalApp
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the host configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -247,68 +220,6 @@ Class LocalApp
<a id="Hi_HiNcKits_LocalApp_UserConfig_" data-uid="Hi.HiNcKits.LocalApp.AppConfig*"></a>
<h3 id="Hi_HiNcKits_LocalApp_UserConfig" data-uid="Hi.HiNcKits.LocalApp.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 static AppConfig AppConfig { get; }</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_LocalApp_UserEnv_" data-uid="Hi.HiNcKits.LocalApp.UserEnv*"></a>
<h3 id="Hi_HiNcKits_LocalApp_UserEnv" data-uid="Hi.HiNcKits.LocalApp.UserEnv">
UserEnv
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UserEnv UserEnv { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.HiNcKits.UserEnv.html">UserEnv</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
@@ -320,7 +231,8 @@ Class LocalApp
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes the application by loading configuration, logging in licenses, and starting services.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -346,7 +258,8 @@ Class LocalApp
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Cleans up the application by stopping services and logging out licenses.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -365,58 +278,6 @@ Class LocalApp
<a id="Hi_HiNcKits_LocalApp_LooseSaveUserConfig_" data-uid="Hi.HiNcKits.LocalApp.LooseSaveUserConfig*"></a>
<h3 id="Hi_HiNcKits_LocalApp_LooseSaveUserConfig" data-uid="Hi.HiNcKits.LocalApp.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 static void LooseSaveUserConfig()</code></pre>
</div>
<a id="Hi_HiNcKits_LocalApp_SaveUserConfig_" data-uid="Hi.HiNcKits.LocalApp.SaveUserConfig*"></a>
<h3 id="Hi_HiNcKits_LocalApp_SaveUserConfig" data-uid="Hi.HiNcKits.LocalApp.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 static void SaveUserConfig()</code></pre>
</div>
</article>
@@ -2,11 +2,11 @@
<html>
<head>
<meta charset="utf-8">
<title>Class RenderingService | HiAPI-C# 2025 </title>
<title>Class ProxyConfig | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class RenderingService | HiAPI-C# 2025 ">
<meta name="title" content="Class ProxyConfig | HiAPI-C# 2025 ">
<meta name="description" content="管理 DispEngine 實例和渲染操作的服務">
<meta name="description" content="Configuration for proxy-related settings.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -84,25 +84,25 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Webapi.Services.RenderingService">
<article data-uid="Hi.HiNcKits.ProxyConfig">
<h1 id="Hi_Webapi_Services_RenderingService" data-uid="Hi.Webapi.Services.RenderingService" class="text-break">
Class RenderingService
<h1 id="Hi_HiNcKits_ProxyConfig" data-uid="Hi.HiNcKits.ProxyConfig" class="text-break">
Class ProxyConfig
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Webapi.html">Webapi</a>.<a class="xref" href="Hi.Webapi.Services.html">Services</a></dd></dl>
<dl><dt>Assembly</dt><dd>Hi.Webapi.dll</dd></dl>
<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>管理 DispEngine 實例和渲染操作的服務</p>
<div class="markdown summary"><p>Configuration for proxy-related settings.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RenderingService : IDisposable</code></pre>
<pre><code class="lang-csharp hljs">public class ProxyConfig : IMakeXmlSource</code></pre>
</div>
@@ -112,14 +112,14 @@ Class RenderingService
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">RenderingService</span></div>
<div><span class="xref">ProxyConfig</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>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
</dd>
</dl>
@@ -184,23 +184,95 @@ Class RenderingService
</h2>
<a id="Hi_Webapi_Services_RenderingService__ctor_" data-uid="Hi.Webapi.Services.RenderingService.#ctor*"></a>
<a id="Hi_HiNcKits_ProxyConfig__ctor_" data-uid="Hi.HiNcKits.ProxyConfig.#ctor*"></a>
<h3 id="Hi_Webapi_Services_RenderingService__ctor_Microsoft_Extensions_Logging_ILogger_Hi_Webapi_Services_RenderingService__" data-uid="Hi.Webapi.Services.RenderingService.#ctor(Microsoft.Extensions.Logging.ILogger{Hi.Webapi.Services.RenderingService})">
RenderingService(ILogger&lt;RenderingService&gt;)
<h3 id="Hi_HiNcKits_ProxyConfig__ctor" data-uid="Hi.HiNcKits.ProxyConfig.#ctor">
ProxyConfig()
</h3>
<div class="markdown level1 summary"></div>
<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 RenderingService(ILogger&lt;RenderingService&gt; logger)</code></pre>
<pre><code class="lang-csharp hljs">public ProxyConfig()</code></pre>
</div>
<a id="Hi_HiNcKits_ProxyConfig__ctor_" data-uid="Hi.HiNcKits.ProxyConfig.#ctor*"></a>
<h3 id="Hi_HiNcKits_ProxyConfig__ctor_System_Xml_Linq_XElement_System_String_" data-uid="Hi.HiNcKits.ProxyConfig.#ctor(System.Xml.Linq.XElement,System.String)">
ProxyConfig(XElement, string)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.HiNcKits.ProxyConfig.html">ProxyConfig</a> class from XML data.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ProxyConfig(XElement src, string baseDirectory)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<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.Webapi.Services.RenderingService.html">RenderingService</a>&gt;</dt>
<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_ProxyConfig_AdminDirectory_" data-uid="Hi.HiNcKits.ProxyConfig.AdminDirectory*"></a>
<h3 id="Hi_HiNcKits_ProxyConfig_AdminDirectory" data-uid="Hi.HiNcKits.ProxyConfig.AdminDirectory">
AdminDirectory
</h3>
<div class="markdown level1 summary"><p>Gets or sets the admin directory path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AdminDirectory { 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>
@@ -211,6 +283,34 @@ Class RenderingService
<a id="Hi_HiNcKits_ProxyConfig_XName_" data-uid="Hi.HiNcKits.ProxyConfig.XName*"></a>
<h3 id="Hi_HiNcKits_ProxyConfig_XName" data-uid="Hi.HiNcKits.ProxyConfig.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>
@@ -219,90 +319,40 @@ Class RenderingService
</h2>
<a id="Hi_Webapi_Services_RenderingService_Dispose_" data-uid="Hi.Webapi.Services.RenderingService.Dispose*"></a>
<a id="Hi_HiNcKits_ProxyConfig_MakeXmlSource_" data-uid="Hi.HiNcKits.ProxyConfig.MakeXmlSource*"></a>
<h3 id="Hi_Webapi_Services_RenderingService_Dispose" data-uid="Hi.Webapi.Services.RenderingService.Dispose">
Dispose()
<h3 id="Hi_HiNcKits_ProxyConfig_MakeXmlSource_System_String_System_String_System_Boolean_" data-uid="Hi.HiNcKits.ProxyConfig.MakeXmlSource(System.String,System.String,System.Boolean)">
MakeXmlSource(string, string, bool)
</h3>
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
<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 void Dispose()</code></pre>
</div>
<a id="Hi_Webapi_Services_RenderingService_GetActiveEngineCount_" data-uid="Hi.Webapi.Services.RenderingService.GetActiveEngineCount*"></a>
<h3 id="Hi_Webapi_Services_RenderingService_GetActiveEngineCount" data-uid="Hi.Webapi.Services.RenderingService.GetActiveEngineCount">
GetActiveEngineCount()
</h3>
<div class="markdown level1 summary"><p>獲取當前活動的引擎數量</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int GetActiveEngineCount()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Webapi_Services_RenderingService_GetOrCreateEngine_" data-uid="Hi.Webapi.Services.RenderingService.GetOrCreateEngine*"></a>
<h3 id="Hi_Webapi_Services_RenderingService_GetOrCreateEngine_System_String_" data-uid="Hi.Webapi.Services.RenderingService.GetOrCreateEngine(System.String)">
GetOrCreateEngine(string)
</h3>
<div class="markdown level1 summary"><p>創建或獲取一個 DispEngine 實例</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DispEngine GetOrCreateEngine(string sessionId)</code></pre>
<pre><code class="lang-csharp hljs">public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>sessionId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for resolving relative paths</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path for 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="Hi.Disp.DispEngine.html">DispEngine</a></dt>
<dd></dd>
<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>
@@ -311,43 +361,11 @@ Class RenderingService
<a id="Hi_Webapi_Services_RenderingService_RemoveEngine_" data-uid="Hi.Webapi.Services.RenderingService.RemoveEngine*"></a>
<h3 id="Hi_Webapi_Services_RenderingService_RemoveEngine_System_String_" data-uid="Hi.Webapi.Services.RenderingService.RemoveEngine(System.String)">
RemoveEngine(string)
</h3>
<div class="markdown level1 summary"><p>移除指定的 DispEngine</p>
<h4 class="section" id="Hi_HiNcKits_ProxyConfig_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>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool RemoveEngine(string sessionId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>sessionId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
+16 -8
View File
@@ -94,6 +94,16 @@
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd><p>Application/Environment Configuration</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.AppService.html">AppService</a></dt>
<dd><p>Application/Environment Service.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.HiNcHost.html">HiNcHost</a></dt>
<dd><p>Rich HiNC Service.
@@ -102,19 +112,17 @@ Host class for HiNC functionality that provides project management, path resolut
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.HostConfig.html">HostConfig</a></dt>
<dd></dd>
<dd><p>Configuration for host-related settings.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.LocalApp.html">LocalApp</a></dt>
<dd></dd>
<dd><p>Local application initialization and cleanup utilities.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.AppConfig.html">AppConfig</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.HiNcKits.UserEnv.html">UserEnv</a></dt>
<dd><p>Environment of a HiNC user.</p>
<dt><a class="xref" href="Hi.HiNcKits.ProxyConfig.html">ProxyConfig</a></dt>
<dd><p>Configuration for proxy-related settings.</p>
</dd>
</dl>
<h3 id="enums">
@@ -2,11 +2,11 @@
<html>
<head>
<meta charset="utf-8">
<title>Class DynamicMachiningProjectDisplayee | HiAPI-C# 2025 </title>
<title>Class DynamicMachiningProjectDisplayee0 | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class DynamicMachiningProjectDisplayee | HiAPI-C# 2025 ">
<meta name="title" content="Class DynamicMachiningProjectDisplayee0 | HiAPI-C# 2025 ">
<meta name="description" content="Provides display capabilities for a milling course.">
<meta name="description" content="Provides display capabilities for a milling course. obsoleted.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -84,12 +84,12 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee">
<article data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0">
<h1 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee" class="text-break">
Class DynamicMachiningProjectDisplayee
<h1 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0" class="text-break">
Class DynamicMachiningProjectDisplayee0
</h1>
<div class="facts text-secondary">
@@ -97,12 +97,13 @@ Class DynamicMachiningProjectDisplayee
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"><p>Provides display capabilities for a milling course.</p>
<div class="markdown summary"><p>Provides display capabilities for a milling course.
obsoleted.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DynamicMachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex</code></pre>
<pre><code class="lang-csharp hljs">public class DynamicMachiningProjectDisplayee0 : IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex</code></pre>
</div>
@@ -112,7 +113,7 @@ Class DynamicMachiningProjectDisplayee
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">DynamicMachiningProjectDisplayee</span></div>
<div><span class="xref">DynamicMachiningProjectDisplayee0</span></div>
</dd>
</dl>
@@ -196,19 +197,19 @@ Class DynamicMachiningProjectDisplayee
</h2>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee__ctor_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.#ctor*"></a>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0__ctor_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.#ctor*"></a>
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee__ctor_System_Func_Hi_MachiningProcs_MachiningProject__" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.#ctor(System.Func{Hi.MachiningProcs.MachiningProject})">
DynamicMachiningProjectDisplayee(Func&lt;MachiningProject&gt;)
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0__ctor_System_Func_Hi_MachiningProcs_MachiningProject__" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.#ctor(System.Func{Hi.MachiningProcs.MachiningProject})">
DynamicMachiningProjectDisplayee0(Func&lt;MachiningProject&gt;)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html">DynamicMachiningProjectDisplayee</a> class with default settings.</p>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.html">DynamicMachiningProjectDisplayee0</a> class with default settings.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DynamicMachiningProjectDisplayee(Func&lt;MachiningProject&gt; machiningProjectHost)</code></pre>
<pre><code class="lang-csharp hljs">public DynamicMachiningProjectDisplayee0(Func&lt;MachiningProject&gt; machiningProjectHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -229,19 +230,19 @@ Class DynamicMachiningProjectDisplayee
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee__ctor_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.#ctor*"></a>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0__ctor_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.#ctor*"></a>
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee__ctor_System_Func_Hi_MachiningProcs_MachiningProject__System_Collections_BitArray_System_Action_System_Collections_BitArray__" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.#ctor(System.Func{Hi.MachiningProcs.MachiningProject},System.Collections.BitArray,System.Action{System.Collections.BitArray})">
DynamicMachiningProjectDisplayee(Func&lt;MachiningProject&gt;, BitArray, Action&lt;BitArray&gt;)
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0__ctor_System_Func_Hi_MachiningProcs_MachiningProject__System_Collections_BitArray_System_Action_System_Collections_BitArray__" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.#ctor(System.Func{Hi.MachiningProcs.MachiningProject},System.Collections.BitArray,System.Action{System.Collections.BitArray})">
DynamicMachiningProjectDisplayee0(Func&lt;MachiningProject&gt;, BitArray, Action&lt;BitArray&gt;)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html">DynamicMachiningProjectDisplayee</a> class.</p>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.html">DynamicMachiningProjectDisplayee0</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DynamicMachiningProjectDisplayee(Func&lt;MachiningProject&gt; machiningProjectHost, BitArray renderingFlagBitArray, Action&lt;BitArray&gt; setRenderingFlagFunc)</code></pre>
<pre><code class="lang-csharp hljs">public DynamicMachiningProjectDisplayee0(Func&lt;MachiningProject&gt; machiningProjectHost, BitArray renderingFlagBitArray, Action&lt;BitArray&gt; setRenderingFlagFunc)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -272,9 +273,9 @@ Class DynamicMachiningProjectDisplayee
</h2>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_MachiningProject_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.MachiningProject*"></a>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_MachiningProject_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.MachiningProject*"></a>
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_MachiningProject" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.MachiningProject">
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_MachiningProject" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.MachiningProject">
MachiningProject
</h3>
@@ -304,9 +305,9 @@ Class DynamicMachiningProjectDisplayee
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_RenderingFlagBitArray_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.RenderingFlagBitArray*"></a>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_RenderingFlagBitArray_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.RenderingFlagBitArray*"></a>
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_RenderingFlagBitArray" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.RenderingFlagBitArray">
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_RenderingFlagBitArray" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.RenderingFlagBitArray">
RenderingFlagBitArray
</h3>
@@ -340,9 +341,9 @@ Class DynamicMachiningProjectDisplayee
</h2>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_Display_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.Display*"></a>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_Display_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.Display*"></a>
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_Display_Hi_Disp_Bind_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.Display(Hi.Disp.Bind)">
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_Display_Hi_Disp_Bind_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.Display(Hi.Disp.Bind)">
Display(Bind)
</h3>
@@ -373,9 +374,9 @@ Class DynamicMachiningProjectDisplayee
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_ExpandToBox3d_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.ExpandToBox3d*"></a>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_ExpandToBox3d_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.ExpandToBox3d*"></a>
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.ExpandToBox3d(Hi.Geom.Box3d)">
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_ExpandToBox3d_Hi_Geom_Box3d_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.ExpandToBox3d(Hi.Geom.Box3d)">
ExpandToBox3d(Box3d)
</h3>
@@ -407,9 +408,9 @@ This function is usually used to compute the bounding box of elements.</p>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_GetAnchor_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.GetAnchor*"></a>
<a id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_GetAnchor_" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.GetAnchor*"></a>
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee_GetAnchor" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.GetAnchor">
<h3 id="Hi_MachiningProcs_DynamicMachiningProjectDisplayee0_GetAnchor" data-uid="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.GetAnchor">
GetAnchor()
</h3>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IMachiningProjectGetter | HiAPI-C# 2025 ">
<meta name="description" content="Interface for objects that can provide a MachiningProject instance.">
<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 IMachiningProjectGetter
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Interface for objects that can provide a MachiningProject instance.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -152,7 +153,8 @@ Interface IMachiningProjectGetter
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the MachiningProject instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -163,7 +165,8 @@ Interface IMachiningProjectGetter
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
<dd></dd>
<dd><p>The MachiningProject instance.</p>
</dd>
</dl>
@@ -1,203 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IMachiningProjectHost | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IMachiningProjectHost | 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.IMachiningProjectHost">
<h1 id="Hi_MachiningProcs_IMachiningProjectHost" data-uid="Hi.MachiningProcs.IMachiningProjectHost" class="text-break">
Interface IMachiningProjectHost
</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 IMachiningProjectHost</code></pre>
</div>
<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="properties">Properties
</h2>
<a id="Hi_MachiningProcs_IMachiningProjectHost_MachiningProject_" data-uid="Hi.MachiningProcs.IMachiningProjectHost.MachiningProject*"></a>
<h3 id="Hi_MachiningProcs_IMachiningProjectHost_MachiningProject" data-uid="Hi.MachiningProcs.IMachiningProjectHost.MachiningProject">
MachiningProject
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">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>
</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>
@@ -1,210 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IPathedMachiningProjectHost | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IPathedMachiningProjectHost | 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.IPathedMachiningProjectHost">
<h1 id="Hi_MachiningProcs_IPathedMachiningProjectHost" data-uid="Hi.MachiningProcs.IPathedMachiningProjectHost" class="text-break">
Interface IPathedMachiningProjectHost
</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 IPathedMachiningProjectHost : IMachiningProjectHost</code></pre>
</div>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<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>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_MachiningProcs_IPathedMachiningProjectHost_MachiningProjectPath_" data-uid="Hi.MachiningProcs.IPathedMachiningProjectHost.MachiningProjectPath*"></a>
<h3 id="Hi_MachiningProcs_IPathedMachiningProjectHost_MachiningProjectPath" data-uid="Hi.MachiningProcs.IPathedMachiningProjectHost.MachiningProjectPath">
MachiningProjectPath
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">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>
</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="Interface IProjectService | HiAPI-C# 2025 ">
<meta name="description" content="Interface for services that manage machining projects.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,11 +97,12 @@ Interface IProjectService
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Interface for services that manage machining projects.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IProjectService : IMachiningProjectGetter, IPathedMachiningProjectHost, IMachiningProjectHost</code></pre>
<pre><code class="lang-csharp hljs">public interface IProjectService : IMachiningProjectGetter</code></pre>
</div>
@@ -116,12 +117,6 @@ Interface IProjectService
<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">
@@ -154,6 +149,74 @@ Interface IProjectService
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_MachiningProcs_IProjectService_MachiningProject_" data-uid="Hi.MachiningProcs.IProjectService.MachiningProject*"></a>
<h3 id="Hi_MachiningProcs_IProjectService_MachiningProject" data-uid="Hi.MachiningProcs.IProjectService.MachiningProject">
MachiningProject
</h3>
<div class="markdown level1 summary"><p>Gets or sets the machining project instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">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_IProjectService_MachiningProjectPath_" data-uid="Hi.MachiningProcs.IProjectService.MachiningProjectPath*"></a>
<h3 id="Hi_MachiningProcs_IProjectService_MachiningProjectPath" data-uid="Hi.MachiningProcs.IProjectService.MachiningProjectPath">
MachiningProjectPath
</h3>
<div class="markdown level1 summary"><p>Gets or sets the path to the machining project file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">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>
</article>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Delegate LocalProjectService.MachiningProjectChangedDelegate | HiAPI-C# 2025 ">
<meta name="description" content="Delegate for machining project changed events.">
<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 @@ Delegate LocalProjectService.MachiningProjectChangedDelegate
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Delegate for machining project changed events.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -107,9 +108,11 @@ Delegate LocalProjectService.MachiningProjectChangedDelegate
<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>
<dd><p>The new machining project.</p>
</dd>
<dt><code>projectPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The path to the project file.</p>
</dd>
</dl>
@@ -103,7 +103,7 @@ Apply absolute file path.</p>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class LocalProjectService : IProjectService, IMachiningProjectGetter, IPathedMachiningProjectHost, IMachiningProjectHost</code></pre>
<pre><code class="lang-csharp hljs">public class LocalProjectService : IProjectService, IMachiningProjectGetter</code></pre>
</div>
@@ -122,8 +122,6 @@ Apply absolute file path.</p>
<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>
@@ -222,19 +220,22 @@ Apply absolute file path.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> class.</p>
</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>
<pre><code class="lang-csharp hljs">public LocalProjectService(AppService appService, 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>appService</code> <a class="xref" href="Hi.HiNcKits.AppService.html">AppService</a></dt>
<dd><p>The application service.</p>
</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>
<dd><p>The logger instance.</p>
</dd>
</dl>
@@ -252,6 +253,38 @@ Apply absolute file path.</p>
</h2>
<a id="Hi_MachiningProcs_LocalProjectService_AppService_" data-uid="Hi.MachiningProcs.LocalProjectService.AppService*"></a>
<h3 id="Hi_MachiningProcs_LocalProjectService_AppService" data-uid="Hi.MachiningProcs.LocalProjectService.AppService">
AppService
</h3>
<div class="markdown level1 summary"><p>Gets the application service instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AppService AppService { 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>
<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">
@@ -259,7 +292,8 @@ Apply absolute file path.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the logger instance for this service.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -290,7 +324,8 @@ Apply absolute file path.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the machining project instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -321,7 +356,8 @@ Apply absolute file path.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the path to the machining project file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -352,7 +388,8 @@ Apply absolute file path.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the directory containing the machining project.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -376,37 +413,6 @@ Apply absolute file path.</p>
<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>
@@ -451,7 +457,8 @@ Apply absolute file path.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the MachiningProject instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -462,7 +469,8 @@ Apply absolute file path.</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
<dd></dd>
<dd><p>The MachiningProject instance.</p>
</dd>
</dl>
@@ -620,7 +628,7 @@ Apply absolute file path.</p>
</h3>
<div class="markdown level1 summary"><p>Save project by ProjectPathRoute.</p>
<div class="markdown level1 summary"><p>Save project by project path.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -645,12 +653,230 @@ Apply absolute file path.</p>
<h3 id="Hi_MachiningProcs_LocalProjectService_ClStrip_AbsDispEndChanged" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip_AbsDispEndChanged">
ClStrip_AbsDispEndChanged
</h3>
<div class="markdown level1 summary"><p>Event raised when the absolute display end position changes for <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler ClStrip_AbsDispEndChanged</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler">EventHandler</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_ClStrip_DispBeginChanged" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip_DispBeginChanged">
ClStrip_DispBeginChanged
</h3>
<div class="markdown level1 summary"><p>Event raised when the display begin position changes for <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler ClStrip_DispBeginChanged</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler">EventHandler</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_ClStrip_DispEndChanged" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip_DispEndChanged">
ClStrip_DispEndChanged
</h3>
<div class="markdown level1 summary"><p>Event raised when the display end position changes for <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler ClStrip_DispEndChanged</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler">EventHandler</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_ClStrip_MachiningStepSelected" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip_MachiningStepSelected">
ClStrip_MachiningStepSelected
</h3>
<div class="markdown level1 summary"><p>The same effecting position as <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_ClStrip_PosSelected">ClStrip_PosSelected</a> but with more convenient arguments for the end-user for <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;MachiningStep&gt; ClStrip_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_MachiningProcs_LocalProjectService_ClStrip_PosAdded" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip_PosAdded">
ClStrip_PosAdded
</h3>
<div class="markdown level1 summary"><p>Event raised when a new position is added to the strip for <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;ClStripPos&gt; ClStrip_PosAdded</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.CutterLocations.ClStrips.ClStripPos.html">ClStripPos</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_ClStrip_PosEntered" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip_PosEntered">
ClStrip_PosEntered
</h3>
<div class="markdown level1 summary"><p>Event raised when the mouse enters a position for <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;ClStripPos&gt; ClStrip_PosEntered</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="Hi.CutterLocations.ClStrips.ClStripPos.html">ClStripPos</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_ClStrip_PosSelected" data-uid="Hi.MachiningProcs.LocalProjectService.ClStrip_PosSelected">
ClStrip_PosSelected
</h3>
<div class="markdown level1 summary"><p>Event raised when a position is selected for <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;ClStripPos&gt; ClStrip_PosSelected</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="Hi.CutterLocations.ClStrips.ClStripPos.html">ClStripPos</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_MachiningProjectChanged" data-uid="Hi.MachiningProcs.LocalProjectService.MachiningProjectChanged">
MachiningProjectChanged
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Event raised when the machining project changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -675,6 +901,223 @@ Apply absolute file path.</p>
<h3 id="Hi_MachiningProcs_LocalProjectService_PacePlayer_IsFinishedChangedEvent" data-uid="Hi.MachiningProcs.LocalProjectService.PacePlayer_IsFinishedChangedEvent">
PacePlayer_IsFinishedChangedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered when the finished state changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; PacePlayer_IsFinishedChangedEvent</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="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_PacePlayer_IsLockedChangedEvent" data-uid="Hi.MachiningProcs.LocalProjectService.PacePlayer_IsLockedChangedEvent">
PacePlayer_IsLockedChangedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered when the lock state changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; PacePlayer_IsLockedChangedEvent</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="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_PacePlayer_IsRunningChangedEvent" data-uid="Hi.MachiningProcs.LocalProjectService.PacePlayer_IsRunningChangedEvent">
PacePlayer_IsRunningChangedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered when the running state changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; PacePlayer_IsRunningChangedEvent</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="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_PacePlayer_ResetedEvent" data-uid="Hi.MachiningProcs.LocalProjectService.PacePlayer_ResetedEvent">
PacePlayer_ResetedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered after the player has been reset.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action PacePlayer_ResetedEvent</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">Action</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_SessionMessageHost_CollectionCleared" data-uid="Hi.MachiningProcs.LocalProjectService.SessionMessageHost_CollectionCleared">
SessionMessageHost_CollectionCleared
</h3>
<div class="markdown level1 summary"><p>Event raised when the collection is cleared.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action SessionMessageHost_CollectionCleared</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">Action</a></dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_SessionMessageHost_CollectionItemAdded" data-uid="Hi.MachiningProcs.LocalProjectService.SessionMessageHost_CollectionItemAdded">
SessionMessageHost_CollectionItemAdded
</h3>
<div class="markdown level1 summary"><p>Event raised when a new milling message is added to the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;SessionMessagePack&gt; SessionMessageHost_CollectionItemAdded</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.MachiningProcs.SessionMessagePack.html">SessionMessagePack</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_MachiningProcs_LocalProjectService_SessionMessageHost_CollectionItemChanged" data-uid="Hi.MachiningProcs.LocalProjectService.SessionMessageHost_CollectionItemChanged">
SessionMessageHost_CollectionItemChanged
</h3>
<div class="markdown level1 summary"><p>Event raised when a collection item is changed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action SessionMessageHost_CollectionItemChanged</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">Action</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
@@ -634,7 +634,8 @@ Only take effect if the <a class="xref" href="Hi.MachiningProcs.MachiningProject
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether stroke limit checking is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1020,7 +1021,8 @@ Updates related components when changed.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the NC environment from the NC runner.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1051,7 +1053,8 @@ Updates related components when changed.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the dictionary of NC optimization options.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1440,7 +1443,8 @@ Ensures proper initialization of workpiece properties.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Executes an act and collects all results.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1450,11 +1454,14 @@ Ensures proper initialization of workpiece properties.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
<dd></dd>
<dd><p>The act to execute.</p>
</dd>
<dt><code>sourceCommand</code> <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
<dd></dd>
<dd><p>The source command that triggered the act.</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
<dd><p>Cancellation token to cancel the operation.</p>
</dd>
</dl>
@@ -1627,7 +1634,8 @@ Clear the state from previous session (if existed).</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the MachiningProject instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1638,7 +1646,8 @@ Clear the state from previous session (if existed).</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
<dd></dd>
<dd><p>The MachiningProject instance.</p>
</dd>
</dl>
@@ -1853,7 +1862,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>Processes an act and returns the results.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1863,17 +1873,21 @@ Since the folder can be moving with the configuration file.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
<dd></dd>
<dd><p>The act to process.</p>
</dd>
<dt><code>sourceCommand</code> <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
<dd></dd>
<dd><p>The source command that triggered the act.</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
<dd><p>Cancellation token to cancel the operation.</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="https://learn.microsoft.com/dotnet/api/system.object">object</a>&gt;</dt>
<dd></dd>
<dd><p>Enumerable of results from processing the act.</p>
</dd>
</dl>
@@ -196,39 +196,6 @@ Class MachiningProjectDisplayee
</h2>
<a id="Hi_MachiningProcs_MachiningProjectDisplayee__ctor_" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.#ctor*"></a>
<h3 id="Hi_MachiningProcs_MachiningProjectDisplayee__ctor_Hi_MachiningProcs_MachiningProject_" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.#ctor(Hi.MachiningProcs.MachiningProject)">
MachiningProjectDisplayee(MachiningProject)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> class with default rendering flags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningProjectDisplayee(MachiningProject machiningProject)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>machiningProject</code> <a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></dt>
<dd><p>The machining project to display.</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProjectDisplayee__ctor_" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.#ctor*"></a>
<h3 id="Hi_MachiningProcs_MachiningProjectDisplayee__ctor_Hi_MachiningProcs_MachiningProject_System_Collections_BitArray_" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.#ctor(Hi.MachiningProcs.MachiningProject,System.Collections.BitArray)">
@@ -263,6 +230,38 @@ Class MachiningProjectDisplayee
<a id="Hi_MachiningProcs_MachiningProjectDisplayee__ctor_" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.#ctor*"></a>
<h3 id="Hi_MachiningProcs_MachiningProjectDisplayee__ctor_System_Func_Hi_MachiningProcs_MachiningProject__" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.#ctor(System.Func{Hi.MachiningProcs.MachiningProject})">
MachiningProjectDisplayee(Func&lt;MachiningProject&gt;)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> class with default rendering flags.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningProjectDisplayee(Func&lt;MachiningProject&gt; machiningProjectGetter)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>machiningProjectGetter</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
@@ -274,7 +273,8 @@ Class MachiningProjectDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the Heidenhain coordinate entry displayee for Heidenhain-based coordinate systems.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -305,7 +305,8 @@ Class MachiningProjectDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the ISO coordinate entry displayee for ISO-based coordinate systems.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -341,7 +342,7 @@ Class MachiningProjectDisplayee
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MachiningProject MachiningProject { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public MachiningProject MachiningProject { get; }</code></pre>
</div>
@@ -361,6 +362,37 @@ Class MachiningProjectDisplayee
<a id="Hi_MachiningProcs_MachiningProjectDisplayee_MachiningProjectGetter_" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.MachiningProjectGetter*"></a>
<h3 id="Hi_MachiningProcs_MachiningProjectDisplayee_MachiningProjectGetter" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.MachiningProjectGetter">
MachiningProjectGetter
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Func&lt;MachiningProject&gt; MachiningProjectGetter { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_MachiningProjectDisplayee_RenderingFlagBitArray_" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.RenderingFlagBitArray*"></a>
<h3 id="Hi_MachiningProcs_MachiningProjectDisplayee_RenderingFlagBitArray" data-uid="Hi.MachiningProcs.MachiningProjectDisplayee.RenderingFlagBitArray">
@@ -0,0 +1,691 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ProxyProjectService | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ProxyProjectService | HiAPI-C# 2025 ">
<meta name="description" content="Delegate (User-based) Project Service. Apply relative file path from .">
<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.ProxyProjectService">
<h1 id="Hi_MachiningProcs_ProxyProjectService" data-uid="Hi.MachiningProcs.ProxyProjectService" class="text-break">
Class ProxyProjectService
</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>Delegate (User-based) Project Service.
Apply relative file path from <a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html#Hi_MachiningProcs_ProxyProjectService_AdminDirectory">AdminDirectory</a>.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ProxyProjectService : IProjectService, IMachiningProjectGetter</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">ProxyProjectService</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>
</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_ProxyProjectService__ctor_" data-uid="Hi.MachiningProcs.ProxyProjectService.#ctor*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService__ctor_Hi_MachiningProcs_LocalProjectService_Microsoft_Extensions_Options_IOptions_Hi_HiNcKits_ProxyConfig__" data-uid="Hi.MachiningProcs.ProxyProjectService.#ctor(Hi.MachiningProcs.LocalProjectService,Microsoft.Extensions.Options.IOptions{Hi.HiNcKits.ProxyConfig})">
ProxyProjectService(LocalProjectService, IOptions&lt;ProxyConfig&gt;)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html">ProxyProjectService</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ProxyProjectService(LocalProjectService localProjectService, IOptions&lt;ProxyConfig&gt; proxyConfigOptions)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>localProjectService</code> <a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a></dt>
<dd><p>The local project service.</p>
</dd>
<dt><code>proxyConfigOptions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.options.ioptions-1">IOptions</a>&lt;<a class="xref" href="Hi.HiNcKits.ProxyConfig.html">ProxyConfig</a>&gt;</dt>
<dd><p>The proxy configuration options.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_MachiningProcs_ProxyProjectService_AdminDirectory_" data-uid="Hi.MachiningProcs.ProxyProjectService.AdminDirectory*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_AdminDirectory" data-uid="Hi.MachiningProcs.ProxyProjectService.AdminDirectory">
AdminDirectory
</h3>
<div class="markdown level1 summary"><p>Gets the admin directory path from the proxy configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AdminDirectory { 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_ProxyProjectService_LocalProjectService_" data-uid="Hi.MachiningProcs.ProxyProjectService.LocalProjectService*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_LocalProjectService" data-uid="Hi.MachiningProcs.ProxyProjectService.LocalProjectService">
LocalProjectService
</h3>
<div class="markdown level1 summary"><p>Gets the local project service instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LocalProjectService LocalProjectService { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a></dt>
<dd></dd>
</dl>
<a id="Hi_MachiningProcs_ProxyProjectService_MachiningProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.MachiningProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_MachiningProject" data-uid="Hi.MachiningProcs.ProxyProjectService.MachiningProject">
MachiningProject
</h3>
<div class="markdown level1 summary"><p>Gets or sets the machining project instance.</p>
</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_ProxyProjectService_MachiningProjectPath_" data-uid="Hi.MachiningProcs.ProxyProjectService.MachiningProjectPath*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_MachiningProjectPath" data-uid="Hi.MachiningProcs.ProxyProjectService.MachiningProjectPath">
MachiningProjectPath
</h3>
<div class="markdown level1 summary"><p>Gets or sets the path to the machining project file.</p>
</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_ProxyProjectService_ProjectPathRelativeToAdmin_" data-uid="Hi.MachiningProcs.ProxyProjectService.ProjectPathRelativeToAdmin*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_ProjectPathRelativeToAdmin" data-uid="Hi.MachiningProcs.ProxyProjectService.ProjectPathRelativeToAdmin">
ProjectPathRelativeToAdmin
</h3>
<div class="markdown level1 summary"><p>Gets the project path relative to the admin directory.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ProjectPathRelativeToAdmin { 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_ProxyProjectService_ProxyConfigOptions_" data-uid="Hi.MachiningProcs.ProxyProjectService.ProxyConfigOptions*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_ProxyConfigOptions" data-uid="Hi.MachiningProcs.ProxyProjectService.ProxyConfigOptions">
ProxyConfigOptions
</h3>
<div class="markdown level1 summary"><p>Gets the proxy configuration options.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IOptions&lt;ProxyConfig&gt; ProxyConfigOptions { 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.options.ioptions-1">IOptions</a>&lt;<a class="xref" href="Hi.HiNcKits.ProxyConfig.html">ProxyConfig</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_MachiningProcs_ProxyProjectService_CloseProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.CloseProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_CloseProject" data-uid="Hi.MachiningProcs.ProxyProjectService.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_ProxyProjectService_GetMachiningProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.GetMachiningProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_GetMachiningProject" data-uid="Hi.MachiningProcs.ProxyProjectService.GetMachiningProject">
GetMachiningProject()
</h3>
<div class="markdown level1 summary"><p>Gets the MachiningProject instance.</p>
</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><p>The MachiningProject instance.</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_ProxyProjectService_LoadProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.LoadProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_LoadProject_System_String_" data-uid="Hi.MachiningProcs.ProxyProjectService.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 relativeFilePath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relativeFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path from the admin directory root</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_ProxyProjectService_NewProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.NewProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_NewProject_System_String_" data-uid="Hi.MachiningProcs.ProxyProjectService.NewProject(System.String)">
NewProject(string)
</h3>
<div class="markdown level1 summary"><p>Creates a new 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 void NewProject(string relativeFilePath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relativeFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path from the admin directory</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_ProxyProjectService_ReloadProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.ReloadProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_ReloadProject" data-uid="Hi.MachiningProcs.ProxyProjectService.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_ProxyProjectService_SaveAsProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.SaveAsProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_SaveAsProject_System_String_" data-uid="Hi.MachiningProcs.ProxyProjectService.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 Task SaveAsProject(string relativeFilePath)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>relativeFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path from the admin directory root</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></dd>
</dl>
<a id="Hi_MachiningProcs_ProxyProjectService_SaveProject_" data-uid="Hi.MachiningProcs.ProxyProjectService.SaveProject*"></a>
<h3 id="Hi_MachiningProcs_ProxyProjectService_SaveProject" data-uid="Hi.MachiningProcs.ProxyProjectService.SaveProject">
SaveProject()
</h3>
<div class="markdown level1 summary"><p>Saves the current project.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task SaveProject()</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>
</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>
@@ -161,7 +161,8 @@ Category: Foreground.</p>
</dd>
<dt id="Hi_MachiningProcs_RenderingFlag_Dummy"><code>Dummy = 0</code></dt>
<dd></dd>
<dd><p>Dummy placeholder flag.</p>
</dd>
<dt id="Hi_MachiningProcs_RenderingFlag_Fixture"><code>Fixture = 4</code></dt>
<dd><p>Fixture rendering flag.
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class RuntimeApi | HiAPI-C# 2025 ">
<meta name="description" content="Runtime API for machining operations.">
<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 RuntimeApi
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Runtime API for machining operations.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -425,7 +426,8 @@ This property only has an effect if collision detection is enabled.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to pause on failure during execution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -885,7 +887,8 @@ public static int MillingForceCycleDivisionNum { get; set; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the NC optimization options.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1414,7 +1417,8 @@ public double OptSpindleTorqueSafetyFactor { get; set; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the parameter template dimension (2D or 3D).</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1478,7 +1482,8 @@ public int ParaTemplateDimension { get; set; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the session message host for displaying messages.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1750,7 +1755,8 @@ milling step() has not triggered yet.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Begins a new machining session.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1905,7 +1911,8 @@ public void EndPreserve()</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Ends the current machining session.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2342,7 +2349,8 @@ public void Pause()</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Plays an act with pacing control.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2353,11 +2361,14 @@ public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationT
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>act</code> <a class="xref" href="Hi.Numerical.Acts.IAct.html">IAct</a></dt>
<dd></dd>
<dd><p>The act to play.</p>
</dd>
<dt><code>sourceCommand</code> <a class="xref" href="Hi.MachiningSteps.ISourceCommand.html">ISourceCommand</a></dt>
<dd></dd>
<dd><p>The source command.</p>
</dd>
<dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a>?</dt>
<dd></dd>
<dd><p>Cancellation token.</p>
</dd>
</dl>
@@ -2378,7 +2389,8 @@ public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationT
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Plays a CL (cutter location) teleport operation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2389,17 +2401,23 @@ public void PlayClTeleport(double x, double y, double z, double i, double j, dou
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>X coordinate.</p>
</dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Y coordinate.</p>
</dd>
<dt><code>z</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>Z coordinate.</p>
</dd>
<dt><code>i</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>I vector component.</p>
</dd>
<dt><code>j</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>J vector component.</p>
</dd>
<dt><code>k</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dd><p>K vector component.</p>
</dd>
</dl>
@@ -2491,7 +2509,8 @@ public void PlayNcFile(string relNcFilePath)</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Plays a tooling teleport operation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2502,7 +2521,8 @@ public void PlayToolingTeleport(int toolId)</code></pre>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>toolId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dd><p>The tool ID to teleport.</p>
</dd>
</dl>
@@ -745,6 +745,38 @@ public class RuntimeController : ControllerBase, ICsScriptApi</code></pre>
<a id="Hi_MachiningProcs_RuntimeController__ctor_" data-uid="Hi.MachiningProcs.RuntimeController.#ctor*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController__ctor_Hi_MachiningProcs_IProjectService_" data-uid="Hi.MachiningProcs.RuntimeController.#ctor(Hi.MachiningProcs.IProjectService)">
RuntimeController(IProjectService)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RuntimeController(IProjectService projectService)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>projectService</code> <a class="xref" href="Hi.MachiningProcs.IProjectService.html">IProjectService</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
@@ -955,7 +987,8 @@ This property only has an effect if collision detection is enabled.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EnablePauseOnFailure">EnablePauseOnFailure</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1415,7 +1448,8 @@ public static int MillingForceCycleDivisionNum { get; set; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_NcOptOption">NcOptOption</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1944,7 +1978,8 @@ public double OptSpindleTorqueSafetyFactor { get; set; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_ParaTemplateDimension">ParaTemplateDimension</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1976,7 +2011,8 @@ public int ParaTemplateDimension { get; set; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the runtime API instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2039,7 +2075,8 @@ public int ParaTemplateDimension { get; set; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_SessionMessageHost">SessionMessageHost</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2316,7 +2353,8 @@ public void BeginSelection(string key, AnchorMode anchorMode = AnchorMode.LineBe
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_BeginSession">BeginSession()</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2476,7 +2514,8 @@ public void EndSelection(string key, AnchorMode anchorMode = AnchorMode.LineEnd,
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_EndSession">EndSession()</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2925,7 +2964,8 @@ public void Pause()</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_PlayAct_Hi_Numerical_Acts_IAct_Hi_MachiningSteps_ISourceCommand_System_Nullable_System_Threading_CancellationToken__">PlayAct(IAct, ISourceCommand, CancellationToken?)</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -2962,7 +3002,8 @@ public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationT
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_PlayClTeleport_System_Double_System_Double_System_Double_System_Double_System_Double_System_Double_">PlayClTeleport(double, double, double, double, double, double)</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -3078,7 +3119,8 @@ public void PlayNcFile(string relNcFilePath)</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html#Hi_MachiningProcs_RuntimeApi_PlayToolingTeleport_System_Int32_">PlayToolingTeleport(int)</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -3908,7 +3950,7 @@ 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">[HttpPost]
<pre><code class="lang-csharp hljs">[NonAction]
public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate)</code></pre>
</div>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SetupController | HiAPI-C# 2025 ">
<meta name="description" content="Controller for setup operations of machining projects.">
<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 SetupController
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Controller for setup operations of machining projects.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -707,22 +708,24 @@ public class SetupController : ControllerBase</code></pre>
<a id="Hi_MachiningProcs_SetupController__ctor_" data-uid="Hi.MachiningProcs.SetupController.#ctor*"></a>
<h3 id="Hi_MachiningProcs_SetupController__ctor_Hi_MachiningProcs_IPathedMachiningProjectHost_" data-uid="Hi.MachiningProcs.SetupController.#ctor(Hi.MachiningProcs.IPathedMachiningProjectHost)">
SetupController(IPathedMachiningProjectHost)
<h3 id="Hi_MachiningProcs_SetupController__ctor_Hi_MachiningProcs_IProjectService_" data-uid="Hi.MachiningProcs.SetupController.#ctor(Hi.MachiningProcs.IProjectService)">
SetupController(IProjectService)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SetupController(IPathedMachiningProjectHost pathedMachiningProjectHost)</code></pre>
<pre><code class="lang-csharp hljs">public SetupController(IProjectService projectService)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>pathedMachiningProjectHost</code> <a class="xref" href="Hi.MachiningProcs.IPathedMachiningProjectHost.html">IPathedMachiningProjectHost</a></dt>
<dd></dd>
<dt><code>projectService</code> <a class="xref" href="Hi.MachiningProcs.IProjectService.html">IProjectService</a></dt>
<dd><p>The project service.</p>
</dd>
</dl>
@@ -783,7 +786,8 @@ public class SetupController : ControllerBase</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Applies a CL milling device to the machining equipment.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -810,7 +814,8 @@ public void ApplyClMillingDevice()</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Loads a fixture from the specified XML file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -821,7 +826,8 @@ public void LoadFixture(string fixtureXmlFilePath)</code></pre>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>fixtureXmlFilePath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The XML file path of the fixture to load.</p>
</dd>
</dl>
@@ -842,7 +848,8 @@ public void LoadFixture(string fixtureXmlFilePath)</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Loads a machining project from the specified file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -853,7 +860,8 @@ public void LoadProject(string filePath)</code></pre>
<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>The file path to load the project from.</p>
</dd>
</dl>
@@ -874,7 +882,8 @@ public void LoadProject(string filePath)</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Saves the current machining project.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -95,8 +95,9 @@
Classes
</h3>
<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>
<dt><a class="xref" href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.html">DynamicMachiningProjectDisplayee0</a></dt>
<dd><p>Provides display capabilities for a milling course.
obsoleted.</p>
</dd>
</dl>
<dl class="jumplist">
@@ -152,11 +153,18 @@ Provides settings for physics simulation, evaluation, and temperature control.</
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.MillingUtil.html">MillingUtil</a></dt>
<dd><p>Provides utility methods for milling calculations and operations.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html">ProxyProjectService</a></dt>
<dd><p>Delegate (User-based) Project Service.
Apply relative file path from <a class="xref" href="Hi.MachiningProcs.ProxyProjectService.html#Hi_MachiningProcs_ProxyProjectService_AdminDirectory">AdminDirectory</a>.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeApi.html">RuntimeApi</a></dt>
<dd></dd>
<dd><p>Runtime API for machining operations.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.RuntimeController.html">RuntimeController</a></dt>
@@ -182,26 +190,21 @@ such as source commands, machining steps, exceptions, and tagged messages.</p>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.SetupController.html">SetupController</a></dt>
<dd></dd>
<dd><p>Controller for setup operations of machining projects.</p>
</dd>
</dl>
<h3 id="interfaces">
Interfaces
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.IMachiningProjectGetter.html">IMachiningProjectGetter</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.IMachiningProjectHost.html">IMachiningProjectHost</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.IPathedMachiningProjectHost.html">IPathedMachiningProjectHost</a></dt>
<dd></dd>
<dd><p>Interface for objects that can provide a MachiningProject instance.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.IProjectService.html">IProjectService</a></dt>
<dd></dd>
<dd><p>Interface for services that manage machining projects.</p>
</dd>
</dl>
<h3 id="enums">
Enums
@@ -226,7 +229,8 @@ Delegates
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.LocalProjectService.MachiningProjectChangedDelegate.html">LocalProjectService.MachiningProjectChangedDelegate</a></dt>
<dd></dd>
<dd><p>Delegate for machining project changed events.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html">MachiningActRunner.MachiningStepBuiltDelegate</a></dt>
@@ -1912,7 +1912,7 @@ public double? FrictionPower_W { get; }</code></pre>
</h3>
<div class="markdown level1 summary"><p>Gets the infinite insistent spindle power ratio</p>
<div class="markdown level1 summary"><p>Continuous spindle power ratio: input power / time-unlimited maximum power per spindle capability.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2386,7 +2386,7 @@ public double MaxMomentAboutToolTip_Nm { get; }</code></pre>
</h3>
<div class="markdown level1 summary"><p>Gets the maximum spindle power ratio</p>
<div class="markdown level1 summary"><p>Maximum spindle power ratio: input power / instantaneous maximum power per spindle capability.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2856,7 +2856,7 @@ public double SpindleCyclePeriod_s { get; }</code></pre>
</h3>
<div class="markdown level1 summary"><p>Gets the input spindle power in Watts.</p>
<div class="markdown level1 summary"><p>Input spindle power in watts: energy entering the spindle.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2891,8 +2891,8 @@ public double SpindleInputPower_W { get; }</code></pre>
</h3>
<div class="markdown level1 summary"><p>Spindle power. Watt.
Axial Power Taken By Workpiece.</p>
<div class="markdown level1 summary"><p>Spindle output power in watts (axial power taken by workpiece).
Energy at the cutting end after spindle losses; causes workpiece/chip deformation and temperature rise.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -326,7 +326,8 @@ Class AptDerivative
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the default polar resolution for 2D operations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -651,7 +652,7 @@ This function is usually used to compute the bounding box of elements.</p>
</h3>
<div class="markdown level1 summary"><p>Generates a new STL.</p>
<div class="markdown level1 summary"><p>Generates an STL representation of the tool geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -662,14 +663,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><p>Polar resolution</p>
<dd><p>The polar resolution to use for generation.</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>A newly created STL.</p>
<dd><p>The generated STL object.</p>
</dd>
</dl>
@@ -192,7 +192,8 @@ Class MillingTraining
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the parameter template for cutting operations.</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 HeidenhainCoordinateEntryDisplayee | HiAPI-C# 2025 ">
<meta name="description" content="Displayee for Heidenhain coordinate entry visualization.">
<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 HeidenhainCoordinateEntryDisplayee
<dl><dt>Assembly</dt><dd>HiUniNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Displayee for Heidenhain coordinate entry visualization.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -371,7 +372,8 @@ Class HeidenhainCoordinateEntryDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show Heidenhain datum preset information.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -402,7 +404,8 @@ Class HeidenhainCoordinateEntryDisplayee
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to show Heidenhain datum shift information.</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 IsoCoordinateEntryDisplayee | HiAPI-C# 2025 ">
<meta name="description" content="Displayee for ISO coordinate entry visualization.">
<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 IsoCoordinateEntryDisplayee
<dl><dt>Assembly</dt><dd>HiUniNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Displayee for ISO coordinate entry visualization.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -203,7 +204,8 @@ Class IsoCoordinateEntryDisplayee
</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.IsoCoordinateEntryDisplayee.html">IsoCoordinateEntryDisplayee</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -213,9 +215,11 @@ Class IsoCoordinateEntryDisplayee
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncEnvFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="Hi.Numerical.NcEnv.html">NcEnv</a>&gt;</dt>
<dd></dd>
<dd><p>The function that provides the NcEnv instance.</p>
</dd>
<dt><code>millingEquipmentSource</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html">IMachiningEquipment</a>&gt;</dt>
<dd></dd>
<dd><p>The function that provides the machining equipment.</p>
</dd>
</dl>
@@ -1400,9 +1400,11 @@ Set to NaN if tooling motion not apply the axis motion.</p>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mcXyzabc_mm_rad</code> <a class="xref" href="Hi.Geom.DVec3d.html">DVec3d</a></dt>
<dd></dd>
<dd><p>Machine coordinates in mm and radians.</p>
</dd>
<dt><code>messageKit</code> <a class="xref" href="Hi.Common.Messages.IMessageKit.html">IMessageKit</a></dt>
<dd></dd>
<dd><p>Message kit for error reporting.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
@@ -486,7 +486,8 @@ Start on 0.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the file number.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1295,7 +1296,8 @@ Start on 0.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the line number.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -1327,7 +1329,8 @@ public int LineNo { get; }</code></pre>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the machine ABC coordinates in degrees.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -106,11 +106,13 @@ Classes
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a></dt>
<dd></dd>
<dd><p>Displayee for Heidenhain coordinate entry visualization.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.IsoCoordinateEntryDisplayee.html">IsoCoordinateEntryDisplayee</a></dt>
<dd></dd>
<dd><p>Displayee for ISO coordinate entry visualization.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Numerical.IsoCoordinateTable.html">IsoCoordinateTable</a></dt>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class EnablingWrapper | HiAPI-C# 2025 ">
<meta name="description" content="Wrapper for shell commands that provides enable/disable 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,8 @@ Class EnablingWrapper
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Wrapper for shell commands that provides enable/disable functionality.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -218,7 +219,8 @@ Class EnablingWrapper
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.ShellCommands.EnablingWrapper.html">EnablingWrapper</a> class with the specified command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -228,7 +230,8 @@ Class EnablingWrapper
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>command</code> <a class="xref" href="Hi.ShellCommands.IShellCommand.html">IShellCommand</a></dt>
<dd></dd>
<dd><p>The command to wrap.</p>
</dd>
</dl>
@@ -269,7 +272,8 @@ Class EnablingWrapper
<dd><p>Relative file path</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
<dd><p>Additional resources</p>
</dd>
</dl>
@@ -294,7 +298,8 @@ Class EnablingWrapper
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the wrapped shell command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -325,7 +330,8 @@ Class EnablingWrapper
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether the wrapped command is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -163,7 +163,8 @@ Interface ITitleCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -174,7 +175,8 @@ Interface ITitleCommand
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -240,7 +240,8 @@ Class ListCommand
<dd><p>Relative file path.</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
<dd><p>Additional resources</p>
</dd>
</dl>
@@ -334,7 +335,8 @@ The item in list is null capable.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -345,7 +347,8 @@ The item in list is null capable.</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -220,7 +220,8 @@ Class NcCodeCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.ShellCommands.NcCodeCommand.html">NcCodeCommand</a> class with the specified NC text.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -230,7 +231,8 @@ Class NcCodeCommand
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>nc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The NC code text.</p>
</dd>
</dl>
@@ -392,7 +394,8 @@ Alternative file name for the NC code file.</p>
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -403,7 +406,8 @@ Alternative file name for the NC code file.</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -220,7 +220,8 @@ Class NcFileCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.ShellCommands.NcFileCommand.html">NcFileCommand</a> class with the specified NC file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -230,7 +231,8 @@ Class NcFileCommand
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>ncFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The NC file path.</p>
</dd>
</dl>
@@ -359,7 +361,8 @@ Class NcFileCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -370,7 +373,8 @@ Class NcFileCommand
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -240,7 +240,8 @@ Class NcOptOptionCommand
<dd><p>Relative file path</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
<dd><p>Additional resources</p>
</dd>
</dl>
@@ -265,7 +266,8 @@ Class NcOptOptionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the NC optimization options.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -332,7 +334,8 @@ Class NcOptOptionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -343,7 +346,8 @@ Class NcOptOptionCommand
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -240,7 +240,8 @@ Class PostExecutionCommand
<dd><p>Relative file path</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
<dd><p>Additional resources</p>
</dd>
</dl>
@@ -265,7 +266,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to enable geometry difference detection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -296,7 +298,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to enable optimization to files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -327,7 +330,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to write runtime geometry to file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -358,7 +362,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to write shot files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -389,7 +394,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to write step files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -420,7 +426,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the geometry difference detection radius in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -451,7 +458,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the optimization file template path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -482,7 +490,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the runtime geometry file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -513,7 +522,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the shot file template path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -544,7 +554,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the time resolution for shot files in milliseconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -575,7 +586,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the step file template path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -642,7 +654,8 @@ Class PostExecutionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -653,7 +666,8 @@ Class PostExecutionCommand
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -240,7 +240,8 @@ Class PreSettingCommand
<dd><p>Relative file path</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
<dd><p>Additional resources</p>
</dd>
</dl>
@@ -265,7 +266,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether collision detection is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -296,7 +298,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to pause on failure.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -327,7 +330,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether physics is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -358,7 +362,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to enable reading runtime geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -389,7 +394,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the machining motion resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -420,7 +426,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the machining resolution in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -451,7 +458,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the runtime geometry file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -518,7 +526,8 @@ Class PreSettingCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -529,7 +538,8 @@ Class PreSettingCommand
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -261,7 +261,8 @@ Class ScriptCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the execution template command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -292,7 +293,8 @@ Class ScriptCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the optimization configuration template command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -323,7 +325,8 @@ Class ScriptCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the pre-setting template command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -487,7 +490,8 @@ Class ScriptCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets the title of the command.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -498,7 +502,8 @@ Class ScriptCommand
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dd><p>The command title.</p>
</dd>
</dl>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SimpleSessionCommand | HiAPI-C# 2025 ">
<meta name="description" content="Simple session command for executing machining operations.">
<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 SimpleSessionCommand
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown summary"><p>Simple session command for executing machining operations.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
@@ -238,7 +239,8 @@ Class SimpleSessionCommand
<dd><p>Relative file path</p>
</dd>
<dt><code>res</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd></dd>
<dd><p>Additional resources</p>
</dd>
</dl>
@@ -263,7 +265,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether collision detection is enabled.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -294,7 +297,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to enable geometry difference detection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -325,7 +329,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to enable optimization to files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -356,7 +361,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to pause on failure.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -387,7 +393,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to enable reading runtime geometry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -418,7 +425,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to write runtime geometry to file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -449,7 +457,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to write shot files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -480,7 +489,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets whether to write step files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -511,7 +521,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the geometry difference detection radius in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -542,7 +553,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the machining motion resolution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -573,7 +585,8 @@ Class SimpleSessionCommand
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the machining resolution in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -637,7 +650,8 @@ Because of the design idea is for simplicity, only expect the wrapper content to
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the NC optimization options.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -668,7 +682,8 @@ Because of the design idea is for simplicity, only expect the wrapper content to
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the optimization file template path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -699,7 +714,8 @@ Because of the design idea is for simplicity, only expect the wrapper content to
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the runtime geometry file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -730,7 +746,8 @@ Because of the design idea is for simplicity, only expect the wrapper content to
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the runtime geometry file template.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -761,7 +778,8 @@ Because of the design idea is for simplicity, only expect the wrapper content to
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the shot file template path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -792,7 +810,8 @@ Because of the design idea is for simplicity, only expect the wrapper content to
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the time resolution for shot files in milliseconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -823,7 +842,8 @@ Because of the design idea is for simplicity, only expect the wrapper content to
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Gets or sets the step file template path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -96,7 +96,8 @@ Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.ShellCommands.EnablingWrapper.html">EnablingWrapper</a></dt>
<dd></dd>
<dd><p>Wrapper for shell commands that provides enable/disable functionality.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.ShellCommands.GeomDiffCommand.html">GeomDiffCommand</a></dt>
@@ -165,7 +166,8 @@ Classes
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.ShellCommands.SimpleSessionCommand.html">SimpleSessionCommand</a></dt>
<dd></dd>
<dd><p>Simple session command for executing machining operations.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html">WriteRuntimeGeomToStlCommand</a></dt>
@@ -1,833 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class RenderingHub | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class RenderingHub | HiAPI-C# 2025 ">
<meta name="description" content="SignalR Hub 用於處理渲染畫布的實時通信">
<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.Webapi.Hubs.RenderingHub">
<h1 id="Hi_Webapi_Hubs_RenderingHub" data-uid="Hi.Webapi.Hubs.RenderingHub" class="text-break">
Class RenderingHub
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Webapi.html">Webapi</a>.<a class="xref" href="Hi.Webapi.Hubs.html">Hubs</a></dd></dl>
<dl><dt>Assembly</dt><dd>Hi.Webapi.dll</dd></dl>
</div>
<div class="markdown summary"><p>SignalR Hub 用於處理渲染畫布的實時通信</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RenderingHub : Hub, 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><a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.signalr.hub">Hub</a></div>
<div><span class="xref">RenderingHub</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/microsoft.aspnetcore.signalr.hub.onconnectedasync">Hub.OnConnectedAsync()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.signalr.hub.dispose#microsoft-aspnetcore-signalr-hub-dispose(system-boolean)">Hub.Dispose(bool)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.signalr.hub.dispose#microsoft-aspnetcore-signalr-hub-dispose">Hub.Dispose()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.signalr.hub.clients">Hub.Clients</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.signalr.hub.context">Hub.Context</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.signalr.hub.groups">Hub.Groups</a>
</div>
<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_Webapi_Hubs_RenderingHub__ctor_" data-uid="Hi.Webapi.Hubs.RenderingHub.#ctor*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub__ctor_Hi_Webapi_Services_RenderingService_Microsoft_Extensions_Logging_ILogger_Hi_Webapi_Hubs_RenderingHub__" data-uid="Hi.Webapi.Hubs.RenderingHub.#ctor(Hi.Webapi.Services.RenderingService,Microsoft.Extensions.Logging.ILogger{Hi.Webapi.Hubs.RenderingHub})">
RenderingHub(RenderingService, ILogger&lt;RenderingHub&gt;)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RenderingHub(RenderingService renderingService, ILogger&lt;RenderingHub&gt; logger)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>renderingService</code> <a class="xref" href="Hi.Webapi.Services.RenderingService.html">RenderingService</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.Webapi.Hubs.RenderingHub.html">RenderingHub</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleKeyDown_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleKeyDown*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleKeyDown_System_String_System_String_System_Boolean_System_Boolean_System_Boolean_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleKeyDown(System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
HandleKeyDown(string, string, bool, bool, bool)
</h3>
<div class="markdown level1 summary"><p>處理鍵盤按下事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleKeyDown(string key, string code, bool ctrlKey, bool shiftKey, bool altKey)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>code</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>ctrlKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>shiftKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>altKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleKeyUp_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleKeyUp*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleKeyUp_System_String_System_String_System_Boolean_System_Boolean_System_Boolean_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleKeyUp(System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
HandleKeyUp(string, string, bool, bool, bool)
</h3>
<div class="markdown level1 summary"><p>處理鍵盤釋放事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleKeyUp(string key, string code, bool ctrlKey, bool shiftKey, bool altKey)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>key</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>code</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>ctrlKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>shiftKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
<dt><code>altKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleMouseDown_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseDown*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleMouseDown_System_Double_System_Double_System_Int32_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseDown(System.Double,System.Double,System.Int32)">
HandleMouseDown(double, double, int)
</h3>
<div class="markdown level1 summary"><p>處理鼠標按下事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleMouseDown(double x, double y, int button)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>button</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleMouseMove_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseMove*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleMouseMove_System_Double_System_Double_System_Int32_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseMove(System.Double,System.Double,System.Int32)">
HandleMouseMove(double, double, int)
</h3>
<div class="markdown level1 summary"><p>處理鼠標移動事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleMouseMove(double x, double y, int buttonMask)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>buttonMask</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleMouseUp_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseUp*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleMouseUp_System_Double_System_Double_System_Int32_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseUp(System.Double,System.Double,System.Int32)">
HandleMouseUp(double, double, int)
</h3>
<div class="markdown level1 summary"><p>處理鼠標釋放事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleMouseUp(double x, double y, int button)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>button</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleMouseWheel_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseWheel*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleMouseWheel_System_Double_System_Double_System_Double_System_Double_System_String_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleMouseWheel(System.Double,System.Double,System.Double,System.Double,System.String)">
HandleMouseWheel(double, double, double, double, string)
</h3>
<div class="markdown level1 summary"><p>處理鼠標滾輪事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleMouseWheel(double x, double y, double deltaX, double deltaY, string browserBrand = &quot;chrome&quot;)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>deltaX</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>deltaY</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>browserBrand</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleResize_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleResize*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleResize_System_Int32_System_Int32_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleResize(System.Int32,System.Int32)">
HandleResize(int, int)
</h3>
<div class="markdown level1 summary"><p>處理窗口大小變化</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleResize(int width, int height)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>width</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>height</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleTouchDown_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleTouchDown*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleTouchDown_System_Int32_System_Double_System_Double_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleTouchDown(System.Int32,System.Double,System.Double)">
HandleTouchDown(int, double, double)
</h3>
<div class="markdown level1 summary"><p>處理觸摸按下事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleTouchDown(int pointerId, double x, double y)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>pointerId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleTouchMove_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleTouchMove*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleTouchMove_System_Int32_System_Double_System_Double_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleTouchMove(System.Int32,System.Double,System.Double)">
HandleTouchMove(int, double, double)
</h3>
<div class="markdown level1 summary"><p>處理觸摸移動事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleTouchMove(int pointerId, double x, double y)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>pointerId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>x</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>y</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleTouchUp_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleTouchUp*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleTouchUp_System_Int32_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleTouchUp(System.Int32)">
HandleTouchUp(int)
</h3>
<div class="markdown level1 summary"><p>處理觸摸釋放事件</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleTouchUp(int pointerId)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>pointerId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_HandleVisibilityChange_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleVisibilityChange*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_HandleVisibilityChange_System_String_" data-uid="Hi.Webapi.Hubs.RenderingHub.HandleVisibilityChange(System.String)">
HandleVisibilityChange(string)
</h3>
<div class="markdown level1 summary"><p>處理可見性變化</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task HandleVisibilityChange(string visibilityState)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>visibilityState</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_InitializeCanvas_" data-uid="Hi.Webapi.Hubs.RenderingHub.InitializeCanvas*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_InitializeCanvas_System_Int32_System_Int32_" data-uid="Hi.Webapi.Hubs.RenderingHub.InitializeCanvas(System.Int32,System.Int32)">
InitializeCanvas(int, int)
</h3>
<div class="markdown level1 summary"><p>客戶端連接時初始化渲染引擎</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task InitializeCanvas(int width, int height)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>width</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>height</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_OnDisconnectedAsync_" data-uid="Hi.Webapi.Hubs.RenderingHub.OnDisconnectedAsync*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_OnDisconnectedAsync_System_Exception_" data-uid="Hi.Webapi.Hubs.RenderingHub.OnDisconnectedAsync(System.Exception)">
OnDisconnectedAsync(Exception)
</h3>
<div class="markdown level1 summary"><p>客戶端斷開連接時清理資源</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Task OnDisconnectedAsync(Exception exception)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>exception</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
<dd></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></dd>
</dl>
<a id="Hi_Webapi_Hubs_RenderingHub_SetView_" data-uid="Hi.Webapi.Hubs.RenderingHub.SetView*"></a>
<h3 id="Hi_Webapi_Hubs_RenderingHub_SetView_System_String_" data-uid="Hi.Webapi.Hubs.RenderingHub.SetView(System.String)">
SetView(string)
</h3>
<div class="markdown level1 summary"><p>設置視圖</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task SetView(string viewType)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>viewType</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></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></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>
@@ -1,127 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace Hi.Webapi.Hubs | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace Hi.Webapi.Hubs | 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.Webapi.Hubs">
<h1 id="Hi_Webapi_Hubs" data-uid="Hi.Webapi.Hubs" class="text-break">Namespace Hi.Webapi.Hubs</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Webapi.Hubs.RenderingHub.html">RenderingHub</a></dt>
<dd><p>SignalR Hub 用於處理渲染畫布的實時通信</p>
</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>
@@ -1,127 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Namespace Hi.Webapi.Services | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Namespace Hi.Webapi.Services | 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.Webapi.Services">
<h1 id="Hi_Webapi_Services" data-uid="Hi.Webapi.Services" class="text-break">Namespace Hi.Webapi.Services</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">
Classes
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Webapi.Services.RenderingService.html">RenderingService</a></dt>
<dd><p>管理 DispEngine 實例和渲染操作的服務</p>
</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>
+22 -27
View File
@@ -1121,6 +1121,12 @@
<a href="Hi.HiNcKits.html" name="" title="Hi.HiNcKits">Hi.HiNcKits</a>
<ul class="nav level2">
<li>
<a href="Hi.HiNcKits.AppConfig.html" name="" title="AppConfig">AppConfig</a>
</li>
<li>
<a href="Hi.HiNcKits.AppService.html" name="" title="AppService">AppService</a>
</li>
<li>
<a href="Hi.HiNcKits.BasePathEnum.html" name="" title="BasePathEnum">BasePathEnum</a>
</li>
@@ -1134,10 +1140,7 @@
<a href="Hi.HiNcKits.LocalApp.html" name="" title="LocalApp">LocalApp</a>
</li>
<li>
<a href="Hi.HiNcKits.AppConfig.html" name="" title="AppConfig">AppConfig</a>
</li>
<li>
<a href="Hi.HiNcKits.UserEnv.html" name="" title="UserEnv">UserEnv</a>
<a href="Hi.HiNcKits.ProxyConfig.html" name="" title="ProxyConfig">ProxyConfig</a>
</li>
</ul>
</li>
@@ -1255,16 +1258,19 @@
<a href="Hi.MachiningProcs.ConfigStepFunc.html" name="" title="ConfigStepFunc">ConfigStepFunc</a>
</li>
<li>
<a href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html" name="" title="DynamicMachiningProjectDisplayee">DynamicMachiningProjectDisplayee</a>
<a href="Hi.MachiningProcs.DynamicMachiningProjectDisplayee0.html" name="" title="DynamicMachiningProjectDisplayee0">DynamicMachiningProjectDisplayee0</a>
</li>
<li>
<a href="Hi.MachiningProcs.IMachiningProjectGetter.html" name="" title="IMachiningProjectGetter">IMachiningProjectGetter</a>
</li>
<li>
<a href="Hi.MachiningProcs.IMachiningProjectHost.html" name="" title="IMachiningProjectHost">IMachiningProjectHost</a>
<a href="Hi.MachiningProcs.IProjectService.html" name="" title="IProjectService">IProjectService</a>
</li>
<li>
<a href="Hi.MachiningProcs.IPathedMachiningProjectHost.html" name="" title="IPathedMachiningProjectHost">IPathedMachiningProjectHost</a>
<a href="Hi.MachiningProcs.LocalProjectService.html" name="" title="LocalProjectService">LocalProjectService</a>
</li>
<li>
<a href="Hi.MachiningProcs.LocalProjectService.MachiningProjectChangedDelegate.html" name="" title="LocalProjectService.MachiningProjectChangedDelegate">LocalProjectService.MachiningProjectChangedDelegate</a>
</li>
<li>
<a href="Hi.MachiningProcs.MachiningActRunner.html" name="" title="MachiningActRunner">MachiningActRunner</a>
@@ -1296,9 +1302,15 @@
<li>
<a href="Hi.MachiningProcs.MillingUtil.html" name="" title="MillingUtil">MillingUtil</a>
</li>
<li>
<a href="Hi.MachiningProcs.ProxyProjectService.html" name="" title="ProxyProjectService">ProxyProjectService</a>
</li>
<li>
<a href="Hi.MachiningProcs.RenderingFlag.html" name="" title="RenderingFlag">RenderingFlag</a>
</li>
<li>
<a href="Hi.MachiningProcs.RuntimeApi.html" name="" title="RuntimeApi">RuntimeApi</a>
</li>
<li>
<a href="Hi.MachiningProcs.RuntimeController.html" name="" title="RuntimeController">RuntimeController</a>
</li>
@@ -1339,6 +1351,9 @@
<li>
<a href="Hi.MachiningSteps.MachiningStep.html" name="" title="MachiningStep">MachiningStep</a>
</li>
<li>
<a href="Hi.MachiningSteps.MachiningStep.CollidedKeyPair.html" name="" title="MachiningStep.CollidedKeyPair">MachiningStep.CollidedKeyPair</a>
</li>
<li>
<a href="Hi.MachiningSteps.MachiningStepUtil.html" name="" title="MachiningStepUtil">MachiningStepUtil</a>
</li>
@@ -3025,26 +3040,6 @@
</li>
</ul>
</li>
<li>
<span class="expand-stub"></span>
<a href="Hi.Webapi.Hubs.html" name="" title="Hi.Webapi.Hubs">Hi.Webapi.Hubs</a>
<ul class="nav level2">
<li>
<a href="Hi.Webapi.Hubs.RenderingHub.html" name="" title="RenderingHub">RenderingHub</a>
</li>
</ul>
</li>
<li>
<span class="expand-stub"></span>
<a href="Hi.Webapi.Services.html" name="" title="Hi.Webapi.Services">Hi.Webapi.Services</a>
<ul class="nav level2">
<li>
<a href="Hi.Webapi.Services.RenderingService.html" name="" title="RenderingService">RenderingService</a>
</li>
</ul>
</li>
<li>
<span class="expand-stub"></span>
<a href="Hi.WinForm.Disp.html" name="" title="Hi.WinForm.Disp">Hi.WinForm.Disp</a>
File diff suppressed because one or more lines are too long