diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html
index 65da869c..6214f93f 100644
--- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html
+++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html
@@ -445,8 +445,8 @@ Since the folder can be moving with the configuration file.
-
@@ -1114,9 +1114,9 @@ Maximum rotary speed in degds.
-
+
-
+
SetToolHeightCompensationOnFeatureNormal
@@ -1146,9 +1146,9 @@ Maximum rotary speed in degds.
-
+
-
+
StrokeLimitAbc_rad
@@ -1178,9 +1178,9 @@ Maximum rotary speed in degds.
-
+
-
+
StrokeLimitXyz_mm
@@ -1210,9 +1210,9 @@ Maximum rotary speed in degds.
-
+
-
+
ToolingMcAbc_deg
@@ -1245,9 +1245,9 @@ Unit is degree.
-
+
-
+
ToolingMcAbc_rad
@@ -1280,9 +1280,9 @@ Unit is radian.
-
+
-
+
ToolingMcXyz
@@ -1314,9 +1314,9 @@ Set to NaN if tooling motion not apply the axis motion.
-
+
-
+
ToolingTime
@@ -1346,9 +1346,9 @@ Set to NaN if tooling motion not apply the axis motion.
-
+
-
+
XName
@@ -1382,9 +1382,9 @@ Set to NaN if tooling motion not apply the axis motion.
-
+
-
+
CheckStrokeLimit(DVec3d, IMessageHost)
@@ -1424,9 +1424,9 @@ Set to NaN if tooling motion not apply the axis motion.
-
+
-
+
IsAxisExisted(int)
@@ -1463,9 +1463,9 @@ Set to NaN if tooling motion not apply the axis motion.
-
+
-
+
MakeXmlSource(string, string, bool)
@@ -1505,7 +1505,7 @@ This method may also generate additional resources such as related files.
-
Remarks
+
Remarks
For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The baseDirectory is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcLine.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.HardNcLine.html
similarity index 71%
rename from App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcLine.html
rename to App/wwwroot/HiAPI-docsite/api/Hi.Numerical.HardNcLine.html
index da02f63c..989214c2 100644
--- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcLine.html
+++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.HardNcLine.html
@@ -2,9 +2,9 @@
- Class NcLine | HiAPI-C# 2025
+ Class HardNcLine | HiAPI-C# 2025
-
+
@@ -84,12 +84,12 @@
-
+
-
-Class NcLine
+
+Class HardNcLine
@@ -102,7 +102,7 @@ Class NcLine
-
public class NcLine : IIndexedFileLine, IFileLine, IFileLineIndex, IGetIndexedFileLine, IGetFileLineIndex, IFlagText
+
public class HardNcLine : IIndexedFileLine, IFileLine, IFileLineIndex, IGetIndexedFileLine, IGetFileLineIndex, IFlagText
@@ -1744,7 +1744,7 @@ Hence the NC values have to be memorized.
-
Remarks
+
Remarks
NC is the better source property than MC.
Ex. a NC line command: X100. The Y and Z value may vary if using MC converting back to NC.
The error of Y and Z will keeps accumulating until the next explicit YZ command assignment.
@@ -1757,9 +1757,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
RadiusCompensationBuf
@@ -1789,9 +1789,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
RapidFeedrate_mmdmin
@@ -1821,9 +1821,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
RapidFeedrate_mmds
@@ -1853,9 +1853,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
S
@@ -1885,9 +1885,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
SpindleSpeed_radds
@@ -1917,9 +1917,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
SpindleSpeed_rpm
@@ -1949,9 +1949,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
T
@@ -1981,9 +1981,9 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
+
TiltPlaneNcArg
@@ -2017,10 +2017,10 @@ So be care that do not change the NC XYZ if not needed.
-
+
-
- GetAttacherMat(NcEnv)
+
+ GetAttacherMat(HardNcEnv)
@@ -2029,12 +2029,12 @@ So be care that do not change the NC XYZ if not needed.
public static Vec3d GetCoordinateOffset(bool hasSiemensG500, int isoCoordinateId, int heidenhainCycleDef247Q339, HeidenhainCycleDef7Arg heidenhainCycleDef7Arg, NcEnv ncEnv)
+
public static Vec3d GetCoordinateOffset(bool hasSiemensG500, int isoCoordinateId, int heidenhainCycleDef247Q339, HeidenhainCycleDef7Arg heidenhainCycleDef7Arg, HardNcEnv ncEnv)
Since the building process may require the information of the related node, a whole node is passed in.
+The passed-in BlockEntry.CmdBlock can be null or not,
+This function is supposed to create it or refine it.
+ GetBlock(LinkedListNode<IndexedFileLine>, out LinkedListNode<IndexedFileLine>, out LinkedListNode<IndexedFileLine>)
+
+
+
+
+
+
+
+
public void GetBlock(LinkedListNode<IndexedFileLine> srcNode, out LinkedListNode<IndexedFileLine> beginNode, out LinkedListNode<IndexedFileLine> endNode)
For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
+The baseDirectory is typically the folder at the nearest configuration file folder.
+Since the folder can be moving with the configuration file.
The Color Guide System allows you to assign colors and rendering priorities to visual elements based on machining steps or data states.
+
Overview
+
The IColorGuide interface defines the core functionality for color mapping, allowing different colors and rendering priorities to be returned based on various steps or states. This system is particularly suitable for scenarios requiring visual encoding based on data states, such as CNC machining path visualization.
Color priorities determine which machining state is displayed when multiple operations overlap in 3D space
+
Higher priority colors (like collision detection) will override lower priority colors (like normal cutting)
+
+
Application Scenarios
+
The Color Guide System is suitable for the following scenarios:
+
+
CNC Machining Visualization: Display different path colors based on machining states
+
Data State Encoding: Convert numerical states to visual color representations
+
Priority-based Graph Scaling: When zooming out or viewing dense data, higher priority colors (critical states) remain visible while lower priority colors may be consolidated
+
Multi-resolution Rendering: Critical machining issues (collisions, safety violations) are always displayed regardless of zoom level or data density
+
+
Registering Color Guide in Project
+
To make the Color Guide effective in a project, implement the IColorGuide interface and register it in the project's color guide dictionary.
+
XML Serialization
+
See About XML IO for details on XML serialization implementation.
Retrieve and update <xref:Hi.Numerical.NcEnv> settings
Save changes to the project
With Rendering Engine
diff --git a/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/machining-chain-page.html b/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/machining-chain-page.html
index 8a886d0f..1dc1cded 100644
--- a/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/machining-chain-page.html
+++ b/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/mech/machining-chain-page.html
@@ -96,7 +96,7 @@ The model is managed by the getter function and setter function (see NcEnv
+
GeneralTransform control uses its own layout with direct API calls and <xref:Hi.Vec3d> components, instead of embedding StaticRotation and StaticTranslation as sub-components. This avoids redundant title display when nested.
+
GeneralTransform control uses its own layout with direct API calls and Vec3d components, instead of embedding StaticRotation and StaticTranslation as sub-components. This avoids redundant title display when nested.
Transformer Type Selection Bar
Transformer Type Selection Bar get or set ITransformer.
When the message is an Exception, the brief message shows Message while the full exception details are logged to file.
+
When the message is an Exception, the brief message shows <xref:System.Exception.Message*> while the full exception details are logged to file.
Platform-Specific Layouts
WPF Application
diff --git a/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html b/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html
index 02f4cdce..5d782340 100644
--- a/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html
+++ b/App/wwwroot/HiAPI-docsite/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html
@@ -101,7 +101,7 @@ Only editable if the RenderingFlag-based checkboxes that deal the boolean value in RenderingFlagBitArray, such as “Show Machine”, “Show Workpiece”, etc..
Except the ClStrip option since there has already be managed by the Show CL Strip Button.
-Show HeidenhainCoordinate checkbox only if MachiningProject.NcEnv.CncBrand is Heidenhain.
+Show HeidenhainCoordinate checkbox only if MachiningProject.NcEnv.<xref:Hi.Numerical.NcEnv.CncBrand> is Heidenhain.
Create the submenu component class since the other GUI component also use it. See controller page
diff --git a/App/wwwroot/HiAPI-docsite/dev-doc/general-hinc-workflow/index.html b/App/wwwroot/HiAPI-docsite/dev-doc/general-hinc-workflow/index.html
index 7791d081..7dda0361 100644
--- a/App/wwwroot/HiAPI-docsite/dev-doc/general-hinc-workflow/index.html
+++ b/App/wwwroot/HiAPI-docsite/dev-doc/general-hinc-workflow/index.html
@@ -118,7 +118,7 @@
diff --git a/App/wwwroot/HiAPI-docsite/dev-doc/toc.json b/App/wwwroot/HiAPI-docsite/dev-doc/toc.json
index fcfc90e1..3da57bbb 100644
--- a/App/wwwroot/HiAPI-docsite/dev-doc/toc.json
+++ b/App/wwwroot/HiAPI-docsite/dev-doc/toc.json
@@ -1,2 +1,2 @@
-{"items":[{"name":"Overview","href":"index.html","topicHref":"index.html"},{"name":"Release Note","href":"release-note/index.html","topicHref":"release-note/index.html"},{"name":"System Requirements","href":"system-requirements.html","topicHref":"system-requirements.html"},{"name":"Getting Started","href":"getting-started/index.html","topicHref":"getting-started/index.html"},{"name":"HiNC GUI Architecture","href":"build-hinc/index.html","topicHref":"build-hinc/index.html","items":[{"name":"General Rules","href":"build-hinc/general-rules.html","topicHref":"build-hinc/general-rules.html"},{"name":"Common Patterns","items":[{"name":"DictionaryService and DictionaryHub Pattern","href":"build-hinc/common/dictionary-service-pattern.html","topicHref":"build-hinc/common/dictionary-service-pattern.html"}]},{"name":"Web Service Architecture","items":[{"name":"Rendering Canvas on Web Service","href":"build-hinc/hinc-web-service/disp-web-service.html","topicHref":"build-hinc/hinc-web-service/disp-web-service.html"}]},{"name":"Initialize HiAPI","href":"build-hinc/initialize-hiapi.html","topicHref":"build-hinc/initialize-hiapi.html"},{"name":"Main Panel","href":"build-hinc/main-panel.html","topicHref":"build-hinc/main-panel.html"},{"name":"Bottom Message Bar","href":"build-hinc/message-section-on-main-panel.html","topicHref":"build-hinc/message-section-on-main-panel.html"},{"name":"RenderingCanvas Tool Bar","href":"build-hinc/renderingcanvas-tool-bar.html","topicHref":"build-hinc/renderingcanvas-tool-bar.html"},{"name":"Player Panel","href":"build-hinc/player/index.html","topicHref":"build-hinc/player/index.html","items":[{"name":"Player Tool Bar","href":"build-hinc/player/player-tool-bar.html","topicHref":"build-hinc/player/player-tool-bar.html"},{"name":"Player Extended RenderingCanvas Tool Bar","href":"build-hinc/player/player-extended-renderingcanvas-tool-bar.html","topicHref":"build-hinc/player/player-extended-renderingcanvas-tool-bar.html"},{"name":"Selected-Step Info Panel","href":"build-hinc/player/selected-step-info-panel.html","topicHref":"build-hinc/player/selected-step-info-panel.html"}]},{"name":"Session Message Panel","href":"build-hinc/session-message-panel/index.html","topicHref":"build-hinc/session-message-panel/index.html"},{"name":"Preference","items":[{"name":"Preference Menu","href":"build-hinc/preference/index.html","topicHref":"build-hinc/preference/index.html"},{"name":"Graphic-Cache Dropdown","href":"build-hinc/preference/graphic-cache-dropdown.html","topicHref":"build-hinc/preference/graphic-cache-dropdown.html"},{"name":"Language Selection","href":"build-hinc/preference/language-selection-submenu.html","topicHref":"build-hinc/preference/language-selection-submenu.html"},{"name":"Step Present Preference","href":"build-hinc/preference/step-present-preference-page.html","topicHref":"build-hinc/preference/step-present-preference-page.html"}]},{"name":"Widget","items":[{"name":"Vec3d Control","href":"build-hinc/widget/vec3d/index.html","topicHref":"build-hinc/widget/vec3d/index.html"},{"name":"Object Management Menu Button","href":"build-hinc/widget/object-management-menu-button.html","topicHref":"build-hinc/widget/object-management-menu-button.html"},{"name":"GUI File Path Assignment","href":"build-hinc/widget/gui-file-path-assignment.html","topicHref":"build-hinc/widget/gui-file-path-assignment.html"},{"name":"Polar Resolution 2D Panel","href":"build-hinc/widget/polar-resolution-2d-panel.html","topicHref":"build-hinc/widget/polar-resolution-2d-panel.html"},{"name":"Numeric Input/Output Utilities","href":"build-hinc/widget/numeric-io-utilities.html","topicHref":"build-hinc/widget/numeric-io-utilities.html"},{"name":"Resizable Bar","href":"build-hinc/widget/resizable-bar.html","topicHref":"build-hinc/widget/resizable-bar.html"}]},{"name":"Geometry Panels","href":"build-hinc/geom/index.html","topicHref":"build-hinc/geom/index.html","items":[{"name":"Box3d Control","href":"build-hinc/geom/box3d-control.html","topicHref":"build-hinc/geom/box3d-control.html"},{"name":"Cylindroid Control","href":"build-hinc/geom/cylindroid-control.html","topicHref":"build-hinc/geom/cylindroid-control.html"},{"name":"Geometry Combination Control","href":"build-hinc/geom/geom-combination-control.html","topicHref":"build-hinc/geom/geom-combination-control.html"},{"name":"Geometry Management Panel","href":"build-hinc/geom/geom-manage-control.html","topicHref":"build-hinc/geom/geom-manage-control.html"},{"name":"Runtime Geometry Panel","href":"build-hinc/geom/runtime-geom-panel.html","topicHref":"build-hinc/geom/runtime-geom-panel.html"},{"name":"STL File Control","href":"build-hinc/geom/stlfile-control.html","topicHref":"build-hinc/geom/stlfile-control.html"},{"name":"Transformation Geometry Control","href":"build-hinc/geom/transformation-geom-control.html","topicHref":"build-hinc/geom/transformation-geom-control.html"}]},{"name":"Mechanism","items":[{"name":"Transformers","href":"build-hinc/mech/topo/transformers.html","topicHref":"build-hinc/mech/topo/transformers.html"},{"name":"Fixture Page","href":"build-hinc/mech/fixture-page.html","topicHref":"build-hinc/mech/fixture-page.html"},{"name":"Workpiece Page","href":"build-hinc/mech/workpiece-page.html","topicHref":"build-hinc/mech/workpiece-page.html"}]},{"name":"Controller Page","href":"build-hinc/controller/index.html","topicHref":"build-hinc/controller/index.html"},{"name":"Mission Page","href":"build-hinc/mission/index.html","topicHref":"build-hinc/mission/index.html","items":[{"name":"Script Command Panel","href":"build-hinc/mission/script-command-panel.html","topicHref":"build-hinc/mission/script-command-panel.html"},{"name":"List Command Panel","href":"build-hinc/mission/ListCommand-panel.html","topicHref":"build-hinc/mission/ListCommand-panel.html"},{"name":"PreSetting Command Panel","href":"build-hinc/mission/PreSettingCommand-panel.html","topicHref":"build-hinc/mission/PreSettingCommand-panel.html"},{"name":"NcOptOption Panel","href":"build-hinc/mission/NcOptOption-panel.html","topicHref":"build-hinc/mission/NcOptOption-panel.html"},{"name":"NcFile Command Panel","href":"build-hinc/mission/NcFileCommand-panel.html","topicHref":"build-hinc/mission/NcFileCommand-panel.html"},{"name":"NcCode Command Panel","href":"build-hinc/mission/NcCodeCommand-panel.html","topicHref":"build-hinc/mission/NcCodeCommand-panel.html"},{"name":"PostExecution Command Panel","href":"build-hinc/mission/PostExecutionCommand-panel.html","topicHref":"build-hinc/mission/PostExecutionCommand-panel.html"}]}]},{"name":"Logic","items":[{"name":"Basic Geometry","href":"basic/geom/basic-geometry.html","topicHref":"basic/geom/basic-geometry.html"},{"name":"Rendering","href":"basic/rendering/index.html","topicHref":"basic/rendering/index.html","items":[{"name":"Using RenderingCanvas with DispEngine","href":"basic/rendering/rendering-canvas/index.html","topicHref":"basic/rendering/rendering-canvas/index.html"},{"name":"Building Your Own Rendering Canvas","href":"basic/rendering/rendering-canvas/custom-implementation.html","topicHref":"basic/rendering/rendering-canvas/custom-implementation.html"},{"name":"Drawing","href":"basic/rendering/drawing/index.html","topicHref":"basic/rendering/drawing/index.html"}]},{"name":"Mechanism Topology","items":[{"name":"Overview","href":"basic/mechanism/index.html","topicHref":"basic/mechanism/index.html"},{"name":"Topology Structure","href":"basic/mechanism/Topo/index.html","topicHref":"basic/mechanism/Topo/index.html"},{"name":"Transformers","href":"basic/mechanism/transformers/index.html","topicHref":"basic/mechanism/transformers/index.html"},{"name":"Render Topology","href":"basic/mechanism/render-topology/index.html","topicHref":"basic/mechanism/render-topology/index.html"}]},{"name":"XML IO","href":"basic/common/xml-io.html","topicHref":"basic/common/xml-io.html"}]}]}
+{"items":[{"name":"Overview","href":"index.html","topicHref":"index.html"},{"name":"Release Note","href":"release-note/index.html","topicHref":"release-note/index.html"},{"name":"System Requirements","href":"system-requirements.html","topicHref":"system-requirements.html"},{"name":"Getting Started","href":"getting-started/index.html","topicHref":"getting-started/index.html"},{"name":"HiNC GUI Architecture","href":"build-hinc/index.html","topicHref":"build-hinc/index.html","items":[{"name":"General Rules","href":"build-hinc/general-rules.html","topicHref":"build-hinc/general-rules.html"},{"name":"Common Patterns","items":[{"name":"DictionaryService and DictionaryHub Pattern","href":"build-hinc/common/dictionary-service-pattern.html","topicHref":"build-hinc/common/dictionary-service-pattern.html"}]},{"name":"Web Service Architecture","items":[{"name":"Rendering Canvas on Web Service","href":"build-hinc/hinc-web-service/disp-web-service.html","topicHref":"build-hinc/hinc-web-service/disp-web-service.html"}]},{"name":"Initialize HiAPI","href":"build-hinc/initialize-hiapi.html","topicHref":"build-hinc/initialize-hiapi.html"},{"name":"Main Panel","href":"build-hinc/main-panel.html","topicHref":"build-hinc/main-panel.html"},{"name":"Bottom Message Bar","href":"build-hinc/message-section-on-main-panel.html","topicHref":"build-hinc/message-section-on-main-panel.html"},{"name":"RenderingCanvas Tool Bar","href":"build-hinc/renderingcanvas-tool-bar.html","topicHref":"build-hinc/renderingcanvas-tool-bar.html"},{"name":"Player Panel","href":"build-hinc/player/index.html","topicHref":"build-hinc/player/index.html","items":[{"name":"Player Tool Bar","href":"build-hinc/player/player-tool-bar.html","topicHref":"build-hinc/player/player-tool-bar.html"},{"name":"Player Extended RenderingCanvas Tool Bar","href":"build-hinc/player/player-extended-renderingcanvas-tool-bar.html","topicHref":"build-hinc/player/player-extended-renderingcanvas-tool-bar.html"},{"name":"Selected-Step Info Panel","href":"build-hinc/player/selected-step-info-panel.html","topicHref":"build-hinc/player/selected-step-info-panel.html"}]},{"name":"Session Message Panel","href":"build-hinc/session-message-panel/index.html","topicHref":"build-hinc/session-message-panel/index.html"},{"name":"Preference","items":[{"name":"Preference Menu","href":"build-hinc/preference/index.html","topicHref":"build-hinc/preference/index.html"},{"name":"Graphic-Cache Dropdown","href":"build-hinc/preference/graphic-cache-dropdown.html","topicHref":"build-hinc/preference/graphic-cache-dropdown.html"},{"name":"Language Selection","href":"build-hinc/preference/language-selection-submenu.html","topicHref":"build-hinc/preference/language-selection-submenu.html"},{"name":"Step Present Preference","href":"build-hinc/preference/step-present-preference-page.html","topicHref":"build-hinc/preference/step-present-preference-page.html"}]},{"name":"Widget","items":[{"name":"Vec3d Control","href":"build-hinc/widget/vec3d/index.html","topicHref":"build-hinc/widget/vec3d/index.html"},{"name":"Object Management Menu Button","href":"build-hinc/widget/object-management-menu-button.html","topicHref":"build-hinc/widget/object-management-menu-button.html"},{"name":"GUI File Path Assignment","href":"build-hinc/widget/gui-file-path-assignment.html","topicHref":"build-hinc/widget/gui-file-path-assignment.html"},{"name":"Polar Resolution 2D Panel","href":"build-hinc/widget/polar-resolution-2d-panel.html","topicHref":"build-hinc/widget/polar-resolution-2d-panel.html"},{"name":"Numeric Input/Output Utilities","href":"build-hinc/widget/numeric-io-utilities.html","topicHref":"build-hinc/widget/numeric-io-utilities.html"},{"name":"Resizable Bar","href":"build-hinc/widget/resizable-bar.html","topicHref":"build-hinc/widget/resizable-bar.html"}]},{"name":"Geometry Panels","href":"build-hinc/geom/index.html","topicHref":"build-hinc/geom/index.html","items":[{"name":"Box3d Control","href":"build-hinc/geom/box3d-control.html","topicHref":"build-hinc/geom/box3d-control.html"},{"name":"Cylindroid Control","href":"build-hinc/geom/cylindroid-control.html","topicHref":"build-hinc/geom/cylindroid-control.html"},{"name":"Geometry Combination Control","href":"build-hinc/geom/geom-combination-control.html","topicHref":"build-hinc/geom/geom-combination-control.html"},{"name":"Geometry Management Panel","href":"build-hinc/geom/geom-manage-control.html","topicHref":"build-hinc/geom/geom-manage-control.html"},{"name":"Runtime Geometry Panel","href":"build-hinc/geom/runtime-geom-panel.html","topicHref":"build-hinc/geom/runtime-geom-panel.html"},{"name":"STL File Control","href":"build-hinc/geom/stlfile-control.html","topicHref":"build-hinc/geom/stlfile-control.html"},{"name":"Transformation Geometry Control","href":"build-hinc/geom/transformation-geom-control.html","topicHref":"build-hinc/geom/transformation-geom-control.html"}]},{"name":"Mechanism","items":[{"name":"Transformers","href":"build-hinc/mech/topo/transformers.html","topicHref":"build-hinc/mech/topo/transformers.html"},{"name":"Fixture Page","href":"build-hinc/mech/fixture-page.html","topicHref":"build-hinc/mech/fixture-page.html"},{"name":"Workpiece Page","href":"build-hinc/mech/workpiece-page.html","topicHref":"build-hinc/mech/workpiece-page.html"}]},{"name":"Controller Page","href":"build-hinc/controller/index.html","topicHref":"build-hinc/controller/index.html"},{"name":"Mission Page","href":"build-hinc/mission/index.html","topicHref":"build-hinc/mission/index.html","items":[{"name":"Script Command Panel","href":"build-hinc/mission/script-command-panel.html","topicHref":"build-hinc/mission/script-command-panel.html"},{"name":"List Command Panel","href":"build-hinc/mission/ListCommand-panel.html","topicHref":"build-hinc/mission/ListCommand-panel.html"},{"name":"PreSetting Command Panel","href":"build-hinc/mission/PreSettingCommand-panel.html","topicHref":"build-hinc/mission/PreSettingCommand-panel.html"},{"name":"NcOptOption Panel","href":"build-hinc/mission/NcOptOption-panel.html","topicHref":"build-hinc/mission/NcOptOption-panel.html"},{"name":"NcFile Command Panel","href":"build-hinc/mission/NcFileCommand-panel.html","topicHref":"build-hinc/mission/NcFileCommand-panel.html"},{"name":"NcCode Command Panel","href":"build-hinc/mission/NcCodeCommand-panel.html","topicHref":"build-hinc/mission/NcCodeCommand-panel.html"},{"name":"PostExecution Command Panel","href":"build-hinc/mission/PostExecutionCommand-panel.html","topicHref":"build-hinc/mission/PostExecutionCommand-panel.html"}]}]},{"name":"Logic","items":[{"name":"Basic Geometry","href":"basic/geom/basic-geometry.html","topicHref":"basic/geom/basic-geometry.html"},{"name":"Rendering","href":"basic/rendering/index.html","topicHref":"basic/rendering/index.html","items":[{"name":"Using RenderingCanvas with DispEngine","href":"basic/rendering/rendering-canvas/index.html","topicHref":"basic/rendering/rendering-canvas/index.html"},{"name":"Building Your Own Rendering Canvas","href":"basic/rendering/rendering-canvas/custom-implementation.html","topicHref":"basic/rendering/rendering-canvas/custom-implementation.html"},{"name":"Drawing","href":"basic/rendering/drawing/index.html","topicHref":"basic/rendering/drawing/index.html"},{"name":"Color Guide System","href":"basic/rendering/color-guide/index.html","topicHref":"basic/rendering/color-guide/index.html"}]},{"name":"Mechanism Topology","items":[{"name":"Overview","href":"basic/mechanism/index.html","topicHref":"basic/mechanism/index.html"},{"name":"Topology Structure","href":"basic/mechanism/Topo/index.html","topicHref":"basic/mechanism/Topo/index.html"},{"name":"Transformers","href":"basic/mechanism/transformers/index.html","topicHref":"basic/mechanism/transformers/index.html"},{"name":"Render Topology","href":"basic/mechanism/render-topology/index.html","topicHref":"basic/mechanism/render-topology/index.html"}]},{"name":"XML IO","href":"basic/common/xml-io.html","topicHref":"basic/common/xml-io.html"}]}]}
diff --git a/App/wwwroot/HiAPI-docsite/index.json b/App/wwwroot/HiAPI-docsite/index.json
index fff56dee..5a5549f5 100644
--- a/App/wwwroot/HiAPI-docsite/index.json
+++ b/App/wwwroot/HiAPI-docsite/index.json
@@ -339,6 +339,11 @@
"title": "Class FixedSizeConcurrentLinkedListUtil | HiAPI-C# 2025",
"summary": "Class FixedSizeConcurrentLinkedListUtil Namespace Hi.Common.Collections Assembly HiGeom.dll Utility of Fixed Size Concurrent LinkedList. public static class FixedSizeConcurrentLinkedListUtil Inheritance object FixedSizeConcurrentLinkedListUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetThreadSafeEnumerable(LinkedList, object) Gets a thread-safe enumerable from the linked list by creating a copy of the list under a lock. public static IEnumerable GetThreadSafeEnumerable(this LinkedList delegatorLinkedList, object locker = null) Parameters delegatorLinkedList LinkedList The source linked list. locker object The object to use as a lock for synchronization. If null, the linked list itself will be used as the lock object. Returns IEnumerable A thread-safe enumerable of the elements in the linked list. Type Parameters T The type of elements in the linked list. ThreadSafeEnqueue(LinkedList, T, int, object) Enqueue data to delegatorLinkedList synchronizely. public static void ThreadSafeEnqueue(this LinkedList delegatorLinkedList, T data, int bufferCapacity, object locker = null) Parameters delegatorLinkedList LinkedList data T bufferCapacity int if capacity smaller or equal to zero. The capacity is assume infinity. locker object locker is locker for delegatorLinkedList synchronization. if null, apply delegatorLinkedList as locker. Type Parameters T"
},
+ "api/Hi.Common.Collections.LinkedListUtil.html": {
+ "href": "api/Hi.Common.Collections.LinkedListUtil.html",
+ "title": "Class LinkedListUtil | HiAPI-C# 2025",
+ "summary": "Class LinkedListUtil Namespace Hi.Common.Collections Assembly HiGeom.dll public static class LinkedListUtil Inheritance object LinkedListUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Enumerate(LinkedListNode, LinkedListNode) public static IEnumerable> Enumerate(this LinkedListNode beginNode, LinkedListNode endNode) Parameters beginNode LinkedListNode endNode LinkedListNode exclusive end node. It can be null. Returns IEnumerable> Type Parameters T"
+ },
"api/Hi.Common.Collections.ListIndexBasedEnumerable-1.html": {
"href": "api/Hi.Common.Collections.ListIndexBasedEnumerable-1.html",
"title": "Class ListIndexBasedEnumerable | HiAPI-C# 2025",
@@ -387,7 +392,7 @@
"api/Hi.Common.Collections.html": {
"href": "api/Hi.Common.Collections.html",
"title": "Namespace Hi.Common.Collections | HiAPI-C# 2025",
- "summary": "Namespace Hi.Common.Collections Classes DictionaryUtil Utility class providing extension methods for dictionary operations. EnumerableUtil Utility class providing extension methods for enumerable collections. FixedSizeConcurrentLinkedListUtil Utility of Fixed Size Concurrent LinkedList. ListIndexBasedEnumerable Provides an enumerable wrapper for a list that iterates over a specified range of indices. ListIndexBasedIEnumerator Provides an enumerator that iterates over a specified range of indices in a list. ListUtil Provides utility methods for working with lists and collections. SortedListUtil Utility class providing extension methods for SortedList operations. SubList Represents a sub-list view of a source list within a specified index range. SynList Thread-safe List. Enums ListUtil.OuterPolationMode Defines the mode for handling values outside the range of a collection during interpolation. SearchTargetMode Specifies the search method to use when looking for values in a sorted list. SeekDirection Specifies the seek direction for sorted list operations."
+ "summary": "Namespace Hi.Common.Collections Classes DictionaryUtil Utility class providing extension methods for dictionary operations. EnumerableUtil Utility class providing extension methods for enumerable collections. FixedSizeConcurrentLinkedListUtil Utility of Fixed Size Concurrent LinkedList. LinkedListUtil ListIndexBasedEnumerable Provides an enumerable wrapper for a list that iterates over a specified range of indices. ListIndexBasedIEnumerator Provides an enumerator that iterates over a specified range of indices in a list. ListUtil Provides utility methods for working with lists and collections. SortedListUtil Utility class providing extension methods for SortedList operations. SubList Represents a sub-list view of a source list within a specified index range. SynList Thread-safe List. Enums ListUtil.OuterPolationMode Defines the mode for handling values outside the range of a collection during interpolation. SearchTargetMode Specifies the search method to use when looking for values in a sorted list. SeekDirection Specifies the seek direction for sorted list operations."
},
"api/Hi.Common.ConcurrentTimeCounter.html": {
"href": "api/Hi.Common.ConcurrentTimeCounter.html",
@@ -482,7 +487,7 @@
"api/Hi.Common.FileLines.FileLineIndex.html": {
"href": "api/Hi.Common.FileLines.FileLineIndex.html",
"title": "Class FileLineIndex | HiAPI-C# 2025",
- "summary": "Class FileLineIndex Namespace Hi.Common.FileLines Assembly HiGeom.dll Represents a location in a file by its file index and line number. public class FileLineIndex : IFileLineIndex, IGetFileLineIndex, IComparable, IMakeXmlSource, IToXElement Inheritance object FileLineIndex Implements IFileLineIndex IGetFileLineIndex IComparable IMakeXmlSource IToXElement Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MathUtil.Clamp(T, T, T) FileLineUtil.GetFileNo(IFileLineIndex) FileLineUtil.GetLineNo(IFileLineIndex) FileLineUtil.MixedIndex(IFileLineIndex) FileLineUtil.MixedIndex(IGetFileLineIndex) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors FileLineIndex() Initializes a new instance of the FileLineIndex class. public FileLineIndex() FileLineIndex(IFileLineIndex) Initializes a new instance of the FileLineIndex class by copying another instance. public FileLineIndex(IFileLineIndex src) Parameters src IFileLineIndex The source FileLineIndex to copy from FileLineIndex(int, int) Initializes a new instance of the FileLineIndex class with specified indices. public FileLineIndex(int fileIndex, int lineIndex) Parameters fileIndex int The zero-based file index lineIndex int The zero-based line index FileLineIndex(XElement) Initializes a new instance of the FileLineIndex class from an XML element. public FileLineIndex(XElement src) Parameters src XElement The XML element containing the file and line indices Properties FileIndex File Index. Start on 0. public int FileIndex { get; set; } Property Value int FileNo Gets or sets the one-based file number (FileIndex + 1) public int FileNo { get; set; } Property Value int LineIndex Line Index. Start on 0. public int LineIndex { get; set; } Property Value int LineNo Gets or sets the one-based line number (LineIndex + 1) public int LineNo { get; set; } Property Value int XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string Methods CompareTo(IFileLineIndex) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(IFileLineIndex other) Parameters other IFileLineIndex An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order. Equals(object) Determines whether the specified object is equal to the current object. public override bool Equals(object obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source exhibitionOnly bool if true, the extended file creation is suppressed. Returns XElement An XML element representing the object's state Remarks For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToUserString() Returns a user-friendly string representation of the file and line numbers. public string ToUserString() Returns string A string in the format “(FileNo:X,LineNo:Y)” ToXElement() Converts the current instance to an XElement. public XElement ToXElement() Returns XElement An XElement representing this index."
+ "summary": "Class FileLineIndex Namespace Hi.Common.FileLines Assembly HiGeom.dll Represents a location in a file by its file index and line number. public class FileLineIndex : IFileLineIndex, IGetFileLineIndex, IComparable, IMakeXmlSource, IToXElement, IToPresentDto Inheritance object FileLineIndex Implements IFileLineIndex IGetFileLineIndex IComparable IMakeXmlSource IToXElement IToPresentDto Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MathUtil.Clamp(T, T, T) FileLineUtil.GetFileNo(IFileLineIndex) FileLineUtil.GetLineNo(IFileLineIndex) FileLineUtil.MixedIndex(IFileLineIndex) FileLineUtil.MixedIndex(IGetFileLineIndex) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors FileLineIndex() Initializes a new instance of the FileLineIndex class. public FileLineIndex() FileLineIndex(IFileLineIndex) Initializes a new instance of the FileLineIndex class by copying another instance. public FileLineIndex(IFileLineIndex src) Parameters src IFileLineIndex The source FileLineIndex to copy from FileLineIndex(int, int) Initializes a new instance of the FileLineIndex class with specified indices. public FileLineIndex(int fileIndex, int lineIndex) Parameters fileIndex int The zero-based file index lineIndex int The zero-based line index FileLineIndex(XElement) Initializes a new instance of the FileLineIndex class from an XML element. public FileLineIndex(XElement src) Parameters src XElement The XML element containing the file and line indices Properties FileIndex File Index. Start on 0. public int FileIndex { get; set; } Property Value int FileNo Gets or sets the one-based file number (FileIndex + 1) public int FileNo { get; set; } Property Value int LineIndex Line Index. Start on 0. public int LineIndex { get; set; } Property Value int LineNo Gets or sets the one-based line number (LineIndex + 1) public int LineNo { get; set; } Property Value int XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string Methods CompareTo(IFileLineIndex) Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. public int CompareTo(IFileLineIndex other) Parameters other IFileLineIndex An object to compare with this instance. Returns int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order. Equals(object) Determines whether the specified object is equal to the current object. public override bool Equals(object obj) Parameters obj object The object to compare with the current object. Returns bool true if the specified object is equal to the current object; otherwise, false. GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source exhibitionOnly bool if true, the extended file creation is suppressed. Returns XElement An XML element representing the object's state Remarks For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file. ToPresentDto() Convert to presentation DTO (Data Transfer Object) for JSON serialization. The returned object includes type metadata for web API presentation. public object ToPresentDto() Returns object DTO object with type and object properties ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToUserString() Returns a user-friendly string representation of the file and line numbers. public string ToUserString() Returns string A string in the format “(FileNo:X,LineNo:Y)” ToXElement() Converts the current instance to an XElement. public XElement ToXElement() Returns XElement An XElement representing this index. Operators operator ==(FileLineIndex, FileLineIndex) Determines whether two FileLineIndex instances are equal. public static bool operator ==(FileLineIndex left, FileLineIndex right) Parameters left FileLineIndex right FileLineIndex Returns bool operator >(FileLineIndex, FileLineIndex) Determines whether left is greater than right. public static bool operator >(FileLineIndex left, FileLineIndex right) Parameters left FileLineIndex right FileLineIndex Returns bool operator >=(FileLineIndex, FileLineIndex) Determines whether left is greater than or equal to right. public static bool operator >=(FileLineIndex left, FileLineIndex right) Parameters left FileLineIndex right FileLineIndex Returns bool operator !=(FileLineIndex, FileLineIndex) Determines whether two FileLineIndex instances are not equal. public static bool operator !=(FileLineIndex left, FileLineIndex right) Parameters left FileLineIndex right FileLineIndex Returns bool operator <(FileLineIndex, FileLineIndex) Determines whether left is less than right. public static bool operator <(FileLineIndex left, FileLineIndex right) Parameters left FileLineIndex right FileLineIndex Returns bool operator <=(FileLineIndex, FileLineIndex) Determines whether left is less than or equal to right. public static bool operator <=(FileLineIndex left, FileLineIndex right) Parameters left FileLineIndex right FileLineIndex Returns bool"
},
"api/Hi.Common.FileLines.FileLinePipingKit.html": {
"href": "api/Hi.Common.FileLines.FileLinePipingKit.html",
@@ -492,7 +497,7 @@
"api/Hi.Common.FileLines.FileLineUtil.html": {
"href": "api/Hi.Common.FileLines.FileLineUtil.html",
"title": "Class FileLineUtil | HiAPI-C# 2025",
- "summary": "Class FileLineUtil Namespace Hi.Common.FileLines Assembly HiGeom.dll Utility of IFileLineIndex. public static class FileLineUtil Inheritance object FileLineUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetFileNo(IFileLineIndex) Gets the file number (1-based) from the file line index. public static int GetFileNo(this IFileLineIndex src) Parameters src IFileLineIndex The file line index. Returns int The file number (1-based). GetLineNo(IFileLineIndex) Gets the line number (1-based) from the file line index. public static int GetLineNo(this IFileLineIndex src) Parameters src IFileLineIndex The file line index. Returns int The line number (1-based). GetMixedIndex(int, int) Creates a mixed index from file index and line index. public static int GetMixedIndex(int fileIndex, int lineIndex) Parameters fileIndex int The file index (0-based). lineIndex int The line index (0-based). Returns int A mixed index combining file and line indices. MixedIndex(IFileLineIndex) Mix FileIndex and LineIndex. Return FileIndex* 1_000_000_000 + LineIndex. public static int MixedIndex(this IFileLineIndex src) Parameters src IFileLineIndex src Returns int Mixed number MixedIndex(IGetFileLineIndex) Mix FileIndex and LineIndex. Return FileIndex* 1_000_000_000 + LineIndex. public static int MixedIndex(this IGetFileLineIndex src) Parameters src IGetFileLineIndex src Returns int Mixed number"
+ "summary": "Class FileLineUtil Namespace Hi.Common.FileLines Assembly HiGeom.dll Utility of IFileLineIndex. public static class FileLineUtil Inheritance object FileLineUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetFileNo(IFileLineIndex) Gets the file number (1-based) from the file line index. public static int GetFileNo(this IFileLineIndex src) Parameters src IFileLineIndex The file line index. Returns int The file number (1-based). GetLineNo(IFileLineIndex) Gets the line number (1-based) from the file line index. public static int GetLineNo(this IFileLineIndex src) Parameters src IFileLineIndex The file line index. Returns int The line number (1-based). GetMixedIndex(int, int) Creates a mixed index from file index and line index. public static int GetMixedIndex(int fileIndex, int lineIndex) Parameters fileIndex int The file index (0-based). lineIndex int The line index (0-based). Returns int A mixed index combining file and line indices. MixedIndex(IFileLineIndex) Mix FileIndex and LineIndex. Return FileIndex* 10_000_000 + LineIndex. public static int MixedIndex(this IFileLineIndex src) Parameters src IFileLineIndex src Returns int Mixed number MixedIndex(IGetFileLineIndex) Mix FileIndex and LineIndex. Return FileIndex* 10_000_000 + LineIndex. public static int MixedIndex(this IGetFileLineIndex src) Parameters src IGetFileLineIndex src Returns int Mixed number"
},
"api/Hi.Common.FileLines.FileUtil.html": {
"href": "api/Hi.Common.FileLines.FileUtil.html",
@@ -652,7 +657,7 @@
"api/Hi.Common.JsonUtil.html": {
"href": "api/Hi.Common.JsonUtil.html",
"title": "Class JsonUtil | HiAPI-C# 2025",
- "summary": "Class JsonUtil Namespace Hi.Common Assembly HiGeom.dll Helper utilities for reading and writing JSON files. public static class JsonUtil Inheritance object JsonUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods WritePartialJson(string, string, TConfig) Writes a config object into a named section of a JSON file; merges when file exists and overwrites the same section name. public static void WritePartialJson(string filePath, string configName, TConfig config) Parameters filePath string JSON file path configName string Section name to write config TConfig Section object to write Type Parameters TConfig Type of the config object"
+ "summary": "Class JsonUtil Namespace Hi.Common Assembly HiGeom.dll Helper utilities for reading and writing JSON files. public static class JsonUtil Inheritance object JsonUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods CallJsonObjectByPath(JsonObject, IEnumerable) public static JsonObject CallJsonObjectByPath(this JsonObject srcdst, IEnumerable jsonObjectPath) Parameters srcdst JsonObject jsonObjectPath IEnumerable Returns JsonObject WritePartialJson(string, string, TConfig) Writes a config object into a named section of a JSON file; merges when file exists and overwrites the same section name. public static void WritePartialJson(string filePath, string configName, TConfig config) Parameters filePath string JSON file path configName string Section name to write config TConfig Section object to write Type Parameters TConfig Type of the config object"
},
"api/Hi.Common.LooseRunner.MergedCancellationTokenRun.html": {
"href": "api/Hi.Common.LooseRunner.MergedCancellationTokenRun.html",
@@ -1897,7 +1902,7 @@
"api/Hi.MachiningProcs.LocalProjectService.html": {
"href": "api/Hi.MachiningProcs.LocalProjectService.html",
"title": "Class LocalProjectService | HiAPI-C# 2025",
- "summary": "Class LocalProjectService Namespace Hi.MachiningProcs Assembly HiNc.dll Root(Local) project service. Apply absolute file path. public class LocalProjectService : IProjectService, IMachiningProjectGetter, IMachiningStepHost, IGetMachiningEquipment, IDisposable Inheritance object LocalProjectService Implements IProjectService IMachiningProjectGetter IMachiningStepHost IGetMachiningEquipment IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks LocalProjectService handles the runtime data and cache generally not requires configuration IO. Compare to MachiningProject, LocalProjectService also handles events that does not reset on the MachiningProject been reloaded. Constructors LocalProjectService() Ctor. public LocalProjectService() LocalProjectService(UserService, ILogger) Initializes a new instance. public LocalProjectService(UserService userService, ILogger logger) Parameters userService UserService The application service. logger ILogger The logger instance. Properties BoundSelectorHost Gets the bound selector host for managing selection boundaries. public BoundSelectorHost BoundSelectorHost { get; } Property Value BoundSelectorHost ClStrip Gets the cutter location strip containing the machining steps. public ClStrip ClStrip { get; } Property Value ClStrip CoordinateEntryDisplayee Gets the displayee for coordinate entry visualization. public CoordinateEntryDisplayee CoordinateEntryDisplayee { get; } Property Value CoordinateEntryDisplayee DictionaryColorGuide Gets the color guide for dictionary-based coloring. public DictionaryColorGuide DictionaryColorGuide { get; } Property Value DictionaryColorGuide EnableCollisionDetection Gets or sets whether collision detection is enabled. When set to true, initializes collision detection mechanism. public bool EnableCollisionDetection { get; set; } Property Value bool EnablePauseOnFailure Gets or sets whether to pause execution on failure. public bool EnablePauseOnFailure { get; set; } Property Value bool EnableStrokeLimitCheck Gets or sets whether stroke limit checking is enabled. public bool EnableStrokeLimitCheck { get; set; } Property Value bool Fixture Gets or sets the fixture. public Fixture Fixture { get; set; } Property Value Fixture Global global variable for RuntimeApi. Not save on XML. public Dictionary Global { get; set; } Property Value Dictionary InspectingKey Gets or sets the current inspecting key for visualization. When set, updates the inspecting quantity function. public string InspectingKey { get; set; } Property Value string InspectingQuantityFunc Gets the function that retrieves the quantity value for the current inspecting key. public Func InspectingQuantityFunc { get; } Property Value Func Logger Gets the logger instance for this service. public ILogger Logger { get; } Property Value ILogger MachiningActRunner Gets the machining act runner responsible for executing machining operations. public MachiningActRunner MachiningActRunner { get; } Property Value MachiningActRunner MachiningChain Gets or sets the machining chain. public IMachiningChain MachiningChain { get; set; } Property Value IMachiningChain MachiningChainFile Gets or sets the file path of the solid machining chain. This is used for XML serialization and file management. public string MachiningChainFile { get; set; } Property Value string MachiningEquipment Gets or sets the machining equipment used for milling. Updates related components when changed. public MachiningEquipment MachiningEquipment { get; set; } Property Value MachiningEquipment MachiningProject Gets or sets the machining project instance. public MachiningProject MachiningProject { get; set; } Property Value MachiningProject MachiningProjectPath public string MachiningProjectPath { get; set; } Property Value string MachiningSession Gets the current machining session. public MachiningSession MachiningSession { get; set; } Property Value MachiningSession MachiningTool Gets or sets the machining tool. public IMachiningTool MachiningTool { get; set; } Property Value IMachiningTool MachiningToolHouse Gets or sets the machining tool house containing tool configurations. public MachiningToolHouse MachiningToolHouse { get; set; } Property Value MachiningToolHouse MachiningToolHouseFile Gets or sets the file path to the milling tool house configuration. public string MachiningToolHouseFile { get; set; } Property Value string MillingStepLuggageReader Gets the reader for accessing milling step luggage data. public ParallelBulkReader MillingStepLuggageReader { get; } Property Value ParallelBulkReader NcOptProc Gets the NC optimization processor for optimizing NC programs. public NcOptProc NcOptProc { get; } Property Value NcOptProc NcRunner Gets the NC runner responsible for executing NC programs. public NcRunner NcRunner { get; } Property Value NcRunner PacePlayer Gets the pace player for controlling execution pace of milling operations. public PacePlayer PacePlayer { get; } Property Value PacePlayer Progress Gets the progress reporting mechanism for long-running operations. public Progress Progress { get; } Property Value Progress ProjectDirectory Gets the directory containing the machining project. public string ProjectDirectory { get; } Property Value string RuntimeApi Gets the shell API for interacting with this machining process. public RuntimeApi RuntimeApi { get; } Property Value RuntimeApi SessionMessageHost Gets the message host for displaying messages, warnings, and errors. public SessionMessageHost SessionMessageHost { get; } Property Value SessionMessageHost StepPropertyAccessDictionary Gets the dictionary mapping property keys to their access methods. public ConcurrentDictionary> StepPropertyAccessDictionary { get; } Property Value ConcurrentDictionary> TimeMapping Gets or sets the time mapping for synchronizing different time-based data streams. public TimeMapping TimeMapping { get; set; } Property Value TimeMapping UserService Gets the application service instance. public UserService UserService { get; } Property Value UserService Workpiece Gets or sets the workpiece to be machined. Ensures proper initialization of workpiece properties. public Workpiece Workpiece { get; set; } Property Value Workpiece Methods Act(IAct, IIndexedFileLine, CancellationToken?) Executes an act and collects all results. public void Act(IAct act, IIndexedFileLine sourceCommand = null, CancellationToken? cancellationToken = null) Parameters act IAct The act to execute. sourceCommand IIndexedFileLine The source command that triggered the act. cancellationToken CancellationToken? Cancellation token to cancel the operation. BeginSession() Initiate a simulation session. Clear the state from previous session (if existed). public void BeginSession() CloseProject() Closes the current project. public void CloseProject() Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool EndSession() Ends the current machining session and releases associated resources. public void EndSession() GetInspectingKeyPresentName(StringLocalizer) Gets the localized presentation name for the current inspecting key. public string GetInspectingKeyPresentName(StringLocalizer stringLocalizer) Parameters stringLocalizer StringLocalizer The string localizer to use for localization Returns string The localized presentation name GetLocalProjectService() Get Local Project Service as base-service. public LocalProjectService GetLocalProjectService() Returns LocalProjectService Local Project Service GetMachiningProject() Gets the MachiningProject instance. public MachiningProject GetMachiningProject() Returns MachiningProject The MachiningProject instance. GetMillingEquipment() Get MachiningEquipment. public MachiningEquipment GetMillingEquipment() Returns MachiningEquipment MachiningEquipment LoadProject(string) Loads a project by file path relative to the admin directory. public void LoadProject(string projectPath) Parameters projectPath string The absolute file path NewProject(string) Creates a new project by file path. public void NewProject(string projectPath) Parameters projectPath string The absolute file path PlayCsvFile(string, string) Plays a CSV file from the specified path. public void PlayCsvFile(string baseDirectory, string relFilePath) Parameters baseDirectory string Base directory for resolving relative paths. relFilePath string Relative path to the CSV file. PlayNc(string, string) Plays NC commands from raw text with pace control. public void PlayNc(string ncText, string fileNameAlternative = \"--\") Parameters ncText string The NC command text to execute fileNameAlternative string Alternative name to associate with the NC program PlayNcFile(string, string) Plays an NC file from the specified path with pace control. public void PlayNcFile(string baseDirectory, string relFilePath) Parameters baseDirectory string Base directory for resolving relative paths relFilePath string Relative path to the NC file ProcAct(IAct, IIndexedFileLine, CancellationToken?) Processes an act and returns the results. public IEnumerable