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

tune

Browse Source
This commit is contained in:
iamboss 2026-01-08 21:07:15 +08:00
parent f7f4fe0aac
commit f81f03cb13
279 changed files with 6575 additions and 5080 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
App/Hi.WpfPlus.dll
View File

Binary file not shown.

BIN
App/HiCbtr.dll
View File

Binary file not shown.

BIN
App/HiDisp.dll
View File

Binary file not shown.

BIN
App/HiGeom.dll
View File

Binary file not shown.

BIN
App/HiLicense.dll
View File

Binary file not shown.

BIN
App/HiMech.dll
View File

Binary file not shown.

150
App/HiNC-2025-win-desktop.deps.json
View File

@ -11,9 +11,9 @@
"dependencies": { "dependencies": {
"AvalonEdit": "6.3.0.90", "AvalonEdit": "6.3.0.90",
"FontAwesome.Sharp": "6.3.0", "FontAwesome.Sharp": "6.3.0",
"Hi.WpfPlus": "3.1.92", "Hi.WpfPlus": "3.1.93",
"HiNc": "3.1.108", "HiNc": "3.1.109",
"HiNc-Resource": "3.1.8", "HiNc-Resource": "3.1.9",
"runtimepack.Microsoft.NETCore.App.Runtime.win-x64": "10.0.1", "runtimepack.Microsoft.NETCore.App.Runtime.win-x64": "10.0.1",
"runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64": "10.0.1", "runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64": "10.0.1",
"runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64": "10.0.1" "runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64": "10.0.1"
@ -1673,36 +1673,36 @@
} }
} }
}, },
"Hi.WpfPlus/3.1.92": { "Hi.WpfPlus/3.1.93": {
"dependencies": { "dependencies": {
"HiDisp": "3.1.94" "HiDisp": "3.1.95"
}, },
"runtime": { "runtime": {
"lib/net10.0-windows7.0/Hi.WpfPlus.dll": { "lib/net10.0-windows7.0/Hi.WpfPlus.dll": {
"assemblyVersion": "3.1.92.0", "assemblyVersion": "3.1.93.0",
"fileVersion": "3.1.92.0" "fileVersion": "3.1.93.0"
} }
} }
}, },
"HiCbtr/3.1.92": { "HiCbtr/3.1.93": {
"dependencies": { "dependencies": {
"HiDisp": "3.1.94" "HiDisp": "3.1.95"
}, },
"runtime": { "runtime": {
"lib/net10.0/HiCbtr.dll": { "lib/net10.0/HiCbtr.dll": {
"assemblyVersion": "3.1.92.0", "assemblyVersion": "3.1.93.0",
"fileVersion": "3.1.92.0" "fileVersion": "3.1.93.0"
} }
} }
}, },
"HiDisp/3.1.94": { "HiDisp/3.1.95": {
"dependencies": { "dependencies": {
"HiGeom": "3.1.86" "HiGeom": "3.1.87"
}, },
"runtime": { "runtime": {
"lib/net10.0/HiDisp.dll": { "lib/net10.0/HiDisp.dll": {
"assemblyVersion": "3.1.94.0", "assemblyVersion": "3.1.95.0",
"fileVersion": "3.1.94.0" "fileVersion": "3.1.95.0"
} }
}, },
"native": { "native": {
@ -1720,7 +1720,7 @@
} }
} }
}, },
"HiGeom/3.1.86": { "HiGeom/3.1.87": {
"dependencies": { "dependencies": {
"Google.Protobuf": "3.28.3", "Google.Protobuf": "3.28.3",
"Grpc.AspNetCore": "2.66.0", "Grpc.AspNetCore": "2.66.0",
@ -1731,8 +1731,8 @@
}, },
"runtime": { "runtime": {
"lib/net10.0/HiGeom.dll": { "lib/net10.0/HiGeom.dll": {
"assemblyVersion": "3.1.86.0", "assemblyVersion": "3.1.87.0",
"fileVersion": "3.1.86.0" "fileVersion": "3.1.87.0"
} }
}, },
"resources": { "resources": {
@ -1744,27 +1744,27 @@
} }
} }
}, },
"HiLicense/3.1.86": { "HiLicense/3.1.87": {
"dependencies": { "dependencies": {
"HiGeom": "3.1.86" "HiGeom": "3.1.87"
}, },
"runtime": { "runtime": {
"lib/net10.0/HiLicense.dll": { "lib/net10.0/HiLicense.dll": {
"assemblyVersion": "3.1.86.0", "assemblyVersion": "3.1.87.0",
"fileVersion": "3.1.86.0" "fileVersion": "3.1.87.0"
} }
} }
}, },
"HiMech/3.1.99": { "HiMech/3.1.100": {
"dependencies": { "dependencies": {
"CommandLineParser": "2.9.1", "CommandLineParser": "2.9.1",
"HiCbtr": "3.1.92", "HiCbtr": "3.1.93",
"Microsoft.CodeAnalysis.CSharp.Scripting": "5.0.0" "Microsoft.CodeAnalysis.CSharp.Scripting": "5.0.0"
}, },
"runtime": { "runtime": {
"lib/net10.0/HiMech.dll": { "lib/net10.0/HiMech.dll": {
"assemblyVersion": "3.1.99.0", "assemblyVersion": "3.1.100.0",
"fileVersion": "3.1.99.0" "fileVersion": "3.1.100.0"
} }
}, },
"resources": { "resources": {
@ -1779,19 +1779,19 @@
} }
} }
}, },
"HiNc/3.1.108": { "HiNc/3.1.109": {
"dependencies": { "dependencies": {
"Google.Protobuf": "3.28.3", "Google.Protobuf": "3.28.3",
"Grpc.AspNetCore": "2.66.0", "Grpc.AspNetCore": "2.66.0",
"Grpc.Net.Client": "2.66.0", "Grpc.Net.Client": "2.66.0",
"HiLicense": "3.1.86", "HiLicense": "3.1.87",
"HiMech": "3.1.99", "HiMech": "3.1.100",
"HiUniNc": "3.1.96" "HiUniNc": "3.1.97"
}, },
"runtime": { "runtime": {
"lib/net10.0/HiNc.dll": { "lib/net10.0/HiNc.dll": {
"assemblyVersion": "3.1.108.0", "assemblyVersion": "3.1.109.0",
"fileVersion": "3.1.108.0" "fileVersion": "3.1.109.0"
} }
}, },
"resources": { "resources": {
@ -1803,22 +1803,22 @@
} }
} }
}, },
"HiNc-Resource/3.1.8": { "HiNc-Resource/3.1.9": {
"runtime": { "runtime": {
"lib/net10.0/HiNc-Resource.dll": { "lib/net10.0/HiNc-Resource.dll": {
"assemblyVersion": "3.1.8.0", "assemblyVersion": "3.1.9.0",
"fileVersion": "3.1.8.0" "fileVersion": "3.1.9.0"
} }
} }
}, },
"HiUniNc/3.1.96": { "HiUniNc/3.1.97": {
"dependencies": { "dependencies": {
"HiMech": "3.1.99" "HiMech": "3.1.100"
}, },
"runtime": { "runtime": {
"lib/net10.0/HiUniNc.dll": { "lib/net10.0/HiUniNc.dll": {
"assemblyVersion": "3.1.96.0", "assemblyVersion": "3.1.97.0",
"fileVersion": "3.1.96.0" "fileVersion": "3.1.97.0"
} }
} }
}, },
@ -2191,68 +2191,68 @@
"path": "grpc.net.common/2.66.0", "path": "grpc.net.common/2.66.0",
"hashPath": "grpc.net.common.2.66.0.nupkg.sha512" "hashPath": "grpc.net.common.2.66.0.nupkg.sha512"
}, },
"Hi.WpfPlus/3.1.92": { "Hi.WpfPlus/3.1.93": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-YznvH8xz3oPeWXRnX1kCMCAVZ0qPpksf3NmYX5/uBAt5Hd3aGr+ocM0gA3N3k7vUUblWs6OW22oJ4e/WheSYbg==", "sha512": "sha512-BjoOB6Wfmb46BuWvXeBenvAFLCZbMG7an/piwawcKVqyVTbhxr7aBExk0wEHSb4JNAn3VdbWJTydcUBiyvGh4Q==",
"path": "hi.wpfplus/3.1.92", "path": "hi.wpfplus/3.1.93",
"hashPath": "hi.wpfplus.3.1.92.nupkg.sha512" "hashPath": "hi.wpfplus.3.1.93.nupkg.sha512"
}, },
"HiCbtr/3.1.92": { "HiCbtr/3.1.93": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-u39MwB30TI56rP2AqqnCD5t8DYO/6g7614qU/BLO0PY72xyuDjOR00bSIsAVpyogryUMQ/gnEI0Xcib7yoKhgA==", "sha512": "sha512-N5hmmHhbDBr1WmvDZ4csNPDFUsQZDSvrIVHuVctYDWCgQhTFTWIWdloucXwhBPt4ThV9nu0HmXrYng1p9aJLtg==",
"path": "hicbtr/3.1.92", "path": "hicbtr/3.1.93",
"hashPath": "hicbtr.3.1.92.nupkg.sha512" "hashPath": "hicbtr.3.1.93.nupkg.sha512"
}, },
"HiDisp/3.1.94": { "HiDisp/3.1.95": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-/JtLg77lTg17EVmvN7D6wwALMidRJbNVyxuxzQAbLtX4qSbHbmhSr9az3N+tfoO+ZJe7CQkiGxJSFSbjTPf9Lg==", "sha512": "sha512-Cv9ipFMzifB0IY1GzeFJ9NiuPINQSSmyc+GkmJx+vQDFFdF+1eaBiuWLS45nyU1STnG/IQENLOucwUto9+UROg==",
"path": "hidisp/3.1.94", "path": "hidisp/3.1.95",
"hashPath": "hidisp.3.1.94.nupkg.sha512" "hashPath": "hidisp.3.1.95.nupkg.sha512"
}, },
"HiGeom/3.1.86": { "HiGeom/3.1.87": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-rWft+iZD8jJ1gTqIyqrlqkqks79QkirSE/jKf0DSw13HgQpX9kv0jMq4HAESyHGJtXvY/606hugaZG+1VSKTNw==", "sha512": "sha512-YlCs9e4xjt01tWDu4mnQ9BkFJ83pbZrr6LeiA7RssQnXN1n2r7SUlNP9w/3ksLyjPItfhV+k2ozKGOk1mRDmeg==",
"path": "higeom/3.1.86", "path": "higeom/3.1.87",
"hashPath": "higeom.3.1.86.nupkg.sha512" "hashPath": "higeom.3.1.87.nupkg.sha512"
}, },
"HiLicense/3.1.86": { "HiLicense/3.1.87": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-HEIn2SA9Zeapfxkq3wU5rjbznICDMMhHcE+uPjXzfmlRNtz5RHH1UXucqS6lh/Kz7Lm9U1kQgXwKw6Kygy491Q==", "sha512": "sha512-a0zO6Yw8KVb54BkSw7K66GgY3ZYtAh9nbiOkF25fcAus+HyoyxQeBYLAcxai/Uw0XMSpWi2afnT53z2SVPIJaw==",
"path": "hilicense/3.1.86", "path": "hilicense/3.1.87",
"hashPath": "hilicense.3.1.86.nupkg.sha512" "hashPath": "hilicense.3.1.87.nupkg.sha512"
}, },
"HiMech/3.1.99": { "HiMech/3.1.100": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-0nJwUOU+ne6sSwSoEQq7O4uyG/iD854olnHR0Soh/KnYm/kjvZIp12LZJnWUdHoDY7UuOw9+Qm+jjwv/AMqTRg==", "sha512": "sha512-0SxlkeukAqW2hSgIwz9SqpTW+1rq37k3ANX3prhCKmN08FNbQZkExX9891ccP55JeNWKgc2zNl1HM9WpQzbYYQ==",
"path": "himech/3.1.99", "path": "himech/3.1.100",
"hashPath": "himech.3.1.99.nupkg.sha512" "hashPath": "himech.3.1.100.nupkg.sha512"
}, },
"HiNc/3.1.108": { "HiNc/3.1.109": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-jn4bpKuhtP8T8MmnuRVIutpmvGlc3PEuu/93azoEFB5ZeCwCxNFnpCJojXysuXqaDmeRlvNAiLkakTtIAfp1yw==", "sha512": "sha512-g5Urfh/77kBnXB+7Rw2bpJtE9OtBuAM8oXMLLdxtnudpJl8ym0K4dUc2EsppeNAE40mCkJDw5CkOvjx+0BYj/Q==",
"path": "hinc/3.1.108", "path": "hinc/3.1.109",
"hashPath": "hinc.3.1.108.nupkg.sha512" "hashPath": "hinc.3.1.109.nupkg.sha512"
}, },
"HiNc-Resource/3.1.8": { "HiNc-Resource/3.1.9": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-g9k77byHdH0geBhhyeTDYau0ePJbxoCocOP7fejWPqm+YDdNUVNHTY5tNTRwRyRfnB4Y+Kw+zCLetSIXikiG4w==", "sha512": "sha512-sm+/X3NPfact0oUKhiUqkz2xppUB6c357msVsMP3vuAmJmyzNcz4whi4iEahud2PKYCi8+Umr0DZ2/sx4gCoYg==",
"path": "hinc-resource/3.1.8", "path": "hinc-resource/3.1.9",
"hashPath": "hinc-resource.3.1.8.nupkg.sha512" "hashPath": "hinc-resource.3.1.9.nupkg.sha512"
}, },
"HiUniNc/3.1.96": { "HiUniNc/3.1.97": {
"type": "package", "type": "package",
"serviceable": true, "serviceable": true,
"sha512": "sha512-lY+QIRLxVgq1hcv3Rfb8oGNTkO6lG2BwAy+W3daXNY80u3rFE8zz5tSDnvMxn0rHHBDfnSlNeUYAmBglsArlzA==", "sha512": "sha512-x55Gex5naGqsI4+t5VOxLeVpxsv4cR5wzuo2MoRpj+0b4/9d9+PC+tYh6/E6AZwvklceK4iUrXCVhw4ZV5MxrA==",
"path": "hiuninc/3.1.96", "path": "hiuninc/3.1.97",
"hashPath": "hiuninc.3.1.96.nupkg.sha512" "hashPath": "hiuninc.3.1.97.nupkg.sha512"
}, },
"MathNet.Numerics/5.0.0": { "MathNet.Numerics/5.0.0": {
"type": "package", "type": "package",

BIN
App/HiNC-2025-win-desktop.dll
View File

Binary file not shown.

BIN
App/HiNC-2025-win-desktop.pdb
View File

Binary file not shown.

BIN
App/HiNc-Resource.dll
View File

Binary file not shown.

BIN
App/HiNc.dll
View File

Binary file not shown.

BIN
App/HiUniNc.dll
View File

Binary file not shown.

BIN
App/en/HiGeom.resources.dll
View File

Binary file not shown.

BIN
App/en/HiMech.resources.dll
View File

Binary file not shown.

2
App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DictionaryColorGuide.html
View File

@ -518,7 +518,7 @@ Only effect on <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
<dd><p>rgb</p> <dd><p>rgb</p>
</dd> </dd>
<dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> <dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>priority</p> <dd><p>priority. Larger one takes priority.</p>
</dd> </dd>
</dl> </dl>

2
App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DiscreteQuantityColorGuide.html
View File

@ -448,7 +448,7 @@ Only effect on <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
<dd><p>rgb</p> <dd><p>rgb</p>
</dd> </dd>
<dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> <dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>priority</p> <dd><p>priority. Larger one takes priority.</p>
</dd> </dd>
</dl> </dl>

2
App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FilteredColorGuide.html
View File

@ -453,7 +453,7 @@ Only effect on <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
<dd><p>rgb</p> <dd><p>rgb</p>
</dd> </dd>
<dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> <dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>priority</p> <dd><p>priority. Larger one takes priority.</p>
</dd> </dd>
</dl> </dl>

2
App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FuncRangeColorGuide.html
View File

@ -493,7 +493,7 @@ Only effect on <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
<dd><p>rgb</p> <dd><p>rgb</p>
</dd> </dd>
<dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> <dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>priority</p> <dd><p>priority. Larger one takes priority.</p>
</dd> </dd>
</dl> </dl>

2
App/wwwroot/HiAPI-docsite/api/Hi.Coloring.IColorGuide.html
View File

@ -220,7 +220,7 @@ Only effect on <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
<dd><p>rgb</p> <dd><p>rgb</p>
</dd> </dd>
<dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> <dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>priority</p> <dd><p>priority. Larger one takes priority.</p>
</dd> </dd>
</dl> </dl>

2
App/wwwroot/HiAPI-docsite/api/Hi.Coloring.PlainColorGuide.html
View File

@ -415,7 +415,7 @@ Only effect on <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
<dd><p>rgb</p> <dd><p>rgb</p>
</dd> </dd>
<dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> <dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>priority</p> <dd><p>priority. Larger one takes priority.</p>
</dd> </dd>
</dl> </dl>

2
App/wwwroot/HiAPI-docsite/api/Hi.Coloring.QuantityColorGuide.html
View File

@ -517,7 +517,7 @@ Only effect on <a class="xref" href="Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
<dd><p>rgb</p> <dd><p>rgb</p>
</dd> </dd>
<dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> <dt><code>attachmentPriority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>priority</p> <dd><p>priority. Larger one takes priority.</p>
</dd> </dd>
</dl> </dl>

206
App/wwwroot/HiAPI-docsite/api/Hi.Common.IToPresentDto.html Normal file
View File

@ -0,0 +1,206 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface IToPresentDto | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface IToPresentDto | 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.Common.IToPresentDto">
<h1 id="Hi_Common_IToPresentDto" data-uid="Hi.Common.IToPresentDto" class="text-break">
Interface IToPresentDto
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.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 IToPresentDto</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="methods">Methods
</h2>
<a id="Hi_Common_IToPresentDto_ToPresentDto_" data-uid="Hi.Common.IToPresentDto.ToPresentDto*"></a>
<h3 id="Hi_Common_IToPresentDto_ToPresentDto" data-uid="Hi.Common.IToPresentDto.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and object properties</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>

4
App/wwwroot/HiAPI-docsite/api/Hi.Common.html
View File

@ -343,6 +343,10 @@ Generally used to suggest a name when generating or saving files.</p>
<dd><p>Interface for objects that have a source file.</p> <dd><p>Interface for objects that have a source file.</p>
</dd> </dd>
</dl> </dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></dt>
<dd></dd>
</dl>
<dl class="jumplist"> <dl class="jumplist">
<dt><a class="xref" href="Hi.Common.IUpdateByContent.html">IUpdateByContent</a></dt> <dt><a class="xref" href="Hi.Common.IUpdateByContent.html">IUpdateByContent</a></dt>
<dd><p>Interface for objects that can update themselves based on their content.</p> <dd><p>Interface for objects that can update themselves based on their content.</p>

4
App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispEngine.html
View File

@ -183,8 +183,8 @@ Class DispEngine
<div class="markdown level0 remarks"><p>The <code>DispEngine</code> is the core rendering and interaction engine for HiAPI applications.</p> <div class="markdown level0 remarks"><p>The <code>DispEngine</code> is the core rendering and interaction engine for HiAPI applications.</p>
<h2 id="related-documentation">Related Documentation</h2> <h2 id="related-documentation">Related Documentation</h2>
<ul> <ul>
<li><a href="../brief/dev-doc/basic/rendering-canvas/index.md">Using RenderingCanvas with DispEngine</a></li> <li><a href="../dev-doc/basic/rendering/rendering-canvas/index.html">Using RenderingCanvas with DispEngine</a></li>
<li><a href="../brief/dev-doc/basic/rendering-canvas/custom-implementation.md">Building Your Own Rendering Canvas</a></li> <li><a href="../dev-doc/basic/rendering/rendering-canvas/custom-implementation.html">Building Your Own Rendering Canvas</a></li>
</ul> </ul>
<p>The DispEngine provides a unified API for handling rendering, user interaction, and touch gestures across different UI frameworks.</p> <p>The DispEngine provides a unified API for handling rendering, user interaction, and touch gestures across different UI frameworks.</p>
</div> </div>

37
App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box3d.html
View File

@ -104,7 +104,7 @@ The data contains in a <a class="xref" href="Hi.Geom.Box3d.html">Box3d</a> is <a
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Box3d : IExpandToBox3d, IEquatable&lt;Box3d&gt;, IStlSource, IGetStl, IMakeXmlSource, IBinaryIo, IWriteBin, IDuplicate, IFormattable</code></pre> <pre><code class="lang-csharp hljs">public class Box3d : IExpandToBox3d, IEquatable&lt;Box3d&gt;, IStlSource, IGetStl, IMakeXmlSource, IBinaryIo, IWriteBin, IDuplicate, IFormattable, IToPresentDto</code></pre>
</div> </div>
@ -130,6 +130,7 @@ The data contains in a <a class="xref" href="Hi.Geom.Box3d.html">Box3d</a> is <a
<div><a class="xref" href="Hi.Common.IWriteBin.html">IWriteBin</a></div> <div><a class="xref" href="Hi.Common.IWriteBin.html">IWriteBin</a></div>
<div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div> <div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iformattable">IFormattable</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iformattable">IFormattable</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -2210,6 +2211,40 @@ The <a class="xref" href="Hi.Geom.Box3d.html#Hi_Geom_Box3d_Min">Min</a> and <a
<a id="Hi_Geom_Box3d_ToPresentDto_" data-uid="Hi.Geom.Box3d.ToPresentDto*"></a>
<h3 id="Hi_Geom_Box3d_ToPresentDto" data-uid="Hi.Geom.Box3d.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert Box3d to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type, min, max properties</p>
</dd>
</dl>
<a id="Hi_Geom_Box3d_ToString_" data-uid="Hi.Geom.Box3d.ToString*"></a> <a id="Hi_Geom_Box3d_ToString_" data-uid="Hi.Geom.Box3d.ToString*"></a>
<h3 id="Hi_Geom_Box3d_ToString" data-uid="Hi.Geom.Box3d.ToString"> <h3 id="Hi_Geom_Box3d_ToString" data-uid="Hi.Geom.Box3d.ToString">

37
App/wwwroot/HiAPI-docsite/api/Hi.Geom.Cylindroid.html
View File

@ -102,7 +102,7 @@ Class Cylindroid
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Cylindroid : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList, IGenStl</code></pre> <pre><code class="lang-csharp hljs">public class Cylindroid : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList, IGenStl, IToPresentDto</code></pre>
</div> </div>
@ -127,6 +127,7 @@ Class Cylindroid
<div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div> <div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div>
<div><a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a></div> <div><a class="xref" href="Hi.Geom.IGetZrList.html">IGetZrList</a></div>
<div><a class="xref" href="Hi.Geom.IGenStl.html">IGenStl</a></div> <div><a class="xref" href="Hi.Geom.IGenStl.html">IGenStl</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -787,6 +788,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Geom_Cylindroid_ToPresentDto_" data-uid="Hi.Geom.Cylindroid.ToPresentDto*"></a>
<h3 id="Hi_Geom_Cylindroid_ToPresentDto" data-uid="Hi.Geom.Cylindroid.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert Cylindroid to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and zrPairs properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Geom.StlFile.html
View File

@ -102,7 +102,7 @@ Class StlFile
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class StlFile : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IDuplicate, ISourceFile</code></pre> <pre><code class="lang-csharp hljs">public class StlFile : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IDuplicate, ISourceFile, IToPresentDto</code></pre>
</div> </div>
@ -125,6 +125,7 @@ Class StlFile
<div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div> <div><a class="xref" href="Hi.Geom.IExpandToBox3d.html">IExpandToBox3d</a></div>
<div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div> <div><a class="xref" href="Hi.Common.IDuplicate.html">IDuplicate</a></div>
<div><a class="xref" href="Hi.Common.ISourceFile.html">ISourceFile</a></div> <div><a class="xref" href="Hi.Common.ISourceFile.html">ISourceFile</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -673,6 +674,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Geom_StlFile_ToPresentDto_" data-uid="Hi.Geom.StlFile.ToPresentDto*"></a>
<h3 id="Hi_Geom_StlFile_ToPresentDto" data-uid="Hi.Geom.StlFile.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert StlFile to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and sourceFile properties</p>
</dd>
</dl>
</article> </article>

75
App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec3d.html
View File

@ -103,7 +103,7 @@ Class Vec3d
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">[BsonIgnoreExtraElements] <pre><code class="lang-csharp hljs">[BsonIgnoreExtraElements]
public class Vec3d : IEquatable&lt;Vec3d&gt;, IExpandToBox3d, IBinaryIo, IWriteBin, ICsvRowIo, IEqualityOperators&lt;Vec3d, Vec3d, bool&gt;, IAdditionOperators&lt;Vec3d, Vec3d, Vec3d&gt;, ISubtractionOperators&lt;Vec3d, Vec3d, Vec3d&gt;, IMultiplyOperators&lt;Vec3d, double, Vec3d&gt;, IMultiplyOperators&lt;Vec3d, Mat4d, Vec3d&gt;, IDivisionOperators&lt;Vec3d, double, Vec3d&gt;, IVec&lt;double&gt;, IFormattable</code></pre> public class Vec3d : IEquatable&lt;Vec3d&gt;, IExpandToBox3d, IBinaryIo, IWriteBin, ICsvRowIo, IEqualityOperators&lt;Vec3d, Vec3d, bool&gt;, IAdditionOperators&lt;Vec3d, Vec3d, Vec3d&gt;, ISubtractionOperators&lt;Vec3d, Vec3d, Vec3d&gt;, IMultiplyOperators&lt;Vec3d, double, Vec3d&gt;, IMultiplyOperators&lt;Vec3d, Mat4d, Vec3d&gt;, IDivisionOperators&lt;Vec3d, double, Vec3d&gt;, IVec&lt;double&gt;, IFormattable, IToPresentDto</code></pre>
</div> </div>
@ -133,6 +133,7 @@ public class Vec3d : IEquatable&lt;Vec3d&gt;, IExpandToBox3d, IBinaryIo, IWriteB
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.idivisionoperators-3">IDivisionOperators</a>&lt;<a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a>&gt;</div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.idivisionoperators-3">IDivisionOperators</a>&lt;<a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</a>&gt;</div>
<div><a class="xref" href="Hi.Geom.IVec-1.html">IVec</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</div> <div><a class="xref" href="Hi.Geom.IVec-1.html">IVec</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iformattable">IFormattable</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iformattable">IFormattable</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -3775,6 +3776,40 @@ Direction 0,1,2 indicate x,y,z respectively.</p>
<a id="Hi_Geom_Vec3d_ToPresentDto_" data-uid="Hi.Geom.Vec3d.ToPresentDto*"></a>
<h3 id="Hi_Geom_Vec3d_ToPresentDto" data-uid="Hi.Geom.Vec3d.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert Vec3d to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type, x, y, z properties</p>
</dd>
</dl>
<a id="Hi_Geom_Vec3d_ToString_" data-uid="Hi.Geom.Vec3d.ToString*"></a> <a id="Hi_Geom_Vec3d_ToString_" data-uid="Hi.Geom.Vec3d.ToString*"></a>
<h3 id="Hi_Geom_Vec3d_ToString" data-uid="Hi.Geom.Vec3d.ToString"> <h3 id="Hi_Geom_Vec3d_ToString" data-uid="Hi.Geom.Vec3d.ToString">
@ -4010,6 +4045,44 @@ Direction 0,1,2 indicate x,y,z respectively.</p>
<a id="Hi_Geom_Vec3d_TryParseLoose_" data-uid="Hi.Geom.Vec3d.TryParseLoose*"></a>
<h3 id="Hi_Geom_Vec3d_TryParseLoose_System_String_Hi_Geom_Vec3d__" data-uid="Hi.Geom.Vec3d.TryParseLoose(System.String,Hi.Geom.Vec3d@)">
TryParseLoose(string, out Vec3d)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool TryParseLoose(string text, out Vec3d dst)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>dst</code> <a class="xref" href="Hi.Geom.Vec3d.html">Vec3d</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>
<a id="Hi_Geom_Vec3d_WriteBin_" data-uid="Hi.Geom.Vec3d.WriteBin*"></a> <a id="Hi_Geom_Vec3d_WriteBin_" data-uid="Hi.Geom.Vec3d.WriteBin*"></a>
<h3 id="Hi_Geom_Vec3d_WriteBin_System_IO_BinaryWriter_" data-uid="Hi.Geom.Vec3d.WriteBin(System.IO.BinaryWriter)"> <h3 id="Hi_Geom_Vec3d_WriteBin_System_IO_BinaryWriter_" data-uid="Hi.Geom.Vec3d.WriteBin(System.IO.BinaryWriter)">

2
App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RuntimeApi.html
View File

@ -3867,7 +3867,7 @@ public void SetUniformContourTrayShiftAngle_deg(int toolId, double angle_deg)</c
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;TrainMillingPara(Fx|Fy|Fz, $1dstFile)&quot;)] <pre><code class="lang-csharp hljs">[JsAce(&quot;TrainMillingPara(Fx|Fy|Fz, $1dstFile)&quot;)]
public void TrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2, ICuttingPara paraTemplate = null)</code></pre> public void TrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 0.1, ICuttingPara paraTemplate = null)</code></pre>
</div> </div>
<h4 class="section">Parameters</h4> <h4 class="section">Parameters</h4>

37
App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachiningStep.html
View File

@ -3794,43 +3794,6 @@ public double GetCutterDermisTemperature_C(double depth_mm)</code></pre>
<a id="Hi_MachiningSteps_MachiningStep_GetKeyToQuantityNativeDictionary_" data-uid="Hi.MachiningSteps.MachiningStep.GetKeyToQuantityNativeDictionary*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_GetKeyToQuantityNativeDictionary_Hi_Mech_IMachiningChain_" data-uid="Hi.MachiningSteps.MachiningStep.GetKeyToQuantityNativeDictionary(Hi.Mech.IMachiningChain)">
GetKeyToQuantityNativeDictionary(IMachiningChain)
</h3>
<div class="markdown level1 summary"><p>Internal use.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static ConcurrentDictionary&lt;string, PropertyAccess&lt;MachiningStep&gt;&gt; GetKeyToQuantityNativeDictionary(IMachiningChain machiningChain)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>machiningChain</code> <a class="xref" href="Hi.Mech.IMachiningChain.html">IMachiningChain</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.collections.concurrent.concurrentdictionary-2">ConcurrentDictionary</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="Hi.MachiningSteps.PropertyAccess-1.html">PropertyAccess</a>&lt;<a class="xref" href="Hi.MachiningSteps.MachiningStep.html">MachiningStep</a>&gt;&gt;</dt>
<dd></dd>
</dl>
<a id="Hi_MachiningSteps_MachiningStep_GetMcValue_" data-uid="Hi.MachiningSteps.MachiningStep.GetMcValue*"></a> <a id="Hi_MachiningSteps_MachiningStep_GetMcValue_" data-uid="Hi.MachiningSteps.MachiningStep.GetMcValue*"></a>
<h3 id="Hi_MachiningSteps_MachiningStep_GetMcValue_Hi_Mech_IMachiningChain_System_String_" data-uid="Hi.MachiningSteps.MachiningStep.GetMcValue(Hi.Mech.IMachiningChain,System.String)"> <h3 id="Hi_MachiningSteps_MachiningStep_GetMcValue_Hi_Mech_IMachiningChain_System_String_" data-uid="Hi.MachiningSteps.MachiningStep.GetMcValue(Hi.Mech.IMachiningChain,System.String)">

71
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicFreeform.html
View File

@ -102,7 +102,7 @@ Class DynamicFreeform
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DynamicFreeform : IDynamicTransformer, ITransformer, IMakeXmlSource</code></pre> <pre><code class="lang-csharp hljs">public class DynamicFreeform : IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer, IToPresentDto</code></pre>
</div> </div>
@ -122,6 +122,8 @@ Class DynamicFreeform
<div><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></div>
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -361,6 +363,39 @@ Class DynamicFreeform
<a id="Hi_Mech_Topo_DynamicFreeform_GetInverseTransformer_" data-uid="Hi.Mech.Topo.DynamicFreeform.GetInverseTransformer*"></a>
<h3 id="Hi_Mech_Topo_DynamicFreeform_GetInverseTransformer" data-uid="Hi.Mech.Topo.DynamicFreeform.GetInverseTransformer">
GetInverseTransformer()
</h3>
<div class="markdown level1 summary"><p>Gets the inverse transformer of this transformer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ITransformer GetInverseTransformer()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></dt>
<dd><p>The inverse transformer.</p>
</dd>
</dl>
<a id="Hi_Mech_Topo_DynamicFreeform_GetMat_" data-uid="Hi.Mech.Topo.DynamicFreeform.GetMat*"></a> <a id="Hi_Mech_Topo_DynamicFreeform_GetMat_" data-uid="Hi.Mech.Topo.DynamicFreeform.GetMat*"></a>
<h3 id="Hi_Mech_Topo_DynamicFreeform_GetMat" data-uid="Hi.Mech.Topo.DynamicFreeform.GetMat"> <h3 id="Hi_Mech_Topo_DynamicFreeform_GetMat" data-uid="Hi.Mech.Topo.DynamicFreeform.GetMat">
@ -545,6 +580,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_DynamicFreeform_ToPresentDto_" data-uid="Hi.Mech.Topo.DynamicFreeform.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_DynamicFreeform_ToPresentDto" data-uid="Hi.Mech.Topo.DynamicFreeform.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert StaticFreeform to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and matrix properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicRotation.html
View File

@ -102,7 +102,7 @@ Class DynamicRotation
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DynamicRotation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer</code></pre> <pre><code class="lang-csharp hljs">public class DynamicRotation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer, IToPresentDto</code></pre>
</div> </div>
@ -124,6 +124,7 @@ Class DynamicRotation
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -710,6 +711,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_DynamicRotation_ToPresentDto_" data-uid="Hi.Mech.Topo.DynamicRotation.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_DynamicRotation_ToPresentDto" data-uid="Hi.Mech.Topo.DynamicRotation.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert DynamicRotation to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type, axis, angleDeg, and pivot properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicTranslation.html
View File

@ -102,7 +102,7 @@ Class DynamicTranslation
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DynamicTranslation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer</code></pre> <pre><code class="lang-csharp hljs">public class DynamicTranslation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer, IToPresentDto</code></pre>
</div> </div>
@ -124,6 +124,7 @@ Class DynamicTranslation
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -643,6 +644,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_DynamicTranslation_ToPresentDto_" data-uid="Hi.Mech.Topo.DynamicTranslation.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_DynamicTranslation_ToPresentDto" data-uid="Hi.Mech.Topo.DynamicTranslation.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert DynamicTranslation to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type, axis, and step properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.GeneralTransform.html
View File

@ -102,7 +102,7 @@ Class GeneralTransform
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class GeneralTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer</code></pre> <pre><code class="lang-csharp hljs">public class GeneralTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer, IToPresentDto</code></pre>
</div> </div>
@ -123,6 +123,7 @@ Class GeneralTransform
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -638,6 +639,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_GeneralTransform_ToPresentDto_" data-uid="Hi.Mech.Topo.GeneralTransform.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_GeneralTransform_ToPresentDto" data-uid="Hi.Mech.Topo.GeneralTransform.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert GeneralTransform to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type, scale, rotation, and translation properties</p>
</dd>
</dl>
</article> </article>

5
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicRegular.html
View File

@ -102,7 +102,7 @@ Interface IDynamicRegular
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IDynamicRegular : IDynamicTransformer, ITransformer, IMakeXmlSource</code></pre> <pre><code class="lang-csharp hljs">public interface IDynamicRegular : IDynamicTransformer, ITransformer, IMakeXmlSource, IToPresentDto</code></pre>
</div> </div>
@ -126,6 +126,9 @@ Interface IDynamicRegular
<div> <div>
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a> <a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a>
</div> </div>
<div>
<a class="xref" href="Hi.Common.IToPresentDto.html#Hi_Common_IToPresentDto_ToPresentDto">IToPresentDto.ToPresentDto()</a>
</div>
</dd></dl> </dd></dl>
<dl class="typelist extensionMethods"> <dl class="typelist extensionMethods">

5
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicTransformer.html
View File

@ -102,7 +102,7 @@ Interface IDynamicTransformer
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IDynamicTransformer : ITransformer, IMakeXmlSource</code></pre> <pre><code class="lang-csharp hljs">public interface IDynamicTransformer : ITransformer, IMakeXmlSource, IToPresentDto</code></pre>
</div> </div>
@ -126,6 +126,9 @@ Interface IDynamicTransformer
<div> <div>
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a> <a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a>
</div> </div>
<div>
<a class="xref" href="Hi.Common.IToPresentDto.html#Hi_Common_IToPresentDto_ToPresentDto">IToPresentDto.ToPresentDto()</a>
</div>
</dd></dl> </dd></dl>
<dl class="typelist extensionMethods"> <dl class="typelist extensionMethods">

5
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IStaticTransformer.html
View File

@ -102,7 +102,7 @@ Interface IStaticTransformer
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IStaticTransformer : ITransformer, IMakeXmlSource</code></pre> <pre><code class="lang-csharp hljs">public interface IStaticTransformer : ITransformer, IMakeXmlSource, IToPresentDto</code></pre>
</div> </div>
@ -126,6 +126,9 @@ Interface IStaticTransformer
<div> <div>
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a> <a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a>
</div> </div>
<div>
<a class="xref" href="Hi.Common.IToPresentDto.html#Hi_Common_IToPresentDto_ToPresentDto">IToPresentDto.ToPresentDto()</a>
</div>
</dd></dl> </dd></dl>
<dl class="typelist extensionMethods"> <dl class="typelist extensionMethods">

5
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITransformer.html
View File

@ -102,7 +102,7 @@ Interface ITransformer
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface ITransformer : IMakeXmlSource</code></pre> <pre><code class="lang-csharp hljs">public interface ITransformer : IMakeXmlSource, IToPresentDto</code></pre>
</div> </div>
@ -117,6 +117,9 @@ Interface ITransformer
<div> <div>
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a> <a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a>
</div> </div>
<div>
<a class="xref" href="Hi.Common.IToPresentDto.html#Hi_Common_IToPresentDto_ToPresentDto">IToPresentDto.ToPresentDto()</a>
</div>
</dd></dl> </dd></dl>
<dl class="typelist extensionMethods"> <dl class="typelist extensionMethods">

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.NoTransform.html
View File

@ -102,7 +102,7 @@ Class NoTransform
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class NoTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer</code></pre> <pre><code class="lang-csharp hljs">public class NoTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IToPresentDto, IGetInverseTransformer</code></pre>
</div> </div>
@ -122,6 +122,7 @@ Class NoTransform
<div><a class="xref" href="Hi.Mech.Topo.IStaticTransformer.html">IStaticTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IStaticTransformer.html">IStaticTransformer</a></div>
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
</dd> </dd>
</dl> </dl>
@ -470,6 +471,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_NoTransform_ToPresentDto_" data-uid="Hi.Mech.Topo.NoTransform.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_NoTransform_ToPresentDto" data-uid="Hi.Mech.Topo.NoTransform.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and object properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StackTransformer.html
View File

@ -102,7 +102,7 @@ Class StackTransformer
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class StackTransformer : ITransformer, IMakeXmlSource, IDisposable</code></pre> <pre><code class="lang-csharp hljs">public class StackTransformer : ITransformer, IMakeXmlSource, IToPresentDto, IDisposable</code></pre>
</div> </div>
@ -121,6 +121,7 @@ Class StackTransformer
<dd> <dd>
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
</dd> </dd>
</dl> </dl>
@ -733,6 +734,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_StackTransformer_ToPresentDto_" data-uid="Hi.Mech.Topo.StackTransformer.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_StackTransformer_ToPresentDto" data-uid="Hi.Mech.Topo.StackTransformer.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert StackTransformer to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and stack properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticFreeform.html
View File

@ -102,7 +102,7 @@ Class StaticFreeform
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class StaticFreeform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer</code></pre> <pre><code class="lang-csharp hljs">public class StaticFreeform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer, IToPresentDto</code></pre>
</div> </div>
@ -123,6 +123,7 @@ Class StaticFreeform
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -606,6 +607,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_StaticFreeform_ToPresentDto_" data-uid="Hi.Mech.Topo.StaticFreeform.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_StaticFreeform_ToPresentDto" data-uid="Hi.Mech.Topo.StaticFreeform.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert StaticFreeform to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and matrix properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticRotation.html
View File

@ -102,7 +102,7 @@ Class StaticRotation
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class StaticRotation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer</code></pre> <pre><code class="lang-csharp hljs">public class StaticRotation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer, IToPresentDto</code></pre>
</div> </div>
@ -123,6 +123,7 @@ Class StaticRotation
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -670,6 +671,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_StaticRotation_ToPresentDto_" data-uid="Hi.Mech.Topo.StaticRotation.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_StaticRotation_ToPresentDto" data-uid="Hi.Mech.Topo.StaticRotation.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert StaticRotation to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type, axis, angleDeg, and pivot properties</p>
</dd>
</dl>
</article> </article>

37
App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticTranslation.html
View File

@ -102,7 +102,7 @@ Class StaticTranslation
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class StaticTranslation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer</code></pre> <pre><code class="lang-csharp hljs">public class StaticTranslation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer, IToPresentDto</code></pre>
</div> </div>
@ -123,6 +123,7 @@ Class StaticTranslation
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IGetInverseTransformer.html">IGetInverseTransformer</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
</dd> </dd>
</dl> </dl>
@ -604,6 +605,40 @@ Since the folder can be moving with the configuration file.</p>
<a id="Hi_Mech_Topo_StaticTranslation_ToPresentDto_" data-uid="Hi.Mech.Topo.StaticTranslation.ToPresentDto*"></a>
<h3 id="Hi_Mech_Topo_StaticTranslation_ToPresentDto" data-uid="Hi.Mech.Topo.StaticTranslation.ToPresentDto">
ToPresentDto()
</h3>
<div class="markdown level1 summary"><p>Convert StaticTranslation to presentation DTO (Data Transfer Object) for JSON serialization.
The returned object includes type metadata for web API presentation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object ToPresentDto()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>DTO object with type and translation properties</p>
</dd>
</dl>
<a id="Hi_Mech_Topo_StaticTranslation_ToString_" data-uid="Hi.Mech.Topo.StaticTranslation.ToString*"></a> <a id="Hi_Mech_Topo_StaticTranslation_ToString_" data-uid="Hi.Mech.Topo.StaticTranslation.ToString*"></a>
<h3 id="Hi_Mech_Topo_StaticTranslation_ToString" data-uid="Hi.Mech.Topo.StaticTranslation.ToString"> <h3 id="Hi_Mech_Topo_StaticTranslation_ToString" data-uid="Hi.Mech.Topo.StaticTranslation.ToString">

5
App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.INcTransformer.html
View File

@ -102,7 +102,7 @@ Interface INcTransformer
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface INcTransformer : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke</code></pre> <pre><code class="lang-csharp hljs">public interface INcTransformer : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IToPresentDto, INcStroke</code></pre>
</div> </div>
@ -129,6 +129,9 @@ Interface INcTransformer
<div> <div>
<a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a> <a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html#Hi_Common_XmlUtils_IMakeXmlSource_MakeXmlSource_System_String_System_String_System_Boolean_">IMakeXmlSource.MakeXmlSource(string, string, bool)</a>
</div> </div>
<div>
<a class="xref" href="Hi.Common.IToPresentDto.html#Hi_Common_IToPresentDto_ToPresentDto">IToPresentDto.ToPresentDto()</a>
</div>
<div> <div>
<a class="xref" href="Hi.NcMech.Topo.INcStroke.html#Hi_NcMech_Topo_INcStroke_GetKeyCode">INcStroke.GetKeyCode()</a> <a class="xref" href="Hi.NcMech.Topo.INcStroke.html#Hi_NcMech_Topo_INcStroke_GetKeyCode">INcStroke.GetKeyCode()</a>
</div> </div>

6
App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcRotation.html
View File

@ -103,7 +103,7 @@ Provides functionality for rotational motion with stroke and speed limits.</p>
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class NcRotation : DynamicRotation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke</code></pre> <pre><code class="lang-csharp hljs">public class NcRotation : DynamicRotation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IToPresentDto, INcStroke</code></pre>
</div> </div>
@ -127,6 +127,7 @@ Provides functionality for rotational motion with stroke and speed limits.</p>
<div><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></div>
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
<div><a class="xref" href="Hi.NcMech.Topo.INcStroke.html">INcStroke</a></div> <div><a class="xref" href="Hi.NcMech.Topo.INcStroke.html">INcStroke</a></div>
</dd> </dd>
</dl> </dl>
@ -162,6 +163,9 @@ Provides functionality for rotational motion with stroke and speed limits.</p>
<div> <div>
<a class="xref" href="Hi.Mech.Topo.DynamicRotation.html#Hi_Mech_Topo_DynamicRotation_Pivot">DynamicRotation.Pivot</a> <a class="xref" href="Hi.Mech.Topo.DynamicRotation.html#Hi_Mech_Topo_DynamicRotation_Pivot">DynamicRotation.Pivot</a>
</div> </div>
<div>
<a class="xref" href="Hi.Mech.Topo.DynamicRotation.html#Hi_Mech_Topo_DynamicRotation_ToPresentDto">DynamicRotation.ToPresentDto()</a>
</div>
<div> <div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div> </div>

6
App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcTranslation.html
View File

@ -103,7 +103,7 @@ Provides functionality for linear motion with stroke and speed limits.</p>
<div class="markdown conceptual"></div> <div class="markdown conceptual"></div>
<div class="codewrapper"> <div class="codewrapper">
<pre><code class="lang-csharp hljs">public class NcTranslation : DynamicTranslation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke</code></pre> <pre><code class="lang-csharp hljs">public class NcTranslation : DynamicTranslation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IToPresentDto, INcStroke</code></pre>
</div> </div>
@ -127,6 +127,7 @@ Provides functionality for linear motion with stroke and speed limits.</p>
<div><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></div>
<div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div> <div><a class="xref" href="Hi.Mech.Topo.ITransformer.html">ITransformer</a></div>
<div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div> <div><a class="xref" href="Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a></div>
<div><a class="xref" href="Hi.Common.IToPresentDto.html">IToPresentDto</a></div>
<div><a class="xref" href="Hi.NcMech.Topo.INcStroke.html">INcStroke</a></div> <div><a class="xref" href="Hi.NcMech.Topo.INcStroke.html">INcStroke</a></div>
</dd> </dd>
</dl> </dl>
@ -156,6 +157,9 @@ Provides functionality for linear motion with stroke and speed limits.</p>
<div> <div>
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_Len">DynamicTranslation.Len</a> <a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_Len">DynamicTranslation.Len</a>
</div> </div>
<div>
<a class="xref" href="Hi.Mech.Topo.DynamicTranslation.html#Hi_Mech_Topo_DynamicTranslation_ToPresentDto">DynamicTranslation.ToPresentDto()</a>
</div>
<div> <div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div> </div>

3
App/wwwroot/HiAPI-docsite/api/toc.html
View File

@ -285,6 +285,9 @@
<li> <li>
<a href="Hi.Common.ISourceFile.html" name="" title="ISourceFile">ISourceFile</a> <a href="Hi.Common.ISourceFile.html" name="" title="ISourceFile">ISourceFile</a>
</li> </li>
<li>
<a href="Hi.Common.IToPresentDto.html" name="" title="IToPresentDto">IToPresentDto</a>
</li>
<li> <li>
<a href="Hi.Common.IUpdateByContent.html" name="" title="IUpdateByContent">IUpdateByContent</a> <a href="Hi.Common.IUpdateByContent.html" name="" title="IUpdateByContent">IUpdateByContent</a>
</li> </li>

2
App/wwwroot/HiAPI-docsite/api/toc.json
View File

File diff suppressed because one or more lines are too long

177
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/index.html
View File

@ -1,177 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Sketch to Build HiNC GUI | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Sketch to Build HiNC GUI | 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="">
<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="">
<h1 id="sketch-to-build-hinc-gui">Sketch to Build HiNC GUI</h1>
<p>Apply <a href="general-rules.html">General Rules</a> to build the HiNC GUI.</p>
<h2 id="wpf-application-source-code">WPF Application Source Code</h2>
<p>The source code of HiNC-2025-win-desktop project is at the git repository:</p>
<p><a href="https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-win-desktop.git">https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-win-desktop.git</a></p>
<h2 id="web-service-application-source-code">Web Service Application Source Code</h2>
<p>HiNC-2025-webservice apply vue.</p>
<p>The source code of HiNC-2025-webservice project is at the git repository:</p>
<p><a href="https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-webservice.git">https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-webservice.git</a></p>
<h2 id="web-architecture-patterns">Web Architecture Patterns</h2>
<ul>
<li><a href="common/dictionary-service-pattern.html">DictionaryService and DictionaryHub Pattern</a> - Connection-scoped object indexing for hierarchical components</li>
<li><a href="hinc-web-service/disp-web-service.html">Rendering Canvas on Web Service</a> - WebSocket-based 3D canvas rendering architecture using SignalR Hub</li>
</ul>
<h2 id="step-by-step-program-construction-check-list">Step by Step Program Construction Check List</h2>
<div class="TIP">
<h5>Tip</h5>
<p>If you are using AI agent to build the application:</p>
<ul>
<li>Ask AI to do only one job at one time to ensure the quality.</li>
</ul>
</div>
<ol>
<li>Create and config a application project.
<ol>
<li>Set the project platform to x64.</li>
<li>Create a application project.</li>
<li>Add <code>HiNc</code> packages to the project. See <a href="../getting-started/index.html">Getting Started</a> to config the packages.</li>
</ol>
<div class="NOTE">
<h5>Note</h5>
<p>Add <code>Hi.WpfPlus</code> packages to the project if the building WPF project.</p>
</div>
</li>
<li>Create Main Window, set the layout according to <a href="main-panel.html#main-panel-layout">Main Panel Layout</a>.</li>
<li>Build <code>Message Section</code> according to <a href="message-section-on-main-panel.html">Message Section on Main Panel</a>.</li>
<li>Initialize HiAPI at application entry point according to <a href="initialize-hiapi.html">Initialize HiAPI</a>.</li>
<li>Set behavior of <code>Navigation Menu</code>/<code>Project</code> according to <a href="main-panel.html#behavior-of-navigation-menuproject">Behavior of Navigation Menu/Project</a>.</li>
<li>Create <a href="renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a> for later usage.</li>
<li>Create by <code>Player Panel</code> the <a href="player/index.html#step-by-step-program-construction-check-list">Player Panel Step by Step Program Construction Check List</a>.</li>
<li>Build behavior of <a href="preference/graphic-cache-dropdown.html">Graphic-Cache Dropdown</a>.</li>
<li>Build basic GUI widget component:
<ul>
<li><a href="widget/vec3d/index.html">Vec3dControl</a></li>
</ul>
</li>
<li>Build <a href="mech/topo/transformers.html">Transformers</a></li>
<li>Build <a href="geom/index.html">Geometry Panels</a>.</li>
<li>Build <a href="mech/fixture-page.html">Fixture Page</a>.</li>
<li>Build <a href="mech/workpiece-page.html">Workpiece Page</a>.</li>
<li>Build <a href="controller/index.html">Controller Page</a>.</li>
<li>Build <a href="mech/tool-house-page.html">ToolHouse Page</a>.</li>
<li>Add application icon, splash screen and etc..</li>
<li>(The content is consturcting..)</li>
</ol>
<div class="TIP">
<h5>Tip</h5>
<ul>
<li>Complete the check list step by step.</li>
<li>Compile to ensure the code work on each step completed.</li>
<li>You MUST read the cited hyperlink before you do the job. ASK if you think the hyperlink is not work.</li>
</ul>
</div>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></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>

174
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/index.html
View File

@ -1,174 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Player Panel | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Player Panel | 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="">
<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="">
<h1 id="player-panel">Player Panel</h1>
<p>The model of the player panel is <a class="xref" href="../../../../api/Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> and <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html">UserService</a>.</p>
<h2 id="step-by-step-program-construction-check-list">Step by Step Program Construction Check List</h2>
<ol>
<li>Create the <code>Player Panel</code> Layout and set <code>Player Panel</code>/<code>RenderingCanvas</code>.</li>
<li>Set behavior of RenderingCanvas.</li>
<li>Create <a href="player-tool-bar.html">Player Tool Bar</a>.</li>
<li>Create layout of <a href="player-extended-renderingcanvas-tool-bar.html">Player extended RenderingCanvas Tool Bar</a>.</li>
<li>Complete Behavior of <code>Navigation Menu</code>/<code>Player</code> on the <a href="../main-panel.html">Main Panel</a>.</li>
<li>Build behavior of <code>Player extended RenderingCanvas Tool Bar</code>
<ol>
<li>Set behavior of <a href="player-extended-renderingcanvas-tool-bar.html#behavior-of-cl-strip-buttons-and-fit-view-button">Behavior of CL Strip Buttons and Fit View Button</a>.</li>
<li>Set behavior of <a href="player-extended-renderingcanvas-tool-bar.html#behavior-of-project-rendering-items-dropdown">Behavior of Project Rendering Items DropDown</a>.</li>
<li>Set notification to <code>Player extended RenderingCanvas Tool Bar</code> if project changed by <a href="../main-panel.html">Main Panel</a>.</li>
</ol>
</li>
<li>Set Player Panel as default panel on <code>Page Panel</code> when open the main window. The related toolbar has to be set, too.</li>
<li>Build <a href="../session-message-panel/index.html">Session Message Panel</a>.</li>
<li>Build <a href="../preference/step-present-preference-page.html">Step Present Preference Page</a></li>
<li>Build <a href="selected-step-info-panel.html">Selected-Step Info Panel</a></li>
</ol>
<h2 id="belonged-tool-bars">Belonged Tool Bars</h2>
<ul>
<li><a href="player-tool-bar.html">Player Tool Bar</a></li>
<li><a href="../renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a></li>
<li><a href="player-extended-renderingcanvas-tool-bar.html">Player extended RenderingCanvas Tool Bar</a></li>
</ul>
<h2 id="layout-of-player-panel">Layout of <code>Player Panel</code></h2>
<ul>
<li>Central <a href="../../basic/rendering/rendering-canvas/index.html">RenderingCanvas</a></li>
<li>vertical splition bar (draggable to resize the width of the two div)</li>
<li>Side Panel
<ul>
<li>Upper <a href="selected-step-info-panel.html">Selected-Step Info Panel</a></li>
<li>horizontal splition bar (draggable to resize the height of the two panel)</li>
<li>Lower <a href="../session-message-panel/index.html">Session Message Panel</a></li>
</ul>
</li>
</ul>
<h2 id="behavior-of-player-panelrenderingcanvas">Behavior of <code>Player Panel</code>/<code>RenderingCanvas</code></h2>
<p>On initializing, create <a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> and set it to <code>RenderingCanvas</code>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a>. The <a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> constructor argument is from the model <a class="xref" href="../../../../api/Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> from <code>Player Panel</code>.</p>
<p>Dispose RenderingCanvas on <code>Player Panel</code> disposing.</p>
<h2 id="source-code-path-and-specification">Source Code Path and Specification</h2>
<p>See <a href="../index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>
<ul>
<li>Play/PlayerPanel</li>
</ul>
<h3 id="webapi-application-source-code-path">Webapi Application Source Code Path</h3>
<ul>
<li>wwwroot/player/player-panel.js</li>
<li>wwwroot/player/player-panel.html</li>
<li>Players/PlayerController.cs</li>
<li>Players/PlayerStatusHub.cs</li>
<li>Players/PlayerStatusService.cs</li>
<li>Players/SessionMessageHub.cs</li>
<li>Players/SessionMessageService.cs</li>
<li>Players/SelectedStepInfoHub.cs</li>
<li>Players/SelectedStepInfoService.cs</li>
</ul>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></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>

2
App/wwwroot/HiAPI-docsite/brief/dev-doc/toc.json
View File

File diff suppressed because one or more lines are too long

125
App/wwwroot/HiAPI-docsite/brief/index.html
View File

@ -1,125 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>HiNC Documentation | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="HiNC Documentation | 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="">
<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="content">
<div class="actionbar">
<nav id="breadcrumb"></nav>
</div>
<article data-uid="">
<h1 id="hinc-documentation">HiNC Documentation</h1>
<p>Welcome to the HiNC documentation website. This site contains documentation for both the HiNC software and its development API.</p>
<h2 id="documentation-sections">Documentation Sections</h2>
<h3 id="1-user-guide">1. User Guide</h3>
<p>Complete documentation for using the HiNC software, including installation, features, and troubleshooting.</p>
<ul>
<li><a href="user-guide/index.html">User Guide</a></li>
</ul>
<h3 id="2-developer-documentation">2. Developer Documentation</h3>
<p>Technical documentation for the HiNC API, including reference, requirements, and integration guides.</p>
<ul>
<li><a href="dev-doc/index.html">Developer Documentation</a></li>
</ul>
<p>The sample code using HiNC API:</p>
<ul>
<li><a href="sample/Sample.Machining.html">Sample Code</a></li>
</ul>
<p>HiNC API specification:</p>
<ul>
<li><a href="../api/Hi.Machining.html">API Reference</a></li>
</ul>
<h2 id="ai-collaboration">AI Collaboration</h2>
<p>Let AI agent scan HiAPI Doc (Brief) Web Root: <a href="index.html">https://superhightech.com.tw/HiAPI-docsite/brief/</a> to get help.</p>
<p>The brief web root does not contains the <a href="../api/toc.html">API Reference</a>. Since the API Reference contains too many pages. It is not recommand to send it to AI agent if the AI capability is not enough.</p>
<p>HiNC / HiAPI does not provide LLM. You should use the 3rd party AI agent to apply the document.</p>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></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>

32
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/common/xml-io.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/common/xml-io.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="About XML IO | HiAPI-C# 2025 "> <meta name="title" content="About XML IO | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,11 +87,11 @@
<article data-uid=""> <article data-uid="">
<h1 id="about-xml-io">About XML IO</h1> <h1 id="about-xml-io">About XML IO</h1>
<p>The XML IO design pattern in HiNc Framework is based on <a class="xref" href="../../../../api/Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a> interface and <a class="xref" href="../../../../api/Hi.Common.XmlUtils.XFactory.html">XFactory</a> class. This pattern provides a standardized way to serialize and deserialize objects to and from XML format.</p> <p>The XML IO design pattern in HiNc Framework is based on <a class="xref" href="../../../api/Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a> interface and <a class="xref" href="../../../api/Hi.Common.XmlUtils.XFactory.html">XFactory</a> class. This pattern provides a standardized way to serialize and deserialize objects to and from XML format.</p>
<p>Don't serialize the runtime member object like <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func&lt;TResult&gt;</a> or <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a> either cache object. The runtime objects can be optionally sent by the res part on the XFactory Registration or set by the other host or dependent object. If it is set by the other object, then there is nothing can do to it in the XML IO procedure.</p> <p>Don't serialize the runtime member object like <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func&lt;TResult&gt;</a> or <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a> either cache object. The runtime objects can be optionally sent by the res part on the XFactory Registration or set by the other host or dependent object. If it is set by the other object, then there is nothing can do to it in the XML IO procedure.</p>
<h2 id="core-components">Core Components</h2> <h2 id="core-components">Core Components</h2>
<h3 id="imakexmlsource-interface">IMakeXmlSource Interface</h3> <h3 id="imakexmlsource-interface">IMakeXmlSource Interface</h3>
<p>The <a class="xref" href="../../../../api/Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a> interface defines the contract for objects that can be serialized to XML format. It contains a single method <code>MakeXmlSource</code>.</p> <p>The <a class="xref" href="../../../api/Hi.Common.XmlUtils.IMakeXmlSource.html">IMakeXmlSource</a> interface defines the contract for objects that can be serialized to XML format. It contains a single method <code>MakeXmlSource</code>.</p>
<h3 id="xfactory-registration">XFactory Registration</h3> <h3 id="xfactory-registration">XFactory Registration</h3>
<p>Every class implementing IMakeXmlSource must:</p> <p>Every class implementing IMakeXmlSource must:</p>
<ol> <ol>
@ -99,7 +99,7 @@
<li>Register itself in the static constructor using XFactory.Regs.Add</li> <li>Register itself in the static constructor using XFactory.Regs.Add</li>
<li>Implement XML serialization and deserialization logic</li> <li>Implement XML serialization and deserialization logic</li>
</ol> </ol>
<p>For example, see <a class="xref" href="../../../../api/Hi.Milling.Apts.BallApt.html">BallApt</a>:</p> <p>For example, see <a class="xref" href="../../../api/Hi.Milling.Apts.BallApt.html">BallApt</a>:</p>
<pre><code class="lang-csharp" name="XmlRegistration">static BallApt() <pre><code class="lang-csharp" name="XmlRegistration">static BallApt()
{ {
// Register to the &lt;see cref=&quot;XFactory.Default&quot;/&gt;. // Register to the &lt;see cref=&quot;XFactory.Default&quot;/&gt;.
@ -107,7 +107,7 @@
} }
</code></pre><h2 id="implementation-patterns">Implementation Patterns</h2> </code></pre><h2 id="implementation-patterns">Implementation Patterns</h2>
<h3 id="simple-value-objects">Simple Value Objects</h3> <h3 id="simple-value-objects">Simple Value Objects</h3>
<p>See <a class="xref" href="../../../../api/Hi.Milling.Apts.BallApt.html">BallApt</a> implementation:</p> <p>See <a class="xref" href="../../../api/Hi.Milling.Apts.BallApt.html">BallApt</a> implementation:</p>
<pre><code class="lang-csharp" name="XmlImplementation">/// &lt;summary&gt; <pre><code class="lang-csharp" name="XmlImplementation">/// &lt;summary&gt;
/// Name for XML IO. /// Name for XML IO.
/// &lt;/summary&gt; /// &lt;/summary&gt;
@ -133,7 +133,7 @@ public XElement ToXElement()
); );
} }
</code></pre><h3 id="complex-data-structures">Complex Data Structures</h3> </code></pre><h3 id="complex-data-structures">Complex Data Structures</h3>
<p>See <a class="xref" href="../../../../api/Hi.Milling.SpindleCapability.html">SpindleCapability</a> implementation:</p> <p>See <a class="xref" href="../../../api/Hi.Milling.SpindleCapability.html">SpindleCapability</a> implementation:</p>
<pre><code class="lang-csharp" name="XmlImplementation">/// &lt;summary&gt; <pre><code class="lang-csharp" name="XmlImplementation">/// &lt;summary&gt;
/// Name for XML IO. /// Name for XML IO.
/// &lt;/summary&gt; /// &lt;/summary&gt;
@ -272,9 +272,9 @@ public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibit
</code></pre><h2 id="best-practices">Best Practices</h2> </code></pre><h2 id="best-practices">Best Practices</h2>
<ol> <ol>
<li><strong>XName</strong>: Always define static XName property matching the class name.</li> <li><strong>XName</strong>: Always define static XName property matching the class name.</li>
<li><strong>Registration</strong>: Register in static constructor using <a class="xref" href="../../../../api/Hi.Common.XmlUtils.XFactory.html">XFactory</a>.Regs</li> <li><strong>Registration</strong>: Register in static constructor using <a class="xref" href="../../../api/Hi.Common.XmlUtils.XFactory.html">XFactory</a>.Regs</li>
<li>Call the XName such like <code>_ = CalleeClass.XName;</code> in the caller class static initailization field so that the registration takes effect before calling the Callee construction by <a class="xref" href="../../../../api/Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</li> <li>Call the XName such like <code>_ = CalleeClass.XName;</code> in the caller class static initailization field so that the registration takes effect before calling the Callee construction by <a class="xref" href="../../../api/Hi.Common.XmlUtils.XFactory.html">XFactory</a>.</li>
<li><strong>Error Handling</strong>: Use appropriate <a class="xref" href="../../../../api/Hi.Common.XmlUtils.GenMode.html">GenMode</a></li> <li><strong>Error Handling</strong>: Use appropriate <a class="xref" href="../../../api/Hi.Common.XmlUtils.GenMode.html">GenMode</a></li>
<li><strong>Legacy Support</strong>: Maintain backward compatibility when needed</li> <li><strong>Legacy Support</strong>: Maintain backward compatibility when needed</li>
</ol> </ol>

38
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/geom/basic-geometry.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/geom/basic-geometry.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Geometry Objects | HiAPI-C# 2025 "> <meta name="title" content="Geometry Objects | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,29 +87,29 @@
<article data-uid=""> <article data-uid="">
<h1 id="geometry-objects">Geometry Objects</h1> <h1 id="geometry-objects">Geometry Objects</h1>
<p><strong><a class="xref" href="../../../../api/Hi.Geom.IGetStl.html">IGetStl</a></strong> is the base interface for all geometry objects in HiAPI, providing unified STL support.</p> <p><strong><a class="xref" href="../../../api/Hi.Geom.IGetStl.html">IGetStl</a></strong> is the base interface for all geometry objects in HiAPI, providing unified STL support.</p>
<p>Several common geometry types are available:</p> <p>Several common geometry types are available:</p>
<ul> <ul>
<li>Basic Geometrys <li>Basic Geometrys
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Geom.Box3d.html">Box3d</a></li> <li><a class="xref" href="../../../api/Hi.Geom.Box3d.html">Box3d</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.Cylindroid.html">Cylindroid</a></li> <li><a class="xref" href="../../../api/Hi.Geom.Cylindroid.html">Cylindroid</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.Stl.html">Stl</a></li> <li><a class="xref" href="../../../api/Hi.Geom.Stl.html">Stl</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.StlFile.html">StlFile</a></li> <li><a class="xref" href="../../../api/Hi.Geom.StlFile.html">StlFile</a></li>
</ul> </ul>
</li> </li>
<li>Management Geometrys <li>Management Geometrys
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a></li> <li><a class="xref" href="../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a></li> <li><a class="xref" href="../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
<p>See <a href="../mechanism/transformers/index.html">Transformations</a> for <a class="xref" href="../../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a>.</p> <p>See <a href="../mechanism/transformers/index.html">Transformations</a> for <a class="xref" href="../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a>.</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Mech.Topo.GeneralTransform.html">GeneralTransform</a></li> <li><a class="xref" href="../../../api/Hi.Mech.Topo.GeneralTransform.html">GeneralTransform</a></li>
<li><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a></li> <li><a class="xref" href="../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a></li>
<li><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a></li> <li><a class="xref" href="../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a></li>
</ul> </ul>
<div class="NOTE"> <div class="NOTE">
<h5>Note</h5> <h5>Note</h5>

0
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/chain.png → App/wwwroot/HiAPI-docsite/dev-doc/basic/mechanism/Topo/chain.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

0
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/chainLink.png → App/wwwroot/HiAPI-docsite/dev-doc/basic/mechanism/Topo/chainLink.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

28
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/index.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/mechanism/Topo/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Kinematic Topology | HiAPI-C# 2025 "> <meta name="title" content="Kinematic Topology | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,14 +87,14 @@
<article data-uid="Usage.HiMech.Topo"> <article data-uid="Usage.HiMech.Topo">
<h1 id="kinematic-topology">Kinematic Topology</h1> <h1 id="kinematic-topology">Kinematic Topology</h1>
<p>The Kinematic Topology is composed of three elemental classes: <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a></strong>, <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.Branch.html">Branch</a></strong> and <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a></strong>.</p> <p>The Kinematic Topology is composed of three elemental classes: <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a></strong>, <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.Branch.html">Branch</a></strong> and <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a></strong>.</p>
<h2 id="basic-elements">Basic Elements</h2> <h2 id="basic-elements">Basic Elements</h2>
<h3 id="anchors-and-branches">Anchors and Branches</h3> <h3 id="anchors-and-branches">Anchors and Branches</h3>
<p><strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a></strong> object contains a cartesian coordinate. It can be a mechanical component or a flag.</p> <p><strong><a class="xref" href="../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a></strong> object contains a cartesian coordinate. It can be a mechanical component or a flag.</p>
<p><strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.Branch.html">Branch</a></strong> object is a directional link between two <a class="xref" href="../../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a> objects. It contains the <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a></strong> object. The <a class="xref" href="../../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a> object contains a coordinate <strong>transformation matrix</strong>. As shown in the following sketch:</p> <p><strong><a class="xref" href="../../../../api/Hi.Mech.Topo.Branch.html">Branch</a></strong> object is a directional link between two <a class="xref" href="../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a> objects. It contains the <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a></strong> object. The <a class="xref" href="../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a> object contains a coordinate <strong>transformation matrix</strong>. As shown in the following sketch:</p>
<p><img src="chainLink.png" alt="Chain Structure"></p> <p><img src="chainLink.png" alt="Chain Structure"></p>
<h3 id="assembly-management">Assembly Management</h3> <h3 id="assembly-management">Assembly Management</h3>
<p><strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a></strong> (Assembly) provides organization and management of Anchors. An Assembly can contain both Anchors and other Assemblies. Key features include:</p> <p><strong><a class="xref" href="../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a></strong> (Assembly) provides organization and management of Anchors. An Assembly can contain both Anchors and other Assemblies. Key features include:</p>
<ul> <ul>
<li>Grouping related Anchors together</li> <li>Grouping related Anchors together</li>
<li>Managing coordinate transformations</li> <li>Managing coordinate transformations</li>
@ -104,7 +104,7 @@
<h2 id="kinematic-chain-example">Kinematic Chain Example</h2> <h2 id="kinematic-chain-example">Kinematic Chain Example</h2>
<p>The following figure shows a kinematic chain of a non-orthogonal 5-axis machine tool:</p> <p>The following figure shows a kinematic chain of a non-orthogonal 5-axis machine tool:</p>
<p><img src="vmt.png" alt="VMT Structure"></p> <p><img src="vmt.png" alt="VMT Structure"></p>
<p>Each <a class="xref" href="../../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a> represents a component:</p> <p>Each <a class="xref" href="../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a> represents a component:</p>
<ul> <ul>
<li>Axis components: X, Y, Z, B, C</li> <li>Axis components: X, Y, Z, B, C</li>
<li>Base components: O (base1), O* (base2)</li> <li>Base components: O (base1), O* (base2)</li>
@ -116,7 +116,7 @@
\[ \[
M_{WT} = M_{CW}^{-1} \cdot M_{YC}^{-1} \cdot M_{OY}^{-1} \cdot M_{OO^*} \cdot M_{O^*X} \cdot M_{XZ} \cdot M_{ZB} \cdot M_{BS} \cdot M_{ST} M_{WT} = M_{CW}^{-1} \cdot M_{YC}^{-1} \cdot M_{OY}^{-1} \cdot M_{OO^*} \cdot M_{O^*X} \cdot M_{XZ} \cdot M_{ZB} \cdot M_{BS} \cdot M_{ST}
\]</div> \]</div>
<p>This matrix can be obtained using <a class="xref" href="../../../../../api/Hi.Mech.Topo.Asmb.html#Hi_Mech_Topo_Asmb_GetMat4d_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_">GetMat4d(IGetAnchor, IGetAnchor)</a>.</p> <p>This matrix can be obtained using <a class="xref" href="../../../../api/Hi.Mech.Topo.Asmb.html#Hi_Mech_Topo_Asmb_GetMat4d_Hi_Mech_Topo_IGetAnchor_Hi_Mech_Topo_IGetAnchor_">GetMat4d(IGetAnchor, IGetAnchor)</a>.</p>
</article> </article>

0
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/vmt.png → App/wwwroot/HiAPI-docsite/dev-doc/basic/mechanism/Topo/vmt.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 90 KiB

22
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/index.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/mechanism/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="HiAPI Mechanics Overview | HiAPI-C# 2025 "> <meta name="title" content="HiAPI Mechanics Overview | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -105,9 +105,9 @@
</ul> </ul>
<h2 id="api-references">API References</h2> <h2 id="api-references">API References</h2>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Mech.Topo.html">Hi.Mech.Topo</a> - Core topology functionality</li> <li><a class="xref" href="../../../api/Hi.Mech.Topo.html">Hi.Mech.Topo</a> - Core topology functionality</li>
<li><a class="xref" href="../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a> - Assembly-related functionality</li> <li><a class="xref" href="../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a> - Assembly-related functionality</li>
<li><a class="xref" href="../../../../api/Hi.Mech.Topo.Branch.html">Branch</a> - Chain-related functionality</li> <li><a class="xref" href="../../../api/Hi.Mech.Topo.Branch.html">Branch</a> - Chain-related functionality</li>
</ul> </ul>
<h2 id="examples">Examples</h2> <h2 id="examples">Examples</h2>
<p>Please refer to the examples in each sub-section to learn how to use these features to build your applications.</p> <p>Please refer to the examples in each sub-section to learn how to use these features to build your applications.</p>

24
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/render-topology/index.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/mechanism/render-topology/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Render Topology | HiAPI-C# 2025 "> <meta name="title" content="Render Topology | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -88,7 +88,7 @@
<h1 id="render-topology">Render Topology</h1> <h1 id="render-topology">Render Topology</h1>
<p>Read <a href="../Topo/index.html">Kinematic Topology</a> <a href="../../rendering/index.html">Rendering</a> for the prerequisite.</p> <p>Read <a href="../Topo/index.html">Kinematic Topology</a> <a href="../../rendering/index.html">Rendering</a> for the prerequisite.</p>
<p>A <a class="xref" href="../../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a> is a group to render its descendent <a class="xref" href="../../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a>s.</p> <p>A <a class="xref" href="../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a> is a group to render its descendent <a class="xref" href="../../../../api/Hi.Mech.Topo.Anchor.html">Anchor</a>s.</p>
<p>Several ways to render with the topology:</p> <p>Several ways to render with the topology:</p>
<ul> <ul>
<li>Render by Anchoring Matrix Map</li> <li>Render by Anchoring Matrix Map</li>
@ -96,10 +96,10 @@
</ul> </ul>
<h2 id="render-by-anchoring-matrix-map">Render by Anchoring Matrix Map</h2> <h2 id="render-by-anchoring-matrix-map">Render by Anchoring Matrix Map</h2>
<h2 id="render-by-anchored-displayee">Render by Anchored Displayee</h2> <h2 id="render-by-anchored-displayee">Render by Anchored Displayee</h2>
<p>Inherit <a class="xref" href="../../../../../api/Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a> or apply <a class="xref" href="../../../../../api/Hi.Mech.Topo.AnchoredDisplayee.html">AnchoredDisplayee</a> to <a class="xref" href="../../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a>.Display().</p> <p>Inherit <a class="xref" href="../../../../api/Hi.Mech.Topo.IAnchoredDisplayee.html">IAnchoredDisplayee</a> or apply <a class="xref" href="../../../../api/Hi.Mech.Topo.AnchoredDisplayee.html">AnchoredDisplayee</a> to <a class="xref" href="../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a>.Display().</p>
<p>Inherit <a class="xref" href="../../../../../api/Hi.Mech.Topo.ITopoDisplayee.html">ITopoDisplayee</a> to manage the object with <a class="xref" href="../../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a> and plural anchors .</p> <p>Inherit <a class="xref" href="../../../../api/Hi.Mech.Topo.ITopoDisplayee.html">ITopoDisplayee</a> to manage the object with <a class="xref" href="../../../../api/Hi.Mech.Topo.Asmb.html">Asmb</a> and plural anchors .</p>
<p>The base logic is also by the anchoring matrix. Here is some class and function wrapping the logic.</p> <p>The base logic is also by the anchoring matrix. Here is some class and function wrapping the logic.</p>
<p>The sample code shows the topology rendering for a <a class="xref" href="../../../../../api/Hi.Milling.MillingTools.MillingTool.html">MillingTool</a> editing helper:</p> <p>The sample code shows the topology rendering for a <a class="xref" href="../../../../api/Hi.Milling.MillingTools.MillingTool.html">MillingTool</a> editing helper:</p>
<pre><code class="lang-csharp" name="MillingToolEditorDisplayee">using Hi.Common; <pre><code class="lang-csharp" name="MillingToolEditorDisplayee">using Hi.Common;
using Hi.Common.Messages; using Hi.Common.Messages;
using Hi.Disp; using Hi.Disp;

56
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/transformers/index.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/mechanism/transformers/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Handle Transform Matrix by ITransformer | HiAPI-C# 2025 "> <meta name="title" content="Handle Transform Matrix by ITransformer | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,32 +87,32 @@
<article data-uid="HiMech.Tutor.transformers"> <article data-uid="HiMech.Tutor.transformers">
<h1 id="handle-transform-matrix-by-itransformer">Handle Transform Matrix by ITransformer</h1> <h1 id="handle-transform-matrix-by-itransformer">Handle Transform Matrix by ITransformer</h1>
<p><strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a></strong> contains a transform matrix and a inverse transform matrix. The matrix is 4x4 column-major matrix, which describe the orientation or movement between 3D coordinates.</p> <p><strong><a class="xref" href="../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a></strong> contains a transform matrix and a inverse transform matrix. The matrix is 4x4 column-major matrix, which describe the orientation or movement between 3D coordinates.</p>
<p>Several common used interface and class are implemented from <a class="xref" href="../../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a>. The inheritance is shown:</p> <p>Several common used interface and class are implemented from <a class="xref" href="../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a>. The inheritance is shown:</p>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.IStaticTransformer.html">IStaticTransformer</a> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.IStaticTransformer.html">IStaticTransformer</a>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.NoTransform.html">NoTransform</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.NoTransform.html">NoTransform</a></li>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a></li>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a></li>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticFreeform.html">StaticFreeform</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticFreeform.html">StaticFreeform</a></li>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.GeneralTransform.html">GeneralTransform</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.GeneralTransform.html">GeneralTransform</a></li>
</ul> </ul>
</li> </li>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.DynamicTranslation.html">DynamicTranslation</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.DynamicTranslation.html">DynamicTranslation</a></li>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.DynamicRotation.html">DynamicRotation</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.DynamicRotation.html">DynamicRotation</a></li>
</ul> </ul>
</li> </li>
<li><a class="xref" href="../../../../../api/Hi.Mech.Topo.DynamicFreeform.html">DynamicFreeform</a></li> <li><a class="xref" href="../../../../api/Hi.Mech.Topo.DynamicFreeform.html">DynamicFreeform</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
<p><strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.IStaticTransformer.html">IStaticTransformer</a></strong> is transformer with constant matrix. <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.NoTransform.html">NoTransform</a></strong>, <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a></strong> and <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a></strong> contains transform matrix of identity, translate and rotate respectively. <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticFreeform.html">StaticFreeform</a></strong> contains a arbitrary constant transform matrix.</p> <p><strong><a class="xref" href="../../../../api/Hi.Mech.Topo.IStaticTransformer.html">IStaticTransformer</a></strong> is transformer with constant matrix. <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.NoTransform.html">NoTransform</a></strong>, <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a></strong> and <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a></strong> contains transform matrix of identity, translate and rotate respectively. <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.StaticFreeform.html">StaticFreeform</a></strong> contains a arbitrary constant transform matrix.</p>
<p>The transform matrix of <a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a> is:</p> <p>The transform matrix of <a class="xref" href="../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a> is:</p>
<div class="math"> <div class="math">
\[ \[
M_{StaticTranslate}= M_{StaticTranslate}=
@ -123,7 +123,7 @@ M_{StaticTranslate}=
Trans.x &amp; Trans.y &amp; Trans.z &amp; 1 Trans.x &amp; Trans.y &amp; Trans.z &amp; 1
\end{bmatrix} \end{bmatrix}
\]</div> \]</div>
<p>The transform matrix of <a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a> and <a class="xref" href="../../../../../api/Hi.Mech.Topo.DynamicRotation.html">DynamicRotation</a> is:</p> <p>The transform matrix of <a class="xref" href="../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a> and <a class="xref" href="../../../../api/Hi.Mech.Topo.DynamicRotation.html">DynamicRotation</a> is:</p>
<div class="math"> <div class="math">
\[ \[
M_{Rotate}= M_{Rotate}=
@ -150,13 +150,13 @@ Rot_{20}(axis,rad) &amp; Rot_{21}(axis,rad) &amp; Rot_{22}(axis,rad) &amp; 0 \\\
Pivot.x &amp; Pivot.y &amp; Pivot.z &amp; 1 Pivot.x &amp; Pivot.y &amp; Pivot.z &amp; 1
\end{bmatrix} \end{bmatrix}
\]</div> \]</div>
<p>Where <a class="xref" href="../../../../../api/Hi.Mech.Topo.DynamicRotation.html#Hi_Mech_Topo_DynamicRotation_Pivot">Pivot</a> is the position of the rotation axis.</p> <p>Where <a class="xref" href="../../../../api/Hi.Mech.Topo.DynamicRotation.html#Hi_Mech_Topo_DynamicRotation_Pivot">Pivot</a> is the position of the rotation axis.</p>
<div class="TIP"> <div class="TIP">
<h5>Tip</h5> <h5>Tip</h5>
<p>Pivot is a point. However, rotation axis is a line. It means that it causes the same matrix no matter how the pivot is moving along the axis.</p> <p>Pivot is a point. However, rotation axis is a line. It means that it causes the same matrix no matter how the pivot is moving along the axis.</p>
</div> </div>
<p><strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></strong> is transformer with inconstant transform matrix. <strong><a class="xref" href="../../../../../api/Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a></strong> has a property <a class="xref" href="../../../../../api/Hi.Mech.Topo.IDynamicRegular.html#Hi_Mech_Topo_IDynamicRegular_Step">Step</a>, implied that the transform matrix is one parameter driven. <a class="xref" href="../../../../../api/Hi.Mech.Topo.TransformerUtil.html#Hi_Mech_Topo_TransformerUtil_GetSteps_Hi_Mech_Topo_IDynamicRegular___">GetSteps(IDynamicRegular[])</a> and <a class="xref" href="../../../../../api/Hi.Mech.Topo.TransformerUtil.html#Hi_Mech_Topo_TransformerUtil_SetSteps_Hi_Mech_Topo_IDynamicRegular___System_Double___">SetSteps(IDynamicRegular[], double[])</a> provide easy handle of an array of <a class="xref" href="../../../../../api/Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a> objects.</p> <p><strong><a class="xref" href="../../../../api/Hi.Mech.Topo.IDynamicTransformer.html">IDynamicTransformer</a></strong> is transformer with inconstant transform matrix. <strong><a class="xref" href="../../../../api/Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a></strong> has a property <a class="xref" href="../../../../api/Hi.Mech.Topo.IDynamicRegular.html#Hi_Mech_Topo_IDynamicRegular_Step">Step</a>, implied that the transform matrix is one parameter driven. <a class="xref" href="../../../../api/Hi.Mech.Topo.TransformerUtil.html#Hi_Mech_Topo_TransformerUtil_GetSteps_Hi_Mech_Topo_IDynamicRegular___">GetSteps(IDynamicRegular[])</a> and <a class="xref" href="../../../../api/Hi.Mech.Topo.TransformerUtil.html#Hi_Mech_Topo_TransformerUtil_SetSteps_Hi_Mech_Topo_IDynamicRegular___System_Double___">SetSteps(IDynamicRegular[], double[])</a> provide easy handle of an array of <a class="xref" href="../../../../api/Hi.Mech.Topo.IDynamicRegular.html">IDynamicRegular</a> objects.</p>
<p>The transform matrix of <a class="xref" href="../../../../../api/Hi.Mech.Topo.DynamicTranslation.html">DynamicTranslation</a> is:</p> <p>The transform matrix of <a class="xref" href="../../../../api/Hi.Mech.Topo.DynamicTranslation.html">DynamicTranslation</a> is:</p>
<div class="math"> <div class="math">
\[ \[
M_{DynamicTranslate}= M_{DynamicTranslate}=
@ -169,7 +169,7 @@ Trans.x \cdot Step &amp; Trans.y \cdot Step &amp; Trans.z \cdot Step &amp; 1
\]</div> \]</div>
<div class="NOTE"> <div class="NOTE">
<h5>Note</h5> <h5>Note</h5>
<p>In convention, <a class="xref" href="../../../../../api/Hi.Mech.Topo.StaticTranslation.html#Hi_Mech_Topo_StaticTranslation_Trans">Trans</a> should be normalized.</p> <p>In convention, <a class="xref" href="../../../../api/Hi.Mech.Topo.StaticTranslation.html#Hi_Mech_Topo_StaticTranslation_Trans">Trans</a> should be normalized.</p>
</div> </div>
</article> </article>

0
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/drawing/easydraw_lines.png → App/wwwroot/HiAPI-docsite/dev-doc/basic/rendering/drawing/easydraw_lines.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.2 KiB

After

Width:  |  Height:  |  Size: 8.2 KiB

40
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/drawing/index.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/rendering/drawing/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Using Hi.Disp.Drawing | HiAPI-C# 2025 "> <meta name="title" content="Using Hi.Disp.Drawing | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,12 +87,12 @@
<article data-uid=""> <article data-uid="">
<h1 id="using-hidispdrawing">Using Hi.Disp.Drawing</h1> <h1 id="using-hidispdrawing">Using Hi.Disp.Drawing</h1>
<p>The <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a> class is the most fundamental and efficient rendering unit that allows you to draw points, lines, and surfaces within the <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.</p> <p>The <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a> class is the most fundamental and efficient rendering unit that allows you to draw points, lines, and surfaces within the <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.</p>
<h2 id="understanding-drawing-structure">Understanding Drawing Structure</h2> <h2 id="understanding-drawing-structure">Understanding Drawing Structure</h2>
<p>Looking at the constructor <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html#Hi_Disp_Drawing__ctor_System_Double___Hi_Disp_Stamp_System_Int32_">Drawing(double[], Stamp, int)</a> helps explain its structure:</p> <p>Looking at the constructor <a class="xref" href="../../../../api/Hi.Disp.Drawing.html#Hi_Disp_Drawing__ctor_System_Double___Hi_Disp_Stamp_System_Int32_">Drawing(double[], Stamp, int)</a> helps explain its structure:</p>
<ul> <ul>
<li>The <code>double[]</code> array contains batch data for rendering, composed of one or more data groups of consistent length</li> <li>The <code>double[]</code> array contains batch data for rendering, composed of one or more data groups of consistent length</li>
<li>Each data group's length is determined by the <a class="xref" href="../../../../../api/Hi.Disp.Stamp.html">Stamp</a> parameter</li> <li>Each data group's length is determined by the <a class="xref" href="../../../../api/Hi.Disp.Stamp.html">Stamp</a> parameter</li>
<li>Each data group describes a single vertex</li> <li>Each data group describes a single vertex</li>
</ul> </ul>
<h2 id="data-components">Data Components</h2> <h2 id="data-components">Data Components</h2>
@ -133,7 +133,7 @@
</tr> </tr>
</tbody> </tbody>
</table> </table>
<p>The <a class="xref" href="../../../../../api/Hi.Disp.Stamp.html">Stamp</a> enumeration combines these abbreviations to create these possible stamps: <code>{V, NV, CV, CNV, PV, PNV, PCV, PCNV}</code>.</p> <p>The <a class="xref" href="../../../../api/Hi.Disp.Stamp.html">Stamp</a> enumeration combines these abbreviations to create these possible stamps: <code>{V, NV, CV, CNV, PV, PNV, PCV, PCNV}</code>.</p>
<h3 id="important-notes">Important Notes:</h3> <h3 id="important-notes">Important Notes:</h3>
<ul> <ul>
<li>The <strong>Vertex</strong> (V) is mandatory, which is why V appears in every Stamp option</li> <li>The <strong>Vertex</strong> (V) is mandatory, which is why V appears in every Stamp option</li>
@ -143,8 +143,8 @@
</ul> </ul>
<h2 id="data-structure-example">Data Structure Example</h2> <h2 id="data-structure-example">Data Structure Example</h2>
<ul> <ul>
<li>If <a class="xref" href="../../../../../api/Hi.Disp.Stamp.html">Stamp</a> is <code>V</code>, each data group consists of 3 double values (x, y, z)</li> <li>If <a class="xref" href="../../../../api/Hi.Disp.Stamp.html">Stamp</a> is <code>V</code>, each data group consists of 3 double values (x, y, z)</li>
<li>If <a class="xref" href="../../../../../api/Hi.Disp.Stamp.html">Stamp</a> is <code>PCV</code>, each data group consists of 1(P) + 3(C) + 3(V) = 7 double values</li> <li>If <a class="xref" href="../../../../api/Hi.Disp.Stamp.html">Stamp</a> is <code>PCV</code>, each data group consists of 1(P) + 3(C) + 3(V) = 7 double values</li>
</ul> </ul>
<h2 id="rendering-mode">Rendering Mode</h2> <h2 id="rendering-mode">Rendering Mode</h2>
<p>The <code>glmode</code> parameter is an OpenGL constant that specifies the drawing mode. You can search for &ldquo;OpenGL Primitives&rdquo; online to see illustrations of these modes.</p> <p>The <code>glmode</code> parameter is an OpenGL constant that specifies the drawing mode. You can search for &ldquo;OpenGL Primitives&rdquo; online to see illustrations of these modes.</p>
@ -164,10 +164,10 @@ var drawing = new Drawing(vertices, Stamp.V, (int)OpenGL.GL_LINE_STRIP);
<h2 id="performance-considerations">Performance Considerations</h2> <h2 id="performance-considerations">Performance Considerations</h2>
<div class="NOTE"> <div class="NOTE">
<h5>Note</h5> <h5>Note</h5>
<p>After a <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a> object is created, its source data is stored in GPU memory. Regardless of the amount of data, the CPU processing load when calling <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html#Hi_Disp_IDisplayee_Display_Hi_Disp_Bind_">Display(Bind)</a> remains consistent. This means displaying 100 points with one <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a> object is approximately 100 times faster than using 100 separate Drawing objects to display 100 individual points.</p> <p>After a <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a> object is created, its source data is stored in GPU memory. Regardless of the amount of data, the CPU processing load when calling <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html#Hi_Disp_IDisplayee_Display_Hi_Disp_Bind_">Display(Bind)</a> remains consistent. This means displaying 100 points with one <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a> object is approximately 100 times faster than using 100 separate Drawing objects to display 100 individual points.</p>
</div> </div>
<h2 id="composing-multiple-idisplayee-objects">Composing Multiple IDisplayee Objects</h2> <h2 id="composing-multiple-idisplayee-objects">Composing Multiple IDisplayee Objects</h2>
<p>A common pattern is to combine multiple <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> objects, including <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a> objects:</p> <p>A common pattern is to combine multiple <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> objects, including <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a> objects:</p>
<pre><code class="lang-csharp">public class MyCompositeDisplayee : IDisplayee <pre><code class="lang-csharp">public class MyCompositeDisplayee : IDisplayee
{ {
private readonly List&lt;IDisplayee&gt; _displayees = new List&lt;IDisplayee&gt;(); private readonly List&lt;IDisplayee&gt; _displayees = new List&lt;IDisplayee&gt;();
@ -231,7 +231,7 @@ var drawing = new Drawing(vertices, Stamp.V, (int)OpenGL.GL_LINE_STRIP);
} }
</code></pre> </code></pre>
<h2 id="creating-common-shapes">Creating Common Shapes</h2> <h2 id="creating-common-shapes">Creating Common Shapes</h2>
<p>Here are some examples of creating common shapes using the <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a> class:</p> <p>Here are some examples of creating common shapes using the <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a> class:</p>
<h3 id="creating-points">Creating Points</h3> <h3 id="creating-points">Creating Points</h3>
<pre><code class="lang-csharp">// Create an array of points <pre><code class="lang-csharp">// Create an array of points
double[] pointData = new double[] { double[] pointData = new double[] {
@ -268,9 +268,9 @@ var triangleDrawing = new Drawing(triangleData, Stamp.V, (int)OpenGL.GL_TRIANGLE
</code></pre> </code></pre>
<h2 id="see-also">See Also</h2> <h2 id="see-also">See Also</h2>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li>
<li><a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li>
<li><a class="xref" href="../../../../../api/Hi.Disp.DispList.html">DispList</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.DispList.html">DispList</a></li>
</ul> </ul>
</article> </article>

30
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/index.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/rendering/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Rendering with HiAPI | HiAPI-C# 2025 "> <meta name="title" content="Rendering with HiAPI | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -89,7 +89,7 @@
<p>This section covers the rendering capabilities of HiAPI, focusing on how to create and display visual content in your applications.</p> <p>This section covers the rendering capabilities of HiAPI, focusing on how to create and display visual content in your applications.</p>
<h2 id="overview">Overview</h2> <h2 id="overview">Overview</h2>
<p>HiAPI provides a powerful rendering system built around the <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> and <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> interface. This system enables you to:</p> <p>HiAPI provides a powerful rendering system built around the <a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a> and <a class="xref" href="../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> interface. This system enables you to:</p>
<ul> <ul>
<li>Create and render 3D and 2D graphics</li> <li>Create and render 3D and 2D graphics</li>
<li>Implement interactive user interfaces</li> <li>Implement interactive user interfaces</li>
@ -130,18 +130,18 @@
<h2 id="basic-rendering-workflow">Basic Rendering Workflow</h2> <h2 id="basic-rendering-workflow">Basic Rendering Workflow</h2>
<p>The typical workflow for rendering with HiAPI follows these steps:</p> <p>The typical workflow for rendering with HiAPI follows these steps:</p>
<ol> <ol>
<li><strong>Create Displayees</strong>: Implement <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> or use existing implementations like <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a></li> <li><strong>Create Displayees</strong>: Implement <a class="xref" href="../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> or use existing implementations like <a class="xref" href="../../../api/Hi.Disp.Drawing.html">Drawing</a></li>
<li><strong>Configure DispEngine</strong>: Create and initialize a <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> with your displayees</li> <li><strong>Configure DispEngine</strong>: Create and initialize a <a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a> with your displayees</li>
<li><strong>UI Integration</strong>: Use RenderingCanvas components to display the rendered content in your UI</li> <li><strong>UI Integration</strong>: Use RenderingCanvas components to display the rendered content in your UI</li>
<li><strong>Handle Input</strong>: Process user interactions through the DispEngine's input handling methods</li> <li><strong>Handle Input</strong>: Process user interactions through the DispEngine's input handling methods</li>
</ol> </ol>
<p>This pattern works consistently across all supported UI frameworks, allowing you to develop cross-platform applications with a unified codebase.</p> <p>This pattern works consistently across all supported UI frameworks, allowing you to develop cross-platform applications with a unified codebase.</p>
<h2 id="see-also">See Also</h2> <h2 id="see-also">See Also</h2>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li> <li><a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li>
<li><a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li> <li><a class="xref" href="../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li>
<li><a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a></li> <li><a class="xref" href="../../../api/Hi.Disp.Drawing.html">Drawing</a></li>
<li><a class="xref" href="../../../../api/Hi.Disp.DispList.html">DispList</a></li> <li><a class="xref" href="../../../api/Hi.Disp.DispList.html">DispList</a></li>
</ul> </ul>
</article> </article>

50
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/custom-implementation.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/rendering/rendering-canvas/custom-implementation.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Building Your Own Rendering Canvas | HiAPI-C# 2025 "> <meta name="title" content="Building Your Own Rendering Canvas | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,26 +87,26 @@
<article data-uid=""> <article data-uid="">
<h1 id="building-your-own-rendering-canvas">Building Your Own Rendering Canvas</h1> <h1 id="building-your-own-rendering-canvas">Building Your Own Rendering Canvas</h1>
<p>This guide provides detailed implementation information for creating your own <code>RenderingCanvas</code> using the <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>. By understanding these implementation details, you can customize the rendering component for specific application needs or create implementations for other UI frameworks.</p> <p>This guide provides detailed implementation information for creating your own <code>RenderingCanvas</code> using the <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>. By understanding these implementation details, you can customize the rendering component for specific application needs or create implementations for other UI frameworks.</p>
<div class="NOTE"> <div class="NOTE">
<h5>Note</h5> <h5>Note</h5>
<p><strong>For Windows Applications</strong>: If you are developing for Windows systems, it is recommended to directly use the existing <code>RenderingCanvas</code> implementations in the <code>Hi.WinForm</code> or <code>Hi.WpfPlus</code> packages, rather than creating your own. These implementations are fully tested, optimized, and maintained.</p> <p><strong>For Windows Applications</strong>: If you are developing for Windows systems, it is recommended to directly use the existing <code>RenderingCanvas</code> implementations in the <code>Hi.WinForm</code> or <code>Hi.WpfPlus</code> packages, rather than creating your own. These implementations are fully tested, optimized, and maintained.</p>
<p>The implementation details provided in this document are primarily for educational purposes or for developers who need to port RenderingCanvas to other platforms/frameworks.</p> <p>The implementation details provided in this document are primarily for educational purposes or for developers who need to port RenderingCanvas to other platforms/frameworks.</p>
</div> </div>
<h2 id="basic-dispengine-usage">Basic DispEngine Usage</h2> <h2 id="basic-dispengine-usage">Basic DispEngine Usage</h2>
<p>The <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> is designed to display objects that implement the <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> interface. This is the fundamental purpose of DispEngine - to render displayable objects. Assign <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> to <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a>.</p> <p>The <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> is designed to display objects that implement the <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> interface. This is the fundamental purpose of DispEngine - to render displayable objects. Assign <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> to <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a>.</p>
<h2 id="core-implementation-pattern">Core Implementation Pattern</h2> <h2 id="core-implementation-pattern">Core Implementation Pattern</h2>
<p>When implementing a custom <code>RenderingCanvas</code> for a UI platform, follow these key steps:</p> <p>When implementing a custom <code>RenderingCanvas</code> for a UI platform, follow these key steps:</p>
<ol> <ol>
<li><strong>Initialize UI Component</strong> - Set up the UI control properties and event handling</li> <li><strong>Initialize UI Component</strong> - Set up the UI control properties and event handling</li>
<li><strong>Configure DispEngine</strong> - Create and properly initialize the <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> instance</li> <li><strong>Configure DispEngine</strong> - Create and properly initialize the <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> instance</li>
<li><strong>Set Up Rendering Pipeline</strong> - Implement buffer swapping mechanism for visualization</li> <li><strong>Set Up Rendering Pipeline</strong> - Implement buffer swapping mechanism for visualization</li>
<li><strong>Handle User Input</strong> - Map platform-specific input events to DispEngine methods</li> <li><strong>Handle User Input</strong> - Map platform-specific input events to DispEngine methods</li>
<li><strong>Manage Component Lifecycle</strong> - Ensure proper resource management and cleanup</li> <li><strong>Manage Component Lifecycle</strong> - Ensure proper resource management and cleanup</li>
</ol> </ol>
<p>Let's examine the actual implementations in WinForm and WPF frameworks to understand these patterns in practice.</p> <p>Let's examine the actual implementations in WinForm and WPF frameworks to understand these patterns in practice.</p>
<h2 id="winform-implementation-details">WinForm Implementation Details</h2> <h2 id="winform-implementation-details">WinForm Implementation Details</h2>
<p>The WinForm implementation in <code>Hi.WinForm</code> combines Windows Forms controls with the <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> rendering system.</p> <p>The WinForm implementation in <code>Hi.WinForm</code> combines Windows Forms controls with the <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> rendering system.</p>
<h3 id="core-properties-and-fields">Core Properties and Fields</h3> <h3 id="core-properties-and-fields">Core Properties and Fields</h3>
<p>Here are the essential properties and fields defined in the WinForm implementation:</p> <p>Here are the essential properties and fields defined in the WinForm implementation:</p>
<pre><code class="lang-csharp" name="RenderingCanvas">/// &lt;summary&gt; <pre><code class="lang-csharp" name="RenderingCanvas">/// &lt;summary&gt;
@ -737,14 +737,14 @@ engine.SetViewToHomeView();
<h3 id="2-render-loop">2. Render Loop</h3> <h3 id="2-render-loop">2. Render Loop</h3>
<p>The rendering process follows this pattern:</p> <p>The rendering process follows this pattern:</p>
<ol> <ol>
<li><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> processes <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> objects</li> <li><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> processes <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> objects</li>
<li>Buffer is swapped and callback is triggered</li> <li>Buffer is swapped and callback is triggered</li>
<li>UI framework renders the buffer to screen</li> <li>UI framework renders the buffer to screen</li>
<li>User input triggers view updates</li> <li>User input triggers view updates</li>
<li>Process repeats</li> <li>Process repeats</li>
</ol> </ol>
<h3 id="3-complete-user-input-mapping">3. Complete User Input Mapping</h3> <h3 id="3-complete-user-input-mapping">3. Complete User Input Mapping</h3>
<p>All user interactions must be mapped to <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> methods:</p> <p>All user interactions must be mapped to <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> methods:</p>
<table> <table>
<thead> <thead>
<tr> <tr>
@ -755,27 +755,27 @@ engine.SetViewToHomeView();
<tbody> <tbody>
<tr> <tr>
<td>Mouse move</td> <td>Mouse move</td>
<td><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseMove_System_Int32_System_Int32_">MouseMove(int, int)</a></td> <td><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseMove_System_Int32_System_Int32_">MouseMove(int, int)</a></td>
</tr> </tr>
<tr> <tr>
<td>Mouse drag</td> <td>Mouse drag</td>
<td><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseDragTransform_System_Int32_System_Int32_Hi_Native_mouse_button_table__transform_view_by_mouse_drag_t_">MouseDragTransform(int, int, mouse_button_table__transform_view_by_mouse_drag_t)</a></td> <td><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseDragTransform_System_Int32_System_Int32_Hi_Native_mouse_button_table__transform_view_by_mouse_drag_t_">MouseDragTransform(int, int, mouse_button_table__transform_view_by_mouse_drag_t)</a></td>
</tr> </tr>
<tr> <tr>
<td>Mouse button</td> <td>Mouse button</td>
<td><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseButtonDown_System_Int64_">MouseButtonDown(long)</a> / <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseButtonUp_System_Int64_">MouseButtonUp(long)</a></td> <td><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseButtonDown_System_Int64_">MouseButtonDown(long)</a> / <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseButtonUp_System_Int64_">MouseButtonUp(long)</a></td>
</tr> </tr>
<tr> <tr>
<td>Mouse wheel</td> <td>Mouse wheel</td>
<td><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseWheel_System_Int32_System_Int32_">MouseWheel(int, int)</a> and <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseWheelTransform_System_Int32_System_Int32_System_Double_">MouseWheelTransform(int, int, double)</a></td> <td><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseWheel_System_Int32_System_Int32_">MouseWheel(int, int)</a> and <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_MouseWheelTransform_System_Int32_System_Int32_System_Double_">MouseWheelTransform(int, int, double)</a></td>
</tr> </tr>
<tr> <tr>
<td>Key press</td> <td>Key press</td>
<td><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_KeyDown_System_Int64_">KeyDown(long)</a> / <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_KeyUp_System_Int64_">KeyUp(long)</a> and <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_KeyDownTransform_System_Int64_Hi_Native_key_table__transform_view_by_key_pressing_t_">KeyDownTransform(long, key_table__transform_view_by_key_pressing_t)</a></td> <td><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_KeyDown_System_Int64_">KeyDown(long)</a> / <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_KeyUp_System_Int64_">KeyUp(long)</a> and <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_KeyDownTransform_System_Int64_Hi_Native_key_table__transform_view_by_key_pressing_t_">KeyDownTransform(long, key_table__transform_view_by_key_pressing_t)</a></td>
</tr> </tr>
<tr> <tr>
<td>Touch events</td> <td>Touch events</td>
<td><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_TouchDown_System_Int32_System_Int32_System_Int32_">TouchDown(int, int, int)</a> / <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_TouchMove_System_Int32_System_Int32_System_Int32_">TouchMove(int, int, int)</a> / <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_TouchUp_System_Int32_">TouchUp(int)</a></td> <td><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_TouchDown_System_Int32_System_Int32_System_Int32_">TouchDown(int, int, int)</a> / <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_TouchMove_System_Int32_System_Int32_System_Int32_">TouchMove(int, int, int)</a> / <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_TouchUp_System_Int32_">TouchUp(int)</a></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -789,7 +789,7 @@ DispEngine.Dispose();
<h2 id="advanced-implementation-considerations">Advanced Implementation Considerations</h2> <h2 id="advanced-implementation-considerations">Advanced Implementation Considerations</h2>
<p>When creating custom implementations, consider these aspects:</p> <p>When creating custom implementations, consider these aspects:</p>
<h3 id="view-manipulation">View Manipulation</h3> <h3 id="view-manipulation">View Manipulation</h3>
<p>Use <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SketchView">SketchView</a> to directly access or modify the view matrix:</p> <p>Use <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SketchView">SketchView</a> to directly access or modify the view matrix:</p>
<pre><code class="lang-csharp">// Get current view matrix <pre><code class="lang-csharp">// Get current view matrix
Mat4d currentView = engine.SketchView; Mat4d currentView = engine.SketchView;
@ -799,10 +799,10 @@ engine.SketchView = currentView * rotation;
</code></pre> </code></pre>
<h2 id="see-also">See Also</h2> <h2 id="see-also">See Also</h2>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li>
<li><a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li>
<li><a class="xref" href="../../../../../api/Hi.Geom.Vec2d.html">Vec2d</a></li> <li><a class="xref" href="../../../../api/Hi.Geom.Vec2d.html">Vec2d</a></li>
<li><a class="xref" href="../../../../../api/Hi.Geom.Mat4d.html">Mat4d</a></li> <li><a class="xref" href="../../../../api/Hi.Geom.Mat4d.html">Mat4d</a></li>
</ul> </ul>
</article> </article>

46
App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/index.html → App/wwwroot/HiAPI-docsite/dev-doc/basic/rendering/rendering-canvas/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Using RenderingCanvas with DispEngine | HiAPI-C# 2025 "> <meta name="title" content="Using RenderingCanvas with DispEngine | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,27 +87,27 @@
<article data-uid=""> <article data-uid="">
<h1 id="using-renderingcanvas-with-dispengine">Using RenderingCanvas with DispEngine</h1> <h1 id="using-renderingcanvas-with-dispengine">Using RenderingCanvas with DispEngine</h1>
<p>The <code>RenderingCanvas</code> is the primary UI component for displaying and interacting with 3D content across different platforms. This section explains how to use it with the <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> to create cross-platform applications.</p> <p>The <code>RenderingCanvas</code> is the primary UI component for displaying and interacting with 3D content across different platforms. This section explains how to use it with the <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> to create cross-platform applications.</p>
<h2 id="overview">Overview</h2> <h2 id="overview">Overview</h2>
<p>The <code>RenderingCanvas</code> class is available in frameworks:</p> <p>The <code>RenderingCanvas</code> class is available in frameworks:</p>
<ul> <ul>
<li><code>Hi.WinForm</code> for Windows Forms applications</li> <li><code>Hi.WinForm</code> for Windows Forms applications</li>
<li><code>Hi.WpfPlus</code> for WPF applications</li> <li><code>Hi.WpfPlus</code> for WPF applications</li>
</ul> </ul>
<p>All implementations share a common architecture centered around the <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> class, enabling consistent rendering and interaction across platforms.</p> <p>All implementations share a common architecture centered around the <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> class, enabling consistent rendering and interaction across platforms.</p>
<h2 id="core-concept-dispengine-and-idisplayee">Core Concept: DispEngine and IDisplayee</h2> <h2 id="core-concept-dispengine-and-idisplayee">Core Concept: DispEngine and IDisplayee</h2>
<p>At the heart of the rendering system is the relationship between <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> and <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a>:</p> <p>At the heart of the rendering system is the relationship between <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> and <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a>:</p>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>: The rendering engine that manages the OpenGL context and handles user interaction</li> <li><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>: The rendering engine that manages the OpenGL context and handles user interaction</li>
<li><a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a>: The interface that defines objects that can be rendered by the DispEngine</li> <li><a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a>: The interface that defines objects that can be rendered by the DispEngine</li>
</ul> </ul>
<p>This relationship is fundamental - <strong>the purpose of <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> is to render <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> objects</strong>.</p> <p>This relationship is fundamental - <strong>the purpose of <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> is to render <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> objects</strong>.</p>
<pre><code class="lang-mermaid">graph TD <pre><code class="lang-mermaid">graph TD
A[IDisplayee Objects] --&gt;|Rendered by| B A[IDisplayee Objects] --&gt;|Rendered by| B
B[DispEngine] &lt;--&gt; C[RenderingCanvas UI Component] B[DispEngine] &lt;--&gt; C[RenderingCanvas UI Component]
</code></pre> </code></pre>
<h3 id="working-with-idisplayee">Working with IDisplayee</h3> <h3 id="working-with-idisplayee">Working with IDisplayee</h3>
<p>Objects implementing <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> define what gets rendered. Typically, you'll use <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a> objects or compose multiple IDisplayee objects together:</p> <p>Objects implementing <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> define what gets rendered. Typically, you'll use <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a> objects or compose multiple IDisplayee objects together:</p>
<pre><code class="lang-csharp">// Create a composite displayee <pre><code class="lang-csharp">// Create a composite displayee
public class MyCompositeDisplayee : IDisplayee public class MyCompositeDisplayee : IDisplayee
{ {
@ -139,7 +139,7 @@ public class MyCompositeDisplayee : IDisplayee
} }
} }
</code></pre> </code></pre>
<p>For more detailed information on creating displayees with <a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a>, see the <a href="../drawing/index.html">Drawing</a> section.</p> <p>For more detailed information on creating displayees with <a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a>, see the <a href="../drawing/index.html">Drawing</a> section.</p>
<h2 id="basic-usage">Basic Usage</h2> <h2 id="basic-usage">Basic Usage</h2>
<h3 id="apply-hiwinform">Apply Hi.WinForm</h3> <h3 id="apply-hiwinform">Apply Hi.WinForm</h3>
<pre><code class="lang-csharp">// Create a new instance with displayee objects <pre><code class="lang-csharp">// Create a new instance with displayee objects
@ -185,7 +185,7 @@ if (showGrid) displayList.Add(gridDisplayee);
renderingCanvas.DispEngine.Displayee = displayList; renderingCanvas.DispEngine.Displayee = displayList;
</code></pre> </code></pre>
<h2 id="key-features-of-dispengine">Key Features of DispEngine</h2> <h2 id="key-features-of-dispengine">Key Features of DispEngine</h2>
<p>The <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> provides cross-platform support for:</p> <p>The <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> provides cross-platform support for:</p>
<ul> <ul>
<li>Handles buffer swapping and image generation</li> <li>Handles buffer swapping and image generation</li>
<li>Mouse/pointer events</li> <li>Mouse/pointer events</li>
@ -195,10 +195,10 @@ renderingCanvas.DispEngine.Displayee = displayList;
<li>Resize and Visibility changed.</li> <li>Resize and Visibility changed.</li>
<li>Camera positioning and orientation</li> <li>Camera positioning and orientation</li>
<li>Standard views (front, top, isometric, etc.)</li> <li>Standard views (front, top, isometric, etc.)</li>
<li>Renders <a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> implementations</li> <li>Renders <a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a> implementations</li>
</ul> </ul>
<h2 id="touch-and-gesture-support">Touch and Gesture Support</h2> <h2 id="touch-and-gesture-support">Touch and Gesture Support</h2>
<p>The <a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> centralizes touch handling across all platforms with a unified API that supports:</p> <p>The <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> centralizes touch handling across all platforms with a unified API that supports:</p>
<ul> <ul>
<li>Single-finger pan</li> <li>Single-finger pan</li>
<li>Two-finger rotate and scale</li> <li>Two-finger rotate and scale</li>
@ -231,10 +231,10 @@ engine.Resize(width, height);
<p>See the <a href="custom-implementation.html">Building Your Own RenderingCanvas</a> guide.</p> <p>See the <a href="custom-implementation.html">Building Your Own RenderingCanvas</a> guide.</p>
<h2 id="see-also">See Also</h2> <h2 id="see-also">See Also</h2>
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a></li>
<li><a class="xref" href="../../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.IDisplayee.html">IDisplayee</a></li>
<li><a class="xref" href="../../../../../api/Hi.Disp.DispList.html">DispList</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.DispList.html">DispList</a></li>
<li><a class="xref" href="../../../../../api/Hi.Disp.Drawing.html">Drawing</a></li> <li><a class="xref" href="../../../../api/Hi.Disp.Drawing.html">Drawing</a></li>
<li><a href="custom-implementation.html">Building Your Own RenderingCanvas</a></li> <li><a href="custom-implementation.html">Building Your Own RenderingCanvas</a></li>
</ul> </ul>

16
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/common/dictionary-service-pattern.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/common/dictionary-service-pattern.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="DictionaryService and DictionaryHub Pattern | HiAPI-C# 2025 "> <meta name="title" content="DictionaryService and DictionaryHub Pattern | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">

25
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/initialize-hiapi.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/common/webapi-with-hub-cleanup-assistence-pattern.html
View File

@ -2,16 +2,16 @@
<html> <html>
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>Initialize HiAPI at Application Entry Point | HiAPI-C# 2025 </title> <title>Webapi with hub-cleapup assistence pattern | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Initialize HiAPI at Application Entry Point | HiAPI-C# 2025 "> <meta name="title" content="Webapi with hub-cleapup assistence pattern | HiAPI-C# 2025 ">
<link rel="icon" href="../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../"> <meta name="docfx:rel" content="../../../">
@ -85,17 +85,16 @@
</div> </div>
<article data-uid=""> <article data-uid="">
<h1 id="initialize-hiapi-at-application-entry-point">Initialize HiAPI at Application Entry Point</h1> <h1 id="webapi-with-hub-cleapup-assistence-pattern">Webapi with hub-cleapup assistence pattern</h1>
<p>At the application entry point, you need to initialize HiAPI and set the exiting event.</p> <p>any of the index key should be registerForCleanup. i.e. any of indexXxx should follow the registerForCleanup.</p>
<ul> <p>clean the indexed key which indexed by the host component in beforeUnmount. And so that the component doesn't clean the key that doesn't create by the component itself.</p>
<li><a class="xref" href="../../../api/Hi.HiNcKits.LocalApp.html#Hi_HiNcKits_LocalApp_AppBegin_">AppBegin</a></li> <p>Although cleanupHub clean them for sure, the code demonstrates example of pure web-api cleanup (So that it can be a complete web-api workflow).</p>
<li><a class="xref" href="../../../api/Hi.HiNcKits.LocalApp.html#Hi_HiNcKits_LocalApp_AppEnd_">AppEnd</a></li> <h2 id="notice">Notice</h2>
</ul> <ol>
<div class="IMPORTANT"> <li>before current key modified, the previous key should be called this.cleanupKey.</li>
<h5>Important</h5> <li>A twin key should be made from the outside key to keep the lifecycle maintained.</li>
<p>Regardless of whether you use the DI-based version or the legacy flow, you must call <code>LocalApp.AppBegin()</code> at application startup and <code>LocalApp.AppEnd()</code> on shutdown to initialize and release licensing, display engine, and background resources.</p> </ol>
</div>
</article> </article>

114
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/controller/index.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/controller/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Controller Page | HiAPI-C# 2025 "> <meta name="title" content="Controller Page | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -91,12 +91,12 @@
<h2 id="key-models">Key Models</h2> <h2 id="key-models">Key Models</h2>
<p>The key models used by the Controller Page are:</p> <p>The key models used by the Controller Page are:</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html">NcEnv</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html">NcEnv</a></li>
<li><a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a></li> <li><a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a></li>
</ul> </ul>
<p>The <a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> contains <a class="xref" href="../../../../api/Hi.Numerical.IsoCoordinateEntryDisplayee.html">IsoCoordinateEntryDisplayee</a> and <a class="xref" href="../../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a>. They are used in this GUI.</p> <p>The <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> contains <a class="xref" href="../../../api/Hi.Numerical.IsoCoordinateEntryDisplayee.html">IsoCoordinateEntryDisplayee</a> and <a class="xref" href="../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a>. They are used in this GUI.</p>
<h3 id="connection-with-main-panel">Connection with Main Panel</h3> <h3 id="connection-with-main-panel">Connection with Main Panel</h3>
<p>The Controller Page is activated through the <a href="../main-panel.html">Main Panel</a>'s Environment menu. It retrieves the <a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a> from the Main Panel and updates the model.</p> <p>The Controller Page is activated through the <a href="../main-panel.html">Main Panel</a>'s Environment menu. It retrieves the <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a> from the Main Panel and updates the model.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Controller Page <li>Controller Page
@ -120,32 +120,32 @@
<ul> <ul>
<li>ISO Coordinate Table Panel <li>ISO Coordinate Table Panel
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html">NcEnv</a>.<a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_IsoCoordinateTable">IsoCoordinateTable</a> Display <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html">NcEnv</a>.<a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_IsoCoordinateTable">IsoCoordinateTable</a> Display
(Note that The XYZ is not sortable on the table.)</li> (Note that The XYZ is not sortable on the table.)</li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li>Datum Preset Table Tab (Only visible for <a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a> controllers) <li>Datum Preset Table Tab (Only visible for <a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a> controllers)
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumPresetTable">HeidenhainDatumPresetTable</a> Panel <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumPresetTable">HeidenhainDatumPresetTable</a> Panel
(Note that The XYZ is not sortable on the table.) (Note that The XYZ is not sortable on the table.)
<ul> <ul>
<li>Show Datum Preset Toggle Button for <a class="xref" href="../../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a></li> <li>Show Datum Preset Toggle Button for <a class="xref" href="../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li>Datum Shift Table Tab (Only visible for <a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a> controllers) <li>Datum Shift Table Tab (Only visible for <a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a> controllers)
(Note that The XYZ is not sortable on the table.) (Note that The XYZ is not sortable on the table.)
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumShiftTable">HeidenhainDatumShiftTable</a> Panel</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumShiftTable">HeidenhainDatumShiftTable</a> Panel</li>
<li>Show Datum Shift Toggle Button for <a class="xref" href="../../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a></li> <li>Show Datum Shift Toggle Button for <a class="xref" href="../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a></li>
</ul> </ul>
</li> </li>
<li>Offset Table Tab <li>Offset Table Tab
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.MillingToolOffsetTable.html">MillingToolOffsetTable</a> Panel <li><a class="xref" href="../../../api/Hi.Numerical.MillingToolOffsetTable.html">MillingToolOffsetTable</a> Panel
<ul> <ul>
<li>Set Ideal Offset Dependent on Tool House Checkbox</li> <li>Set Ideal Offset Dependent on Tool House Checkbox</li>
</ul> </ul>
@ -154,29 +154,29 @@
</li> </li>
<li>Machine Tab <li>Machine Tab
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_RapidFeedrate_mmdmin">RapidFeedrate_mmdmin</a> Settings</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_RapidFeedrate_mmdmin">RapidFeedrate_mmdmin</a> Settings</li>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_ToolingTime">ToolingTime</a> Settings</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_ToolingTime">ToolingTime</a> Settings</li>
<li>Linear Axis Limits Table <li>Linear Axis Limits Table
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitXyz_mm">StrokeLimitXyz_mm</a> Min and Max for X, Y, Z</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitXyz_mm">StrokeLimitXyz_mm</a> Min and Max for X, Y, Z</li>
</ul> </ul>
</li> </li>
<li>Rotary Axis Table <li>Rotary Axis Table
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitAbc_rad">StrokeLimitAbc_rad</a> Min and Max for A, B, C</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitAbc_rad">StrokeLimitAbc_rad</a> Min and Max for A, B, C</li>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_MaxRotarySpeedABC_radds">MaxRotarySpeedABC_radds</a> for A, B, C</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_MaxRotarySpeedABC_radds">MaxRotarySpeedABC_radds</a> for A, B, C</li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li>Brand Tab <li>Brand Tab
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_CncBrand">CncBrand</a> Selection Dropdown <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_CncBrand">CncBrand</a> Selection Dropdown
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Syntec">Syntec</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Syntec">Syntec</a></li>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Fanuc">Fanuc</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Fanuc">Fanuc</a></li>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a></li>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Siemens">Siemens</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Siemens">Siemens</a></li>
</ul> </ul>
</li> </li>
<li>Brand-specific Settings Panel (content varies based on selected brand)</li> <li>Brand-specific Settings Panel (content varies based on selected brand)</li>
@ -184,8 +184,8 @@
</li> </li>
<li>Config Tab <li>Config Tab
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_SetToolHeightCompensationOnFeatureNormal">SetToolHeightCompensationOnFeatureNormal</a> Setting</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_SetToolHeightCompensationOnFeatureNormal">SetToolHeightCompensationOnFeatureNormal</a> Setting</li>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_EnableShortestRotary">EnableShortestRotary</a> Setting</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_EnableShortestRotary">EnableShortestRotary</a> Setting</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -203,7 +203,7 @@ See Rendering Items SubMenu from <a href="../player/player-extended-renderingcan
</li> </li>
<li>RenderingCanvas <li>RenderingCanvas
<ul> <ul>
<li>The <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a></li> <li>The <a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -214,7 +214,7 @@ See Rendering Items SubMenu from <a href="../player/player-extended-renderingcan
<div class="TIP"> <div class="TIP">
<h5>Tip</h5> <h5>Tip</h5>
<p>Viewer Panel is not essential in the single user desktop application if this page raises a new window so that there arises a duplicate rendering content with the Main Window. This page should have a code-behind boolean property to add / remove the Viewer Panel. There should not preserve space for the un-existed Viewer Panel.</p> <p>Viewer Panel is not essential in the single user desktop application if this page raises a new window so that there arises a duplicate rendering content with the Main Window. This page should have a code-behind boolean property to add / remove the Viewer Panel. There should not preserve space for the un-existed Viewer Panel.</p>
<p>Apply <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a> on initialization if Viewer Panel has enabled.</p> <p>Apply <a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a> on initialization if Viewer Panel has enabled.</p>
</div> </div>
<div class="TIP"> <div class="TIP">
<h5>Tip</h5> <h5>Tip</h5>
@ -222,54 +222,54 @@ See Rendering Items SubMenu from <a href="../player/player-extended-renderingcan
</div> </div>
<h2 id="behavior">Behavior</h2> <h2 id="behavior">Behavior</h2>
<h3 id="iso-coordinate-table">ISO Coordinate Table</h3> <h3 id="iso-coordinate-table">ISO Coordinate Table</h3>
<p>The ISO coordinate table allows users to edit and manage coordinates for the <a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_IsoCoordinateTable">IsoCoordinateTable</a>. Each entry consists of:</p> <p>The ISO coordinate table allows users to edit and manage coordinates for the <a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_IsoCoordinateTable">IsoCoordinateTable</a>. Each entry consists of:</p>
<ul> <ul>
<li>An index identifier</li> <li>An index identifier</li>
<li>X, Y, Z coordinate values</li> <li>X, Y, Z coordinate values</li>
<li>Action buttons to set the entry to program zero or machine zero</li> <li>Action buttons to set the entry to program zero or machine zero</li>
</ul> </ul>
<p>Row selection updates <a class="xref" href="../../../../api/Hi.Numerical.IsoCoordinateEntryDisplayee.html#Hi_Numerical_IsoCoordinateEntryDisplayee_IsoCoordinateId">IsoCoordinateId</a>.</p> <p>Row selection updates <a class="xref" href="../../../api/Hi.Numerical.IsoCoordinateEntryDisplayee.html#Hi_Numerical_IsoCoordinateEntryDisplayee_IsoCoordinateId">IsoCoordinateId</a>.</p>
<h3 id="datum-preset-and-shift-tables-heidenhain">Datum Preset and Shift Tables (Heidenhain)</h3> <h3 id="datum-preset-and-shift-tables-heidenhain">Datum Preset and Shift Tables (Heidenhain)</h3>
<p>These tables are specific to <a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a> controllers and provide interfaces for:</p> <p>These tables are specific to <a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a> controllers and provide interfaces for:</p>
<ul> <ul>
<li>Setting datum preset positions in <a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumPresetTable">HeidenhainDatumPresetTable</a></li> <li>Setting datum preset positions in <a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumPresetTable">HeidenhainDatumPresetTable</a></li>
<li>Configuring datum shifts in <a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumShiftTable">HeidenhainDatumShiftTable</a></li> <li>Configuring datum shifts in <a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_HeidenhainDatumShiftTable">HeidenhainDatumShiftTable</a></li>
<li>Visualizing selected datum in the 3D viewer with <a class="xref" href="../../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a></li> <li>Visualizing selected datum in the 3D viewer with <a class="xref" href="../../../api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html">HeidenhainCoordinateEntryDisplayee</a></li>
</ul> </ul>
<h3 id="offset-table">Offset Table</h3> <h3 id="offset-table">Offset Table</h3>
<p>Manages tool offsets with the following capabilities:</p> <p>Manages tool offsets with the following capabilities:</p>
<ul> <ul>
<li>Display and edit ideal radius and height values in <a class="xref" href="../../../../api/Hi.Numerical.MillingToolOffsetTable.html">MillingToolOffsetTable</a></li> <li>Display and edit ideal radius and height values in <a class="xref" href="../../../api/Hi.Numerical.MillingToolOffsetTable.html">MillingToolOffsetTable</a></li>
<li>Configure radial and axial wear values</li> <li>Configure radial and axial wear values</li>
<li>Option to automatically set ideal offset based on the <a class="xref" href="../../../../api/Hi.Machining.MachiningToolHouse.html">MachiningToolHouse</a> configuration</li> <li>Option to automatically set ideal offset based on the <a class="xref" href="../../../api/Hi.Machining.MachiningToolHouse.html">MachiningToolHouse</a> configuration</li>
<li>Add new tool offset entries (when not using tool house dependency)</li> <li>Add new tool offset entries (when not using tool house dependency)</li>
</ul> </ul>
<h3 id="machine-configuration">Machine Configuration</h3> <h3 id="machine-configuration">Machine Configuration</h3>
<p>Controls machine-specific settings:</p> <p>Controls machine-specific settings:</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_RapidFeedrate_mmdmin">RapidFeedrate_mmdmin</a> (mm/min)</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_RapidFeedrate_mmdmin">RapidFeedrate_mmdmin</a> (mm/min)</li>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_ToolingTime">ToolingTime</a> (seconds)</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_ToolingTime">ToolingTime</a> (seconds)</li>
<li>Stroke limits (minimum and maximum) for linear axes (<a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitXyz_mm">StrokeLimitXyz_mm</a>)</li> <li>Stroke limits (minimum and maximum) for linear axes (<a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitXyz_mm">StrokeLimitXyz_mm</a>)</li>
<li>Stroke limits and maximum speeds for rotary axes (<a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitAbc_rad">StrokeLimitAbc_rad</a> and <a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_MaxRotarySpeedABC_radds">MaxRotarySpeedABC_radds</a>)</li> <li>Stroke limits and maximum speeds for rotary axes (<a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_StrokeLimitAbc_rad">StrokeLimitAbc_rad</a> and <a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_MaxRotarySpeedABC_radds">MaxRotarySpeedABC_radds</a>)</li>
</ul> </ul>
<h3 id="brand-selection">Brand Selection</h3> <h3 id="brand-selection">Brand Selection</h3>
<p>Allows switching between different CNC controller brands via <a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_CncBrand">CncBrand</a>:</p> <p>Allows switching between different CNC controller brands via <a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_CncBrand">CncBrand</a>:</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Syntec">Syntec</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Syntec">Syntec</a></li>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Fanuc">Fanuc</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Fanuc">Fanuc</a></li>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Heidenhain">Heidenhain</a></li>
<li><a class="xref" href="../../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Siemens">Siemens</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.CncBrand.html#Hi_Numerical_CncBrand_Siemens">Siemens</a></li>
</ul> </ul>
<p>Each brand may have specialized settings that appear when selected.</p> <p>Each brand may have specialized settings that appear when selected.</p>
<h3 id="config-options">Config Options</h3> <h3 id="config-options">Config Options</h3>
<p>General configuration options including:</p> <p>General configuration options including:</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_SetToolHeightCompensationOnFeatureNormal">SetToolHeightCompensationOnFeatureNormal</a> setting</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_SetToolHeightCompensationOnFeatureNormal">SetToolHeightCompensationOnFeatureNormal</a> setting</li>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_EnableShortestRotary">EnableShortestRotary</a> optimization</li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html#Hi_Numerical_NcEnv_EnableShortestRotary">EnableShortestRotary</a> optimization</li>
</ul> </ul>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-locations">Source Code Locations</h2>
<p>See <a href="../index.html">this page</a> for git repository.</p> <p>See <a href="../index.html">HiNC GUI Architecture</a> for git repository links.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3> <h3 id="wpf-application">WPF Application</h3>
<ul> <ul>
<li>Numerical/Controller/ControllerWindow</li> <li>Numerical/Controller/ControllerWindow</li>
<li>Numerical/Controller/IsoCoordinateTablePanel</li> <li>Numerical/Controller/IsoCoordinateTablePanel</li>
@ -277,7 +277,7 @@ See Rendering Items SubMenu from <a href="../player/player-extended-renderingcan
<li>Numerical/Controller/DatumShiftTablePanel</li> <li>Numerical/Controller/DatumShiftTablePanel</li>
<li>Numerical/Controller/ControllerExtendedRenderingCanvasToolBar</li> <li>Numerical/Controller/ControllerExtendedRenderingCanvasToolBar</li>
</ul> </ul>
<h3 id="web-page-application-source-code-path">Web Page Application Source Code Path</h3> <h3 id="web-application">Web Application</h3>
<ul> <ul>
<li>Controller/ControllerController.cs - Backend API controller</li> <li>Controller/ControllerController.cs - Backend API controller</li>
<li>wwwroot/controller/controller-panel.html - Main HTML structure</li> <li>wwwroot/controller/controller-panel.html - Main HTML structure</li>

24
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/controller/web-implementation.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/controller/web-implementation.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Controller Page Web Implementation | HiAPI-C# 2025 "> <meta name="title" content="Controller Page Web Implementation | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -193,15 +193,15 @@
<h3 id="with-project-service">With Project Service</h3> <h3 id="with-project-service">With Project Service</h3>
<p>The controller utilizes the <code>IProjectService</code> to:</p> <p>The controller utilizes the <code>IProjectService</code> to:</p>
<ul> <ul>
<li>Access the current <a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></li> <li>Access the current <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></li>
<li>Retrieve and update <a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html">NcEnv</a> settings</li> <li>Retrieve and update <a class="xref" href="../../../api/Hi.Numerical.NcEnv.html">NcEnv</a> settings</li>
<li>Save changes to the project</li> <li>Save changes to the project</li>
</ul> </ul>
<h3 id="with-rendering-engine">With Rendering Engine</h3> <h3 id="with-rendering-engine">With Rendering Engine</h3>
<p>The controller page integrates with:</p> <p>The controller page integrates with:</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a> for 3D visualization</li> <li><a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a> for 3D visualization</li>
<li><a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> for rendering project data</li> <li><a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProjectDisplayee.html">MachiningProjectDisplayee</a> for rendering project data</li>
<li>Custom rendering flags for controller-specific visualizations</li> <li>Custom rendering flags for controller-specific visualizations</li>
</ul> </ul>
<h2 id="key-differences-from-wpf-implementation">Key Differences from WPF Implementation</h2> <h2 id="key-differences-from-wpf-implementation">Key Differences from WPF Implementation</h2>

39
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/general-rules.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/general-rules.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="General Rules | HiAPI-C# 2025 "> <meta name="title" content="General Rules | HiAPI-C# 2025 ">
<link rel="icon" href="../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../public/docfx.min.css"> <link rel="stylesheet" href="../../public/docfx.min.css">
<link rel="stylesheet" href="../../../public/main.css"> <link rel="stylesheet" href="../../public/main.css">
<meta name="docfx:navrel" content="../../../toc.html"> <meta name="docfx:navrel" content="../../toc.html">
<meta name="docfx:tocrel" content="../toc.html"> <meta name="docfx:tocrel" content="../toc.html">
<meta name="docfx:rel" content="../../../"> <meta name="docfx:rel" content="../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../public/docfx.min.js"></script> <script type="module" src="./../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../index.html"> <a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,12 +87,9 @@
<article data-uid=""> <article data-uid="">
<h1 id="general-rules">General Rules</h1> <h1 id="general-rules">General Rules</h1>
<div class="TIP"> <p>This document describes the common patterns and conventions used throughout the HiNC GUI codebase.</p>
<h5>Tip</h5> <h2 id="message-and-exception-handling">Message and Exception Handling</h2>
<p>You MUST read the cited hyperlink before you do the job. ASK if you think the hyperlink is not work.</p> <p>The HiNC applications use <a class="xref" href="../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> to display user-facing messages, and <a class="xref" href="../../api/Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a class="xref" href="../../api/Hi.Common.ExceptionUtil.html#Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_">ShowException(Exception, object)</a> to handle exceptions with detailed treatment. All messages are displayed in the <a href="message-section-on-main-panel.html">Message Section on Main Panel</a>.</p>
</div>
<h2 id="handle-message-and-exception">Handle Message and Exception</h2>
<p>If message is well-managed, apply <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> to show the message; if the message is <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>, apply <a class="xref" href="../../../api/Hi.Common.ExceptionUtil.html">ExceptionUtil</a>.<a class="xref" href="../../../api/Hi.Common.ExceptionUtil.html#Hi_Common_ExceptionUtil_ShowException_System_Exception_System_Object_">ShowException(Exception, object)</a> to show the exception for detail treatment. The messages are shown in <a href="message-section-on-main-panel.html">Message Section on Main Panel</a>.</p>
<p>For examples of message and exception handling patterns:</p> <p>For examples of message and exception handling patterns:</p>
<ol> <ol>
<li>Normal message handling:</li> <li>Normal message handling:</li>
@ -124,15 +121,17 @@ catch (Exception ex)
</code></pre> </code></pre>
<p>The examples are in project Hi.Sample. See <a href="index.html">this page</a> for git repository.</p> <p>The examples are in project Hi.Sample. See <a href="index.html">this page</a> for git repository.</p>
<h2 id="loose-manner">Loose Manner</h2> <h2 id="loose-manner">Loose Manner</h2>
<p>Run Skippable Rapid Calling Synchronous Action in Loose Manner.</p> <p>The Loose Manner pattern handles rapidly-called synchronous actions where only the last call needs to be effective.</p>
<p>Some synchronous action may be calling rapidly but only the last call has to be effective (or it is endurable to loss some previous action call). Define a <a class="xref" href="../../../api/Hi.Common.LooseRunner.html">LooseRunner</a> and apply <a class="xref" href="../../../api/Hi.Common.LooseRunner.html#Hi_Common_LooseRunner_TryRun_">TryRun</a> to run the action.</p> <p>The <a class="xref" href="../../api/Hi.Common.LooseRunner.html">LooseRunner</a> class manages skippable rapid-calling synchronous actions. When an action is called rapidly, only the last call is executed while previous calls are safely skipped. The <a class="xref" href="../../api/Hi.Common.LooseRunner.html#Hi_Common_LooseRunner_TryRun_">TryRun</a> method is used to execute actions in this manner.</p>
<p>Dispose the <a class="xref" href="../../../api/Hi.Common.LooseRunner.html">LooseRunner</a> on owner disposing to ensure the tryrun action is well-managed.</p> <p>The <a class="xref" href="../../api/Hi.Common.LooseRunner.html">LooseRunner</a> should be disposed when its owner is disposed to ensure proper resource cleanup.</p>
<h2 id="gui-file-path-assignment">GUI File Path Assignment</h2> <h2 id="gui-file-path-assignment">GUI File Path Assignment</h2>
<p>See <a href="widget/gui-file-path-assignment.html">GUI File Path Assignment</a>.</p> <p>See <a href="widget/gui-file-path-assignment.html">GUI File Path Assignment</a>.</p>
<h2 id="numeric-inputoutput-handling">Numeric Input/Output Handling</h2> <h2 id="numeric-inputoutput-handling">Numeric Input/Output Handling</h2>
<p>Implement a <code>numeric-utils.js</code> module to handle special floating-point values in web forms. See <a href="widget/numeric-io-utilities.html">Numeric Input/Output Utilities</a> for implementation details.</p> <p>The <code>numeric-utils.js</code> module handles special floating-point values (such as NaN, Infinity) in web forms. See <a href="widget/numeric-io-utilities.html">Numeric Input/Output Utilities</a> for details.</p>
<h2 id="dictionaryservice-pattern-for-hierarchical-components">DictionaryService Pattern for Hierarchical Components</h2> <h2 id="webapi-with-hub-cleapup-assistence-pattern">Webapi with hub-cleapup assistence pattern</h2>
<p>For web applications with hierarchical SignalR hub connections, use the <a href="common/dictionary-service-pattern.html">DictionaryService and DictionaryHub Pattern</a> to manage connection-scoped object indexing. This pattern provides isolation between components, supports nested components without conflicts, and ensures automatic cleanup of resources on disconnect.</p> <p><a href="common/webapi-with-hub-cleanup-assistence-pattern.html">Webapi with hub-cleapup assistence pattern</a></p>
<h2 id="loose-couple">Loose Couple</h2>
<p>If model of the UI component is null or mismatch, apply status badge instead of throwing exception to keep UI work.</p>
<h2 id="translation-remarks">Translation Remarks</h2> <h2 id="translation-remarks">Translation Remarks</h2>
<p>See <a href="translation-remarks.html">Translation Remarks</a>.</p> <p>See <a href="translation-remarks.html">Translation Remarks</a>.</p>

18
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/box3d-control.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/box3d-control.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Box3dControl | HiAPI-C# 2025 "> <meta name="title" content="Box3dControl | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -110,7 +110,7 @@
<li><strong>Center</strong> Vec3dControl</li> <li><strong>Center</strong> Vec3dControl</li>
</ol> </ol>
<p>The sub-edit mode rules the controls to readonly or editable.</p> <p>The sub-edit mode rules the controls to readonly or editable.</p>
<p>Since the native of <a class="xref" href="../../../../api/Hi.Geom.Box3d.html">Box3d</a> is that only Min and Max Properties are editable, the other mode requires little additional logic to take effect.</p> <p>Since the native of <a class="xref" href="../../../api/Hi.Geom.Box3d.html">Box3d</a> is that only Min and Max Properties are editable, the other mode requires little additional logic to take effect.</p>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../index.html">this page</a> for git repository.</p> <p>See <a href="../index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3> <h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>

16
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/cylindroid-control.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/cylindroid-control.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="CylindroidControl | HiAPI-C# 2025 "> <meta name="title" content="CylindroidControl | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">

18
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/extended-cylinder-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/extended-cylinder-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Extended Cylinder Panel | HiAPI-C# 2025 "> <meta name="title" content="Extended Cylinder Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,7 +87,7 @@
<article data-uid=""> <article data-uid="">
<h1 id="extended-cylinder-panel">Extended Cylinder Panel</h1> <h1 id="extended-cylinder-panel">Extended Cylinder Panel</h1>
<p>The model is <a class="xref" href="../../../../api/Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a>.</p> <p>The model is <a class="xref" href="../../../api/Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Extended Cylinder Panel <li>Extended Cylinder Panel

16
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-combination-control.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/geom-combination-control.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="GeomCombinationControl | HiAPI-C# 2025 "> <meta name="title" content="GeomCombinationControl | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">

40
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-manage-control.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/geom-manage-control.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Geometry Management Panel | HiAPI-C# 2025 "> <meta name="title" content="Geometry Management Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,10 +87,10 @@
<article data-uid=""> <article data-uid="">
<h1 id="geometry-management-panel">Geometry Management Panel</h1> <h1 id="geometry-management-panel">Geometry Management Panel</h1>
<p>Geometry Management Panel get and set a TargetGeometry <a class="xref" href="../../../../api/Hi.Geom.IStlSource.html">IStlSource</a>.</p> <p>Geometry Management Panel get and set a TargetGeometry <a class="xref" href="../../../api/Hi.Geom.IStlSource.html">IStlSource</a>.</p>
<p>null is acceptable for TargetGeometry.</p> <p>null is acceptable for TargetGeometry.</p>
<p>The TargetGeometry can be convert to <a class="xref" href="../../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a> or get out of the <a class="xref" href="../../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a>. The conversion button can be hide by the code-behind property.</p> <p>The TargetGeometry can be convert to <a class="xref" href="../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a> or get out of the <a class="xref" href="../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a>. The conversion button can be hide by the code-behind property.</p>
<p>The TargetGeometry can be convert to <a class="xref" href="../../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a> or get out of the <a class="xref" href="../../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a> if there is only one geometry in <a class="xref" href="../../../../api/Hi.Geom.GeomCombination.html#Hi_Geom_GeomCombination_StlSources">StlSources</a>. The conversion button can be hide by the code-behind property.</p> <p>The TargetGeometry can be convert to <a class="xref" href="../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a> or get out of the <a class="xref" href="../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a> if there is only one geometry in <a class="xref" href="../../../api/Hi.Geom.GeomCombination.html#Hi_Geom_GeomCombination_StlSources">StlSources</a>. The conversion button can be hide by the code-behind property.</p>
<p>The geometry type in the</p> <p>The geometry type in the</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
@ -99,8 +99,8 @@
<li>Geometry Selection and Conversion Bar <li>Geometry Selection and Conversion Bar
<ul> <ul>
<li>Geometry Type Selection Bar</li> <li>Geometry Type Selection Bar</li>
<li><a class="xref" href="../../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a> Conversion Button</li> <li><a class="xref" href="../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a> Conversion Button</li>
<li><a class="xref" href="../../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a> Conversion Button</li> <li><a class="xref" href="../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a> Conversion Button</li>
</ul> </ul>
</li> </li>
<li>Content Panel (varied by the TargetGeometry)</li> <li>Content Panel (varied by the TargetGeometry)</li>
@ -111,16 +111,16 @@
<p>See <a href="index.html">Geometry Panels</a> for the various geometry type.</p> <p>See <a href="index.html">Geometry Panels</a> for the various geometry type.</p>
<p>The geometries are availible by default:</p> <p>The geometries are availible by default:</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Geom.Box3d.html">Box3d</a></li> <li><a class="xref" href="../../../api/Hi.Geom.Box3d.html">Box3d</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.Cylindroid.html">Cylindroid</a></li> <li><a class="xref" href="../../../api/Hi.Geom.Cylindroid.html">Cylindroid</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.StlFile.html">StlFile</a></li> <li><a class="xref" href="../../../api/Hi.Geom.StlFile.html">StlFile</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a></li> <li><a class="xref" href="../../../api/Hi.Geom.TransformationGeom.html">TransformationGeom</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a></li> <li><a class="xref" href="../../../api/Hi.Geom.GeomCombination.html">GeomCombination</a></li>
</ul> </ul>
<p>The geometries are default hiding but they can be code-behind optionally enabled:</p> <p>The geometries are default hiding but they can be code-behind optionally enabled:</p>
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Cbtr.CubeTree.html">CubeTree</a></li> <li><a class="xref" href="../../../api/Hi.Cbtr.CubeTree.html">CubeTree</a></li>
<li><a class="xref" href="../../../../api/Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a></li> <li><a class="xref" href="../../../api/Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a></li>
</ul> </ul>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../index.html">this page</a> for git repository.</p> <p>See <a href="../index.html">this page</a> for git repository.</p>

114
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/renderingcanvas-tool-bar.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/index.html
View File

@ -2,16 +2,16 @@
<html> <html>
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>RenderingCanvas Tool Bar | HiAPI-C# 2025 </title> <title>Geometry Panels | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="RenderingCanvas Tool Bar | HiAPI-C# 2025 "> <meta name="title" content="Geometry Panels | HiAPI-C# 2025 ">
<link rel="icon" href="../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../"> <meta name="docfx:rel" content="../../../">
@ -85,48 +85,80 @@
</div> </div>
<article data-uid=""> <article data-uid="">
<h1 id="renderingcanvas-tool-bar">RenderingCanvas Tool Bar</h1> <h1 id="geometry-panels">Geometry Panels</h1>
<p>The model of the RenderingCanvas Tool Bar is <a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.</p> <p>The Geometry Panels provide GUI components for editing <a href="../../basic/geom/basic-geometry.html">Geometry Objects</a>. The <a href="geom-manage-control.html">Geometry Management Control</a> handles geometry selection, modification, and lifecycle management.</p>
<h2 id="layout-and-behavior">Layout and Behavior</h2> <h2 id="basic-geometry-controls">Basic Geometry Controls</h2>
<table>
<thead>
<tr>
<th>Control</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="box3d-control.html">Box3dControl</a></td>
<td>Edits a 3D box defined by min/max coordinates</td>
</tr>
<tr>
<td><a href="cylindroid-control.html">CylindroidControl</a></td>
<td>Edits a cylindroid with radius values along Z-axis</td>
</tr>
<tr>
<td><a href="stlfile-control.html">StlFileControl</a></td>
<td>Loads and manipulates STL files</td>
</tr>
</tbody>
</table>
<h2 id="transformation-controls">Transformation Controls</h2>
<table>
<thead>
<tr>
<th>Control</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="transformation-geom-control.html">TransformationGeomControl</a></td>
<td>Applies transformations to geometric objects</td>
</tr>
<tr>
<td><a href="geom-combination-control.html">GeomCombinationControl</a></td>
<td>Combines multiple geometric objects</td>
</tr>
</tbody>
</table>
<h2 id="special-controls">Special Controls</h2>
<table>
<thead>
<tr>
<th>Control</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="runtime-geom-panel.html">Runtime Geometry Panel</a></td>
<td>Manages runtime geometry (not <a class="xref" href="../../../api/Hi.Geom.IStlSource.html">IStlSource</a>, but follows similar patterns)</td>
</tr>
<tr>
<td><a href="extended-cylinder-panel.html">Extended Cylinder Panel</a></td>
<td>Extended cylindrical geometry editing</td>
</tr>
</tbody>
</table>
<h2 id="source-code-locations">Source Code Locations</h2>
<p>See <a href="../index.html">HiNC GUI Architecture</a> for git repository links.</p>
<h3 id="wpf-application">WPF Application</h3>
<ul> <ul>
<li><code>View Buttons SubMenu</code> <li><code>Geom/</code></li>
<ul>
<li>Front View Button
Call DispEngine.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToFrontView">SetViewToFrontView()</a>.</li>
<li>Back View Button
Call DispEngine.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToFrontView">SetViewToFrontView()</a> and turn back the view by the code:<pre><code class="lang-csharp" name="SampleCode">DispEngine.SetViewToFrontView();
DispEngine.TurnBackView();
</code></pre></li>
<li>Right View Button
...(refer the instruction above)</li>
<li>Left View Button
...</li>
<li>Top View Button
...</li>
<li>Bottom View Button
...</li>
<li>Isometric View Button
...</li>
</ul> </ul>
</li> <h3 id="web-application">Web Application</h3>
<li>(other RenderingCanvas tool bar item may be appended here)</li>
</ul>
<h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>
<ul> <ul>
<li>Disp/RenderingCanvasToolBar</li> <li><code>wwwroot/geom/</code></li>
</ul> <li><code>Geom/GeomHub.cs</code></li>
<h3 id="webapi-application-source-code-path">Webapi Application Source Code Path</h3>
<p>Frontend:</p>
<ul>
<li>wwwroot/disp/rendering-canvas-tool-bar.js</li>
</ul>
<p>Backend (C#):</p>
<ul>
<li>Disp/RenderingHub.cs - Contains the <code>SetView</code> method that handles view changes from the toolbar</li>
<li>Disp/RenderingService.cs - Manages DispEngine instances</li>
</ul> </ul>
</article> </article>

20
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/runtime-geom-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/runtime-geom-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Runtime Geometry Panel | HiAPI-C# 2025 "> <meta name="title" content="Runtime Geometry Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,10 +87,10 @@
<article data-uid=""> <article data-uid="">
<h1 id="runtime-geometry-panel">Runtime Geometry Panel</h1> <h1 id="runtime-geometry-panel">Runtime Geometry Panel</h1>
<p>Key model is <a class="xref" href="../../../../api/Hi.Cbtr.CubeTreeFile.html">CubeTreeFile</a>.</p> <p>Key model is <a class="xref" href="../../../api/Hi.Cbtr.CubeTreeFile.html">CubeTreeFile</a>.</p>
<div class="NOTE"> <div class="NOTE">
<h5>Note</h5> <h5>Note</h5>
<p>The term Runtime Geometry is <a class="xref" href="../../../../api/Hi.Cbtr.CubeTree.html">CubeTree</a>.</p> <p>The term Runtime Geometry is <a class="xref" href="../../../api/Hi.Cbtr.CubeTree.html">CubeTree</a>.</p>
</div> </div>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>

16
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/stlfile-control.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/stlfile-control.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="StlFileControl | HiAPI-C# 2025 "> <meta name="title" content="StlFileControl | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">

16
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/transformation-geom-control.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/geom/transformation-geom-control.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="TransformationGeomControl | HiAPI-C# 2025 "> <meta name="title" content="TransformationGeomControl | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">

16
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/hinc-web-service/disp-web-service.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/hinc-web-service/disp-web-service.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Rendering Canvas on Web Service Application | HiAPI-C# 2025 "> <meta name="title" content="Rendering Canvas on Web Service Application | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">

188
App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/index.html Normal file
View File

@ -0,0 +1,188 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>HiNC GUI Architecture | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="HiNC GUI Architecture | 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="">
<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="">
<h1 id="hinc-gui-architecture">HiNC GUI Architecture</h1>
<p>This section provides an architectural overview of the HiNC GUI applications. The <a href="general-rules.html">General Rules</a> document describes common patterns and conventions used throughout the codebase.</p>
<h2 id="source-code-repositories">Source Code Repositories</h2>
<h3 id="wpf-desktop-application">WPF Desktop Application</h3>
<p>The HiNC-2025-win-desktop project provides a native Windows desktop application built with WPF.</p>
<ul>
<li>Repository: <a href="https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-win-desktop.git">https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-win-desktop.git</a></li>
</ul>
<h3 id="web-service-application">Web Service Application</h3>
<p>The HiNC-2025-webservice project provides a web-based application using Vue.js for the frontend and ASP.NET Core for the backend.</p>
<ul>
<li>Repository: <a href="https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-webservice.git">https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-webservice.git</a></li>
</ul>
<h2 id="architecture-patterns">Architecture Patterns</h2>
<p>The following architectural patterns are used in the HiNC GUI applications:</p>
<ul>
<li><a href="common/dictionary-service-pattern.html">DictionaryService and DictionaryHub Pattern</a> - Connection-scoped object indexing for hierarchical components</li>
<li><a href="hinc-web-service/disp-web-service.html">Rendering Canvas on Web Service</a> - WebSocket-based 3D canvas rendering architecture using SignalR Hub</li>
</ul>
<h2 id="gui-component-structure">GUI Component Structure</h2>
<p>The HiNC GUI is organized into the following major components:</p>
<h3 id="core-framework">Core Framework</h3>
<ul>
<li><a href="initialize-hiapi.html">Initialize HiAPI</a> - Application initialization and HiAPI setup</li>
<li><a href="main-panel.html">Main Panel</a> - The main window layout and navigation structure</li>
<li><a href="message-section-on-main-panel.html">Message Section</a> - Status and message display area</li>
</ul>
<h3 id="rendering-and-visualization">Rendering and Visualization</h3>
<ul>
<li><a href="renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a> - 3D view control toolbar</li>
<li><a href="player/index.html">Player Panel</a> - Simulation playback and visualization</li>
</ul>
<h3 id="configuration-panels">Configuration Panels</h3>
<ul>
<li><a href="preference/index.html">Preference Menu</a> - Application settings and preferences</li>
<li><a href="preference/graphic-cache-dropdown.html">Graphic-Cache Dropdown</a> - Graphics caching configuration</li>
</ul>
<h3 id="geometry-and-mechanism">Geometry and Mechanism</h3>
<ul>
<li><a href="widget/vec3d/index.html">Widget Components</a> - Reusable GUI widgets (Vec3dControl, etc.)</li>
<li><a href="geom/index.html">Geometry Panels</a> - Geometry definition and management</li>
<li><a href="mech/topo/transformers.html">Transformers</a> - Coordinate transformation components</li>
<li><a href="mech/fixture-page.html">Fixture Page</a> - Fixture configuration</li>
<li><a href="mech/workpiece-page.html">Workpiece Page</a> - Workpiece definition</li>
<li><a href="mech/tool-house-page.html">ToolHouse Page</a> - Tool library management</li>
</ul>
<h3 id="operation">Operation</h3>
<ul>
<li><a href="controller/index.html">Controller Page</a> - Machine controller settings</li>
<li><a href="mission/index.html">Mission Page</a> - Machining mission management</li>
</ul>
<h2 id="building-a-new-hinc-application">Building a New HiNC Application</h2>
<div class="TIP">
<h5>Tip</h5>
<p>To build a new HiNC GUI application from scratch, see <a href="../getting-started/index.html">Getting Started</a> for package configuration and setup instructions.</p>
</div>
<p>If you are building a new application, the following checklist provides a recommended implementation order:</p>
<ol>
<li>Create and configure an application project (x64 platform, add <code>HiNc</code> packages, add <code>Hi.WpfPlus</code> for WPF).</li>
<li>Create Main Window with <a href="main-panel.html#layout-structure">Main Panel Layout</a>.</li>
<li>Implement <a href="message-section-on-main-panel.html">Message Section</a>.</li>
<li><a href="initialize-hiapi.html">Initialize HiAPI</a> at application entry point.</li>
<li>Set up <a href="main-panel.html#project-menu-behavior">Navigation Menu/Project</a> behavior.</li>
<li>Create <a href="renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a>.</li>
<li>Implement <a href="player/index.html">Player Panel</a>.</li>
<li>Implement <a href="preference/graphic-cache-dropdown.html">Graphic-Cache Dropdown</a>.</li>
<li>Build widget components (<a href="widget/vec3d/index.html">Vec3dControl</a>, etc.).</li>
<li>Build <a href="mech/topo/transformers.html">Transformers</a>, <a href="geom/index.html">Geometry Panels</a>.</li>
<li>Build <a href="mech/fixture-page.html">Fixture Page</a>, <a href="mech/workpiece-page.html">Workpiece Page</a>, <a href="controller/index.html">Controller Page</a>, <a href="mech/tool-house-page.html">ToolHouse Page</a>.</li>
</ol>
<div class="NOTE">
<h5>Note</h5>
<p>If you are using an AI agent to build the application, ask the AI to do only one job at a time to ensure quality. Compile to verify code works after each step.</p>
</div>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></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>

130
App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/initialize-hiapi.html Normal file
View File

@ -0,0 +1,130 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>HiAPI Initialization | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="HiAPI Initialization | 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="">
<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="">
<h1 id="hiapi-initialization">HiAPI Initialization</h1>
<p>The HiNC applications initialize HiAPI at the application entry point using the following methods:</p>
<ul>
<li><a class="xref" href="../../api/Hi.HiNcKits.LocalApp.html#Hi_HiNcKits_LocalApp_AppBegin_">AppBegin</a> - Called at application startup</li>
<li><a class="xref" href="../../api/Hi.HiNcKits.LocalApp.html#Hi_HiNcKits_LocalApp_AppEnd_">AppEnd</a> - Called on application shutdown</li>
</ul>
<p>These methods handle the initialization and release of:</p>
<ul>
<li>Licensing</li>
<li>Display engine</li>
<li>Background resources</li>
</ul>
<div class="IMPORTANT">
<h5>Important</h5>
<p>Both DI-based and legacy flow implementations require calling <code>LocalApp.AppBegin()</code> at startup and <code>LocalApp.AppEnd()</code> on shutdown.</p>
</div>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></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>

126
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/main-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/main-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Main Panel | HiAPI-C# 2025 "> <meta name="title" content="Main Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../public/docfx.min.css"> <link rel="stylesheet" href="../../public/docfx.min.css">
<link rel="stylesheet" href="../../../public/main.css"> <link rel="stylesheet" href="../../public/main.css">
<meta name="docfx:navrel" content="../../../toc.html"> <meta name="docfx:navrel" content="../../toc.html">
<meta name="docfx:tocrel" content="../toc.html"> <meta name="docfx:tocrel" content="../toc.html">
<meta name="docfx:rel" content="../../../"> <meta name="docfx:rel" content="../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../public/docfx.min.js"></script> <script type="module" src="./../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../index.html"> <a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,16 +87,18 @@
<article data-uid=""> <article data-uid="">
<h1 id="main-panel">Main Panel</h1> <h1 id="main-panel">Main Panel</h1>
<p>The Main Panel is the primary window of the HiNC application, providing navigation and access to all major features.</p>
<h2 id="key-models">Key Models</h2>
<ul> <ul>
<li>Key Model <li>Project Service
<ul> <ul>
<li>WPF Single-User Desktop Application: Self-hosted <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a></li> <li><strong>WPF Single-User Desktop Application</strong>: Uses self-hosted <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a></li>
<li>Web Service Application: Service inherits from <a class="xref" href="../../../api/Hi.MachiningProcs.IProjectService.html">IProjectService</a></li> <li><strong>Web Service Application</strong>: Service inherits from <a class="xref" href="../../api/Hi.MachiningProcs.IProjectService.html">IProjectService</a></li>
</ul> </ul>
</li> </li>
<li>Other Model: <a class="xref" href="../../../api/Hi.HiNcKits.UserService.html">UserService</a></li> <li><strong>User Service</strong>: <a class="xref" href="../../api/Hi.HiNcKits.UserService.html">UserService</a></li>
</ul> </ul>
<h2 id="main-panel-layout"><code>Main Panel</code> Layout</h2> <h2 id="layout-structure">Layout Structure</h2>
<ul> <ul>
<li>Top <code>Navigation Menu</code> <li>Top <code>Navigation Menu</code>
<ul> <ul>
@ -114,7 +116,7 @@
<li>Machine Tool MenuItem <li>Machine Tool MenuItem
Open <a href="mech/machining-chain-page.html">Machine Tool Page</a> Open <a href="mech/machining-chain-page.html">Machine Tool Page</a>
Sole window in WPF app. Sole window in WPF app.
The page manages <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_MachiningEquipment">MachiningEquipment</a>.<a class="xref" href="../../../api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningChain">MachiningChain</a>.</li> The page manages <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_MachiningEquipment">MachiningEquipment</a>.<a class="xref" href="../../api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html#Hi_Machining_MachiningEquipmentUtils_MachiningEquipment_MachiningChain">MachiningChain</a>.</li>
<li>Controller MenuItem <li>Controller MenuItem
Open <a href="controller/index.html">Controller Page</a></li> Open <a href="controller/index.html">Controller Page</a></li>
<li>Tool House MenuItem</li> <li>Tool House MenuItem</li>
@ -147,48 +149,70 @@ Users can refresh the log content or download the current day's log file for off
<li>Central <code>Page Panel</code></li> <li>Central <code>Page Panel</code></li>
<li><a href="message-section-on-main-panel.html">Message Section on Main Panel</a></li> <li><a href="message-section-on-main-panel.html">Message Section on Main Panel</a></li>
</ul> </ul>
<h2 id="behavior-of-navigation-menuproject">Behavior of <code>Navigation Menu</code>/<code>Project</code></h2> <h2 id="project-menu-behavior">Project Menu Behavior</h2>
<p><code>Project Path Text Field</code> Shows the Project Path if the project is assinged.</p> <p>The <code>Project Path Text Field</code> displays the current project path when a project is loaded. It is implemented as a pure text field (not a button) that allows users to select and copy the path.</p>
<div class="TIP"> <p>The <code>Project</code> Menu manages <a class="xref" href="../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a> with the following operations:</p>
<h5>Tip</h5> <table>
<p><code>Project Path Text Field</code> should not be button style. It should be a pure text field that can be selected and copied.</p> <thead>
<tr>
<th>Operation</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>New</td>
<td>Creates a new project</td>
<td>See <a class="xref" href="../../sample/Sample.Machining.DemoBuildGeomOnlyMachiningProject.html">DemoBuildGeomOnlyMachiningProject</a></td>
</tr>
<tr>
<td>Load</td>
<td>Opens an existing project</td>
<td>See <a class="xref" href="../../sample/Sample.Machining.DemoUseMachiningProject.html">DemoUseMachiningProject</a></td>
</tr>
<tr>
<td>Save</td>
<td>Saves the current project</td>
<td>See <a class="xref" href="../../sample/Sample.Machining.DemoBuildGeomOnlyMachiningProject.html">DemoBuildGeomOnlyMachiningProject</a></td>
</tr>
<tr>
<td>Save As</td>
<td>Saves the project to a new location</td>
<td>See <a class="xref" href="../../sample/Sample.Machining.DemoBuildGeomOnlyMachiningProject.html">DemoBuildGeomOnlyMachiningProject</a></td>
</tr>
</tbody>
</table>
<p>All operation results (success or exception) are displayed via <a class="xref" href="../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a>. When a project is loaded, the Player Panel's RenderingCanvas is set to isometric view using <a class="xref" href="../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a>.</p>
<div class="NOTE">
<h5>Note</h5>
<p>The implementation uses static functions of <a class="xref" href="../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> for message handling. Async operations ensure smooth user experience during file I/O.</p>
</div> </div>
<p>The <code>Project</code> Menu Managing <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>.</p> <h2 id="platform-specific-differences">Platform-Specific Differences</h2>
<p>To <code>New</code> (create), <code>Save</code> and <code>Save As</code> the <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>, See <a class="xref" href="../../sample/Sample.Machining.DemoBuildGeomOnlyMachiningProject.html">DemoBuildGeomOnlyMachiningProject</a> for the example.</p> <h3 id="wpf-application">WPF Application</h3>
<p>To <code>Load</code> <a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a>, See <a class="xref" href="../../sample/Sample.Machining.DemoUseMachiningProject.html">DemoUseMachiningProject</a> for the example.</p>
<p>Show message for the actions result (successed or has exception) by <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a>.</p>
<div class="TIP">
<h5>Tip</h5>
<p>Recommmand using static function of <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> to do the job.
Read document of <a class="xref" href="../../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a> to ensure the proper usage.</p>
</div>
<p>On project loaded (<code>Navigation Menu</code>/<code>Project</code>/<code>Load MenuItem</code>)
, set the Player.Panel.RenderingCanvas.DispEngine to <a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a>.</p>
<div class="TIP">
<h5>Tip</h5>
<p>Using async to comfort the process</p>
</div>
<h2 id="wpf-application-specification">WPF Application Specification</h2>
<p>Limit the GUI that only single Page/Window existed in the application for the sub window from the Main Panel, include Mission, Workpiece and Fixture.</p>
<p>Don't create the Player MenuItem if the target application is WPF Application. Since the Main panel is the Player Panel and the panel is fixed to the main panel.</p>
<h2 id="web-page-application-specification">Web-Page Application Specification</h2>
<p>Apply Player Panel as the default panel.</p>
<h2 id="application-specification-and-source-code-path">Application Specification and Source Code Path</h2>
<p>See <a href="index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>
<ul> <ul>
<li>MainWindow</li> <li>Only a single instance of each sub-window (Mission, Workpiece, Fixture) can exist at a time</li>
<li>The Player MenuItem does not exist in the WPF version, as the Main Panel itself serves as the Player Panel</li>
</ul> </ul>
<h3 id="web-page-application-source-code-path">Web Page Application Source Code Path</h3> <h3 id="web-application">Web Application</h3>
<ul> <ul>
<li>Environments/PreferenceController.cs</li> <li>The Player Panel is the default panel displayed on the main page</li>
<li>Environments/ProjectController.cs</li> <li>The page URL and panel state are synchronized (bi-directional navigation)</li>
<li>wwwroot/app.js</li> </ul>
<li>wwwroot/index.html</li> <h2 id="source-code-locations">Source Code Locations</h2>
<li>wwwroot/preference/log-viewer.js</li> <p>See <a href="index.html">HiNC GUI Architecture</a> for git repository links.</p>
<h3 id="wpf-application-1">WPF Application</h3>
<ul>
<li><code>MainWindow</code></li>
</ul>
<h3 id="web-application-1">Web Application</h3>
<ul>
<li><code>Environments/PreferenceController.cs</code></li>
<li><code>Environments/ProjectController.cs</code></li>
<li><code>wwwroot/app.js</code></li>
<li><code>wwwroot/index.html</code></li>
<li><code>wwwroot/preference/log-viewer.js</code></li>
</ul> </ul>
<h3 id="web-page-application-specification-1">Web Page Application Specification</h3>
<p>The page and URL are bi-directional.</p>
</article> </article>

30
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/apt-profile-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/cutter/apt-profile-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="APT Profile Panel | HiAPI-C# 2025 "> <meta name="title" content="APT Profile Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,23 +87,23 @@
<article data-uid=""> <article data-uid="">
<h1 id="apt-profile-panel">APT Profile Panel</h1> <h1 id="apt-profile-panel">APT Profile Panel</h1>
<p>The main model is <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a> and its property <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a>.<a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a>.</p> <p>The main model is <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a> and its property <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a>.<a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a>.</p>
<p>See <a href="../../../../user-guide/zh-Hant/milling-tool/apt.html">APT Cutter Definition</a>. <a class="xref" href="../../../../../api/Hi.Milling.Apts.GeneralApt.html">GeneralApt</a> is the generalization of other <a class="xref" href="../../../../../api/Hi.Milling.Apts.IAptBased.html">IAptBased</a> types.</p> <p>See <a href="../../../../user-guide/zh-Hant/milling-tool/apt.html">APT Cutter Definition</a>. <a class="xref" href="../../../../api/Hi.Milling.Apts.GeneralApt.html">GeneralApt</a> is the generalization of other <a class="xref" href="../../../../api/Hi.Milling.Apts.IAptBased.html">IAptBased</a> types.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>APT Profile Panel <li>APT Profile Panel
<ul> <ul>
<li>Diameter Input Field (mm)</li> <li>Diameter Input Field (mm)</li>
<li>Round Radius Input Field (mm) <li>Round Radius Input Field (mm)
Visibly if <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../../api/Hi.Milling.Apts.IAptRc.html">IAptRc</a></li> Visibly if <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../api/Hi.Milling.Apts.IAptRc.html">IAptRc</a></li>
<li>Round Ring Radius Input Field(mm) <li>Round Ring Radius Input Field(mm)
Visibly if <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../../api/Hi.Milling.Apts.IAptRr.html">IAptRr</a></li> Visibly if <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../api/Hi.Milling.Apts.IAptRr.html">IAptRr</a></li>
<li>Round Ring Height Input Field(mm) <li>Round Ring Height Input Field(mm)
Visibly if <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../../api/Hi.Milling.Apts.IAptRz.html">IAptRz</a></li> Visibly if <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../api/Hi.Milling.Apts.IAptRz.html">IAptRz</a></li>
<li>Bottom Cone Angle Input Field (deg) <li>Bottom Cone Angle Input Field (deg)
Visibly if <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../../api/Hi.Milling.Apts.IAptAlpha.html">IAptAlpha</a></li> Visibly if <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../api/Hi.Milling.Apts.IAptAlpha.html">IAptAlpha</a></li>
<li>Top Cone Angle Input Field (deg) <li>Top Cone Angle Input Field (deg)
Visibly if <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../../api/Hi.Milling.Apts.IAptBeta.html">IAptBeta</a></li> Visibly if <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> is <a class="xref" href="../../../../api/Hi.Milling.Apts.IAptBeta.html">IAptBeta</a></li>
<li>Length of Cut Input Field (mm)</li> <li>Length of Cut Input Field (mm)</li>
</ul> </ul>
</li> </li>

32
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/freeform-remover-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/cutter/freeform-remover-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Freeform Remover Panel | HiAPI-C# 2025 "> <meta name="title" content="Freeform Remover Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,7 +87,7 @@
<article data-uid=""> <article data-uid="">
<h1 id="freeform-remover-panel">Freeform Remover Panel</h1> <h1 id="freeform-remover-panel">Freeform Remover Panel</h1>
<p>The key model is <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html">FreeformRemover</a>.</p> <p>The key model is <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html">FreeformRemover</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Freeform Remover Panel <li>Freeform Remover Panel
@ -98,7 +98,7 @@
<ul> <ul>
<li><a href="../../geom/geom-manage-control.html">Geometry Management Panel</a> <li><a href="../../geom/geom-manage-control.html">Geometry Management Panel</a>
<ul> <ul>
<li>Manages <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_StrutGeom">StrutGeom</a></li> <li>Manages <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_StrutGeom">StrutGeom</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -107,7 +107,7 @@
<ul> <ul>
<li><a href="../../geom/geom-manage-control.html">Geometry Management Panel</a> <li><a href="../../geom/geom-manage-control.html">Geometry Management Panel</a>
<ul> <ul>
<li>Manages <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_ShaperGeom">ShaperGeom</a></li> <li>Manages <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_ShaperGeom">ShaperGeom</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -115,11 +115,11 @@
<li>Anchor Tab <li>Anchor Tab
<ul> <ul>
<li>Label: Geometry Anchor To Holder Buckle</li> <li>Label: Geometry Anchor To Holder Buckle</li>
<li><a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_KeepHolderBuckleOnTop">KeepHolderBuckleOnTop</a> Checkbox</li> <li><a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_KeepHolderBuckleOnTop">KeepHolderBuckleOnTop</a> Checkbox</li>
<li><a href="../topo/transformers.html">Transformer Manage Panel</a> <li><a href="../topo/transformers.html">Transformer Manage Panel</a>
<ul> <ul>
<li>Model is <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_GeomToHolderTransformer">GeomToHolderTransformer</a></li> <li>Model is <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_GeomToHolderTransformer">GeomToHolderTransformer</a></li>
<li>Enabled if <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_KeepHolderBuckleOnTop">KeepHolderBuckleOnTop</a> is true.</li> <li>Enabled if <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_KeepHolderBuckleOnTop">KeepHolderBuckleOnTop</a> is true.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -128,7 +128,7 @@
<ul> <ul>
<li>Is Spinning Cutter Checkbox <li>Is Spinning Cutter Checkbox
<ul> <ul>
<li>Controls <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_IsSpinningCutter">IsSpinningCutter</a></li> <li>Controls <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_IsSpinningCutter">IsSpinningCutter</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -160,7 +160,7 @@
</li> </li>
</ul> </ul>
<h2 id="implementation-note">Implementation Note</h2> <h2 id="implementation-note">Implementation Note</h2>
<p>Remember to call <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_ClearCache">ClearCache()</a> after geometry changes.</p> <p>Remember to call <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html#Hi_Machining_FreeformRemover_ClearCache">ClearCache()</a> after geometry changes.</p>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../../index.html">this page</a> for git repository.</p> <p>See <a href="../../index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3> <h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>

22
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/index.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/cutter/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Cutter Panel | HiAPI-C# 2025 "> <meta name="title" content="Cutter Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -88,8 +88,8 @@
<h1 id="cutter-panel">Cutter Panel</h1> <h1 id="cutter-panel">Cutter Panel</h1>
<h2 id="overview">Overview</h2> <h2 id="overview">Overview</h2>
<p>The key component is <a class="xref" href="../../../../../api/Hi.Machining.ICutter.html">ICutter</a>.</p> <p>The key component is <a class="xref" href="../../../../api/Hi.Machining.ICutter.html">ICutter</a>.</p>
<p>The Cutter Panel is used to manage cutting tool definitions in HiNC. It supports two main types of cutting tools: <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a> and <a class="xref" href="../../../../../api/Hi.Machining.FreeformRemover.html">FreeformRemover</a>.</p> <p>The Cutter Panel is used to manage cutting tool definitions in HiNC. It supports two main types of cutting tools: <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a> and <a class="xref" href="../../../../api/Hi.Machining.FreeformRemover.html">FreeformRemover</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Cutter Panel <li>Cutter Panel
@ -121,7 +121,7 @@ Varies by the Cutter Type. It can be:
</li> </li>
</ul> </ul>
<h2 id="features">Features</h2> <h2 id="features">Features</h2>
<p>Since <a class="xref" href="../../../../../api/Hi.Machining.ICutter.html">ICutter</a> implements <a class="xref" href="../../../../../api/Hi.Common.IClearCache.html">IClearCache</a>, remember to call the <a class="xref" href="../../../../../api/Hi.Common.IClearCache.html#Hi_Common_IClearCache_ClearCache_">ClearCache</a> method when the cutter geometry or properties change to ensure proper updates in simulation.</p> <p>Since <a class="xref" href="../../../../api/Hi.Machining.ICutter.html">ICutter</a> implements <a class="xref" href="../../../../api/Hi.Common.IClearCache.html">IClearCache</a>, remember to call the <a class="xref" href="../../../../api/Hi.Common.IClearCache.html#Hi_Common_IClearCache_ClearCache_">ClearCache</a> method when the cutter geometry or properties change to ensure proper updates in simulation.</p>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../../index.html">this page</a> for git repository.</p> <p>See <a href="../../index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3> <h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>

98
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/milling-cutter-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/cutter/milling-cutter-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Milling Cutter Panel | HiAPI-C# 2025 "> <meta name="title" content="Milling Cutter Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,7 +87,7 @@
<article data-uid=""> <article data-uid="">
<h1 id="milling-cutter-panel">Milling Cutter Panel</h1> <h1 id="milling-cutter-panel">Milling Cutter Panel</h1>
<p>The key model is <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a>.</p> <p>The key model is <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Milling Cutter Panel <li>Milling Cutter Panel
@ -98,7 +98,7 @@
<li>Upper-Beam Tab <li>Upper-Beam Tab
<ul> <ul>
<li><a href="../../geom/geom-manage-control.html">Geometry Management Control</a> <li><a href="../../geom/geom-manage-control.html">Geometry Management Control</a>
<a class="xref" href="../../../../../api/Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a> option is enabled.</li> <a class="xref" href="../../../../api/Hi.Geom.ExtendedCylinder.html">ExtendedCylinder</a> option is enabled.</li>
</ul> </ul>
</li> </li>
<li><a href="#property-tab">Property Tab</a></li> <li><a href="#property-tab">Property Tab</a></li>
@ -123,12 +123,12 @@
<ul> <ul>
<li>Profile Type Selection Dropdown <li>Profile Type Selection Dropdown
<ul> <ul>
<li>APT General (<a class="xref" href="../../../../../api/Hi.Milling.Apts.GeneralApt.html">GeneralApt</a>)</li> <li>APT General (<a class="xref" href="../../../../api/Hi.Milling.Apts.GeneralApt.html">GeneralApt</a>)</li>
<li>APT Ball (<a class="xref" href="../../../../../api/Hi.Milling.Apts.BallApt.html">BallApt</a>)</li> <li>APT Ball (<a class="xref" href="../../../../api/Hi.Milling.Apts.BallApt.html">BallApt</a>)</li>
<li>APT Column (<a class="xref" href="../../../../../api/Hi.Milling.Apts.ColumnApt.html">ColumnApt</a>)</li> <li>APT Column (<a class="xref" href="../../../../api/Hi.Milling.Apts.ColumnApt.html">ColumnApt</a>)</li>
<li>APT Cone (<a class="xref" href="../../../../../api/Hi.Milling.Apts.ConeApt.html">ConeApt</a>)</li> <li>APT Cone (<a class="xref" href="../../../../api/Hi.Milling.Apts.ConeApt.html">ConeApt</a>)</li>
<li>APT Taper (<a class="xref" href="../../../../../api/Hi.Milling.Apts.TaperApt.html">TaperApt</a>)</li> <li>APT Taper (<a class="xref" href="../../../../api/Hi.Milling.Apts.TaperApt.html">TaperApt</a>)</li>
<li>Custom Spinning Profile (<a class="xref" href="../../../../../api/Hi.Milling.Cutters.CustomSpinningProfile.html">CustomSpinningProfile</a>)</li> <li>Custom Spinning Profile (<a class="xref" href="../../../../api/Hi.Milling.Cutters.CustomSpinningProfile.html">CustomSpinningProfile</a>)</li>
</ul> </ul>
</li> </li>
<li>Profile Configuration Panel <li>Profile Configuration Panel
@ -138,7 +138,7 @@
</li> </li>
</ul> </ul>
<p>See <a class="xref" href="../../../../sample/Sample.Machining.DemoBuildMachiningProject.html">DemoBuildMachiningProject</a> for creating the apt profile and setting to the cutter.</p> <p>See <a class="xref" href="../../../../sample/Sample.Machining.DemoBuildMachiningProject.html">DemoBuildMachiningProject</a> for creating the apt profile and setting to the cutter.</p>
<p>See <a href="apt-profile-panel.html">APT Panel</a> for APT-based Profile Configuration Panel. The APT series option is all wrap by <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a> but with different property <a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a>.<a class="xref" href="../../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> assigned.</p> <p>See <a href="apt-profile-panel.html">APT Panel</a> for APT-based Profile Configuration Panel. The APT series option is all wrap by <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a> but with different property <a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html">AptProfile</a>.<a class="xref" href="../../../../api/Hi.Milling.Cutters.AptProfile.html#Hi_Milling_Cutters_AptProfile_Apt">Apt</a> assigned.</p>
<ul> <ul>
<li>Custom Spinning Profile Panel <li>Custom Spinning Profile Panel
<ul> <ul>
@ -147,7 +147,7 @@
</li> </li>
</ul> </ul>
<h3 id="property-tab">Property Tab</h3> <h3 id="property-tab">Property Tab</h3>
<p>Visible if <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p> <p>Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p>
<ul> <ul>
<li>Integral Mode Selection Dropdown <li>Integral Mode Selection Dropdown
<ul> <ul>
@ -160,7 +160,7 @@
<li>Show the label &lsquo;Cutter Mass&rsquo; if the Cutter is Solid End Integral Mode; Show the label &lsquo;Shank Mass&rsquo; if the Cutter is Insert End Integral Mode.</li> <li>Show the label &lsquo;Cutter Mass&rsquo; if the Cutter is Solid End Integral Mode; Show the label &lsquo;Shank Mass&rsquo; if the Cutter is Insert End Integral Mode.</li>
<li>Value format &ldquo;G4&rdquo;</li> <li>Value format &ldquo;G4&rdquo;</li>
<li>Auto Update CheckBox <li>Auto Update CheckBox
The model is <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_ShankMassAssignmentMode">ShankMassAssignmentMode</a>. The model is <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_ShankMassAssignmentMode">ShankMassAssignmentMode</a>.
<ul> <ul>
<li>When enabled: field becomes readonly and shows calculated value.</li> <li>When enabled: field becomes readonly and shows calculated value.</li>
<li>When disabled: field is editable</li> <li>When disabled: field is editable</li>
@ -174,11 +174,11 @@ The model is <a class="xref" href="../../../../../api/Hi.Milling.Cutters.Milling
<li>Minimum Available Cutting Thickness (μm) <li>Minimum Available Cutting Thickness (μm)
<ul> <ul>
<li>Readonly field with format &ldquo;G4&rdquo;</li> <li>Readonly field with format &ldquo;G4&rdquo;</li>
<li>Shows calculated value from <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_GetMinimumUncutChipThickness_um_Hi_MillingForces_Fittings_ICuttingPara_">GetMinimumUncutChipThickness_um(ICuttingPara)</a>. The argument (cutting parameter) is obtained by the <a class="xref" href="../../../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Workpiece">Workpiece</a>.<a class="xref" href="../../../../../api/Hi.NcMech.Workpieces.Workpiece.html#Hi_NcMech_Workpieces_Workpiece_CuttingPara">CuttingPara</a>. Series pass the models by the GUI if needed.</li> <li>Shows calculated value from <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_GetMinimumUncutChipThickness_um_Hi_MillingForces_Fittings_ICuttingPara_">GetMinimumUncutChipThickness_um(ICuttingPara)</a>. The argument (cutting parameter) is obtained by the <a class="xref" href="../../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Workpiece">Workpiece</a>.<a class="xref" href="../../../../api/Hi.NcMech.Workpieces.Workpiece.html#Hi_NcMech_Workpieces_Workpiece_CuttingPara">CuttingPara</a>. Series pass the models by the GUI if needed.</li>
<li>Note Label <li>Note Label
<ul> <ul>
<li>Show Workpiece Cutting Parameter Name. <li>Show Workpiece Cutting Parameter Name.
Label Text &quot;Reference: Workpiece Cutting Parameter - {<a class="xref" href="../../../../../api/Hi.NcMech.Workpieces.Workpiece.html#Hi_NcMech_Workpieces_Workpiece_CuttingPara">CuttingPara</a>.<a class="xref" href="../../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>}&quot;. Label Text &quot;Reference: Workpiece Cutting Parameter - {<a class="xref" href="../../../../api/Hi.NcMech.Workpieces.Workpiece.html#Hi_NcMech_Workpieces_Workpiece_CuttingPara">CuttingPara</a>.<a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>}&quot;.
Since the thickness depdents on the Workpiece Cutting Parameter and hone radius.</li> Since the thickness depdents on the Workpiece Cutting Parameter and hone radius.</li>
</ul> </ul>
</li> </li>
@ -186,7 +186,7 @@ Since the thickness depdents on the Workpiece Cutting Parameter and hone radius.
</li> </li>
</ul> </ul>
<h3 id="insert-cutter-tab">Insert-Cutter Tab</h3> <h3 id="insert-cutter-tab">Insert-Cutter Tab</h3>
<p>Visible if <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true and Integral Mode is Insert End.</p> <p>Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true and Integral Mode is Insert End.</p>
<ul> <ul>
<li>Insert Number Input field</li> <li>Insert Number Input field</li>
<li>Insert Mass Input field (g) <li>Insert Mass Input field (g)
@ -202,12 +202,12 @@ Since the thickness depdents on the Workpiece Cutting Parameter and hone radius.
</li> </li>
</ul> </ul>
<h3 id="material-tab">Material Tab</h3> <h3 id="material-tab">Material Tab</h3>
<p>Visible if <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p> <p>Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p>
<ul> <ul>
<li>Shank Material (visible only for Integral Mode is Insert End mode) <li>Shank Material (visible only for Integral Mode is Insert End mode)
<ul> <ul>
<li>Material File Selector <li>Material File Selector
Apply <a class="xref" href="../../../../../api/Hi.Physics.IStructureMaterial.html">IStructureMaterial</a> Apply <a class="xref" href="../../../../api/Hi.Physics.IStructureMaterial.html">IStructureMaterial</a>
<ul> <ul>
<li>Menu Dropdown <li>Menu Dropdown
<ul> <ul>
@ -215,9 +215,9 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.IStructureMaterial.htm
<li>Browse Resource Button</li> <li>Browse Resource Button</li>
</ul> </ul>
</li> </li>
<li>Readonly Name TextBox (<a class="xref" href="../../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>) <li>Readonly Name TextBox (<a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>)
<ul> <ul>
<li>ToolTip by <a class="xref" href="../../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a> from the material</li> <li>ToolTip by <a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a> from the material</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -227,7 +227,7 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.IStructureMaterial.htm
<li>Flute Material <li>Flute Material
<ul> <ul>
<li>Material File Selector <li>Material File Selector
Apply <a class="xref" href="../../../../../api/Hi.Physics.CutterMaterial.html">CutterMaterial</a> Apply <a class="xref" href="../../../../api/Hi.Physics.CutterMaterial.html">CutterMaterial</a>
<ul> <ul>
<li>Menu Dropdown <li>Menu Dropdown
<ul> <ul>
@ -235,9 +235,9 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CutterMaterial.html">C
<li>Browse Resource Button</li> <li>Browse Resource Button</li>
</ul> </ul>
</li> </li>
<li>Readonly Name TextBox (<a class="xref" href="../../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>) <li>Readonly Name TextBox (<a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>)
<ul> <ul>
<li>ToolTip by <a class="xref" href="../../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a> from the material</li> <li>ToolTip by <a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a> from the material</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -247,23 +247,23 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CutterMaterial.html">C
<li>Coating Panel <li>Coating Panel
<ul> <ul>
<li>Show note that the sequence starts from surface, i.e. from outer to inner.</li> <li>Show note that the sequence starts from surface, i.e. from outer to inner.</li>
<li>Manages <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_CoatingLayerList">CoatingLayerList</a> <li>Manages <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_CoatingLayerList">CoatingLayerList</a>
<ul> <ul>
<li>Exists sequence management.</li> <li>Exists sequence management.</li>
<li>The first layer has the remark: Air-Exposing Coating.</li> <li>The first layer has the remark: Air-Exposing Coating.</li>
<li><a class="xref" href="../../../../../api/Hi.Physics.ThermalLayer1D.html">ThermalLayer1D</a> Component <li><a class="xref" href="../../../../api/Hi.Physics.ThermalLayer1D.html">ThermalLayer1D</a> Component
<div class="TIP"> <div class="TIP">
<h5>Tip</h5> <h5>Tip</h5>
<ul> <ul>
<li>Keep the child components to one line.</li> <li>Keep the child components to one line.</li>
<li>After Coating Material is manual loaded, set the <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html#Hi_Physics_CoatingMaterial_PreferedThickness_um">PreferedThickness_um</a> to the <a class="xref" href="../../../../../api/Hi.Physics.ThermalLayer1D.html#Hi_Physics_ThermalLayer1D_Length_um">Length_um</a> and update the corresponding field.</li> <li>After Coating Material is manual loaded, set the <a class="xref" href="../../../../api/Hi.Physics.CoatingMaterial.html#Hi_Physics_CoatingMaterial_PreferedThickness_um">PreferedThickness_um</a> to the <a class="xref" href="../../../../api/Hi.Physics.ThermalLayer1D.html#Hi_Physics_ThermalLayer1D_Length_um">Length_um</a> and update the corresponding field.</li>
</ul> </ul>
</div> </div>
<ul> <ul>
<li>Coating Material <li>Coating Material
<ul> <ul>
<li>Material File Selector <li>Material File Selector
Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">CoatingMaterial</a> Apply <a class="xref" href="../../../../api/Hi.Physics.CoatingMaterial.html">CoatingMaterial</a>
<ul> <ul>
<li>Menu Dropdown <li>Menu Dropdown
<ul> <ul>
@ -271,9 +271,9 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">
<li>Browse Resource Button</li> <li>Browse Resource Button</li>
</ul> </ul>
</li> </li>
<li>Readonly Name TextBox (<a class="xref" href="../../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>) <li>Readonly Name TextBox (<a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>)
<ul> <ul>
<li>ToolTip by <a class="xref" href="../../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a> from the material</li> <li>ToolTip by <a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a> from the material</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -282,7 +282,7 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">
</li> </li>
<li>Thickness Input Field (um) (editable) <li>Thickness Input Field (um) (editable)
<ul> <ul>
<li><a class="xref" href="../../../../../api/Hi.Physics.ThermalLayer1D.html#Hi_Physics_ThermalLayer1D_Length_um">Length_um</a></li> <li><a class="xref" href="../../../../api/Hi.Physics.ThermalLayer1D.html#Hi_Physics_ThermalLayer1D_Length_um">Length_um</a></li>
<li>Use format &ldquo;G4&rdquo;</li> <li>Use format &ldquo;G4&rdquo;</li>
</ul> </ul>
</li> </li>
@ -302,13 +302,13 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">
<li>&ldquo;Resource/CoatingMaterial&rdquo;</li> <li>&ldquo;Resource/CoatingMaterial&rdquo;</li>
</ul> </ul>
<h3 id="flute-contours-tab">Flute-Contours Tab</h3> <h3 id="flute-contours-tab">Flute-Contours Tab</h3>
<p>Visible if <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p> <p>Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p>
<p>This part manages <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_FluteContourTray">FluteContourTray</a>.</p> <p>This part manages <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_FluteContourTray">FluteContourTray</a>.</p>
<ul> <ul>
<li>Contour Tray Selection Dropdown <li>Contour Tray Selection Dropdown
<ul> <ul>
<li>Uniform Contour Tray (<a class="xref" href="../../../../../api/Hi.Milling.FluteContours.UniformContourTray.html">UniformContourTray</a>)</li> <li>Uniform Contour Tray (<a class="xref" href="../../../../api/Hi.Milling.FluteContours.UniformContourTray.html">UniformContourTray</a>)</li>
<li>Free Contour Tray (<a class="xref" href="../../../../../api/Hi.Milling.FluteContours.FreeContourTray.html">FreeContourTray</a>)</li> <li>Free Contour Tray (<a class="xref" href="../../../../api/Hi.Milling.FluteContours.FreeContourTray.html">FreeContourTray</a>)</li>
<li>Unset</li> <li>Unset</li>
</ul> </ul>
</li> </li>
@ -333,14 +333,14 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">
</li> </li>
</ul> </ul>
<h3 id="flute-inner-beam-tab">Flute-Inner-Beam Tab</h3> <h3 id="flute-inner-beam-tab">Flute-Inner-Beam Tab</h3>
<p>Visible if <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p> <p>Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p>
<p>This part manages <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_InnerBeamProfile">InnerBeamProfile</a>.</p> <p>This part manages <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_InnerBeamProfile">InnerBeamProfile</a>.</p>
<ul> <ul>
<li>Profile Type Selection Dropdown <li>Profile Type Selection Dropdown
<ul> <ul>
<li>Flute Dependent Ratio Profile (<a class="xref" href="../../../../../api/Hi.Milling.Cutters.FluteDependentRatioProfile.html">FluteDependentRatioProfile</a>)</li> <li>Flute Dependent Ratio Profile (<a class="xref" href="../../../../api/Hi.Milling.Cutters.FluteDependentRatioProfile.html">FluteDependentRatioProfile</a>)</li>
<li>Const Ratio Profile (<a class="xref" href="../../../../../api/Hi.Milling.Cutters.ConstRatioProfile.html">ConstRatioProfile</a>)</li> <li>Const Ratio Profile (<a class="xref" href="../../../../api/Hi.Milling.Cutters.ConstRatioProfile.html">ConstRatioProfile</a>)</li>
<li>Custom Spinning Profile (<a class="xref" href="../../../../../api/Hi.Milling.Cutters.CustomSpinningProfile.html">CustomSpinningProfile</a>)</li> <li>Custom Spinning Profile (<a class="xref" href="../../../../api/Hi.Milling.Cutters.CustomSpinningProfile.html">CustomSpinningProfile</a>)</li>
<li>Unset</li> <li>Unset</li>
</ul> </ul>
</li> </li>
@ -351,7 +351,7 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">
<ul> <ul>
<li>Radius Ratio Number Field (readonly) <li>Radius Ratio Number Field (readonly)
<ul> <ul>
<li>Label also shows the additional information: &lsquo;Dependent on flute num xxx&rsquo;, the &lsquo;xxx&rsquo; is the flute number that pass by <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a>.<a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_FluteContourTray_">FluteContourTray</a>. Series pass the model by the GUI if needed.</li> <li>Label also shows the additional information: &lsquo;Dependent on flute num xxx&rsquo;, the &lsquo;xxx&rsquo; is the flute number that pass by <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a>.<a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html#Hi_Milling_Cutters_MillingCutter_FluteContourTray_">FluteContourTray</a>. Series pass the model by the GUI if needed.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -370,8 +370,8 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">
</li> </li>
</ul> </ul>
<h3 id="optimization-tab">Optimization Tab</h3> <h3 id="optimization-tab">Optimization Tab</h3>
<p>Visible if <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p> <p>Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</p>
<p>This part manages <a class="xref" href="../../../../../api/Hi.NcOpt.MillingCutterOptOption.html">MillingCutterOptOption</a>.</p> <p>This part manages <a class="xref" href="../../../../api/Hi.NcOpt.MillingCutterOptOption.html">MillingCutterOptOption</a>.</p>
<ul> <ul>
<li>Enable Optimization Checkbox <li>Enable Optimization Checkbox
<ul> <ul>
@ -383,7 +383,7 @@ Apply <a class="xref" href="../../../../../api/Hi.Physics.CoatingMaterial.html">
<li>Limit by Theoretical Minimum Feed Per Tooth Checkbox <li>Limit by Theoretical Minimum Feed Per Tooth Checkbox
<ul> <ul>
<li>Shows calculated minimum uncut chip thickness value. <li>Shows calculated minimum uncut chip thickness value.
To get the value, <a class="xref" href="../../../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Workpiece">Workpiece</a>.<a class="xref" href="../../../../../api/Hi.NcMech.Workpieces.Workpiece.html#Hi_NcMech_Workpieces_Workpiece_CuttingPara_">CuttingPara</a> and <a class="xref" href="../../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a> are required. Series pass the model by the GUI if needed.</li> To get the value, <a class="xref" href="../../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Workpiece">Workpiece</a>.<a class="xref" href="../../../../api/Hi.NcMech.Workpieces.Workpiece.html#Hi_NcMech_Workpieces_Workpiece_CuttingPara_">CuttingPara</a> and <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutter.html">MillingCutter</a> are required. Series pass the model by the GUI if needed.</li>
<li>When checked, enforces minimum feed constraint</li> <li>When checked, enforces minimum feed constraint</li>
</ul> </ul>
</li> </li>

32
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/fixture-page.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/fixture-page.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Fixture Page | HiAPI-C# 2025 "> <meta name="title" content="Fixture Page | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -88,9 +88,9 @@
<h1 id="fixture-page">Fixture Page</h1> <h1 id="fixture-page">Fixture Page</h1>
<p>The page triggers by <a href="../main-panel.html">Main Panel</a>.</p> <p>The page triggers by <a href="../main-panel.html">Main Panel</a>.</p>
<p>The key model is <a class="xref" href="../../../../api/Hi.NcMech.Fixtures.Fixture.html">Fixture</a> and <a class="xref" href="../../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a>. <p>The key model is <a class="xref" href="../../../api/Hi.NcMech.Fixtures.Fixture.html">Fixture</a> and <a class="xref" href="../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a>.
Fixture is assigned from the Main Panel's <a class="xref" href="../../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Fixture">Fixture</a>.</p> Fixture is assigned from the Main Panel's <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Fixture">Fixture</a>.</p>
<p><a class="xref" href="../../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a> is from <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_UserConfig">UserConfig</a> which assigned from the parent component.</p> <p><a class="xref" href="../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a> is from <a class="xref" href="../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_UserConfig">UserConfig</a> which assigned from the parent component.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Fixture Page <li>Fixture Page
@ -111,7 +111,7 @@ Fixture is assigned from the Main Panel's <a class="xref" href="../../../../api/
<li>Management Tabs Panel <li>Management Tabs Panel
<ul> <ul>
<li>Geometry Tab <li>Geometry Tab
(Apply <a href="../geom/geom-manage-control.html">Geometry Management Control</a> to set the <a class="xref" href="../../../../api/Hi.NcMech.Fixtures.Fixture.html">Fixture</a>.<a class="xref" href="../../../../api/Hi.NcMech.Fixtures.Fixture.html#Hi_NcMech_Fixtures_Fixture_Geom">Geom</a>.)</li> (Apply <a href="../geom/geom-manage-control.html">Geometry Management Control</a> to set the <a class="xref" href="../../../api/Hi.NcMech.Fixtures.Fixture.html">Fixture</a>.<a class="xref" href="../../../api/Hi.NcMech.Fixtures.Fixture.html#Hi_NcMech_Fixtures_Fixture_Geom">Geom</a>.)</li>
<li>Anchor Tab <li>Anchor Tab
(Apply <a href="topo/transformers.html">Transformer Manage Panel</a> to set the following tabs) (Apply <a href="topo/transformers.html">Transformer Manage Panel</a> to set the following tabs)
<ul> <ul>
@ -130,14 +130,14 @@ Fixture is assigned from the Main Panel's <a class="xref" href="../../../../api/
<li><a href="../renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a></li> <li><a href="../renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a></li>
<li>SetupDisplayee Options ToolBar <li>SetupDisplayee Options ToolBar
<ul> <ul>
<li>Options of <a class="xref" href="../../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html">FixtureEditorDisplayee</a></li> <li>Options of <a class="xref" href="../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html">FixtureEditorDisplayee</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li>RenderingCanvas <li>RenderingCanvas
<ul> <ul>
<li>The <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html">FixtureEditorDisplayee</a> (Apply the model <a class="xref" href="../../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a>).</li> <li>The <a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html">FixtureEditorDisplayee</a> (Apply the model <a class="xref" href="../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a>).</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -151,8 +151,8 @@ Fixture is assigned from the Main Panel's <a class="xref" href="../../../../api/
</div> </div>
<h2 id="behavior">Behavior</h2> <h2 id="behavior">Behavior</h2>
<ul> <ul>
<li>Call <a class="xref" href="../../../../api/Hi.NcMech.Fixtures.Fixture.html">Fixture</a>.<a class="xref" href="../../../../api/Hi.NcMech.Fixtures.Fixture.html#Hi_NcMech_Fixtures_Fixture_ClearGeomCache">ClearGeomCache()</a> on geometry set or changed.</li> <li>Call <a class="xref" href="../../../api/Hi.NcMech.Fixtures.Fixture.html">Fixture</a>.<a class="xref" href="../../../api/Hi.NcMech.Fixtures.Fixture.html#Hi_NcMech_Fixtures_Fixture_ClearGeomCache">ClearGeomCache()</a> on geometry set or changed.</li>
<li>Call RenderCanvas.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a> on geometry set. (Since the assumption of the shape set raise larger viewer changed than content changed, only adjust view of the setter event.)</li> <li>Call RenderCanvas.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a> on geometry set. (Since the assumption of the shape set raise larger viewer changed than content changed, only adjust view of the setter event.)</li>
</ul> </ul>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../index.html">this page</a> for git repository.</p> <p>See <a href="../index.html">this page</a> for git repository.</p>

22
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/cylindroid-holder-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/holder/cylindroid-holder-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Cylindroid Holder Panel | HiAPI-C# 2025 "> <meta name="title" content="Cylindroid Holder Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,7 +87,7 @@
<article data-uid=""> <article data-uid="">
<h1 id="cylindroid-holder-panel">Cylindroid Holder Panel</h1> <h1 id="cylindroid-holder-panel">Cylindroid Holder Panel</h1>
<p>The key model is <a class="xref" href="../../../../../api/Hi.NcMech.Holders.CylindroidHolder.html">CylindroidHolder</a>.</p> <p>The key model is <a class="xref" href="../../../../api/Hi.NcMech.Holders.CylindroidHolder.html">CylindroidHolder</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Cylindroid Holder Panel <li>Cylindroid Holder Panel
@ -105,7 +105,7 @@
</ul> </ul>
</li> </li>
<li>Resolution Tab <li>Resolution Tab
Model: <a class="xref" href="../../../../../api/Hi.NcMech.Holders.CylindroidHolder.html#Hi_NcMech_Holders_CylindroidHolder_PolarResolution2d">PolarResolution2d</a> Model: <a class="xref" href="../../../../api/Hi.NcMech.Holders.CylindroidHolder.html#Hi_NcMech_Holders_CylindroidHolder_PolarResolution2d">PolarResolution2d</a>
<a href="../../widget/polar-resolution-2d-panel.html">Polar Resolution 2d</a></li> <a href="../../widget/polar-resolution-2d-panel.html">Polar Resolution 2d</a></li>
<li>Info Tab <li>Info Tab
<ul> <ul>
@ -119,7 +119,7 @@ Model: <a class="xref" href="../../../../../api/Hi.NcMech.Holders.CylindroidHold
</ul> </ul>
</li> </li>
</ul> </ul>
<p>Remember to call <a class="xref" href="../../../../../api/Hi.NcMech.Holders.CylindroidHolder.html#Hi_NcMech_Holders_CylindroidHolder_UpdateByCylindroid">UpdateByCylindroid()</a> after geometry reference or content changed.</p> <p>Remember to call <a class="xref" href="../../../../api/Hi.NcMech.Holders.CylindroidHolder.html#Hi_NcMech_Holders_CylindroidHolder_UpdateByCylindroid">UpdateByCylindroid()</a> after geometry reference or content changed.</p>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../../index.html">this page</a> for git repository.</p> <p>See <a href="../../index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3> <h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>

22
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/freeform-holder-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/holder/freeform-holder-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Freeform Holder Panel | HiAPI-C# 2025 "> <meta name="title" content="Freeform Holder Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,7 +87,7 @@
<article data-uid=""> <article data-uid="">
<h1 id="freeform-holder-panel">Freeform Holder Panel</h1> <h1 id="freeform-holder-panel">Freeform Holder Panel</h1>
<p>The key model is <a class="xref" href="../../../../../api/Hi.NcMech.Holders.FreeformHolder.html">FreeformHolder</a>.</p> <p>The key model is <a class="xref" href="../../../../api/Hi.NcMech.Holders.FreeformHolder.html">FreeformHolder</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Freeform Holder Panel <li>Freeform Holder Panel
@ -112,7 +112,7 @@
</ul> </ul>
</li> </li>
<li>Resolution Tab <li>Resolution Tab
Model: <a class="xref" href="../../../../../api/Hi.NcMech.Holders.FreeformHolder.html#Hi_NcMech_Holders_FreeformHolder_PolarResolution2d">PolarResolution2d</a> Model: <a class="xref" href="../../../../api/Hi.NcMech.Holders.FreeformHolder.html#Hi_NcMech_Holders_FreeformHolder_PolarResolution2d">PolarResolution2d</a>
<a href="../../widget/polar-resolution-2d-panel.html">Polar Resolution 2d</a></li> <a href="../../widget/polar-resolution-2d-panel.html">Polar Resolution 2d</a></li>
<li>Info Tab <li>Info Tab
<ul> <ul>
@ -126,7 +126,7 @@ Model: <a class="xref" href="../../../../../api/Hi.NcMech.Holders.FreeformHolder
</ul> </ul>
</li> </li>
</ul> </ul>
<p>Remember to call <a class="xref" href="../../../../../api/Hi.NcMech.Holders.FreeformHolder.html#Hi_NcMech_Holders_FreeformHolder_UpdateByGeom">UpdateByGeom()</a> after geometry reference or content changed.</p> <p>Remember to call <a class="xref" href="../../../../api/Hi.NcMech.Holders.FreeformHolder.html#Hi_NcMech_Holders_FreeformHolder_UpdateByGeom">UpdateByGeom()</a> after geometry reference or content changed.</p>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../../index.html">this page</a> for git repository.</p> <p>See <a href="../../index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3> <h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>

22
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/index.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/holder/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Holder Panel | HiAPI-C# 2025 "> <meta name="title" content="Holder Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -92,10 +92,10 @@
<h5>Note</h5> <h5>Note</h5>
<p>While tool holders are essential components in real-world machining operations, some users may choose not to define them in simulation environments for convenience, particularly when collision detection is not a primary concern. The system allows for this flexibility, though it's recommended to include holders for accurate representation and comprehensive collision analysis.</p> <p>While tool holders are essential components in real-world machining operations, some users may choose not to define them in simulation environments for convenience, particularly when collision detection is not a primary concern. The system allows for this flexibility, though it's recommended to include holders for accurate representation and comprehensive collision analysis.</p>
</div> </div>
<p>The primary models involved are subclasses of <a class="xref" href="../../../../../api/Hi.NcMech.Holders.IHolder.html">IHolder</a>. Two common types are:</p> <p>The primary models involved are subclasses of <a class="xref" href="../../../../api/Hi.NcMech.Holders.IHolder.html">IHolder</a>. Two common types are:</p>
<ul> <ul>
<li><strong><a href="cylindroid-holder-panel.html">Cylindroid Holder</a></strong>: Represents holders with a cylindrical geometry. See <a class="xref" href="../../../../../api/Hi.NcMech.Holders.CylindroidHolder.html">CylindroidHolder</a>.</li> <li><strong><a href="cylindroid-holder-panel.html">Cylindroid Holder</a></strong>: Represents holders with a cylindrical geometry. See <a class="xref" href="../../../../api/Hi.NcMech.Holders.CylindroidHolder.html">CylindroidHolder</a>.</li>
<li><strong><a href="freeform-holder-panel.html">Freeform Holder</a></strong>: Represents holders with more complex, freeform geometry, often defined by STL files. See <a class="xref" href="../../../../../api/Hi.NcMech.Holders.FreeformHolder.html">FreeformHolder</a>.</li> <li><strong><a href="freeform-holder-panel.html">Freeform Holder</a></strong>: Represents holders with more complex, freeform geometry, often defined by STL files. See <a class="xref" href="../../../../api/Hi.NcMech.Holders.FreeformHolder.html">FreeformHolder</a>.</li>
</ul> </ul>
<p>Each holder type will have its own specific user interface elements for defining its geometry and properties.</p> <p>Each holder type will have its own specific user interface elements for defining its geometry and properties.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>

22
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/machining-chain-page.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/machining-chain-page.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Machine Tool Page | HiAPI-C# 2025 "> <meta name="title" content="Machine Tool Page | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -90,13 +90,13 @@
<ul> <ul>
<li>Key Model: <li>Key Model:
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Mech.IMachiningChain.html">IMachiningChain</a> <li><a class="xref" href="../../../api/Hi.Mech.IMachiningChain.html">IMachiningChain</a>
The model is managed by the getter function and setter function (see <a href="../widget/object-management-menu-button.html">Object Management Menu Button</a> for the design pattern).</li> The model is managed by the getter function and setter function (see <a href="../widget/object-management-menu-button.html">Object Management Menu Button</a> for the design pattern).</li>
</ul> </ul>
</li> </li>
<li>Assistant Model: <li>Assistant Model:
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.Numerical.NcEnv.html">NcEnv</a></li> <li><a class="xref" href="../../../api/Hi.Numerical.NcEnv.html">NcEnv</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -115,7 +115,7 @@ The model is managed by the getter function and setter function (see <a href="..
</li> </li>
<li>Management Panel <li>Management Panel
<ul> <ul>
<li>If the key model inherits <a class="xref" href="../../../../api/Hi.Common.INameNote.html">INameNote</a>: <li>If the key model inherits <a class="xref" href="../../../api/Hi.Common.INameNote.html">INameNote</a>:
<ul> <ul>
<li>Name Setting Line <li>Name Setting Line
<ul> <ul>

20
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/stick-tool-panel/index.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/stick-tool-panel/index.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Stick Tool Panel | HiAPI-C# 2025 "> <meta name="title" content="Stick Tool Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -89,7 +89,7 @@
<p>The term stick is for not only milling, but other remover like electric discharge machining tool.</p> <p>The term stick is for not only milling, but other remover like electric discharge machining tool.</p>
<p>The key model is MillingTool. <p>The key model is MillingTool.
Other model: <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html">UserService</a>.</p> Other model: <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html">UserService</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Head Line <li>Head Line
@ -122,7 +122,7 @@ Other model: <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.ht
</ul> </ul>
</li> </li>
<li>Intelligent Holder Tab <li>Intelligent Holder Tab
Visible if <a class="xref" href="../../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</li> Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</li>
<li>Info Tab <li>Info Tab
<ul> <ul>
<li>Abstract Note TextField (readonly)</li> <li>Abstract Note TextField (readonly)</li>

36
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/tool-house-page.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/tool-house-page.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Tool House Page | HiAPI-C# 2025 "> <meta name="title" content="Tool House Page | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -89,7 +89,7 @@
<p>The page triggers by <a href="../main-panel.html">Main Panel</a>.</p> <p>The page triggers by <a href="../main-panel.html">Main Panel</a>.</p>
<p>The key model is MachiningToolHouse. <p>The key model is MachiningToolHouse.
The model <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html">UserService</a> is delivered by the host GUI.</p> The model <a class="xref" href="../../../api/Hi.HiNcKits.UserService.html">UserService</a> is delivered by the host GUI.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Tool House Page <li>Tool House Page
@ -144,14 +144,14 @@ The panel has CRUD (and Duplicate) of the tools. Read and Update the selected to
<ul> <ul>
<li>Head Label: Cutter</li> <li>Head Label: Cutter</li>
<li>Show Cutter CheckBox</li> <li>Show Cutter CheckBox</li>
<li>(Options of <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html">MillingCutterEditorDisplayee</a>) <li>(Options of <a class="xref" href="../../../api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html">MillingCutterEditorDisplayee</a>)
<ul> <ul>
<li>Shape Mode SubMenu <li>Shape Mode SubMenu
Set <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html#Hi_Milling_Cutters_MillingCutterEditorDisplayee_ShapeMode">ShapeMode</a> to Solid Bounding Shape if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is false on GUI initialization. Set <a class="xref" href="../../../api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html#Hi_Milling_Cutters_MillingCutterEditorDisplayee_ShapeMode">ShapeMode</a> to Solid Bounding Shape if <a class="xref" href="../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is false on GUI initialization.
<ul> <ul>
<li>Solid Bounding Shape Ratio Button</li> <li>Solid Bounding Shape Ratio Button</li>
<li>Detail Physics Shape Ratio Button <li>Detail Physics Shape Ratio Button
Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</li> Visible if <a class="xref" href="../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -159,7 +159,7 @@ Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi
<li>(spliter)</li> <li>(spliter)</li>
<li>Head Label: Holder</li> <li>Head Label: Holder</li>
<li>Show Holder CheckBox</li> <li>Show Holder CheckBox</li>
<li>(Options of <a class="xref" href="../../../../api/Hi.NcMech.Holders.HolderEditorDisplayee.html">HolderEditorDisplayee</a>) <li>(Options of <a class="xref" href="../../../api/Hi.NcMech.Holders.HolderEditorDisplayee.html">HolderEditorDisplayee</a>)
<ul> <ul>
<li>Show Geometry Anchor CheckBox</li> <li>Show Geometry Anchor CheckBox</li>
<li>Show Spindle Buckle CheckBox</li> <li>Show Spindle Buckle CheckBox</li>
@ -181,7 +181,7 @@ Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi
</li> </li>
<li>RenderingCanvas <li>RenderingCanvas
<ul> <ul>
<li>The <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../../api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html">MillingToolEditorDisplayee</a>.</li> <li>The <a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html">MillingToolEditorDisplayee</a>.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -194,16 +194,16 @@ Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi
<ul> <ul>
<li>Do not apply new window for tool creation. Assume the workflow is user create a default content tool and then user setup it in by the edit panel.</li> <li>Do not apply new window for tool creation. Assume the workflow is user create a default content tool and then user setup it in by the edit panel.</li>
<li>Add a resizable splition bar between Tool List Panel, Selected Tool Editor Panel and Viewer Panel.</li> <li>Add a resizable splition bar between Tool List Panel, Selected Tool Editor Panel and Viewer Panel.</li>
<li>The options of <a class="xref" href="../../../../api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html">MillingCutterEditorDisplayee</a> and <a class="xref" href="../../../../api/Hi.NcMech.Holders.HolderEditorDisplayee.html">HolderEditorDisplayee</a> is enabled only if the upper level options are enabled, i.e. <a class="xref" href="../../../../api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html#Hi_Milling_MillingTools_MillingToolEditorDisplayee_ShowCutter">ShowCutter</a> and <a class="xref" href="../../../../api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html#Hi_Milling_MillingTools_MillingToolEditorDisplayee_ShowHolder">ShowHolder</a>.</li> <li>The options of <a class="xref" href="../../../api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html">MillingCutterEditorDisplayee</a> and <a class="xref" href="../../../api/Hi.NcMech.Holders.HolderEditorDisplayee.html">HolderEditorDisplayee</a> is enabled only if the upper level options are enabled, i.e. <a class="xref" href="../../../api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html#Hi_Milling_MillingTools_MillingToolEditorDisplayee_ShowCutter">ShowCutter</a> and <a class="xref" href="../../../api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html#Hi_Milling_MillingTools_MillingToolEditorDisplayee_ShowHolder">ShowHolder</a>.</li>
<li>Use less layer of EditorDisplayee Options ToolBar for user convenient. Flatten the options of the children displayee except the ratio button group.</li> <li>Use less layer of EditorDisplayee Options ToolBar for user convenient. Flatten the options of the children displayee except the ratio button group.</li>
</ul> </ul>
</div> </div>
<p>The Tool ID can not be repeated. When create new tool, assign a new tool ID (maybe the largest ID plus 1).</p> <p>The Tool ID can not be repeated. When create new tool, assign a new tool ID (maybe the largest ID plus 1).</p>
<p>When a tool is entered, call the renderingCanvas.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToHomeView">SetViewToHomeView()</a>.</p> <p>When a tool is entered, call the renderingCanvas.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToHomeView">SetViewToHomeView()</a>.</p>
<h3 id="duplication-button">Duplication Button</h3> <h3 id="duplication-button">Duplication Button</h3>
<p>Use <a class="xref" href="../../../../api/Hi.Milling.MillingTools.MillingTool.html#Hi_Milling_MillingTools_MillingTool_Duplicate_System_Object___">Duplicate(params object[])</a> to duplicate the tool.</p> <p>Use <a class="xref" href="../../../api/Hi.Milling.MillingTools.MillingTool.html#Hi_Milling_MillingTools_MillingTool_Duplicate_System_Object___">Duplicate(params object[])</a> to duplicate the tool.</p>
<h3 id="noteabstract-textfield">Note/Abstract TextField</h3> <h3 id="noteabstract-textfield">Note/Abstract TextField</h3>
<p>The Note/Abstract TextField shows note if note existed and is not empty string; otherwise it shows the <a class="xref" href="../../../../api/Hi.Milling.MillingTools.MillingTool.html#Hi_Milling_MillingTools_MillingTool_AbstractNote">AbstractNote</a>. The tooltip is the abstract note.</p> <p>The Note/Abstract TextField shows note if note existed and is not empty string; otherwise it shows the <a class="xref" href="../../../api/Hi.Milling.MillingTools.MillingTool.html#Hi_Milling_MillingTools_MillingTool_AbstractNote">AbstractNote</a>. The tooltip is the abstract note.</p>
<h2 id="source-code-path">Source Code Path</h2> <h2 id="source-code-path">Source Code Path</h2>
<p>See <a href="../index.html">this page</a> for git repository.</p> <p>See <a href="../index.html">this page</a> for git repository.</p>
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3> <h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>

36
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/topo/transformers.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/topo/transformers.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Transformers GUI | HiAPI-C# 2025 "> <meta name="title" content="Transformers GUI | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../../public/main.css"> <link rel="stylesheet" href="../../../../public/main.css">
<meta name="docfx:navrel" content="../../../../../toc.html"> <meta name="docfx:navrel" content="../../../../toc.html">
<meta name="docfx:tocrel" content="../../../toc.html"> <meta name="docfx:tocrel" content="../../../toc.html">
<meta name="docfx:rel" content="../../../../../"> <meta name="docfx:rel" content="../../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../../public/docfx.min.js"></script> <script type="module" src="./../../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../../index.html"> <a class="navbar-brand" href="../../../../index.html">
<img id="logo" class="svg" src="../../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -89,7 +89,7 @@
<p>Each <a href="../../../basic/mechanism/transformers/index.html">Transformers</a> has GUI component.</p> <p>Each <a href="../../../basic/mechanism/transformers/index.html">Transformers</a> has GUI component.</p>
<h2 id="transformer-manage-panel">Transformer Manage Panel</h2> <h2 id="transformer-manage-panel">Transformer Manage Panel</h2>
<p>Use Transformer Manage Panel to setup the <a class="xref" href="../../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a>.</p> <p>Use Transformer Manage Panel to setup the <a class="xref" href="../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a>.</p>
<h3 id="layout">Layout</h3> <h3 id="layout">Layout</h3>
<ul> <ul>
<li>Transformer Manage Panel <li>Transformer Manage Panel
@ -99,8 +99,12 @@
</ul> </ul>
</li> </li>
</ul> </ul>
<div class="NOTE">
<h5>Note</h5>
<p><a class="xref" href="../../../../api/Hi.Mech.Topo.GeneralTransform.html">GeneralTransform</a> control uses its own layout with direct API calls and &lt;xref:Hi.Vec3d&gt; components, instead of embedding <a class="xref" href="../../../../api/Hi.Mech.Topo.StaticRotation.html">StaticRotation</a> and <a class="xref" href="../../../../api/Hi.Mech.Topo.StaticTranslation.html">StaticTranslation</a> as sub-components. This avoids redundant title display when nested.</p>
</div>
<h3 id="transformer-type-selection-bar">Transformer Type Selection Bar</h3> <h3 id="transformer-type-selection-bar">Transformer Type Selection Bar</h3>
<p>Transformer Type Selection Bar get or set <a class="xref" href="../../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a>.</p> <p>Transformer Type Selection Bar get or set <a class="xref" href="../../../../api/Hi.Mech.Topo.ITransformer.html">ITransformer</a>.</p>
<p>The Transformer Type Selection Bar has code-behind option to choose what the transformer options to show.</p> <p>The Transformer Type Selection Bar has code-behind option to choose what the transformer options to show.</p>
<p>If the original model (i.e. source model) transformer conflicts with the restricted transformers, show the model.</p> <p>If the original model (i.e. source model) transformer conflicts with the restricted transformers, show the model.</p>
<div class="TIP"> <div class="TIP">
@ -121,11 +125,13 @@
</ul> </ul>
<h3 id="web-page-application-source-code-path">Web Page Application Source Code Path</h3> <h3 id="web-page-application-source-code-path">Web Page Application Source Code Path</h3>
<ul> <ul>
<li>Mech/Topo/TransformerSelectDiv</li> <li>wwwroot/mech/topo/transformer-select-panel.js</li>
<li>Mech/Topo/StaticTranslationDiv</li> <li>wwwroot/mech/topo/static-translation-control.js</li>
<li>Mech/Topo/DynamicTranslationDiv</li> <li>wwwroot/mech/topo/static-rotation-control.js</li>
<li>Mech/Topo/DynamicRotationDiv</li> <li>wwwroot/mech/topo/static-freeform-control.js</li>
<li>Mech/Topo/GeneralTransformDiv</li> <li>wwwroot/mech/topo/dynamic-translation-control.js</li>
<li>wwwroot/mech/topo/dynamic-rotation-control.js</li>
<li>wwwroot/mech/topo/general-transform-control.js</li>
</ul> </ul>
</article> </article>

42
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/workpiece-page.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/workpiece-page.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="Workpiece Page | HiAPI-C# 2025 "> <meta name="title" content="Workpiece Page | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -88,9 +88,9 @@
<h1 id="workpiece-page">Workpiece Page</h1> <h1 id="workpiece-page">Workpiece Page</h1>
<p>The page triggers by <a href="../main-panel.html">Main Panel</a>.</p> <p>The page triggers by <a href="../main-panel.html">Main Panel</a>.</p>
<p>The key model is <a class="xref" href="../../../../api/Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a> and <a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html">WorkpieceEditorDisplayeeConfig</a>. <p>The key model is <a class="xref" href="../../../api/Hi.NcMech.Workpieces.Workpiece.html">Workpiece</a> and <a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html">WorkpieceEditorDisplayeeConfig</a>.
Which is assigned from the Main Panel's <a class="xref" href="../../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Workpiece">Workpiece</a>.</p> Which is assigned from the Main Panel's <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_Workpiece">Workpiece</a>.</p>
<p><a class="xref" href="../../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a> is from <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_UserConfig">UserConfig</a> which assigned from the parent component.</p> <p><a class="xref" href="../../../api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html">FixtureEditorDisplayeeConfig</a> is from <a class="xref" href="../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_UserConfig">UserConfig</a> which assigned from the parent component.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Workpiece Page <li>Workpiece Page
@ -165,7 +165,7 @@ Apply <a href="../geom/runtime-geom-panel.html">Runtime Geometry Panel</a></li>
</ul> </ul>
</li> </li>
<li>Material Tab <li>Material Tab
Visible if <a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true. Visible if <a class="xref" href="../../../api/Hi.HiNcKits.UserService.html#Hi_HiNcKits_UserService_EnablePhysics">EnablePhysics</a> is true.
<ul> <ul>
<li>Workpiece Material File Selector <li>Workpiece Material File Selector
<ul> <ul>
@ -174,9 +174,9 @@ The initial directory is the project directory.</li>
<li>Browse Resource Button <li>Browse Resource Button
The directory is the Default Resource directory.</li> The directory is the Default Resource directory.</li>
<li>Readonly File Path TextBox</li> <li>Readonly File Path TextBox</li>
<li>Readonly Name TextBox (<a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>) <li>Readonly Name TextBox (<a class="xref" href="../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>)
<ul> <ul>
<li>ToolTip: <a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a></li> <li>ToolTip: <a class="xref" href="../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -188,9 +188,9 @@ The initial directory is the project directory.</li>
<li>Browse Resource Button <li>Browse Resource Button
The directory is the Default Resource directory.</li> The directory is the Default Resource directory.</li>
<li>Readonly File Path TextBox</li> <li>Readonly File Path TextBox</li>
<li>Readonly Name TextBox (<a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>) <li>Readonly Name TextBox (<a class="xref" href="../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Name">Name</a>)
<ul> <ul>
<li>ToolTip: <a class="xref" href="../../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a></li> <li>ToolTip: <a class="xref" href="../../../api/Hi.Common.INameNote.html#Hi_Common_INameNote_Note">Note</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -208,14 +208,14 @@ The directory is the Default Resource directory.</li>
<li><a href="../renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a></li> <li><a href="../renderingcanvas-tool-bar.html">RenderingCanvas Tool Bar</a></li>
<li>SetupDisplayee Options ToolBar <li>SetupDisplayee Options ToolBar
<ul> <ul>
<li>Options of <a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a></li> <li>Options of <a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li>RenderingCanvas <li>RenderingCanvas
<ul> <ul>
<li>The <a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a> (Apply the model <a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html">WorkpieceEditorDisplayeeConfig</a>).</li> <li>The <a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_Displayee">Displayee</a> is <a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a> (Apply the model <a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html">WorkpieceEditorDisplayeeConfig</a>).</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -235,11 +235,11 @@ The directory is the Default Resource directory.</li>
</ul> </ul>
<h2 id="behavior">Behavior</h2> <h2 id="behavior">Behavior</h2>
<ul> <ul>
<li><p>Call <a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a>.<a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html#Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_ClearRawGeomCache">ClearRawGeomCache()</a> on Raw Shape set or changed.</p> <li><p>Call <a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a>.<a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html#Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_ClearRawGeomCache">ClearRawGeomCache()</a> on Raw Shape set or changed.</p>
</li> </li>
<li><p>Call <a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a>.<a class="xref" href="../../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html#Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_ClearIdealGeomCache">ClearIdealGeomCache()</a> on Target Shape set or changed.</p> <li><p>Call <a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html">WorkpieceEditorDisplayee</a>.<a class="xref" href="../../../api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html#Hi_NcMech_Workpieces_WorkpieceEditorDisplayee_ClearIdealGeomCache">ClearIdealGeomCache()</a> on Target Shape set or changed.</p>
</li> </li>
<li><p>Call RenderCanvas.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a> on Raw Shape set or Target Shape set. (Since the assumption of the shape set raise larger viewer changed than content changed, only adjust view of the setter event.)</p> <li><p>Call RenderCanvas.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html">DispEngine</a>.<a class="xref" href="../../../api/Hi.Disp.DispEngine.html#Hi_Disp_DispEngine_SetViewToIsometricView">SetViewToIsometricView()</a> on Raw Shape set or Target Shape set. (Since the assumption of the shape set raise larger viewer changed than content changed, only adjust view of the setter event.)</p>
</li> </li>
<li><p>Keep <a href="../widget/gui-file-path-assignment.html#portability">Portability</a> of the Material properties.</p> <li><p>Keep <a href="../widget/gui-file-path-assignment.html#portability">Portability</a> of the Material properties.</p>
</li> </li>

183
App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/message-section-on-main-panel.html Normal file
View File

@ -0,0 +1,183 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Message Section | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Message Section | 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="">
<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="">
<h1 id="message-section">Message Section</h1>
<p>The Message Section displays application messages and logs at the bottom of the Main Panel.</p>
<h2 id="message-handling">Message Handling</h2>
<p>The Message Section is connected to <a class="xref" href="../../api/Hi.Common.Messages.MessageHost.html">MessageHost</a>.<a class="xref" href="../../api/Hi.Common.Messages.MessageHost.html#Hi_Common_Messages_MessageHost_Default">Default</a> through the <code>OnAdding</code> event. When a message is added:</p>
<ol>
<li>The <code>Brief Message Text Field</code> content is updated</li>
<li>The message is appended to the daily log file at <code>logs/log-{DateTime.Now:yyyy-MM-dd}.txt</code></li>
</ol>
<h3 id="message-types">Message Types</h3>
<p>The <a class="xref" href="../../api/Hi.Common.Messages.MessageFlag.html">MessageFlag</a> determines the display behavior:</p>
<table>
<thead>
<tr>
<th>Flag</th>
<th>Display Behavior</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="../../api/Hi.Common.Messages.MessageFlag.html#Hi_Common_Messages_MessageFlag_Exception">Exception</a></td>
<td>Alert style, shown in Message Section</td>
</tr>
<tr>
<td><a class="xref" href="../../api/Hi.Common.Messages.MessageFlag.html#Hi_Common_Messages_MessageFlag_Warning">Warning</a> and above</td>
<td>Shown in Message Section</td>
</tr>
<tr>
<td><a class="xref" href="../../api/Hi.Common.Messages.MessageFlag.html#Hi_Common_Messages_MessageFlag_Info">Info</a> and below</td>
<td>Logged only, not shown in Message Section</td>
</tr>
</tbody>
</table>
<div class="NOTE">
<h5>Note</h5>
<p>When the message is an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a>, the brief message shows <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.message">Message</a> while the full exception details are logged to file.</p>
</div>
<h2 id="platform-specific-layouts">Platform-Specific Layouts</h2>
<h3 id="wpf-application">WPF Application</h3>
<p>The WPF version uses a fixed bottom bar:</p>
<ul>
<li><strong>Message Section Bottom Bar</strong>
<ul>
<li>Brief Message Text Field (selectable for copy)</li>
<li>Show Log Button</li>
</ul>
</li>
</ul>
<h3 id="web-application">Web Application</h3>
<p>The Web version uses Bootstrap-style stacking toasts:</p>
<ul>
<li><strong>Message Section Stacking Toast</strong>
<ul>
<li>Brief Message Text Field</li>
<li>Auto-hide enabled only for low-priority messages</li>
</ul>
</li>
</ul>
<h4 id="log-page">Log Page</h4>
<p>The Log Page provides access to daily logs:</p>
<ul>
<li><strong>Header</strong>: Log Label, Refresh Button, Download Button</li>
<li><strong>Content</strong>: Log TextArea</li>
</ul>
<h2 id="show-log-button">Show Log Button</h2>
<p>The Show Log Button opens a modal or editor view displaying the current day's log content.</p>
<div class="NOTE">
<h5>Note</h5>
<p>The log file may not exist if no messages have been recorded yet.</p>
</div>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></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>

48
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/ListCommand-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mission/ListCommand-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="List Command Panel | HiAPI-C# 2025 "> <meta name="title" content="List Command Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,12 +87,12 @@
<article data-uid=""> <article data-uid="">
<h1 id="list-command-panel">List Command Panel</h1> <h1 id="list-command-panel">List Command Panel</h1>
<p>The key model is <a class="xref" href="../../../../api/Hi.ShellCommands.ListCommand.html">ListCommand</a>.</p> <p>The key model is <a class="xref" href="../../../api/Hi.ShellCommands.ListCommand.html">ListCommand</a>.</p>
<ul> <ul>
<li>Assistant Model <li>Assistant Model
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></li> <li><a class="xref" href="../../../api/Hi.MachiningProcs.MachiningProject.html">MachiningProject</a></li>
<li><a class="xref" href="../../../../api/Hi.HiNcKits.UserService.html">UserService</a></li> <li><a class="xref" href="../../../api/Hi.HiNcKits.UserService.html">UserService</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -102,7 +102,7 @@
<ul> <ul>
<li>Command Entry List Panel <li>Command Entry List Panel
Provide entrys for selection Provide entrys for selection
The model is <a class="xref" href="../../../../api/Hi.ShellCommands.ListCommand.html#Hi_ShellCommands_ListCommand_CommandEntryList">CommandEntryList</a>. The model is <a class="xref" href="../../../api/Hi.ShellCommands.ListCommand.html#Hi_ShellCommands_ListCommand_CommandEntryList">CommandEntryList</a>.
<ul> <ul>
<li>Head Line <li>Head Line
<ul> <ul>
@ -111,7 +111,7 @@ The model is <a class="xref" href="../../../../api/Hi.ShellCommands.ListCommand.
<ul> <ul>
<li>Buttons for adding: <li>Buttons for adding:
<ul> <ul>
<li><a class="xref" href="../../../../api/Hi.ShellCommands.PreSettingCommand.html">PreSettingCommand</a> <li><a class="xref" href="../../../api/Hi.ShellCommands.PreSettingCommand.html">PreSettingCommand</a>
<ul> <ul>
<li>Content Panel: <a href="PreSettingCommand-panel.html">PreSetting Command Panel</a></li> <li>Content Panel: <a href="PreSettingCommand-panel.html">PreSetting Command Panel</a></li>
</ul> </ul>
@ -120,7 +120,7 @@ The model is <a class="xref" href="../../../../api/Hi.ShellCommands.ListCommand.
<p>This command sets up initial parameters before NC simulation which attempt to take the effect.</p> <p>This command sets up initial parameters before NC simulation which attempt to take the effect.</p>
</div> </div>
</li> </li>
<li><a class="xref" href="../../../../api/Hi.ShellCommands.NcOptOptionCommand.html">NcOptOptionCommand</a> <li><a class="xref" href="../../../api/Hi.ShellCommands.NcOptOptionCommand.html">NcOptOptionCommand</a>
<ul> <ul>
<li>Content Panel: <a href="NcOptOption-panel.html">NcOptOption Panel</a></li> <li>Content Panel: <a href="NcOptOption-panel.html">NcOptOption Panel</a></li>
</ul> </ul>
@ -129,18 +129,18 @@ The model is <a class="xref" href="../../../../api/Hi.ShellCommands.ListCommand.
<p>This command is also a type of pre-setting that should be applied before NC simulation which attempt to take the effect.</p> <p>This command is also a type of pre-setting that should be applied before NC simulation which attempt to take the effect.</p>
</div> </div>
</li> </li>
<li><a class="xref" href="../../../../api/Hi.ShellCommands.NcFileCommand.html">NcFileCommand</a> <li><a class="xref" href="../../../api/Hi.ShellCommands.NcFileCommand.html">NcFileCommand</a>
<ul> <ul>
<li>Content Panel: <a href="NcFileCommand-panel.html">NcFile Command Panel</a></li> <li>Content Panel: <a href="NcFileCommand-panel.html">NcFile Command Panel</a></li>
</ul> </ul>
</li> </li>
<li><a class="xref" href="../../../../api/Hi.ShellCommands.NcCodeCommand.html">NcCodeCommand</a></li> <li><a class="xref" href="../../../api/Hi.ShellCommands.NcCodeCommand.html">NcCodeCommand</a></li>
<li><a class="xref" href="../../../../api/Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a> <li><a class="xref" href="../../../api/Hi.ShellCommands.ScriptCommand.html">ScriptCommand</a>
<ul> <ul>
<li>Content Panel: <a href="script-command-panel.html">Script Command Panel</a></li> <li>Content Panel: <a href="script-command-panel.html">Script Command Panel</a></li>
</ul> </ul>
</li> </li>
<li><a class="xref" href="../../../../api/Hi.ShellCommands.PostExecutionCommand.html">PostExecutionCommand</a> <li><a class="xref" href="../../../api/Hi.ShellCommands.PostExecutionCommand.html">PostExecutionCommand</a>
<ul> <ul>
<li>Content Panel: <a href="PostExecutionCommand-panel.html">PostExecution Command Panel</a></li> <li>Content Panel: <a href="PostExecutionCommand-panel.html">PostExecution Command Panel</a></li>
</ul> </ul>
@ -162,7 +162,7 @@ The boxes are draggable for re-order.
<ul> <ul>
<li>Enable CheckBox <li>Enable CheckBox
<ul> <ul>
<li>The model is <a class="xref" href="../../../../api/Hi.ShellCommands.EnablingWrapper.html#Hi_ShellCommands_EnablingWrapper_IsEnabled">IsEnabled</a>.</li> <li>The model is <a class="xref" href="../../../api/Hi.ShellCommands.EnablingWrapper.html#Hi_ShellCommands_EnablingWrapper_IsEnabled">IsEnabled</a>.</li>
</ul> </ul>
<div class="TIP"> <div class="TIP">
<h5>Tip</h5> <h5>Tip</h5>
@ -171,7 +171,7 @@ The boxes are draggable for re-order.
</li> </li>
<li>Title Label <li>Title Label
<ul> <ul>
<li>Apply <a class="xref" href="../../../../api/Hi.ShellCommands.ITitleCommand.html#Hi_ShellCommands_ITitleCommand_GetCommandTitle_">GetCommandTitle</a> if the command is inherited from <a class="xref" href="../../../../api/Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a>; otherwise, show the class name.</li> <li>Apply <a class="xref" href="../../../api/Hi.ShellCommands.ITitleCommand.html#Hi_ShellCommands_ITitleCommand_GetCommandTitle_">GetCommandTitle</a> if the command is inherited from <a class="xref" href="../../../api/Hi.ShellCommands.ITitleCommand.html">ITitleCommand</a>; otherwise, show the class name.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -180,13 +180,13 @@ The boxes are draggable for re-order.
<p>Apply style changed if the entry is selected.</p> <p>Apply style changed if the entry is selected.</p>
</div> </div>
<ul> <ul>
<li>If there is only one <a class="xref" href="../../../../api/Hi.ShellCommands.PreSettingCommand.html">PreSettingCommand</a> in the list and at the begining, Keep it at begining when items adding, shows a &ldquo;pin at begining&rdquo; label with a pin icon.</li> <li>If there is only one <a class="xref" href="../../../api/Hi.ShellCommands.PreSettingCommand.html">PreSettingCommand</a> in the list and at the begining, Keep it at begining when items adding, shows a &ldquo;pin at begining&rdquo; label with a pin icon.</li>
<li>If there is only one <a class="xref" href="../../../../api/Hi.ShellCommands.PostExecutionCommand.html">PostExecutionCommand</a> in the list and at the end, Keep it at end when items adding, shows a &ldquo;pin at end&rdquo; label a pin icon.</li> <li>If there is only one <a class="xref" href="../../../api/Hi.ShellCommands.PostExecutionCommand.html">PostExecutionCommand</a> in the list and at the end, Keep it at end when items adding, shows a &ldquo;pin at end&rdquo; label a pin icon.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li>Support file drag from the external application (such as file explorer), files drag into the Command Entrys List Panel is equivalent to create <a class="xref" href="../../../../api/Hi.ShellCommands.NcFileCommand.html">NcFileCommand</a>s (with the <a class="xref" href="../../../../api/Hi.ShellCommands.EnablingWrapper.html">EnablingWrapper</a>) and set the file into the NC File Command.</li> <li>Support file drag from the external application (such as file explorer), files drag into the Command Entrys List Panel is equivalent to create <a class="xref" href="../../../api/Hi.ShellCommands.NcFileCommand.html">NcFileCommand</a>s (with the <a class="xref" href="../../../api/Hi.ShellCommands.EnablingWrapper.html">EnablingWrapper</a>) and set the file into the NC File Command.</li>
</ul> </ul>
</li> </li>
<li>Vertical Splition Bar <li>Vertical Splition Bar
@ -196,7 +196,7 @@ The boxes are draggable for re-order.
</li> </li>
<li>Selected Command Content Panel <li>Selected Command Content Panel
<ul> <ul>
<li>The model is <a class="xref" href="../../../../api/Hi.ShellCommands.EnablingWrapper.html#Hi_ShellCommands_EnablingWrapper_Command">Command</a>.</li> <li>The model is <a class="xref" href="../../../api/Hi.ShellCommands.EnablingWrapper.html#Hi_ShellCommands_EnablingWrapper_Command">Command</a>.</li>
<li>The panel is based on command type</li> <li>The panel is based on command type</li>
</ul> </ul>
<div class="TIP"> <div class="TIP">

20
App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/NcCodeCommand-panel.html → App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mission/NcCodeCommand-panel.html
View File

@ -7,13 +7,13 @@
<meta name="title" content="NcCodeCommand Panel | HiAPI-C# 2025 "> <meta name="title" content="NcCodeCommand Panel | HiAPI-C# 2025 ">
<link rel="icon" href="../../../../img/HiAPI.favicon.ico"> <link rel="icon" href="../../../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../../../../public/docfx.min.css"> <link rel="stylesheet" href="../../../public/docfx.min.css">
<link rel="stylesheet" href="../../../../public/main.css"> <link rel="stylesheet" href="../../../public/main.css">
<meta name="docfx:navrel" content="../../../../toc.html"> <meta name="docfx:navrel" content="../../../toc.html">
<meta name="docfx:tocrel" content="../../toc.html"> <meta name="docfx:tocrel" content="../../toc.html">
<meta name="docfx:rel" content="../../../../"> <meta name="docfx:rel" content="../../../">
@ -30,7 +30,7 @@
<meta name="loc:copy" content="Copy"> <meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF"> <meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../../../../public/docfx.min.js"></script> <script type="module" src="./../../../public/docfx.min.js"></script>
<script> <script>
const theme = localStorage.getItem('theme') || 'auto' const theme = localStorage.getItem('theme') || 'auto'
@ -43,8 +43,8 @@
<header class="bg-body border-bottom"> <header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap"> <div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../../../../index.html"> <a class="navbar-brand" href="../../../index.html">
<img id="logo" class="svg" src="../../../../img/HiAPI.logo.png" alt=""> <img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
</a> </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"> <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">
@ -87,7 +87,7 @@
<article data-uid=""> <article data-uid="">
<h1 id="nccodecommand-panel">NcCodeCommand Panel</h1> <h1 id="nccodecommand-panel">NcCodeCommand Panel</h1>
<p>The key model is <a class="xref" href="../../../../api/Hi.ShellCommands.NcCodeCommand.html">NcCodeCommand</a>.</p> <p>The key model is <a class="xref" href="../../../api/Hi.ShellCommands.NcCodeCommand.html">NcCodeCommand</a>.</p>
<h2 id="layout">Layout</h2> <h2 id="layout">Layout</h2>
<ul> <ul>
<li>Head Line <li>Head Line
@ -97,7 +97,7 @@
</li> </li>
<li>NC Code Editor Area <li>NC Code Editor Area
<ul> <ul>
<li>The model is <a class="xref" href="../../../../api/Hi.ShellCommands.NcCodeCommand.html#Hi_ShellCommands_NcCodeCommand_NcText">NcText</a>.</li> <li>The model is <a class="xref" href="../../../api/Hi.ShellCommands.NcCodeCommand.html#Hi_ShellCommands_NcCodeCommand_NcText">NcText</a>.</li>
<li>Multi-line text editor for NC code input</li> <li>Multi-line text editor for NC code input</li>
<li>Monospace font for better code readability</li> <li>Monospace font for better code readability</li>
<li>Line numbers display (optional)</li> <li>Line numbers display (optional)</li>

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