diff --git a/App/Accessibility.dll b/App/Accessibility.dll index 00c91431..d1d61616 100644 Binary files a/App/Accessibility.dll and b/App/Accessibility.dll differ diff --git a/App/DirectWriteForwarder.dll b/App/DirectWriteForwarder.dll index bc6c330f..4abcfe48 100644 Binary files a/App/DirectWriteForwarder.dll and b/App/DirectWriteForwarder.dll differ diff --git a/App/Hi.Wpf.dll b/App/Hi.Wpf.dll index 8c0faad0..265f8c3b 100644 Binary files a/App/Hi.Wpf.dll and b/App/Hi.Wpf.dll differ diff --git a/App/HiCbtr.dll b/App/HiCbtr.dll index adcfb5b5..542c4685 100644 Binary files a/App/HiCbtr.dll and b/App/HiCbtr.dll differ diff --git a/App/HiDisp.dll b/App/HiDisp.dll index d13e6940..32ad6680 100644 Binary files a/App/HiDisp.dll and b/App/HiDisp.dll differ diff --git a/App/HiGeom.dll b/App/HiGeom.dll index e02f1cc7..b36aa151 100644 Binary files a/App/HiGeom.dll and b/App/HiGeom.dll differ diff --git a/App/HiLicense.dll b/App/HiLicense.dll index 322ee546..d51dbe33 100644 Binary files a/App/HiLicense.dll and b/App/HiLicense.dll differ diff --git a/App/HiMech.dll b/App/HiMech.dll index e9c952e3..3cf92e76 100644 Binary files a/App/HiMech.dll and b/App/HiMech.dll differ diff --git a/App/HiNC-2025-win-desktop.deps.json b/App/HiNC-2025-win-desktop.deps.json index b1026d41..4078b06d 100644 --- a/App/HiNC-2025-win-desktop.deps.json +++ b/App/HiNC-2025-win-desktop.deps.json @@ -11,677 +11,681 @@ "dependencies": { "AvalonEdit": "6.3.0.90", "FontAwesome.Sharp": "6.3.0", - "Hi.Wpf": "3.1.2", - "HiNc": "3.1.6", - "runtimepack.Microsoft.NETCore.App.Runtime.win-x64": "9.0.5", - "runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64": "9.0.5", - "runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64": "9.0.5" + "Hi.Wpf": "3.1.4", + "HiNc": "3.1.15", + "runtimepack.Microsoft.NETCore.App.Runtime.win-x64": "9.0.7", + "runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64": "9.0.7", + "runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64": "9.0.7" }, "runtime": { "HiNC-2025-win-desktop.dll": {} } }, - "runtimepack.Microsoft.NETCore.App.Runtime.win-x64/9.0.5": { + "runtimepack.Microsoft.NETCore.App.Runtime.win-x64/9.0.7": { "runtime": { "Microsoft.CSharp.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.VisualBasic.Core.dll": { "assemblyVersion": "14.0.0.0", - "fileVersion": "14.0.525.21509" + "fileVersion": "14.0.725.31616" }, "Microsoft.Win32.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Win32.Registry.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.AppContext.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Buffers.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Collections.Concurrent.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Collections.Immutable.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Collections.NonGeneric.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Collections.Specialized.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Collections.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ComponentModel.Annotations.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ComponentModel.DataAnnotations.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ComponentModel.EventBasedAsync.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ComponentModel.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ComponentModel.TypeConverter.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ComponentModel.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Configuration.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Console.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Core.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Data.Common.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Data.DataSetExtensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Data.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.Contracts.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.Debug.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.DiagnosticSource.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.FileVersionInfo.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.Process.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.StackTrace.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.TextWriterTraceListener.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.Tools.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.TraceSource.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Diagnostics.Tracing.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Drawing.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Dynamic.Runtime.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Formats.Asn1.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Formats.Tar.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Globalization.Calendars.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Globalization.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Globalization.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.Compression.Brotli.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.Compression.FileSystem.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.Compression.ZipFile.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.Compression.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.FileSystem.AccessControl.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.FileSystem.DriveInfo.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.FileSystem.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.FileSystem.Watcher.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.FileSystem.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.IsolatedStorage.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.MemoryMappedFiles.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" + }, + "System.IO.Pipelines.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31616" }, "System.IO.Pipes.AccessControl.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.Pipes.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.UnmanagedMemoryStream.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.IO.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Linq.Expressions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Linq.Parallel.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Linq.Queryable.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Linq.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Memory.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Http.Json.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Http.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.HttpListener.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Mail.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.NameResolution.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.NetworkInformation.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Ping.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Quic.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Requests.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Security.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.ServicePoint.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.Sockets.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.WebClient.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.WebHeaderCollection.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.WebProxy.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.WebSockets.Client.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.WebSockets.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Net.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Numerics.Vectors.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Numerics.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ObjectModel.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Private.CoreLib.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Private.DataContractSerialization.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Private.Uri.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Private.Xml.Linq.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Private.Xml.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.DispatchProxy.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.Emit.ILGeneration.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.Emit.Lightweight.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.Emit.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.Metadata.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.TypeExtensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Reflection.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Resources.Reader.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Resources.ResourceManager.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Resources.Writer.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.CompilerServices.Unsafe.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.CompilerServices.VisualC.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Handles.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.InteropServices.JavaScript.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.InteropServices.RuntimeInformation.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.InteropServices.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Intrinsics.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Loader.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Numerics.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Serialization.Formatters.dll": { "assemblyVersion": "8.1.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Serialization.Json.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Serialization.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Serialization.Xml.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.Serialization.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Runtime.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.AccessControl.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Claims.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.Algorithms.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.Cng.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.Csp.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.Encoding.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.OpenSsl.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.X509Certificates.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Principal.Windows.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Principal.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.SecureString.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ServiceModel.Web.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ServiceProcess.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Text.Encoding.CodePages.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Text.Encoding.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Text.Encoding.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Text.Encodings.Web.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Text.Json.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Text.RegularExpressions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Channels.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Overlapped.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Tasks.Dataflow.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Tasks.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Tasks.Parallel.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Tasks.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Thread.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.ThreadPool.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.Timer.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Transactions.Local.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Transactions.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.ValueTuple.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Web.HttpUtility.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Web.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Windows.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.Linq.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.ReaderWriter.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.Serialization.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.XDocument.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.XPath.XDocument.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.XPath.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.XmlDocument.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.XmlSerializer.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Xml.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "mscorlib.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "netstandard.dll": { "assemblyVersion": "2.1.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" } }, "native": { @@ -689,246 +693,278 @@ "fileVersion": "14.42.34436.0" }, "System.IO.Compression.Native.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "clretwrc.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "clrgc.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "clrgcexp.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "clrjit.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "coreclr.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "createdump.exe": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "hostfxr.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "hostpolicy.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "mscordaccore.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, - "mscordaccore_amd64_amd64_9.0.525.21509.dll": { - "fileVersion": "9.0.525.21509" + "mscordaccore_amd64_amd64_9.0.725.31616.dll": { + "fileVersion": "9.0.725.31616" }, "mscordbi.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "mscorrc.dll": { - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "msquic.dll": { "fileVersion": "2.4.8.0" } } }, - "runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64/9.0.5": { + "runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64/9.0.7": { "runtime": { "Accessibility.dll": { "assemblyVersion": "4.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "DirectWriteForwarder.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "Microsoft.VisualBasic.Forms.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "Microsoft.VisualBasic.dll": { "assemblyVersion": "10.1.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "Microsoft.Win32.Registry.AccessControl.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" + }, + "Microsoft.Win32.SystemEvents.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31616" }, "PresentationCore.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework-SystemCore.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework-SystemData.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework-SystemDrawing.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework-SystemXml.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework-SystemXmlLinq.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.Aero.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.Aero2.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.AeroLite.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.Classic.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.Fluent.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.Luna.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.Royale.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationFramework.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationUI.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "ReachFramework.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "System.CodeDom.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" + }, + "System.Configuration.ConfigurationManager.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31616" }, "System.Design.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "System.Diagnostics.EventLog.Messages.dll": { "assemblyVersion": "9.0.0.0", "fileVersion": "0.0.0.0" }, + "System.Diagnostics.EventLog.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31616" + }, "System.Diagnostics.PerformanceCounter.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.DirectoryServices.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" + }, + "System.Drawing.Common.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31604" }, "System.Drawing.Design.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "System.Drawing.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" + }, + "System.Formats.Nrbf.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31616" }, "System.IO.Packaging.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Printing.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" + }, + "System.Private.Windows.Core.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31604" + }, + "System.Resources.Extensions.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.Pkcs.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" + }, + "System.Security.Cryptography.ProtectedData.dll": { + "assemblyVersion": "9.0.0.0", + "fileVersion": "9.0.725.31616" }, "System.Security.Cryptography.Xml.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Security.Permissions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Threading.AccessControl.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Windows.Controls.Ribbon.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "System.Windows.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "System.Windows.Forms.Design.Editors.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "System.Windows.Forms.Design.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "System.Windows.Forms.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "System.Windows.Forms.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21601" + "fileVersion": "9.0.725.31604" }, "System.Windows.Input.Manipulations.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "System.Windows.Presentation.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "System.Xaml.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "UIAutomationClient.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "UIAutomationClientSideProviders.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "UIAutomationProvider.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "UIAutomationTypes.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "WindowsBase.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "WindowsFormsIntegration.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" } }, "native": { @@ -936,569 +972,569 @@ "fileVersion": "10.0.22621.3233" }, "PenImc_cor3.dll": { - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" }, "PresentationNative_cor3.dll": { "fileVersion": "9.0.25.16803" }, "vcruntime140_cor3.dll": { - "fileVersion": "14.44.34823.2" + "fileVersion": "14.44.34918.1" }, "wpfgfx_cor3.dll": { - "fileVersion": "9.0.525.21602" + "fileVersion": "9.0.725.31701" } } }, - "runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64/9.0.5": { + "runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64/9.0.7": { "runtime": { "Microsoft.AspNetCore.Antiforgery.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authentication.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authentication.BearerToken.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authentication.Cookies.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authentication.Core.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authentication.OAuth.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authentication.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authorization.Policy.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Authorization.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Components.Authorization.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Components.Endpoints.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Components.Forms.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Components.Server.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Components.Web.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Components.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Connections.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.CookiePolicy.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Cors.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Cryptography.Internal.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Cryptography.KeyDerivation.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.DataProtection.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.DataProtection.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.DataProtection.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Diagnostics.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Diagnostics.HealthChecks.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Diagnostics.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.HostFiltering.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Hosting.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Hosting.Server.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Hosting.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Html.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Http.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Http.Connections.Common.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Http.Connections.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Http.Extensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Http.Features.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Http.Results.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Http.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.HttpLogging.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.HttpOverrides.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.HttpsPolicy.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Identity.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Localization.Routing.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Localization.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Metadata.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.ApiExplorer.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.Core.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.Cors.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.DataAnnotations.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.Formatters.Json.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.Formatters.Xml.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.Localization.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.Razor.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.RazorPages.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.TagHelpers.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.ViewFeatures.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Mvc.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.OutputCaching.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.RateLimiting.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Razor.Runtime.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Razor.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.RequestDecompression.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.ResponseCaching.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.ResponseCaching.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.ResponseCompression.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Rewrite.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Routing.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Routing.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.HttpSys.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.IIS.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.IISIntegration.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.Kestrel.Core.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.Kestrel.Transport.NamedPipes.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Server.Kestrel.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.Session.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.SignalR.Common.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.SignalR.Core.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.SignalR.Protocols.Json.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.SignalR.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.StaticAssets.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.StaticFiles.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.WebSockets.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.WebUtilities.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.AspNetCore.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Caching.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Caching.Memory.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.Binder.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.CommandLine.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.EnvironmentVariables.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.FileExtensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.Ini.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.Json.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.KeyPerFile.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Configuration.UserSecrets.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.Xml.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Configuration.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.DependencyInjection.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.DependencyInjection.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Diagnostics.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Diagnostics.HealthChecks.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Diagnostics.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Features.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.FileProviders.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.FileProviders.Composite.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.FileProviders.Embedded.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.FileProviders.Physical.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.FileSystemGlobbing.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Hosting.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Hosting.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Http.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Identity.Core.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Identity.Stores.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Localization.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Localization.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Logging.Abstractions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Logging.Configuration.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Logging.Console.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Logging.Debug.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Logging.EventLog.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Logging.EventSource.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Logging.TraceSource.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Logging.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.ObjectPool.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Extensions.Options.ConfigurationExtensions.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Options.DataAnnotations.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Options.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.Primitives.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" }, "Microsoft.Extensions.WebEncoders.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.JSInterop.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "Microsoft.Net.Http.Headers.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.22904" + "fileVersion": "9.0.725.31702" }, "System.Threading.RateLimiting.dll": { "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.525.21509" + "fileVersion": "9.0.725.31616" } }, "native": { "aspnetcorev2_inprocess.dll": { - "fileVersion": "19.0.25119.5" + "fileVersion": "19.0.25168.7" } } }, @@ -1638,40 +1674,40 @@ } }, "Grpc.Tools/2.66.0": {}, - "Hi.Wpf/3.1.2": { + "Hi.Wpf/3.1.4": { "dependencies": { - "HiDisp": "3.1.4" + "HiDisp": "3.1.5" }, "runtime": { "lib/net9.0-windows7.0/Hi.Wpf.dll": { - "assemblyVersion": "3.1.2.0", - "fileVersion": "3.1.2.0" + "assemblyVersion": "3.1.4.0", + "fileVersion": "3.1.4.0" } } }, - "HiCbtr/3.1.5": { + "HiCbtr/3.1.6": { "dependencies": { - "HiDisp": "3.1.4", + "HiDisp": "3.1.5", "MongoDB.Driver.GridFS": "2.30.0" }, "runtime": { "lib/net9.0/HiCbtr.dll": { - "assemblyVersion": "3.1.5.0", - "fileVersion": "3.1.5.0" + "assemblyVersion": "3.1.6.0", + "fileVersion": "3.1.6.0" } } }, - "HiDisp/3.1.4": { + "HiDisp/3.1.5": { "dependencies": { - "HiGeom": "3.1.5", + "HiGeom": "3.1.6", "System.Configuration.ConfigurationManager": "9.0.7", "System.Drawing.Common": "9.0.7", "System.Resources.Extensions": "9.0.7" }, "runtime": { "lib/net9.0/HiDisp.dll": { - "assemblyVersion": "3.1.4.0", - "fileVersion": "3.1.4.0" + "assemblyVersion": "3.1.5.0", + "fileVersion": "3.1.5.0" } }, "native": { @@ -1686,7 +1722,7 @@ } } }, - "HiGeom/3.1.5": { + "HiGeom/3.1.6": { "dependencies": { "Google.Protobuf": "3.28.3", "Grpc.AspNetCore": "2.66.0", @@ -1697,8 +1733,8 @@ }, "runtime": { "lib/net9.0/HiGeom.dll": { - "assemblyVersion": "3.1.5.0", - "fileVersion": "3.1.5.0" + "assemblyVersion": "3.1.6.0", + "fileVersion": "3.1.6.0" } }, "resources": { @@ -1710,27 +1746,27 @@ } } }, - "HiLicense/3.1.3": { + "HiLicense/3.1.4": { "dependencies": { - "HiGeom": "3.1.5" + "HiGeom": "3.1.6" }, "runtime": { "lib/net9.0/HiLicense.dll": { - "assemblyVersion": "3.1.3.0", - "fileVersion": "3.1.3.0" + "assemblyVersion": "3.1.4.0", + "fileVersion": "3.1.4.0" } } }, - "HiMech/3.1.4": { + "HiMech/3.1.5": { "dependencies": { "CommandLineParser": "2.9.1", - "HiCbtr": "3.1.5", + "HiCbtr": "3.1.6", "Microsoft.CodeAnalysis.CSharp.Scripting": "4.14.0" }, "runtime": { "lib/net9.0/HiMech.dll": { - "assemblyVersion": "3.1.4.0", - "fileVersion": "3.1.4.0" + "assemblyVersion": "3.1.5.0", + "fileVersion": "3.1.5.0" } }, "resources": { @@ -1745,20 +1781,20 @@ } } }, - "HiNc/3.1.6": { + "HiNc/3.1.15": { "dependencies": { "Google.Protobuf": "3.28.3", "Grpc.AspNetCore": "2.66.0", "Grpc.Net.Client": "2.66.0", - "HiLicense": "3.1.3", - "HiMech": "3.1.4", - "HiUniNc": "3.1.4", + "HiLicense": "3.1.4", + "HiMech": "3.1.5", + "HiUniNc": "3.1.5", "System.IO.Pipelines": "9.0.7" }, "runtime": { "lib/net9.0/HiNc.dll": { - "assemblyVersion": "3.1.6.0", - "fileVersion": "3.1.6.0" + "assemblyVersion": "3.1.15.0", + "fileVersion": "3.1.15.0" } }, "resources": { @@ -1770,14 +1806,14 @@ } } }, - "HiUniNc/3.1.4": { + "HiUniNc/3.1.5": { "dependencies": { - "HiMech": "3.1.4" + "HiMech": "3.1.5" }, "runtime": { "lib/net9.0/HiUniNc.dll": { - "assemblyVersion": "3.1.4.0", - "fileVersion": "3.1.4.0" + "assemblyVersion": "3.1.5.0", + "fileVersion": "3.1.5.0" } } }, @@ -2056,14 +2092,7 @@ "System.Security.Principal.Windows": "5.0.0" } }, - "Microsoft.Win32.SystemEvents/9.0.7": { - "runtime": { - "runtimes/win/lib/net9.0/Microsoft.Win32.SystemEvents.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31616" - } - } - }, + "Microsoft.Win32.SystemEvents/9.0.7": {}, "MongoDB.Bson/2.30.0": { "dependencies": { "System.Memory": "4.5.5", @@ -2157,12 +2186,6 @@ "dependencies": { "System.Diagnostics.EventLog": "9.0.7", "System.Security.Cryptography.ProtectedData": "9.0.7" - }, - "runtime": { - "lib/net9.0/System.Configuration.ConfigurationManager.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31616" - } } }, "System.Diagnostics.DiagnosticSource/6.0.0": { @@ -2170,56 +2193,19 @@ "System.Runtime.CompilerServices.Unsafe": "6.0.0" } }, - "System.Diagnostics.EventLog/9.0.7": { - "runtime": { - "runtimes/win/lib/net9.0/System.Diagnostics.EventLog.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31616" - } - } - }, + "System.Diagnostics.EventLog/9.0.7": {}, "System.Drawing.Common/9.0.7": { "dependencies": { "Microsoft.Win32.SystemEvents": "9.0.7" - }, - "runtime": { - "lib/net9.0/System.Drawing.Common.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31604" - }, - "lib/net9.0/System.Private.Windows.Core.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31604" - } - } - }, - "System.Formats.Nrbf/9.0.7": { - "runtime": { - "lib/net9.0/System.Formats.Nrbf.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31616" - } - } - }, - "System.IO.Pipelines/9.0.7": { - "runtime": { - "lib/net9.0/System.IO.Pipelines.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31616" - } } }, + "System.Formats.Nrbf/9.0.7": {}, + "System.IO.Pipelines/9.0.7": {}, "System.Memory/4.5.5": {}, "System.Reflection.Metadata/9.0.0": {}, "System.Resources.Extensions/9.0.7": { "dependencies": { "System.Formats.Nrbf": "9.0.7" - }, - "runtime": { - "lib/net9.0/System.Resources.Extensions.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31616" - } } }, "System.Runtime.CompilerServices.Unsafe/6.0.0": {}, @@ -2229,14 +2215,7 @@ "System.Security.Principal.Windows": "5.0.0" } }, - "System.Security.Cryptography.ProtectedData/9.0.7": { - "runtime": { - "lib/net9.0/System.Security.Cryptography.ProtectedData.dll": { - "assemblyVersion": "9.0.0.0", - "fileVersion": "9.0.725.31616" - } - } - }, + "System.Security.Cryptography.ProtectedData/9.0.7": {}, "System.Security.Principal.Windows/5.0.0": {}, "ZstdSharp.Port/0.7.3": { "runtime": { @@ -2254,17 +2233,17 @@ "serviceable": false, "sha512": "" }, - "runtimepack.Microsoft.NETCore.App.Runtime.win-x64/9.0.5": { + "runtimepack.Microsoft.NETCore.App.Runtime.win-x64/9.0.7": { "type": "runtimepack", "serviceable": false, "sha512": "" }, - "runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64/9.0.5": { + "runtimepack.Microsoft.WindowsDesktop.App.Runtime.win-x64/9.0.7": { "type": "runtimepack", "serviceable": false, "sha512": "" }, - "runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64/9.0.5": { + "runtimepack.Microsoft.AspNetCore.App.Runtime.win-x64/9.0.7": { "type": "runtimepack", "serviceable": false, "sha512": "" @@ -2374,61 +2353,61 @@ "path": "grpc.tools/2.66.0", "hashPath": "grpc.tools.2.66.0.nupkg.sha512" }, - "Hi.Wpf/3.1.2": { + "Hi.Wpf/3.1.4": { "type": "package", "serviceable": true, - "sha512": "sha512-lC58nzLkb5bC1AOqy+VfEHpMqxk9Uw7MWR/OtrxGXoFBTYq4UoYT6BhMRvA/G04MUzTRbi78fB2YW71ATWAwOw==", - "path": "hi.wpf/3.1.2", - "hashPath": "hi.wpf.3.1.2.nupkg.sha512" + "sha512": "sha512-FCY5qQmX9qjhlV3xDSYa2xUUCwQn0XaImbUg1nL6lVedild+7Se0ik+EC2rvCeR5lZUoGhiqWwH7quQ+bfnQNw==", + "path": "hi.wpf/3.1.4", + "hashPath": "hi.wpf.3.1.4.nupkg.sha512" }, - "HiCbtr/3.1.5": { + "HiCbtr/3.1.6": { "type": "package", "serviceable": true, - "sha512": "sha512-ihcrtsPC+3ee5cJJ2+CLr/HUilf2PsKWHvDNkqCFqp5npwNZvpORCs9sg048aNhZ4XhMxBhpl4p4bWobjskyyQ==", - "path": "hicbtr/3.1.5", - "hashPath": "hicbtr.3.1.5.nupkg.sha512" + "sha512": "sha512-9WHhvDbNzk+1IZ2+1riP8RofeYghHgNKzQZMdA0lucbwU1olNpRC1tMUf7vzPL5DuF2A5LcPnN+sZYVu80XojA==", + "path": "hicbtr/3.1.6", + "hashPath": "hicbtr.3.1.6.nupkg.sha512" }, - "HiDisp/3.1.4": { + "HiDisp/3.1.5": { "type": "package", "serviceable": true, - "sha512": "sha512-oRFXW5V18BxzTvBdGTMzkjBKwi205gh9YGKoJ+I2x37km7B2wltVA7SVjmh8+P15fsA21JMi93VqoDBYrgRLOA==", - "path": "hidisp/3.1.4", - "hashPath": "hidisp.3.1.4.nupkg.sha512" + "sha512": "sha512-3VwNjm3SoS4NaBW9x+Pg82lZ3xjOCAwExICWUska0x1/Lcyu/XKhz3/CRTd9rQqktn/xSGCRv1BBCVZ/x3D+iw==", + "path": "hidisp/3.1.5", + "hashPath": "hidisp.3.1.5.nupkg.sha512" }, - "HiGeom/3.1.5": { + "HiGeom/3.1.6": { "type": "package", "serviceable": true, - "sha512": "sha512-LKSqrgiqv7ZyRFbqcqmUWGFUwwK/Ze0FEKn6zJUXAysJV3KM5iTEqfr6o9RpMZVYmKvdU6gneM0cIKZKyqCdWg==", - "path": "higeom/3.1.5", - "hashPath": "higeom.3.1.5.nupkg.sha512" + "sha512": "sha512-IXC/qFHYk/Pu2UiiB8hyedvqbTZp+eSZixBsIMeqQ2vjUPGQ8iKphQWj/HyiPvU9NspxKhbLhrami5+YrqK2LQ==", + "path": "higeom/3.1.6", + "hashPath": "higeom.3.1.6.nupkg.sha512" }, - "HiLicense/3.1.3": { + "HiLicense/3.1.4": { "type": "package", "serviceable": true, - "sha512": "sha512-Z5L0L4HNRktfjJVpzD/S7lcXenCfKw5cfPAjoZeV706JFj+OdKCCM0lXc5pGu7CB51hXfS63IEWTsGB+Rx4zzw==", - "path": "hilicense/3.1.3", - "hashPath": "hilicense.3.1.3.nupkg.sha512" + "sha512": "sha512-9JTKfmYrqlJdHqq002WXjxw6kLMqHc5d9kr4ICJj3Beq4BxajVEE0dFWo6cq2nhRE5E/Chyn3FHjvfqmvIKTZQ==", + "path": "hilicense/3.1.4", + "hashPath": "hilicense.3.1.4.nupkg.sha512" }, - "HiMech/3.1.4": { + "HiMech/3.1.5": { "type": "package", "serviceable": true, - "sha512": "sha512-3dDCDlfii8BGmk+8/89Afh0GBxoUVAr53jxXkmUuG353K76wUK4GwzzB9nAwgmzwL1jIi0PVuh7SbXCfAHx+RA==", - "path": "himech/3.1.4", - "hashPath": "himech.3.1.4.nupkg.sha512" + "sha512": "sha512-lYYYHCoosZnakIHl1+C9ieQ6MpieOLy+vmAOb/GsPucqeCrx2Rx3zmbpAbz3On3q9KmuTYfrtaKxnSwcHKC+WA==", + "path": "himech/3.1.5", + "hashPath": "himech.3.1.5.nupkg.sha512" }, - "HiNc/3.1.6": { + "HiNc/3.1.15": { "type": "package", "serviceable": true, - "sha512": "sha512-uiFSZKru5qGz54Q8+YaO1hlW7qXtHL2SBMyvcHq7gYwrlX7VnXi983zMDlkQVXQ5KbcHdOO/bPDclw6xbWnusw==", - "path": "hinc/3.1.6", - "hashPath": "hinc.3.1.6.nupkg.sha512" + "sha512": "sha512-gs/AQCFK73HnwYvAIvQDltgewA32kdwBoNQDCQ459qEzrBYnsr7iofy/8AXuGkQxLZl1vQr1xNEWNEAMpUZDpg==", + "path": "hinc/3.1.15", + "hashPath": "hinc.3.1.15.nupkg.sha512" }, - "HiUniNc/3.1.4": { + "HiUniNc/3.1.5": { "type": "package", "serviceable": true, - "sha512": "sha512-lrlVQec0RKpIrtqkpzwx41jVwUqi32gMJD3GLYngrk7AKFbMTkN+x1vX9cVcxtwNpzJVAvwmnFqabdupQWzjjw==", - "path": "hiuninc/3.1.4", - "hashPath": "hiuninc.3.1.4.nupkg.sha512" + "sha512": "sha512-byaS+9BHglO1gSIjfI4eCUIJzJKpINPSiZZGVLXzMmPRfU1RMPxFKl5P9qyMuK+1Ktd2HKuZtGy2wyhvO6U2vw==", + "path": "hiuninc/3.1.5", + "hashPath": "hiuninc.3.1.5.nupkg.sha512" }, "MathNet.Numerics/5.0.0": { "type": "package", diff --git a/App/HiNC-2025-win-desktop.dll b/App/HiNC-2025-win-desktop.dll index 9b8f8bb4..f6f4f7f7 100644 Binary files a/App/HiNC-2025-win-desktop.dll and b/App/HiNC-2025-win-desktop.dll differ diff --git a/App/HiNC-2025-win-desktop.exe b/App/HiNC-2025-win-desktop.exe index 9d6711d0..bc5798e8 100644 Binary files a/App/HiNC-2025-win-desktop.exe and b/App/HiNC-2025-win-desktop.exe differ diff --git a/App/HiNC-2025-win-desktop.pdb b/App/HiNC-2025-win-desktop.pdb index b32ca5f4..38f9dece 100644 Binary files a/App/HiNC-2025-win-desktop.pdb and b/App/HiNC-2025-win-desktop.pdb differ diff --git a/App/HiNC-2025-win-desktop.runtimeconfig.json b/App/HiNC-2025-win-desktop.runtimeconfig.json index fd176997..6c768cd8 100644 --- a/App/HiNC-2025-win-desktop.runtimeconfig.json +++ b/App/HiNC-2025-win-desktop.runtimeconfig.json @@ -4,15 +4,15 @@ "includedFrameworks": [ { "name": "Microsoft.NETCore.App", - "version": "9.0.5" + "version": "9.0.7" }, { "name": "Microsoft.WindowsDesktop.App", - "version": "9.0.5" + "version": "9.0.7" }, { "name": "Microsoft.AspNetCore.App", - "version": "9.0.5" + "version": "9.0.7" } ], "configProperties": { diff --git a/App/HiNc.dll b/App/HiNc.dll index 5ecd1923..a13216cd 100644 Binary files a/App/HiNc.dll and b/App/HiNc.dll differ diff --git a/App/HiUniNc.dll b/App/HiUniNc.dll index 4c8400f9..2202c4eb 100644 Binary files a/App/HiUniNc.dll and b/App/HiUniNc.dll differ diff --git a/App/Microsoft.AspNetCore.Antiforgery.dll b/App/Microsoft.AspNetCore.Antiforgery.dll index 97767bed..1bbaf990 100644 Binary files a/App/Microsoft.AspNetCore.Antiforgery.dll and b/App/Microsoft.AspNetCore.Antiforgery.dll differ diff --git a/App/Microsoft.AspNetCore.Authentication.Abstractions.dll b/App/Microsoft.AspNetCore.Authentication.Abstractions.dll index f31e77fb..d56395cc 100644 Binary files a/App/Microsoft.AspNetCore.Authentication.Abstractions.dll and b/App/Microsoft.AspNetCore.Authentication.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Authentication.BearerToken.dll b/App/Microsoft.AspNetCore.Authentication.BearerToken.dll index a08e8f71..66aca6c0 100644 Binary files a/App/Microsoft.AspNetCore.Authentication.BearerToken.dll and b/App/Microsoft.AspNetCore.Authentication.BearerToken.dll differ diff --git a/App/Microsoft.AspNetCore.Authentication.Cookies.dll b/App/Microsoft.AspNetCore.Authentication.Cookies.dll index 62bfb01e..f855b2a9 100644 Binary files a/App/Microsoft.AspNetCore.Authentication.Cookies.dll and b/App/Microsoft.AspNetCore.Authentication.Cookies.dll differ diff --git a/App/Microsoft.AspNetCore.Authentication.Core.dll b/App/Microsoft.AspNetCore.Authentication.Core.dll index 379c3583..91012a48 100644 Binary files a/App/Microsoft.AspNetCore.Authentication.Core.dll and b/App/Microsoft.AspNetCore.Authentication.Core.dll differ diff --git a/App/Microsoft.AspNetCore.Authentication.OAuth.dll b/App/Microsoft.AspNetCore.Authentication.OAuth.dll index 8c2a9a78..85ad8f3a 100644 Binary files a/App/Microsoft.AspNetCore.Authentication.OAuth.dll and b/App/Microsoft.AspNetCore.Authentication.OAuth.dll differ diff --git a/App/Microsoft.AspNetCore.Authentication.dll b/App/Microsoft.AspNetCore.Authentication.dll index a555a339..7d27e131 100644 Binary files a/App/Microsoft.AspNetCore.Authentication.dll and b/App/Microsoft.AspNetCore.Authentication.dll differ diff --git a/App/Microsoft.AspNetCore.Authorization.Policy.dll b/App/Microsoft.AspNetCore.Authorization.Policy.dll index 388ce135..a34acb04 100644 Binary files a/App/Microsoft.AspNetCore.Authorization.Policy.dll and b/App/Microsoft.AspNetCore.Authorization.Policy.dll differ diff --git a/App/Microsoft.AspNetCore.Authorization.dll b/App/Microsoft.AspNetCore.Authorization.dll index 594e2237..db1b352f 100644 Binary files a/App/Microsoft.AspNetCore.Authorization.dll and b/App/Microsoft.AspNetCore.Authorization.dll differ diff --git a/App/Microsoft.AspNetCore.Components.Authorization.dll b/App/Microsoft.AspNetCore.Components.Authorization.dll index 172ec9db..7d762014 100644 Binary files a/App/Microsoft.AspNetCore.Components.Authorization.dll and b/App/Microsoft.AspNetCore.Components.Authorization.dll differ diff --git a/App/Microsoft.AspNetCore.Components.Endpoints.dll b/App/Microsoft.AspNetCore.Components.Endpoints.dll index 388e7603..dd2573e9 100644 Binary files a/App/Microsoft.AspNetCore.Components.Endpoints.dll and b/App/Microsoft.AspNetCore.Components.Endpoints.dll differ diff --git a/App/Microsoft.AspNetCore.Components.Forms.dll b/App/Microsoft.AspNetCore.Components.Forms.dll index d30aade3..bdda884c 100644 Binary files a/App/Microsoft.AspNetCore.Components.Forms.dll and b/App/Microsoft.AspNetCore.Components.Forms.dll differ diff --git a/App/Microsoft.AspNetCore.Components.Server.dll b/App/Microsoft.AspNetCore.Components.Server.dll index cea15282..c37dffb9 100644 Binary files a/App/Microsoft.AspNetCore.Components.Server.dll and b/App/Microsoft.AspNetCore.Components.Server.dll differ diff --git a/App/Microsoft.AspNetCore.Components.Web.dll b/App/Microsoft.AspNetCore.Components.Web.dll index 9cf19de8..216430ba 100644 Binary files a/App/Microsoft.AspNetCore.Components.Web.dll and b/App/Microsoft.AspNetCore.Components.Web.dll differ diff --git a/App/Microsoft.AspNetCore.Components.dll b/App/Microsoft.AspNetCore.Components.dll index 2df0853c..032db52d 100644 Binary files a/App/Microsoft.AspNetCore.Components.dll and b/App/Microsoft.AspNetCore.Components.dll differ diff --git a/App/Microsoft.AspNetCore.Connections.Abstractions.dll b/App/Microsoft.AspNetCore.Connections.Abstractions.dll index a354903a..364aa7c7 100644 Binary files a/App/Microsoft.AspNetCore.Connections.Abstractions.dll and b/App/Microsoft.AspNetCore.Connections.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.CookiePolicy.dll b/App/Microsoft.AspNetCore.CookiePolicy.dll index 0870fdcd..1beaa20b 100644 Binary files a/App/Microsoft.AspNetCore.CookiePolicy.dll and b/App/Microsoft.AspNetCore.CookiePolicy.dll differ diff --git a/App/Microsoft.AspNetCore.Cors.dll b/App/Microsoft.AspNetCore.Cors.dll index 43fcf9cc..ed794c7b 100644 Binary files a/App/Microsoft.AspNetCore.Cors.dll and b/App/Microsoft.AspNetCore.Cors.dll differ diff --git a/App/Microsoft.AspNetCore.Cryptography.Internal.dll b/App/Microsoft.AspNetCore.Cryptography.Internal.dll index 564d218b..e13fbe8a 100644 Binary files a/App/Microsoft.AspNetCore.Cryptography.Internal.dll and b/App/Microsoft.AspNetCore.Cryptography.Internal.dll differ diff --git a/App/Microsoft.AspNetCore.Cryptography.KeyDerivation.dll b/App/Microsoft.AspNetCore.Cryptography.KeyDerivation.dll index faed8a3e..a02d75cb 100644 Binary files a/App/Microsoft.AspNetCore.Cryptography.KeyDerivation.dll and b/App/Microsoft.AspNetCore.Cryptography.KeyDerivation.dll differ diff --git a/App/Microsoft.AspNetCore.DataProtection.Abstractions.dll b/App/Microsoft.AspNetCore.DataProtection.Abstractions.dll index 7a8f99bf..638bd700 100644 Binary files a/App/Microsoft.AspNetCore.DataProtection.Abstractions.dll and b/App/Microsoft.AspNetCore.DataProtection.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.DataProtection.Extensions.dll b/App/Microsoft.AspNetCore.DataProtection.Extensions.dll index ea543453..29fbb783 100644 Binary files a/App/Microsoft.AspNetCore.DataProtection.Extensions.dll and b/App/Microsoft.AspNetCore.DataProtection.Extensions.dll differ diff --git a/App/Microsoft.AspNetCore.DataProtection.dll b/App/Microsoft.AspNetCore.DataProtection.dll index 1c75c48e..027d4027 100644 Binary files a/App/Microsoft.AspNetCore.DataProtection.dll and b/App/Microsoft.AspNetCore.DataProtection.dll differ diff --git a/App/Microsoft.AspNetCore.Diagnostics.Abstractions.dll b/App/Microsoft.AspNetCore.Diagnostics.Abstractions.dll index 2c0d77fc..3e9187b1 100644 Binary files a/App/Microsoft.AspNetCore.Diagnostics.Abstractions.dll and b/App/Microsoft.AspNetCore.Diagnostics.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Diagnostics.HealthChecks.dll b/App/Microsoft.AspNetCore.Diagnostics.HealthChecks.dll index 6f11c9f2..80ba7822 100644 Binary files a/App/Microsoft.AspNetCore.Diagnostics.HealthChecks.dll and b/App/Microsoft.AspNetCore.Diagnostics.HealthChecks.dll differ diff --git a/App/Microsoft.AspNetCore.Diagnostics.dll b/App/Microsoft.AspNetCore.Diagnostics.dll index 58e00060..bac348bb 100644 Binary files a/App/Microsoft.AspNetCore.Diagnostics.dll and b/App/Microsoft.AspNetCore.Diagnostics.dll differ diff --git a/App/Microsoft.AspNetCore.HostFiltering.dll b/App/Microsoft.AspNetCore.HostFiltering.dll index 52c41a7c..adac3e79 100644 Binary files a/App/Microsoft.AspNetCore.HostFiltering.dll and b/App/Microsoft.AspNetCore.HostFiltering.dll differ diff --git a/App/Microsoft.AspNetCore.Hosting.Abstractions.dll b/App/Microsoft.AspNetCore.Hosting.Abstractions.dll index 40bcb155..16a9f54f 100644 Binary files a/App/Microsoft.AspNetCore.Hosting.Abstractions.dll and b/App/Microsoft.AspNetCore.Hosting.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Hosting.Server.Abstractions.dll b/App/Microsoft.AspNetCore.Hosting.Server.Abstractions.dll index f8891e00..5937b696 100644 Binary files a/App/Microsoft.AspNetCore.Hosting.Server.Abstractions.dll and b/App/Microsoft.AspNetCore.Hosting.Server.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Hosting.dll b/App/Microsoft.AspNetCore.Hosting.dll index 99dbae80..37aed4a6 100644 Binary files a/App/Microsoft.AspNetCore.Hosting.dll and b/App/Microsoft.AspNetCore.Hosting.dll differ diff --git a/App/Microsoft.AspNetCore.Html.Abstractions.dll b/App/Microsoft.AspNetCore.Html.Abstractions.dll index bf051772..4ef514fc 100644 Binary files a/App/Microsoft.AspNetCore.Html.Abstractions.dll and b/App/Microsoft.AspNetCore.Html.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Http.Abstractions.dll b/App/Microsoft.AspNetCore.Http.Abstractions.dll index 47c07e8e..e5a4c346 100644 Binary files a/App/Microsoft.AspNetCore.Http.Abstractions.dll and b/App/Microsoft.AspNetCore.Http.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Http.Connections.Common.dll b/App/Microsoft.AspNetCore.Http.Connections.Common.dll index a96e99eb..a102a819 100644 Binary files a/App/Microsoft.AspNetCore.Http.Connections.Common.dll and b/App/Microsoft.AspNetCore.Http.Connections.Common.dll differ diff --git a/App/Microsoft.AspNetCore.Http.Connections.dll b/App/Microsoft.AspNetCore.Http.Connections.dll index f568a7c4..642e95a5 100644 Binary files a/App/Microsoft.AspNetCore.Http.Connections.dll and b/App/Microsoft.AspNetCore.Http.Connections.dll differ diff --git a/App/Microsoft.AspNetCore.Http.Extensions.dll b/App/Microsoft.AspNetCore.Http.Extensions.dll index 75a14339..4e49037d 100644 Binary files a/App/Microsoft.AspNetCore.Http.Extensions.dll and b/App/Microsoft.AspNetCore.Http.Extensions.dll differ diff --git a/App/Microsoft.AspNetCore.Http.Features.dll b/App/Microsoft.AspNetCore.Http.Features.dll index 7f5648a9..d1ea553a 100644 Binary files a/App/Microsoft.AspNetCore.Http.Features.dll and b/App/Microsoft.AspNetCore.Http.Features.dll differ diff --git a/App/Microsoft.AspNetCore.Http.Results.dll b/App/Microsoft.AspNetCore.Http.Results.dll index 1cd21e68..32880447 100644 Binary files a/App/Microsoft.AspNetCore.Http.Results.dll and b/App/Microsoft.AspNetCore.Http.Results.dll differ diff --git a/App/Microsoft.AspNetCore.Http.dll b/App/Microsoft.AspNetCore.Http.dll index b224f7a1..24a8cb96 100644 Binary files a/App/Microsoft.AspNetCore.Http.dll and b/App/Microsoft.AspNetCore.Http.dll differ diff --git a/App/Microsoft.AspNetCore.HttpLogging.dll b/App/Microsoft.AspNetCore.HttpLogging.dll index 30e4e0cc..53eea3e0 100644 Binary files a/App/Microsoft.AspNetCore.HttpLogging.dll and b/App/Microsoft.AspNetCore.HttpLogging.dll differ diff --git a/App/Microsoft.AspNetCore.HttpOverrides.dll b/App/Microsoft.AspNetCore.HttpOverrides.dll index 843d1643..0edcd7c0 100644 Binary files a/App/Microsoft.AspNetCore.HttpOverrides.dll and b/App/Microsoft.AspNetCore.HttpOverrides.dll differ diff --git a/App/Microsoft.AspNetCore.HttpsPolicy.dll b/App/Microsoft.AspNetCore.HttpsPolicy.dll index 76a7f874..0e297dfb 100644 Binary files a/App/Microsoft.AspNetCore.HttpsPolicy.dll and b/App/Microsoft.AspNetCore.HttpsPolicy.dll differ diff --git a/App/Microsoft.AspNetCore.Identity.dll b/App/Microsoft.AspNetCore.Identity.dll index d44e9c34..78a6589a 100644 Binary files a/App/Microsoft.AspNetCore.Identity.dll and b/App/Microsoft.AspNetCore.Identity.dll differ diff --git a/App/Microsoft.AspNetCore.Localization.Routing.dll b/App/Microsoft.AspNetCore.Localization.Routing.dll index 383f9623..89893519 100644 Binary files a/App/Microsoft.AspNetCore.Localization.Routing.dll and b/App/Microsoft.AspNetCore.Localization.Routing.dll differ diff --git a/App/Microsoft.AspNetCore.Localization.dll b/App/Microsoft.AspNetCore.Localization.dll index fccd70a8..50f430cb 100644 Binary files a/App/Microsoft.AspNetCore.Localization.dll and b/App/Microsoft.AspNetCore.Localization.dll differ diff --git a/App/Microsoft.AspNetCore.Metadata.dll b/App/Microsoft.AspNetCore.Metadata.dll index f476ad58..a74e00c7 100644 Binary files a/App/Microsoft.AspNetCore.Metadata.dll and b/App/Microsoft.AspNetCore.Metadata.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.Abstractions.dll b/App/Microsoft.AspNetCore.Mvc.Abstractions.dll index bc71ed45..f7768001 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.Abstractions.dll and b/App/Microsoft.AspNetCore.Mvc.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.ApiExplorer.dll b/App/Microsoft.AspNetCore.Mvc.ApiExplorer.dll index d2c165e1..c4d1fefb 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.ApiExplorer.dll and b/App/Microsoft.AspNetCore.Mvc.ApiExplorer.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.Core.dll b/App/Microsoft.AspNetCore.Mvc.Core.dll index 5fb975d5..cb9a3698 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.Core.dll and b/App/Microsoft.AspNetCore.Mvc.Core.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.Cors.dll b/App/Microsoft.AspNetCore.Mvc.Cors.dll index f2fb34a9..c25ce572 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.Cors.dll and b/App/Microsoft.AspNetCore.Mvc.Cors.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.DataAnnotations.dll b/App/Microsoft.AspNetCore.Mvc.DataAnnotations.dll index 743a43ef..7a65844e 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.DataAnnotations.dll and b/App/Microsoft.AspNetCore.Mvc.DataAnnotations.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.Formatters.Json.dll b/App/Microsoft.AspNetCore.Mvc.Formatters.Json.dll index 351a3f8a..aadf127a 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.Formatters.Json.dll and b/App/Microsoft.AspNetCore.Mvc.Formatters.Json.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.Formatters.Xml.dll b/App/Microsoft.AspNetCore.Mvc.Formatters.Xml.dll index 552e0199..4421d510 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.Formatters.Xml.dll and b/App/Microsoft.AspNetCore.Mvc.Formatters.Xml.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.Localization.dll b/App/Microsoft.AspNetCore.Mvc.Localization.dll index d2ad876b..fa892ce0 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.Localization.dll and b/App/Microsoft.AspNetCore.Mvc.Localization.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.Razor.dll b/App/Microsoft.AspNetCore.Mvc.Razor.dll index a0a80f13..98b143e2 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.Razor.dll and b/App/Microsoft.AspNetCore.Mvc.Razor.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.RazorPages.dll b/App/Microsoft.AspNetCore.Mvc.RazorPages.dll index f07e7518..1ee1d54e 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.RazorPages.dll and b/App/Microsoft.AspNetCore.Mvc.RazorPages.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.TagHelpers.dll b/App/Microsoft.AspNetCore.Mvc.TagHelpers.dll index a4bf461f..9fae00f5 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.TagHelpers.dll and b/App/Microsoft.AspNetCore.Mvc.TagHelpers.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.ViewFeatures.dll b/App/Microsoft.AspNetCore.Mvc.ViewFeatures.dll index 9574b330..e33e941d 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.ViewFeatures.dll and b/App/Microsoft.AspNetCore.Mvc.ViewFeatures.dll differ diff --git a/App/Microsoft.AspNetCore.Mvc.dll b/App/Microsoft.AspNetCore.Mvc.dll index ba9afa0d..13bd2ee5 100644 Binary files a/App/Microsoft.AspNetCore.Mvc.dll and b/App/Microsoft.AspNetCore.Mvc.dll differ diff --git a/App/Microsoft.AspNetCore.OutputCaching.dll b/App/Microsoft.AspNetCore.OutputCaching.dll index 374e8b1c..693cfd17 100644 Binary files a/App/Microsoft.AspNetCore.OutputCaching.dll and b/App/Microsoft.AspNetCore.OutputCaching.dll differ diff --git a/App/Microsoft.AspNetCore.RateLimiting.dll b/App/Microsoft.AspNetCore.RateLimiting.dll index 0312e0cd..57e807cb 100644 Binary files a/App/Microsoft.AspNetCore.RateLimiting.dll and b/App/Microsoft.AspNetCore.RateLimiting.dll differ diff --git a/App/Microsoft.AspNetCore.Razor.Runtime.dll b/App/Microsoft.AspNetCore.Razor.Runtime.dll index a2864737..409be968 100644 Binary files a/App/Microsoft.AspNetCore.Razor.Runtime.dll and b/App/Microsoft.AspNetCore.Razor.Runtime.dll differ diff --git a/App/Microsoft.AspNetCore.Razor.dll b/App/Microsoft.AspNetCore.Razor.dll index 9981b247..a79eb32e 100644 Binary files a/App/Microsoft.AspNetCore.Razor.dll and b/App/Microsoft.AspNetCore.Razor.dll differ diff --git a/App/Microsoft.AspNetCore.RequestDecompression.dll b/App/Microsoft.AspNetCore.RequestDecompression.dll index d46a60d4..2c822d9f 100644 Binary files a/App/Microsoft.AspNetCore.RequestDecompression.dll and b/App/Microsoft.AspNetCore.RequestDecompression.dll differ diff --git a/App/Microsoft.AspNetCore.ResponseCaching.Abstractions.dll b/App/Microsoft.AspNetCore.ResponseCaching.Abstractions.dll index f6f1cf16..1e1ea8c2 100644 Binary files a/App/Microsoft.AspNetCore.ResponseCaching.Abstractions.dll and b/App/Microsoft.AspNetCore.ResponseCaching.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.ResponseCaching.dll b/App/Microsoft.AspNetCore.ResponseCaching.dll index c988ffc8..5c7daeef 100644 Binary files a/App/Microsoft.AspNetCore.ResponseCaching.dll and b/App/Microsoft.AspNetCore.ResponseCaching.dll differ diff --git a/App/Microsoft.AspNetCore.ResponseCompression.dll b/App/Microsoft.AspNetCore.ResponseCompression.dll index 90bec8e1..dd888edd 100644 Binary files a/App/Microsoft.AspNetCore.ResponseCompression.dll and b/App/Microsoft.AspNetCore.ResponseCompression.dll differ diff --git a/App/Microsoft.AspNetCore.Rewrite.dll b/App/Microsoft.AspNetCore.Rewrite.dll index bb684023..8496ceb9 100644 Binary files a/App/Microsoft.AspNetCore.Rewrite.dll and b/App/Microsoft.AspNetCore.Rewrite.dll differ diff --git a/App/Microsoft.AspNetCore.Routing.Abstractions.dll b/App/Microsoft.AspNetCore.Routing.Abstractions.dll index 368d9373..bcfb0f9d 100644 Binary files a/App/Microsoft.AspNetCore.Routing.Abstractions.dll and b/App/Microsoft.AspNetCore.Routing.Abstractions.dll differ diff --git a/App/Microsoft.AspNetCore.Routing.dll b/App/Microsoft.AspNetCore.Routing.dll index 8c000731..ae1f5e7c 100644 Binary files a/App/Microsoft.AspNetCore.Routing.dll and b/App/Microsoft.AspNetCore.Routing.dll differ diff --git a/App/Microsoft.AspNetCore.Server.HttpSys.dll b/App/Microsoft.AspNetCore.Server.HttpSys.dll index efbb3a01..a0e5fa17 100644 Binary files a/App/Microsoft.AspNetCore.Server.HttpSys.dll and b/App/Microsoft.AspNetCore.Server.HttpSys.dll differ diff --git a/App/Microsoft.AspNetCore.Server.IIS.dll b/App/Microsoft.AspNetCore.Server.IIS.dll index f0bad494..4510e5c6 100644 Binary files a/App/Microsoft.AspNetCore.Server.IIS.dll and b/App/Microsoft.AspNetCore.Server.IIS.dll differ diff --git a/App/Microsoft.AspNetCore.Server.IISIntegration.dll b/App/Microsoft.AspNetCore.Server.IISIntegration.dll index a1435c95..1ae23595 100644 Binary files a/App/Microsoft.AspNetCore.Server.IISIntegration.dll and b/App/Microsoft.AspNetCore.Server.IISIntegration.dll differ diff --git a/App/Microsoft.AspNetCore.Server.Kestrel.Core.dll b/App/Microsoft.AspNetCore.Server.Kestrel.Core.dll index 59b6e944..41998df1 100644 Binary files a/App/Microsoft.AspNetCore.Server.Kestrel.Core.dll and b/App/Microsoft.AspNetCore.Server.Kestrel.Core.dll differ diff --git a/App/Microsoft.AspNetCore.Server.Kestrel.Transport.NamedPipes.dll b/App/Microsoft.AspNetCore.Server.Kestrel.Transport.NamedPipes.dll index 62d7164d..e5980529 100644 Binary files a/App/Microsoft.AspNetCore.Server.Kestrel.Transport.NamedPipes.dll and b/App/Microsoft.AspNetCore.Server.Kestrel.Transport.NamedPipes.dll differ diff --git a/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.dll b/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.dll index 8c58de00..2847eb01 100644 Binary files a/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.dll and b/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.dll differ diff --git a/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.dll b/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.dll index 1e87f4ce..3bba465a 100644 Binary files a/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.dll and b/App/Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.dll differ diff --git a/App/Microsoft.AspNetCore.Server.Kestrel.dll b/App/Microsoft.AspNetCore.Server.Kestrel.dll index 10c2ea7c..d2a53b8a 100644 Binary files a/App/Microsoft.AspNetCore.Server.Kestrel.dll and b/App/Microsoft.AspNetCore.Server.Kestrel.dll differ diff --git a/App/Microsoft.AspNetCore.Session.dll b/App/Microsoft.AspNetCore.Session.dll index b7df9342..b4a1468e 100644 Binary files a/App/Microsoft.AspNetCore.Session.dll and b/App/Microsoft.AspNetCore.Session.dll differ diff --git a/App/Microsoft.AspNetCore.SignalR.Common.dll b/App/Microsoft.AspNetCore.SignalR.Common.dll index 5d4e5ecc..632e0c25 100644 Binary files a/App/Microsoft.AspNetCore.SignalR.Common.dll and b/App/Microsoft.AspNetCore.SignalR.Common.dll differ diff --git a/App/Microsoft.AspNetCore.SignalR.Core.dll b/App/Microsoft.AspNetCore.SignalR.Core.dll index 7b380a99..70159145 100644 Binary files a/App/Microsoft.AspNetCore.SignalR.Core.dll and b/App/Microsoft.AspNetCore.SignalR.Core.dll differ diff --git a/App/Microsoft.AspNetCore.SignalR.Protocols.Json.dll b/App/Microsoft.AspNetCore.SignalR.Protocols.Json.dll index 0153b51c..6f358f83 100644 Binary files a/App/Microsoft.AspNetCore.SignalR.Protocols.Json.dll and b/App/Microsoft.AspNetCore.SignalR.Protocols.Json.dll differ diff --git a/App/Microsoft.AspNetCore.SignalR.dll b/App/Microsoft.AspNetCore.SignalR.dll index a0679b52..fb08e699 100644 Binary files a/App/Microsoft.AspNetCore.SignalR.dll and b/App/Microsoft.AspNetCore.SignalR.dll differ diff --git a/App/Microsoft.AspNetCore.StaticAssets.dll b/App/Microsoft.AspNetCore.StaticAssets.dll index 93f09ccf..c29c7a2d 100644 Binary files a/App/Microsoft.AspNetCore.StaticAssets.dll and b/App/Microsoft.AspNetCore.StaticAssets.dll differ diff --git a/App/Microsoft.AspNetCore.StaticFiles.dll b/App/Microsoft.AspNetCore.StaticFiles.dll index 9807ec4f..a00247ee 100644 Binary files a/App/Microsoft.AspNetCore.StaticFiles.dll and b/App/Microsoft.AspNetCore.StaticFiles.dll differ diff --git a/App/Microsoft.AspNetCore.WebSockets.dll b/App/Microsoft.AspNetCore.WebSockets.dll index 772eef35..1c06f3ca 100644 Binary files a/App/Microsoft.AspNetCore.WebSockets.dll and b/App/Microsoft.AspNetCore.WebSockets.dll differ diff --git a/App/Microsoft.AspNetCore.WebUtilities.dll b/App/Microsoft.AspNetCore.WebUtilities.dll index 5b073aa8..7c1cb88b 100644 Binary files a/App/Microsoft.AspNetCore.WebUtilities.dll and b/App/Microsoft.AspNetCore.WebUtilities.dll differ diff --git a/App/Microsoft.AspNetCore.dll b/App/Microsoft.AspNetCore.dll index 14f8593f..9613a020 100644 Binary files a/App/Microsoft.AspNetCore.dll and b/App/Microsoft.AspNetCore.dll differ diff --git a/App/Microsoft.CSharp.dll b/App/Microsoft.CSharp.dll index a80a930e..16eefe64 100644 Binary files a/App/Microsoft.CSharp.dll and b/App/Microsoft.CSharp.dll differ diff --git a/App/Microsoft.Extensions.Caching.Abstractions.dll b/App/Microsoft.Extensions.Caching.Abstractions.dll index f73c6f08..bb70aa40 100644 Binary files a/App/Microsoft.Extensions.Caching.Abstractions.dll and b/App/Microsoft.Extensions.Caching.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.Caching.Memory.dll b/App/Microsoft.Extensions.Caching.Memory.dll index cfbc4df1..548a90a7 100644 Binary files a/App/Microsoft.Extensions.Caching.Memory.dll and b/App/Microsoft.Extensions.Caching.Memory.dll differ diff --git a/App/Microsoft.Extensions.Configuration.Abstractions.dll b/App/Microsoft.Extensions.Configuration.Abstractions.dll index 09363f86..ba79194e 100644 Binary files a/App/Microsoft.Extensions.Configuration.Abstractions.dll and b/App/Microsoft.Extensions.Configuration.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.Configuration.Binder.dll b/App/Microsoft.Extensions.Configuration.Binder.dll index 71cb5a58..a52e9f3e 100644 Binary files a/App/Microsoft.Extensions.Configuration.Binder.dll and b/App/Microsoft.Extensions.Configuration.Binder.dll differ diff --git a/App/Microsoft.Extensions.Configuration.CommandLine.dll b/App/Microsoft.Extensions.Configuration.CommandLine.dll index 533beb82..a1943030 100644 Binary files a/App/Microsoft.Extensions.Configuration.CommandLine.dll and b/App/Microsoft.Extensions.Configuration.CommandLine.dll differ diff --git a/App/Microsoft.Extensions.Configuration.EnvironmentVariables.dll b/App/Microsoft.Extensions.Configuration.EnvironmentVariables.dll index aecc87b8..4429019d 100644 Binary files a/App/Microsoft.Extensions.Configuration.EnvironmentVariables.dll and b/App/Microsoft.Extensions.Configuration.EnvironmentVariables.dll differ diff --git a/App/Microsoft.Extensions.Configuration.FileExtensions.dll b/App/Microsoft.Extensions.Configuration.FileExtensions.dll index aa43e50b..5a9f1031 100644 Binary files a/App/Microsoft.Extensions.Configuration.FileExtensions.dll and b/App/Microsoft.Extensions.Configuration.FileExtensions.dll differ diff --git a/App/Microsoft.Extensions.Configuration.Ini.dll b/App/Microsoft.Extensions.Configuration.Ini.dll index 944270e1..9b59d9e4 100644 Binary files a/App/Microsoft.Extensions.Configuration.Ini.dll and b/App/Microsoft.Extensions.Configuration.Ini.dll differ diff --git a/App/Microsoft.Extensions.Configuration.Json.dll b/App/Microsoft.Extensions.Configuration.Json.dll index c3fdf39c..2e0358d2 100644 Binary files a/App/Microsoft.Extensions.Configuration.Json.dll and b/App/Microsoft.Extensions.Configuration.Json.dll differ diff --git a/App/Microsoft.Extensions.Configuration.KeyPerFile.dll b/App/Microsoft.Extensions.Configuration.KeyPerFile.dll index 7adc5c58..f8925e00 100644 Binary files a/App/Microsoft.Extensions.Configuration.KeyPerFile.dll and b/App/Microsoft.Extensions.Configuration.KeyPerFile.dll differ diff --git a/App/Microsoft.Extensions.Configuration.UserSecrets.dll b/App/Microsoft.Extensions.Configuration.UserSecrets.dll index 6d880884..60d34614 100644 Binary files a/App/Microsoft.Extensions.Configuration.UserSecrets.dll and b/App/Microsoft.Extensions.Configuration.UserSecrets.dll differ diff --git a/App/Microsoft.Extensions.Configuration.Xml.dll b/App/Microsoft.Extensions.Configuration.Xml.dll index 621bba2a..610acece 100644 Binary files a/App/Microsoft.Extensions.Configuration.Xml.dll and b/App/Microsoft.Extensions.Configuration.Xml.dll differ diff --git a/App/Microsoft.Extensions.Configuration.dll b/App/Microsoft.Extensions.Configuration.dll index 45a8f329..cc39c894 100644 Binary files a/App/Microsoft.Extensions.Configuration.dll and b/App/Microsoft.Extensions.Configuration.dll differ diff --git a/App/Microsoft.Extensions.DependencyInjection.Abstractions.dll b/App/Microsoft.Extensions.DependencyInjection.Abstractions.dll index 259b3efa..b860fd44 100644 Binary files a/App/Microsoft.Extensions.DependencyInjection.Abstractions.dll and b/App/Microsoft.Extensions.DependencyInjection.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.DependencyInjection.dll b/App/Microsoft.Extensions.DependencyInjection.dll index c4ff5be3..0193b6b2 100644 Binary files a/App/Microsoft.Extensions.DependencyInjection.dll and b/App/Microsoft.Extensions.DependencyInjection.dll differ diff --git a/App/Microsoft.Extensions.Diagnostics.Abstractions.dll b/App/Microsoft.Extensions.Diagnostics.Abstractions.dll index 295b8622..0370860d 100644 Binary files a/App/Microsoft.Extensions.Diagnostics.Abstractions.dll and b/App/Microsoft.Extensions.Diagnostics.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll b/App/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll index 42e7e648..10fa215f 100644 Binary files a/App/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll and b/App/Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.Diagnostics.HealthChecks.dll b/App/Microsoft.Extensions.Diagnostics.HealthChecks.dll index 0e75949f..5a145ea9 100644 Binary files a/App/Microsoft.Extensions.Diagnostics.HealthChecks.dll and b/App/Microsoft.Extensions.Diagnostics.HealthChecks.dll differ diff --git a/App/Microsoft.Extensions.Diagnostics.dll b/App/Microsoft.Extensions.Diagnostics.dll index 2023471b..e07b265b 100644 Binary files a/App/Microsoft.Extensions.Diagnostics.dll and b/App/Microsoft.Extensions.Diagnostics.dll differ diff --git a/App/Microsoft.Extensions.Features.dll b/App/Microsoft.Extensions.Features.dll index 3ad8ac13..8587bad6 100644 Binary files a/App/Microsoft.Extensions.Features.dll and b/App/Microsoft.Extensions.Features.dll differ diff --git a/App/Microsoft.Extensions.FileProviders.Abstractions.dll b/App/Microsoft.Extensions.FileProviders.Abstractions.dll index 337e1796..8ce25265 100644 Binary files a/App/Microsoft.Extensions.FileProviders.Abstractions.dll and b/App/Microsoft.Extensions.FileProviders.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.FileProviders.Composite.dll b/App/Microsoft.Extensions.FileProviders.Composite.dll index e44a44f2..33da8c40 100644 Binary files a/App/Microsoft.Extensions.FileProviders.Composite.dll and b/App/Microsoft.Extensions.FileProviders.Composite.dll differ diff --git a/App/Microsoft.Extensions.FileProviders.Embedded.dll b/App/Microsoft.Extensions.FileProviders.Embedded.dll index 9dcd2062..c06a5a3c 100644 Binary files a/App/Microsoft.Extensions.FileProviders.Embedded.dll and b/App/Microsoft.Extensions.FileProviders.Embedded.dll differ diff --git a/App/Microsoft.Extensions.FileProviders.Physical.dll b/App/Microsoft.Extensions.FileProviders.Physical.dll index 6ab37cfa..c859262e 100644 Binary files a/App/Microsoft.Extensions.FileProviders.Physical.dll and b/App/Microsoft.Extensions.FileProviders.Physical.dll differ diff --git a/App/Microsoft.Extensions.FileSystemGlobbing.dll b/App/Microsoft.Extensions.FileSystemGlobbing.dll index 7d8df84f..eec8fc8c 100644 Binary files a/App/Microsoft.Extensions.FileSystemGlobbing.dll and b/App/Microsoft.Extensions.FileSystemGlobbing.dll differ diff --git a/App/Microsoft.Extensions.Hosting.Abstractions.dll b/App/Microsoft.Extensions.Hosting.Abstractions.dll index 154c4167..5e90447e 100644 Binary files a/App/Microsoft.Extensions.Hosting.Abstractions.dll and b/App/Microsoft.Extensions.Hosting.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.Hosting.dll b/App/Microsoft.Extensions.Hosting.dll index d0ad7d88..f8c8300e 100644 Binary files a/App/Microsoft.Extensions.Hosting.dll and b/App/Microsoft.Extensions.Hosting.dll differ diff --git a/App/Microsoft.Extensions.Http.dll b/App/Microsoft.Extensions.Http.dll index 49fb971d..c2d7184c 100644 Binary files a/App/Microsoft.Extensions.Http.dll and b/App/Microsoft.Extensions.Http.dll differ diff --git a/App/Microsoft.Extensions.Identity.Core.dll b/App/Microsoft.Extensions.Identity.Core.dll index 5d2cb3e4..63de651f 100644 Binary files a/App/Microsoft.Extensions.Identity.Core.dll and b/App/Microsoft.Extensions.Identity.Core.dll differ diff --git a/App/Microsoft.Extensions.Identity.Stores.dll b/App/Microsoft.Extensions.Identity.Stores.dll index 82ce1636..9f23f500 100644 Binary files a/App/Microsoft.Extensions.Identity.Stores.dll and b/App/Microsoft.Extensions.Identity.Stores.dll differ diff --git a/App/Microsoft.Extensions.Localization.Abstractions.dll b/App/Microsoft.Extensions.Localization.Abstractions.dll index 70f036c7..9fdbc7ff 100644 Binary files a/App/Microsoft.Extensions.Localization.Abstractions.dll and b/App/Microsoft.Extensions.Localization.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.Localization.dll b/App/Microsoft.Extensions.Localization.dll index 91599662..ecaa9850 100644 Binary files a/App/Microsoft.Extensions.Localization.dll and b/App/Microsoft.Extensions.Localization.dll differ diff --git a/App/Microsoft.Extensions.Logging.Abstractions.dll b/App/Microsoft.Extensions.Logging.Abstractions.dll index 4fdb48d7..d51d7c61 100644 Binary files a/App/Microsoft.Extensions.Logging.Abstractions.dll and b/App/Microsoft.Extensions.Logging.Abstractions.dll differ diff --git a/App/Microsoft.Extensions.Logging.Configuration.dll b/App/Microsoft.Extensions.Logging.Configuration.dll index 4c3a6823..9df7c96c 100644 Binary files a/App/Microsoft.Extensions.Logging.Configuration.dll and b/App/Microsoft.Extensions.Logging.Configuration.dll differ diff --git a/App/Microsoft.Extensions.Logging.Console.dll b/App/Microsoft.Extensions.Logging.Console.dll index 70266007..99db1e24 100644 Binary files a/App/Microsoft.Extensions.Logging.Console.dll and b/App/Microsoft.Extensions.Logging.Console.dll differ diff --git a/App/Microsoft.Extensions.Logging.Debug.dll b/App/Microsoft.Extensions.Logging.Debug.dll index 97625681..414ed7a5 100644 Binary files a/App/Microsoft.Extensions.Logging.Debug.dll and b/App/Microsoft.Extensions.Logging.Debug.dll differ diff --git a/App/Microsoft.Extensions.Logging.EventLog.dll b/App/Microsoft.Extensions.Logging.EventLog.dll index 3e682438..93c76aef 100644 Binary files a/App/Microsoft.Extensions.Logging.EventLog.dll and b/App/Microsoft.Extensions.Logging.EventLog.dll differ diff --git a/App/Microsoft.Extensions.Logging.EventSource.dll b/App/Microsoft.Extensions.Logging.EventSource.dll index 67bea5c9..14771640 100644 Binary files a/App/Microsoft.Extensions.Logging.EventSource.dll and b/App/Microsoft.Extensions.Logging.EventSource.dll differ diff --git a/App/Microsoft.Extensions.Logging.TraceSource.dll b/App/Microsoft.Extensions.Logging.TraceSource.dll index afbda231..413d2ddb 100644 Binary files a/App/Microsoft.Extensions.Logging.TraceSource.dll and b/App/Microsoft.Extensions.Logging.TraceSource.dll differ diff --git a/App/Microsoft.Extensions.Logging.dll b/App/Microsoft.Extensions.Logging.dll index a74091f6..b6df459e 100644 Binary files a/App/Microsoft.Extensions.Logging.dll and b/App/Microsoft.Extensions.Logging.dll differ diff --git a/App/Microsoft.Extensions.ObjectPool.dll b/App/Microsoft.Extensions.ObjectPool.dll index 8cb4def3..321b6595 100644 Binary files a/App/Microsoft.Extensions.ObjectPool.dll and b/App/Microsoft.Extensions.ObjectPool.dll differ diff --git a/App/Microsoft.Extensions.Options.ConfigurationExtensions.dll b/App/Microsoft.Extensions.Options.ConfigurationExtensions.dll index 8a6c014c..4c60cfbf 100644 Binary files a/App/Microsoft.Extensions.Options.ConfigurationExtensions.dll and b/App/Microsoft.Extensions.Options.ConfigurationExtensions.dll differ diff --git a/App/Microsoft.Extensions.Options.DataAnnotations.dll b/App/Microsoft.Extensions.Options.DataAnnotations.dll index ca965628..81e9fcc7 100644 Binary files a/App/Microsoft.Extensions.Options.DataAnnotations.dll and b/App/Microsoft.Extensions.Options.DataAnnotations.dll differ diff --git a/App/Microsoft.Extensions.Options.dll b/App/Microsoft.Extensions.Options.dll index 971192f8..9d0a4eb9 100644 Binary files a/App/Microsoft.Extensions.Options.dll and b/App/Microsoft.Extensions.Options.dll differ diff --git a/App/Microsoft.Extensions.Primitives.dll b/App/Microsoft.Extensions.Primitives.dll index 034b74f5..d858614d 100644 Binary files a/App/Microsoft.Extensions.Primitives.dll and b/App/Microsoft.Extensions.Primitives.dll differ diff --git a/App/Microsoft.Extensions.WebEncoders.dll b/App/Microsoft.Extensions.WebEncoders.dll index 12612301..0e5cbfe8 100644 Binary files a/App/Microsoft.Extensions.WebEncoders.dll and b/App/Microsoft.Extensions.WebEncoders.dll differ diff --git a/App/Microsoft.JSInterop.dll b/App/Microsoft.JSInterop.dll index 6c20c690..b43d7ca3 100644 Binary files a/App/Microsoft.JSInterop.dll and b/App/Microsoft.JSInterop.dll differ diff --git a/App/Microsoft.Net.Http.Headers.dll b/App/Microsoft.Net.Http.Headers.dll index 6b544566..f8efa406 100644 Binary files a/App/Microsoft.Net.Http.Headers.dll and b/App/Microsoft.Net.Http.Headers.dll differ diff --git a/App/Microsoft.VisualBasic.Core.dll b/App/Microsoft.VisualBasic.Core.dll index d09d9eae..f9f40f52 100644 Binary files a/App/Microsoft.VisualBasic.Core.dll and b/App/Microsoft.VisualBasic.Core.dll differ diff --git a/App/Microsoft.VisualBasic.Forms.dll b/App/Microsoft.VisualBasic.Forms.dll index 40501d56..21e05acf 100644 Binary files a/App/Microsoft.VisualBasic.Forms.dll and b/App/Microsoft.VisualBasic.Forms.dll differ diff --git a/App/Microsoft.VisualBasic.dll b/App/Microsoft.VisualBasic.dll index 61cb0724..4435e69c 100644 Binary files a/App/Microsoft.VisualBasic.dll and b/App/Microsoft.VisualBasic.dll differ diff --git a/App/Microsoft.Win32.Primitives.dll b/App/Microsoft.Win32.Primitives.dll index 39f1bdcb..0e2e48a6 100644 Binary files a/App/Microsoft.Win32.Primitives.dll and b/App/Microsoft.Win32.Primitives.dll differ diff --git a/App/Microsoft.Win32.Registry.AccessControl.dll b/App/Microsoft.Win32.Registry.AccessControl.dll index 3c134dcf..43db1d0c 100644 Binary files a/App/Microsoft.Win32.Registry.AccessControl.dll and b/App/Microsoft.Win32.Registry.AccessControl.dll differ diff --git a/App/Microsoft.Win32.Registry.dll b/App/Microsoft.Win32.Registry.dll index b34e4425..1f5562ba 100644 Binary files a/App/Microsoft.Win32.Registry.dll and b/App/Microsoft.Win32.Registry.dll differ diff --git a/App/Microsoft.Win32.SystemEvents.dll b/App/Microsoft.Win32.SystemEvents.dll index efd2745c..44576323 100644 Binary files a/App/Microsoft.Win32.SystemEvents.dll and b/App/Microsoft.Win32.SystemEvents.dll differ diff --git a/App/PenImc_cor3.dll b/App/PenImc_cor3.dll index 16f6bde6..9d147d36 100644 Binary files a/App/PenImc_cor3.dll and b/App/PenImc_cor3.dll differ diff --git a/App/PresentationCore.dll b/App/PresentationCore.dll index 4654bd1e..39148276 100644 Binary files a/App/PresentationCore.dll and b/App/PresentationCore.dll differ diff --git a/App/PresentationFramework-SystemCore.dll b/App/PresentationFramework-SystemCore.dll index 2a09b9e3..89ce7350 100644 Binary files a/App/PresentationFramework-SystemCore.dll and b/App/PresentationFramework-SystemCore.dll differ diff --git a/App/PresentationFramework-SystemData.dll b/App/PresentationFramework-SystemData.dll index 19bee4fb..7ac191a9 100644 Binary files a/App/PresentationFramework-SystemData.dll and b/App/PresentationFramework-SystemData.dll differ diff --git a/App/PresentationFramework-SystemDrawing.dll b/App/PresentationFramework-SystemDrawing.dll index 71ec75eb..4d3932f0 100644 Binary files a/App/PresentationFramework-SystemDrawing.dll and b/App/PresentationFramework-SystemDrawing.dll differ diff --git a/App/PresentationFramework-SystemXml.dll b/App/PresentationFramework-SystemXml.dll index 67010286..6c08049d 100644 Binary files a/App/PresentationFramework-SystemXml.dll and b/App/PresentationFramework-SystemXml.dll differ diff --git a/App/PresentationFramework-SystemXmlLinq.dll b/App/PresentationFramework-SystemXmlLinq.dll index 37eb422e..ab484955 100644 Binary files a/App/PresentationFramework-SystemXmlLinq.dll and b/App/PresentationFramework-SystemXmlLinq.dll differ diff --git a/App/PresentationFramework.Aero.dll b/App/PresentationFramework.Aero.dll index 939c0e10..a8d5d2c4 100644 Binary files a/App/PresentationFramework.Aero.dll and b/App/PresentationFramework.Aero.dll differ diff --git a/App/PresentationFramework.Aero2.dll b/App/PresentationFramework.Aero2.dll index 42c74cc4..8cc7d49c 100644 Binary files a/App/PresentationFramework.Aero2.dll and b/App/PresentationFramework.Aero2.dll differ diff --git a/App/PresentationFramework.AeroLite.dll b/App/PresentationFramework.AeroLite.dll index d1a81bc8..617fba3a 100644 Binary files a/App/PresentationFramework.AeroLite.dll and b/App/PresentationFramework.AeroLite.dll differ diff --git a/App/PresentationFramework.Classic.dll b/App/PresentationFramework.Classic.dll index 1edcb940..68041b45 100644 Binary files a/App/PresentationFramework.Classic.dll and b/App/PresentationFramework.Classic.dll differ diff --git a/App/PresentationFramework.Fluent.dll b/App/PresentationFramework.Fluent.dll index 2750cfd6..57c1242a 100644 Binary files a/App/PresentationFramework.Fluent.dll and b/App/PresentationFramework.Fluent.dll differ diff --git a/App/PresentationFramework.Luna.dll b/App/PresentationFramework.Luna.dll index 8a09df29..7e2d7ac8 100644 Binary files a/App/PresentationFramework.Luna.dll and b/App/PresentationFramework.Luna.dll differ diff --git a/App/PresentationFramework.Royale.dll b/App/PresentationFramework.Royale.dll index a74f85e8..6d432e8b 100644 Binary files a/App/PresentationFramework.Royale.dll and b/App/PresentationFramework.Royale.dll differ diff --git a/App/PresentationFramework.dll b/App/PresentationFramework.dll index a26ccbce..9d9ed38e 100644 Binary files a/App/PresentationFramework.dll and b/App/PresentationFramework.dll differ diff --git a/App/PresentationUI.dll b/App/PresentationUI.dll index d2c65a49..d7f597f5 100644 Binary files a/App/PresentationUI.dll and b/App/PresentationUI.dll differ diff --git a/App/ReachFramework.dll b/App/ReachFramework.dll index c3587089..43a8af53 100644 Binary files a/App/ReachFramework.dll and b/App/ReachFramework.dll differ diff --git a/App/System.AppContext.dll b/App/System.AppContext.dll index 204700e4..dd1b8083 100644 Binary files a/App/System.AppContext.dll and b/App/System.AppContext.dll differ diff --git a/App/System.Buffers.dll b/App/System.Buffers.dll index 5b3d79ec..809ba8ee 100644 Binary files a/App/System.Buffers.dll and b/App/System.Buffers.dll differ diff --git a/App/System.CodeDom.dll b/App/System.CodeDom.dll index da4bf1e3..49c9ef0c 100644 Binary files a/App/System.CodeDom.dll and b/App/System.CodeDom.dll differ diff --git a/App/System.Collections.Concurrent.dll b/App/System.Collections.Concurrent.dll index 93e8f1ef..559bf6f4 100644 Binary files a/App/System.Collections.Concurrent.dll and b/App/System.Collections.Concurrent.dll differ diff --git a/App/System.Collections.Immutable.dll b/App/System.Collections.Immutable.dll index d585dc16..093e7023 100644 Binary files a/App/System.Collections.Immutable.dll and b/App/System.Collections.Immutable.dll differ diff --git a/App/System.Collections.NonGeneric.dll b/App/System.Collections.NonGeneric.dll index 87b77a5f..d7d2da31 100644 Binary files a/App/System.Collections.NonGeneric.dll and b/App/System.Collections.NonGeneric.dll differ diff --git a/App/System.Collections.Specialized.dll b/App/System.Collections.Specialized.dll index 06ed3a75..1f2307ab 100644 Binary files a/App/System.Collections.Specialized.dll and b/App/System.Collections.Specialized.dll differ diff --git a/App/System.Collections.dll b/App/System.Collections.dll index a6a93824..1092068d 100644 Binary files a/App/System.Collections.dll and b/App/System.Collections.dll differ diff --git a/App/System.ComponentModel.Annotations.dll b/App/System.ComponentModel.Annotations.dll index 6cf4ae96..4cdb1ea3 100644 Binary files a/App/System.ComponentModel.Annotations.dll and b/App/System.ComponentModel.Annotations.dll differ diff --git a/App/System.ComponentModel.DataAnnotations.dll b/App/System.ComponentModel.DataAnnotations.dll index 0e06df8f..050be730 100644 Binary files a/App/System.ComponentModel.DataAnnotations.dll and b/App/System.ComponentModel.DataAnnotations.dll differ diff --git a/App/System.ComponentModel.EventBasedAsync.dll b/App/System.ComponentModel.EventBasedAsync.dll index 14a9008f..0c4250f0 100644 Binary files a/App/System.ComponentModel.EventBasedAsync.dll and b/App/System.ComponentModel.EventBasedAsync.dll differ diff --git a/App/System.ComponentModel.Primitives.dll b/App/System.ComponentModel.Primitives.dll index bbc01da4..9da9db08 100644 Binary files a/App/System.ComponentModel.Primitives.dll and b/App/System.ComponentModel.Primitives.dll differ diff --git a/App/System.ComponentModel.TypeConverter.dll b/App/System.ComponentModel.TypeConverter.dll index ad4c7f2e..d4fad90f 100644 Binary files a/App/System.ComponentModel.TypeConverter.dll and b/App/System.ComponentModel.TypeConverter.dll differ diff --git a/App/System.ComponentModel.dll b/App/System.ComponentModel.dll index c9d7fd1d..c1c33e09 100644 Binary files a/App/System.ComponentModel.dll and b/App/System.ComponentModel.dll differ diff --git a/App/System.Configuration.ConfigurationManager.dll b/App/System.Configuration.ConfigurationManager.dll index 0e22b0e4..68338c02 100644 Binary files a/App/System.Configuration.ConfigurationManager.dll and b/App/System.Configuration.ConfigurationManager.dll differ diff --git a/App/System.Configuration.dll b/App/System.Configuration.dll index 2a5dcc2a..a73be5ea 100644 Binary files a/App/System.Configuration.dll and b/App/System.Configuration.dll differ diff --git a/App/System.Console.dll b/App/System.Console.dll index 7b554bed..bc27b606 100644 Binary files a/App/System.Console.dll and b/App/System.Console.dll differ diff --git a/App/System.Core.dll b/App/System.Core.dll index 7be8e7b6..9550e31f 100644 Binary files a/App/System.Core.dll and b/App/System.Core.dll differ diff --git a/App/System.Data.Common.dll b/App/System.Data.Common.dll index 38c0678c..efa7d258 100644 Binary files a/App/System.Data.Common.dll and b/App/System.Data.Common.dll differ diff --git a/App/System.Data.DataSetExtensions.dll b/App/System.Data.DataSetExtensions.dll index ea3760a3..2c41333d 100644 Binary files a/App/System.Data.DataSetExtensions.dll and b/App/System.Data.DataSetExtensions.dll differ diff --git a/App/System.Data.dll b/App/System.Data.dll index 053f3919..b78b25ac 100644 Binary files a/App/System.Data.dll and b/App/System.Data.dll differ diff --git a/App/System.Design.dll b/App/System.Design.dll index 8247e217..ae530709 100644 Binary files a/App/System.Design.dll and b/App/System.Design.dll differ diff --git a/App/System.Diagnostics.Contracts.dll b/App/System.Diagnostics.Contracts.dll index cb80dba5..caec9ead 100644 Binary files a/App/System.Diagnostics.Contracts.dll and b/App/System.Diagnostics.Contracts.dll differ diff --git a/App/System.Diagnostics.Debug.dll b/App/System.Diagnostics.Debug.dll index a052be51..c1791215 100644 Binary files a/App/System.Diagnostics.Debug.dll and b/App/System.Diagnostics.Debug.dll differ diff --git a/App/System.Diagnostics.DiagnosticSource.dll b/App/System.Diagnostics.DiagnosticSource.dll index 0d2080c6..2881b62d 100644 Binary files a/App/System.Diagnostics.DiagnosticSource.dll and b/App/System.Diagnostics.DiagnosticSource.dll differ diff --git a/App/System.Diagnostics.EventLog.Messages.dll b/App/System.Diagnostics.EventLog.Messages.dll index 450d1051..277041f8 100644 Binary files a/App/System.Diagnostics.EventLog.Messages.dll and b/App/System.Diagnostics.EventLog.Messages.dll differ diff --git a/App/System.Diagnostics.EventLog.dll b/App/System.Diagnostics.EventLog.dll index 760df478..2bc0ab65 100644 Binary files a/App/System.Diagnostics.EventLog.dll and b/App/System.Diagnostics.EventLog.dll differ diff --git a/App/System.Diagnostics.FileVersionInfo.dll b/App/System.Diagnostics.FileVersionInfo.dll index ee90bfdf..6b2d2ba7 100644 Binary files a/App/System.Diagnostics.FileVersionInfo.dll and b/App/System.Diagnostics.FileVersionInfo.dll differ diff --git a/App/System.Diagnostics.PerformanceCounter.dll b/App/System.Diagnostics.PerformanceCounter.dll index e50cde08..e1ed2919 100644 Binary files a/App/System.Diagnostics.PerformanceCounter.dll and b/App/System.Diagnostics.PerformanceCounter.dll differ diff --git a/App/System.Diagnostics.Process.dll b/App/System.Diagnostics.Process.dll index 8b8a7350..611325d0 100644 Binary files a/App/System.Diagnostics.Process.dll and b/App/System.Diagnostics.Process.dll differ diff --git a/App/System.Diagnostics.StackTrace.dll b/App/System.Diagnostics.StackTrace.dll index 557110e4..a7de04bc 100644 Binary files a/App/System.Diagnostics.StackTrace.dll and b/App/System.Diagnostics.StackTrace.dll differ diff --git a/App/System.Diagnostics.TextWriterTraceListener.dll b/App/System.Diagnostics.TextWriterTraceListener.dll index 83b1d8e4..f3ae1703 100644 Binary files a/App/System.Diagnostics.TextWriterTraceListener.dll and b/App/System.Diagnostics.TextWriterTraceListener.dll differ diff --git a/App/System.Diagnostics.Tools.dll b/App/System.Diagnostics.Tools.dll index d77619b0..e95e57ca 100644 Binary files a/App/System.Diagnostics.Tools.dll and b/App/System.Diagnostics.Tools.dll differ diff --git a/App/System.Diagnostics.TraceSource.dll b/App/System.Diagnostics.TraceSource.dll index 1aa62e77..58b7620d 100644 Binary files a/App/System.Diagnostics.TraceSource.dll and b/App/System.Diagnostics.TraceSource.dll differ diff --git a/App/System.Diagnostics.Tracing.dll b/App/System.Diagnostics.Tracing.dll index 7cc9184f..7f58e90c 100644 Binary files a/App/System.Diagnostics.Tracing.dll and b/App/System.Diagnostics.Tracing.dll differ diff --git a/App/System.DirectoryServices.dll b/App/System.DirectoryServices.dll index f80d6ff2..1aa1777c 100644 Binary files a/App/System.DirectoryServices.dll and b/App/System.DirectoryServices.dll differ diff --git a/App/System.Drawing.Common.dll b/App/System.Drawing.Common.dll index fe7d4c4e..7a51406c 100644 Binary files a/App/System.Drawing.Common.dll and b/App/System.Drawing.Common.dll differ diff --git a/App/System.Drawing.Design.dll b/App/System.Drawing.Design.dll index 161f8677..00ed577f 100644 Binary files a/App/System.Drawing.Design.dll and b/App/System.Drawing.Design.dll differ diff --git a/App/System.Drawing.Primitives.dll b/App/System.Drawing.Primitives.dll index fc83ebda..bcbe6bb8 100644 Binary files a/App/System.Drawing.Primitives.dll and b/App/System.Drawing.Primitives.dll differ diff --git a/App/System.Drawing.dll b/App/System.Drawing.dll index 1f3dd289..c1561db2 100644 Binary files a/App/System.Drawing.dll and b/App/System.Drawing.dll differ diff --git a/App/System.Dynamic.Runtime.dll b/App/System.Dynamic.Runtime.dll index aae5bdc9..82d3ec84 100644 Binary files a/App/System.Dynamic.Runtime.dll and b/App/System.Dynamic.Runtime.dll differ diff --git a/App/System.Formats.Asn1.dll b/App/System.Formats.Asn1.dll index a2306e43..6be6f8f6 100644 Binary files a/App/System.Formats.Asn1.dll and b/App/System.Formats.Asn1.dll differ diff --git a/App/System.Formats.Nrbf.dll b/App/System.Formats.Nrbf.dll index 217c6ca0..df3ed27a 100644 Binary files a/App/System.Formats.Nrbf.dll and b/App/System.Formats.Nrbf.dll differ diff --git a/App/System.Formats.Tar.dll b/App/System.Formats.Tar.dll index 405c129a..3623e0d7 100644 Binary files a/App/System.Formats.Tar.dll and b/App/System.Formats.Tar.dll differ diff --git a/App/System.Globalization.Calendars.dll b/App/System.Globalization.Calendars.dll index 5f5e2088..046b0275 100644 Binary files a/App/System.Globalization.Calendars.dll and b/App/System.Globalization.Calendars.dll differ diff --git a/App/System.Globalization.Extensions.dll b/App/System.Globalization.Extensions.dll index 96958165..38a20e3c 100644 Binary files a/App/System.Globalization.Extensions.dll and b/App/System.Globalization.Extensions.dll differ diff --git a/App/System.Globalization.dll b/App/System.Globalization.dll index a08a80ad..dd215eff 100644 Binary files a/App/System.Globalization.dll and b/App/System.Globalization.dll differ diff --git a/App/System.IO.Compression.Brotli.dll b/App/System.IO.Compression.Brotli.dll index eaeb4b2a..5dfdcc1e 100644 Binary files a/App/System.IO.Compression.Brotli.dll and b/App/System.IO.Compression.Brotli.dll differ diff --git a/App/System.IO.Compression.FileSystem.dll b/App/System.IO.Compression.FileSystem.dll index c01bc802..19664f5e 100644 Binary files a/App/System.IO.Compression.FileSystem.dll and b/App/System.IO.Compression.FileSystem.dll differ diff --git a/App/System.IO.Compression.Native.dll b/App/System.IO.Compression.Native.dll index 299cfa1f..baedada9 100644 Binary files a/App/System.IO.Compression.Native.dll and b/App/System.IO.Compression.Native.dll differ diff --git a/App/System.IO.Compression.ZipFile.dll b/App/System.IO.Compression.ZipFile.dll index a6f4dfa5..0927ab65 100644 Binary files a/App/System.IO.Compression.ZipFile.dll and b/App/System.IO.Compression.ZipFile.dll differ diff --git a/App/System.IO.Compression.dll b/App/System.IO.Compression.dll index cbbe0d3e..b03e3b75 100644 Binary files a/App/System.IO.Compression.dll and b/App/System.IO.Compression.dll differ diff --git a/App/System.IO.FileSystem.AccessControl.dll b/App/System.IO.FileSystem.AccessControl.dll index a56c8517..5190098b 100644 Binary files a/App/System.IO.FileSystem.AccessControl.dll and b/App/System.IO.FileSystem.AccessControl.dll differ diff --git a/App/System.IO.FileSystem.DriveInfo.dll b/App/System.IO.FileSystem.DriveInfo.dll index 1a8bc8f7..c2ecdf96 100644 Binary files a/App/System.IO.FileSystem.DriveInfo.dll and b/App/System.IO.FileSystem.DriveInfo.dll differ diff --git a/App/System.IO.FileSystem.Primitives.dll b/App/System.IO.FileSystem.Primitives.dll index e44bb8cd..693316b5 100644 Binary files a/App/System.IO.FileSystem.Primitives.dll and b/App/System.IO.FileSystem.Primitives.dll differ diff --git a/App/System.IO.FileSystem.Watcher.dll b/App/System.IO.FileSystem.Watcher.dll index c4dc5438..b9006c82 100644 Binary files a/App/System.IO.FileSystem.Watcher.dll and b/App/System.IO.FileSystem.Watcher.dll differ diff --git a/App/System.IO.FileSystem.dll b/App/System.IO.FileSystem.dll index 1ac5c9b5..ae5474cb 100644 Binary files a/App/System.IO.FileSystem.dll and b/App/System.IO.FileSystem.dll differ diff --git a/App/System.IO.IsolatedStorage.dll b/App/System.IO.IsolatedStorage.dll index 807600ad..3356fce0 100644 Binary files a/App/System.IO.IsolatedStorage.dll and b/App/System.IO.IsolatedStorage.dll differ diff --git a/App/System.IO.MemoryMappedFiles.dll b/App/System.IO.MemoryMappedFiles.dll index 2f47e8bd..90616470 100644 Binary files a/App/System.IO.MemoryMappedFiles.dll and b/App/System.IO.MemoryMappedFiles.dll differ diff --git a/App/System.IO.Packaging.dll b/App/System.IO.Packaging.dll index 4ab04dcc..7f2a9ac4 100644 Binary files a/App/System.IO.Packaging.dll and b/App/System.IO.Packaging.dll differ diff --git a/App/System.IO.Pipelines.dll b/App/System.IO.Pipelines.dll index eda8c236..153a5702 100644 Binary files a/App/System.IO.Pipelines.dll and b/App/System.IO.Pipelines.dll differ diff --git a/App/System.IO.Pipes.AccessControl.dll b/App/System.IO.Pipes.AccessControl.dll index 489fa4a1..b4c4f339 100644 Binary files a/App/System.IO.Pipes.AccessControl.dll and b/App/System.IO.Pipes.AccessControl.dll differ diff --git a/App/System.IO.Pipes.dll b/App/System.IO.Pipes.dll index 23ccf19f..39b16d98 100644 Binary files a/App/System.IO.Pipes.dll and b/App/System.IO.Pipes.dll differ diff --git a/App/System.IO.UnmanagedMemoryStream.dll b/App/System.IO.UnmanagedMemoryStream.dll index b9ffee2d..3e3d3b1b 100644 Binary files a/App/System.IO.UnmanagedMemoryStream.dll and b/App/System.IO.UnmanagedMemoryStream.dll differ diff --git a/App/System.IO.dll b/App/System.IO.dll index 6a73add9..b4759547 100644 Binary files a/App/System.IO.dll and b/App/System.IO.dll differ diff --git a/App/System.Linq.Expressions.dll b/App/System.Linq.Expressions.dll index a7921d94..af24ddb7 100644 Binary files a/App/System.Linq.Expressions.dll and b/App/System.Linq.Expressions.dll differ diff --git a/App/System.Linq.Parallel.dll b/App/System.Linq.Parallel.dll index 8e952295..2ea4a639 100644 Binary files a/App/System.Linq.Parallel.dll and b/App/System.Linq.Parallel.dll differ diff --git a/App/System.Linq.Queryable.dll b/App/System.Linq.Queryable.dll index 286cae56..16d6064c 100644 Binary files a/App/System.Linq.Queryable.dll and b/App/System.Linq.Queryable.dll differ diff --git a/App/System.Linq.dll b/App/System.Linq.dll index 5ee0e227..91430691 100644 Binary files a/App/System.Linq.dll and b/App/System.Linq.dll differ diff --git a/App/System.Memory.dll b/App/System.Memory.dll index 0840ba8a..3a73a288 100644 Binary files a/App/System.Memory.dll and b/App/System.Memory.dll differ diff --git a/App/System.Net.Http.Json.dll b/App/System.Net.Http.Json.dll index 44b0cd30..b9b9c642 100644 Binary files a/App/System.Net.Http.Json.dll and b/App/System.Net.Http.Json.dll differ diff --git a/App/System.Net.Http.dll b/App/System.Net.Http.dll index 8b4d9d24..625472b7 100644 Binary files a/App/System.Net.Http.dll and b/App/System.Net.Http.dll differ diff --git a/App/System.Net.HttpListener.dll b/App/System.Net.HttpListener.dll index 3cf2eec4..6453d908 100644 Binary files a/App/System.Net.HttpListener.dll and b/App/System.Net.HttpListener.dll differ diff --git a/App/System.Net.Mail.dll b/App/System.Net.Mail.dll index 48f274dc..2fe214bd 100644 Binary files a/App/System.Net.Mail.dll and b/App/System.Net.Mail.dll differ diff --git a/App/System.Net.NameResolution.dll b/App/System.Net.NameResolution.dll index 67f5eb47..d3e940ed 100644 Binary files a/App/System.Net.NameResolution.dll and b/App/System.Net.NameResolution.dll differ diff --git a/App/System.Net.NetworkInformation.dll b/App/System.Net.NetworkInformation.dll index 3b3ddaff..d784a8e6 100644 Binary files a/App/System.Net.NetworkInformation.dll and b/App/System.Net.NetworkInformation.dll differ diff --git a/App/System.Net.Ping.dll b/App/System.Net.Ping.dll index 0761dfd3..1ee53eb4 100644 Binary files a/App/System.Net.Ping.dll and b/App/System.Net.Ping.dll differ diff --git a/App/System.Net.Primitives.dll b/App/System.Net.Primitives.dll index dbbb63d8..0582a178 100644 Binary files a/App/System.Net.Primitives.dll and b/App/System.Net.Primitives.dll differ diff --git a/App/System.Net.Quic.dll b/App/System.Net.Quic.dll index 348d25ec..6a8c1dba 100644 Binary files a/App/System.Net.Quic.dll and b/App/System.Net.Quic.dll differ diff --git a/App/System.Net.Requests.dll b/App/System.Net.Requests.dll index dd18ff82..23a8f2de 100644 Binary files a/App/System.Net.Requests.dll and b/App/System.Net.Requests.dll differ diff --git a/App/System.Net.Security.dll b/App/System.Net.Security.dll index f40c84a2..dc844425 100644 Binary files a/App/System.Net.Security.dll and b/App/System.Net.Security.dll differ diff --git a/App/System.Net.ServicePoint.dll b/App/System.Net.ServicePoint.dll index 2946d11f..c8c55b94 100644 Binary files a/App/System.Net.ServicePoint.dll and b/App/System.Net.ServicePoint.dll differ diff --git a/App/System.Net.Sockets.dll b/App/System.Net.Sockets.dll index d992670b..a506da42 100644 Binary files a/App/System.Net.Sockets.dll and b/App/System.Net.Sockets.dll differ diff --git a/App/System.Net.WebClient.dll b/App/System.Net.WebClient.dll index 8a8310ea..ac49f9b5 100644 Binary files a/App/System.Net.WebClient.dll and b/App/System.Net.WebClient.dll differ diff --git a/App/System.Net.WebHeaderCollection.dll b/App/System.Net.WebHeaderCollection.dll index ffa07f7b..acf4f8e0 100644 Binary files a/App/System.Net.WebHeaderCollection.dll and b/App/System.Net.WebHeaderCollection.dll differ diff --git a/App/System.Net.WebProxy.dll b/App/System.Net.WebProxy.dll index 241d7e89..f379d12c 100644 Binary files a/App/System.Net.WebProxy.dll and b/App/System.Net.WebProxy.dll differ diff --git a/App/System.Net.WebSockets.Client.dll b/App/System.Net.WebSockets.Client.dll index e0b17f7f..e7fe7351 100644 Binary files a/App/System.Net.WebSockets.Client.dll and b/App/System.Net.WebSockets.Client.dll differ diff --git a/App/System.Net.WebSockets.dll b/App/System.Net.WebSockets.dll index 47641696..2bd94faa 100644 Binary files a/App/System.Net.WebSockets.dll and b/App/System.Net.WebSockets.dll differ diff --git a/App/System.Net.dll b/App/System.Net.dll index 766c93ae..804ec929 100644 Binary files a/App/System.Net.dll and b/App/System.Net.dll differ diff --git a/App/System.Numerics.Vectors.dll b/App/System.Numerics.Vectors.dll index adb1d599..20cf05f6 100644 Binary files a/App/System.Numerics.Vectors.dll and b/App/System.Numerics.Vectors.dll differ diff --git a/App/System.Numerics.dll b/App/System.Numerics.dll index 07028054..94ca9784 100644 Binary files a/App/System.Numerics.dll and b/App/System.Numerics.dll differ diff --git a/App/System.ObjectModel.dll b/App/System.ObjectModel.dll index 82c99d39..c812ea7c 100644 Binary files a/App/System.ObjectModel.dll and b/App/System.ObjectModel.dll differ diff --git a/App/System.Printing.dll b/App/System.Printing.dll index 73b5c02d..da879301 100644 Binary files a/App/System.Printing.dll and b/App/System.Printing.dll differ diff --git a/App/System.Private.CoreLib.dll b/App/System.Private.CoreLib.dll index 34b2e5cf..4d330449 100644 Binary files a/App/System.Private.CoreLib.dll and b/App/System.Private.CoreLib.dll differ diff --git a/App/System.Private.DataContractSerialization.dll b/App/System.Private.DataContractSerialization.dll index dd4b1b91..89260529 100644 Binary files a/App/System.Private.DataContractSerialization.dll and b/App/System.Private.DataContractSerialization.dll differ diff --git a/App/System.Private.Uri.dll b/App/System.Private.Uri.dll index aff60191..db469d47 100644 Binary files a/App/System.Private.Uri.dll and b/App/System.Private.Uri.dll differ diff --git a/App/System.Private.Windows.Core.dll b/App/System.Private.Windows.Core.dll index 7a220236..e211c11d 100644 Binary files a/App/System.Private.Windows.Core.dll and b/App/System.Private.Windows.Core.dll differ diff --git a/App/System.Private.Xml.Linq.dll b/App/System.Private.Xml.Linq.dll index be4656fd..350c03eb 100644 Binary files a/App/System.Private.Xml.Linq.dll and b/App/System.Private.Xml.Linq.dll differ diff --git a/App/System.Private.Xml.dll b/App/System.Private.Xml.dll index 6b1025ca..206073b7 100644 Binary files a/App/System.Private.Xml.dll and b/App/System.Private.Xml.dll differ diff --git a/App/System.Reflection.DispatchProxy.dll b/App/System.Reflection.DispatchProxy.dll index f3ca5791..ec9241f7 100644 Binary files a/App/System.Reflection.DispatchProxy.dll and b/App/System.Reflection.DispatchProxy.dll differ diff --git a/App/System.Reflection.Emit.ILGeneration.dll b/App/System.Reflection.Emit.ILGeneration.dll index dbb1df79..37b2e81b 100644 Binary files a/App/System.Reflection.Emit.ILGeneration.dll and b/App/System.Reflection.Emit.ILGeneration.dll differ diff --git a/App/System.Reflection.Emit.Lightweight.dll b/App/System.Reflection.Emit.Lightweight.dll index 1809e1c4..a5fee0dd 100644 Binary files a/App/System.Reflection.Emit.Lightweight.dll and b/App/System.Reflection.Emit.Lightweight.dll differ diff --git a/App/System.Reflection.Emit.dll b/App/System.Reflection.Emit.dll index 5c651f2e..2503b8a8 100644 Binary files a/App/System.Reflection.Emit.dll and b/App/System.Reflection.Emit.dll differ diff --git a/App/System.Reflection.Extensions.dll b/App/System.Reflection.Extensions.dll index ff0864e1..9b7f803c 100644 Binary files a/App/System.Reflection.Extensions.dll and b/App/System.Reflection.Extensions.dll differ diff --git a/App/System.Reflection.Metadata.dll b/App/System.Reflection.Metadata.dll index 1e7cb331..81e6880c 100644 Binary files a/App/System.Reflection.Metadata.dll and b/App/System.Reflection.Metadata.dll differ diff --git a/App/System.Reflection.Primitives.dll b/App/System.Reflection.Primitives.dll index d2716123..6569090a 100644 Binary files a/App/System.Reflection.Primitives.dll and b/App/System.Reflection.Primitives.dll differ diff --git a/App/System.Reflection.TypeExtensions.dll b/App/System.Reflection.TypeExtensions.dll index 58a617cb..56fa0c05 100644 Binary files a/App/System.Reflection.TypeExtensions.dll and b/App/System.Reflection.TypeExtensions.dll differ diff --git a/App/System.Reflection.dll b/App/System.Reflection.dll index a9cbb57f..05a897ba 100644 Binary files a/App/System.Reflection.dll and b/App/System.Reflection.dll differ diff --git a/App/System.Resources.Extensions.dll b/App/System.Resources.Extensions.dll index f5a789ce..867f0610 100644 Binary files a/App/System.Resources.Extensions.dll and b/App/System.Resources.Extensions.dll differ diff --git a/App/System.Resources.Reader.dll b/App/System.Resources.Reader.dll index 22f5dc8c..93f8add4 100644 Binary files a/App/System.Resources.Reader.dll and b/App/System.Resources.Reader.dll differ diff --git a/App/System.Resources.ResourceManager.dll b/App/System.Resources.ResourceManager.dll index 583763dc..5fc069bb 100644 Binary files a/App/System.Resources.ResourceManager.dll and b/App/System.Resources.ResourceManager.dll differ diff --git a/App/System.Resources.Writer.dll b/App/System.Resources.Writer.dll index 172f7875..0c8ef4e6 100644 Binary files a/App/System.Resources.Writer.dll and b/App/System.Resources.Writer.dll differ diff --git a/App/System.Runtime.CompilerServices.Unsafe.dll b/App/System.Runtime.CompilerServices.Unsafe.dll index 9c96e336..12ab7673 100644 Binary files a/App/System.Runtime.CompilerServices.Unsafe.dll and b/App/System.Runtime.CompilerServices.Unsafe.dll differ diff --git a/App/System.Runtime.CompilerServices.VisualC.dll b/App/System.Runtime.CompilerServices.VisualC.dll index d63658fc..41b750af 100644 Binary files a/App/System.Runtime.CompilerServices.VisualC.dll and b/App/System.Runtime.CompilerServices.VisualC.dll differ diff --git a/App/System.Runtime.Extensions.dll b/App/System.Runtime.Extensions.dll index 3fcf4bed..62af3ea8 100644 Binary files a/App/System.Runtime.Extensions.dll and b/App/System.Runtime.Extensions.dll differ diff --git a/App/System.Runtime.Handles.dll b/App/System.Runtime.Handles.dll index bbd5ead7..65636bdb 100644 Binary files a/App/System.Runtime.Handles.dll and b/App/System.Runtime.Handles.dll differ diff --git a/App/System.Runtime.InteropServices.JavaScript.dll b/App/System.Runtime.InteropServices.JavaScript.dll index f2906f00..37a9c843 100644 Binary files a/App/System.Runtime.InteropServices.JavaScript.dll and b/App/System.Runtime.InteropServices.JavaScript.dll differ diff --git a/App/System.Runtime.InteropServices.RuntimeInformation.dll b/App/System.Runtime.InteropServices.RuntimeInformation.dll index a77b2b38..4ffc82a1 100644 Binary files a/App/System.Runtime.InteropServices.RuntimeInformation.dll and b/App/System.Runtime.InteropServices.RuntimeInformation.dll differ diff --git a/App/System.Runtime.InteropServices.dll b/App/System.Runtime.InteropServices.dll index 1666a7ff..0d43814f 100644 Binary files a/App/System.Runtime.InteropServices.dll and b/App/System.Runtime.InteropServices.dll differ diff --git a/App/System.Runtime.Intrinsics.dll b/App/System.Runtime.Intrinsics.dll index 8513c0ae..7ae8d6a4 100644 Binary files a/App/System.Runtime.Intrinsics.dll and b/App/System.Runtime.Intrinsics.dll differ diff --git a/App/System.Runtime.Loader.dll b/App/System.Runtime.Loader.dll index 6d523ce2..f9927a23 100644 Binary files a/App/System.Runtime.Loader.dll and b/App/System.Runtime.Loader.dll differ diff --git a/App/System.Runtime.Numerics.dll b/App/System.Runtime.Numerics.dll index c76a6b3f..1ebbf292 100644 Binary files a/App/System.Runtime.Numerics.dll and b/App/System.Runtime.Numerics.dll differ diff --git a/App/System.Runtime.Serialization.Formatters.dll b/App/System.Runtime.Serialization.Formatters.dll index e3020be8..a0161997 100644 Binary files a/App/System.Runtime.Serialization.Formatters.dll and b/App/System.Runtime.Serialization.Formatters.dll differ diff --git a/App/System.Runtime.Serialization.Json.dll b/App/System.Runtime.Serialization.Json.dll index 237eee7d..e2f5547f 100644 Binary files a/App/System.Runtime.Serialization.Json.dll and b/App/System.Runtime.Serialization.Json.dll differ diff --git a/App/System.Runtime.Serialization.Primitives.dll b/App/System.Runtime.Serialization.Primitives.dll index 500c1a15..ed2eb709 100644 Binary files a/App/System.Runtime.Serialization.Primitives.dll and b/App/System.Runtime.Serialization.Primitives.dll differ diff --git a/App/System.Runtime.Serialization.Xml.dll b/App/System.Runtime.Serialization.Xml.dll index e9108a35..ead7a6fc 100644 Binary files a/App/System.Runtime.Serialization.Xml.dll and b/App/System.Runtime.Serialization.Xml.dll differ diff --git a/App/System.Runtime.Serialization.dll b/App/System.Runtime.Serialization.dll index d3b6ce63..f452089f 100644 Binary files a/App/System.Runtime.Serialization.dll and b/App/System.Runtime.Serialization.dll differ diff --git a/App/System.Runtime.dll b/App/System.Runtime.dll index 115819b1..dfbbe0b5 100644 Binary files a/App/System.Runtime.dll and b/App/System.Runtime.dll differ diff --git a/App/System.Security.AccessControl.dll b/App/System.Security.AccessControl.dll index 1a5de13e..b55531d3 100644 Binary files a/App/System.Security.AccessControl.dll and b/App/System.Security.AccessControl.dll differ diff --git a/App/System.Security.Claims.dll b/App/System.Security.Claims.dll index 6b76f8ea..29ba2196 100644 Binary files a/App/System.Security.Claims.dll and b/App/System.Security.Claims.dll differ diff --git a/App/System.Security.Cryptography.Algorithms.dll b/App/System.Security.Cryptography.Algorithms.dll index eba90c4f..b70966e4 100644 Binary files a/App/System.Security.Cryptography.Algorithms.dll and b/App/System.Security.Cryptography.Algorithms.dll differ diff --git a/App/System.Security.Cryptography.Cng.dll b/App/System.Security.Cryptography.Cng.dll index 89dda841..266b5e9a 100644 Binary files a/App/System.Security.Cryptography.Cng.dll and b/App/System.Security.Cryptography.Cng.dll differ diff --git a/App/System.Security.Cryptography.Csp.dll b/App/System.Security.Cryptography.Csp.dll index 983e7127..36d335dd 100644 Binary files a/App/System.Security.Cryptography.Csp.dll and b/App/System.Security.Cryptography.Csp.dll differ diff --git a/App/System.Security.Cryptography.Encoding.dll b/App/System.Security.Cryptography.Encoding.dll index 2b3ec5e2..8aca583a 100644 Binary files a/App/System.Security.Cryptography.Encoding.dll and b/App/System.Security.Cryptography.Encoding.dll differ diff --git a/App/System.Security.Cryptography.OpenSsl.dll b/App/System.Security.Cryptography.OpenSsl.dll index bd074671..5297ba78 100644 Binary files a/App/System.Security.Cryptography.OpenSsl.dll and b/App/System.Security.Cryptography.OpenSsl.dll differ diff --git a/App/System.Security.Cryptography.Pkcs.dll b/App/System.Security.Cryptography.Pkcs.dll index b80838cf..cf5f6113 100644 Binary files a/App/System.Security.Cryptography.Pkcs.dll and b/App/System.Security.Cryptography.Pkcs.dll differ diff --git a/App/System.Security.Cryptography.Primitives.dll b/App/System.Security.Cryptography.Primitives.dll index e647f9ab..b6592489 100644 Binary files a/App/System.Security.Cryptography.Primitives.dll and b/App/System.Security.Cryptography.Primitives.dll differ diff --git a/App/System.Security.Cryptography.ProtectedData.dll b/App/System.Security.Cryptography.ProtectedData.dll index 18a14c45..90ea9ebd 100644 Binary files a/App/System.Security.Cryptography.ProtectedData.dll and b/App/System.Security.Cryptography.ProtectedData.dll differ diff --git a/App/System.Security.Cryptography.X509Certificates.dll b/App/System.Security.Cryptography.X509Certificates.dll index 4a08434f..d1f7a7b3 100644 Binary files a/App/System.Security.Cryptography.X509Certificates.dll and b/App/System.Security.Cryptography.X509Certificates.dll differ diff --git a/App/System.Security.Cryptography.Xml.dll b/App/System.Security.Cryptography.Xml.dll index 6b2a71b1..2580d912 100644 Binary files a/App/System.Security.Cryptography.Xml.dll and b/App/System.Security.Cryptography.Xml.dll differ diff --git a/App/System.Security.Cryptography.dll b/App/System.Security.Cryptography.dll index 861d1e03..d8a8bf19 100644 Binary files a/App/System.Security.Cryptography.dll and b/App/System.Security.Cryptography.dll differ diff --git a/App/System.Security.Permissions.dll b/App/System.Security.Permissions.dll index 3d6f5c25..76411288 100644 Binary files a/App/System.Security.Permissions.dll and b/App/System.Security.Permissions.dll differ diff --git a/App/System.Security.Principal.Windows.dll b/App/System.Security.Principal.Windows.dll index 69dff599..35fa25ca 100644 Binary files a/App/System.Security.Principal.Windows.dll and b/App/System.Security.Principal.Windows.dll differ diff --git a/App/System.Security.Principal.dll b/App/System.Security.Principal.dll index 16c285fd..340f9405 100644 Binary files a/App/System.Security.Principal.dll and b/App/System.Security.Principal.dll differ diff --git a/App/System.Security.SecureString.dll b/App/System.Security.SecureString.dll index 897f3d68..137c3bdf 100644 Binary files a/App/System.Security.SecureString.dll and b/App/System.Security.SecureString.dll differ diff --git a/App/System.Security.dll b/App/System.Security.dll index a0f77899..bf6fd670 100644 Binary files a/App/System.Security.dll and b/App/System.Security.dll differ diff --git a/App/System.ServiceModel.Web.dll b/App/System.ServiceModel.Web.dll index 07a6c552..8950106b 100644 Binary files a/App/System.ServiceModel.Web.dll and b/App/System.ServiceModel.Web.dll differ diff --git a/App/System.ServiceProcess.dll b/App/System.ServiceProcess.dll index bdd1432d..653d6e4a 100644 Binary files a/App/System.ServiceProcess.dll and b/App/System.ServiceProcess.dll differ diff --git a/App/System.Text.Encoding.CodePages.dll b/App/System.Text.Encoding.CodePages.dll index b5c92b57..1372332b 100644 Binary files a/App/System.Text.Encoding.CodePages.dll and b/App/System.Text.Encoding.CodePages.dll differ diff --git a/App/System.Text.Encoding.Extensions.dll b/App/System.Text.Encoding.Extensions.dll index dc2fc6ab..f3691f1d 100644 Binary files a/App/System.Text.Encoding.Extensions.dll and b/App/System.Text.Encoding.Extensions.dll differ diff --git a/App/System.Text.Encoding.dll b/App/System.Text.Encoding.dll index 8c46d35b..b89b3593 100644 Binary files a/App/System.Text.Encoding.dll and b/App/System.Text.Encoding.dll differ diff --git a/App/System.Text.Encodings.Web.dll b/App/System.Text.Encodings.Web.dll index 220aab48..0f314dd9 100644 Binary files a/App/System.Text.Encodings.Web.dll and b/App/System.Text.Encodings.Web.dll differ diff --git a/App/System.Text.Json.dll b/App/System.Text.Json.dll index eac4c6fb..1e75eecf 100644 Binary files a/App/System.Text.Json.dll and b/App/System.Text.Json.dll differ diff --git a/App/System.Text.RegularExpressions.dll b/App/System.Text.RegularExpressions.dll index 20214349..fbfd8dca 100644 Binary files a/App/System.Text.RegularExpressions.dll and b/App/System.Text.RegularExpressions.dll differ diff --git a/App/System.Threading.AccessControl.dll b/App/System.Threading.AccessControl.dll index e43674cf..81bcf520 100644 Binary files a/App/System.Threading.AccessControl.dll and b/App/System.Threading.AccessControl.dll differ diff --git a/App/System.Threading.Channels.dll b/App/System.Threading.Channels.dll index baedf4e5..b375a9fd 100644 Binary files a/App/System.Threading.Channels.dll and b/App/System.Threading.Channels.dll differ diff --git a/App/System.Threading.Overlapped.dll b/App/System.Threading.Overlapped.dll index 0bd27aa1..1e71fa6e 100644 Binary files a/App/System.Threading.Overlapped.dll and b/App/System.Threading.Overlapped.dll differ diff --git a/App/System.Threading.RateLimiting.dll b/App/System.Threading.RateLimiting.dll index ce501bd8..bea5944d 100644 Binary files a/App/System.Threading.RateLimiting.dll and b/App/System.Threading.RateLimiting.dll differ diff --git a/App/System.Threading.Tasks.Dataflow.dll b/App/System.Threading.Tasks.Dataflow.dll index 50392e5a..27f6c706 100644 Binary files a/App/System.Threading.Tasks.Dataflow.dll and b/App/System.Threading.Tasks.Dataflow.dll differ diff --git a/App/System.Threading.Tasks.Extensions.dll b/App/System.Threading.Tasks.Extensions.dll index 3ee337cf..35253ced 100644 Binary files a/App/System.Threading.Tasks.Extensions.dll and b/App/System.Threading.Tasks.Extensions.dll differ diff --git a/App/System.Threading.Tasks.Parallel.dll b/App/System.Threading.Tasks.Parallel.dll index fae57de9..78d1c960 100644 Binary files a/App/System.Threading.Tasks.Parallel.dll and b/App/System.Threading.Tasks.Parallel.dll differ diff --git a/App/System.Threading.Tasks.dll b/App/System.Threading.Tasks.dll index 0ea33723..917d93d6 100644 Binary files a/App/System.Threading.Tasks.dll and b/App/System.Threading.Tasks.dll differ diff --git a/App/System.Threading.Thread.dll b/App/System.Threading.Thread.dll index 5411cf0b..caa4a6ac 100644 Binary files a/App/System.Threading.Thread.dll and b/App/System.Threading.Thread.dll differ diff --git a/App/System.Threading.ThreadPool.dll b/App/System.Threading.ThreadPool.dll index 11960ac6..2a918c1a 100644 Binary files a/App/System.Threading.ThreadPool.dll and b/App/System.Threading.ThreadPool.dll differ diff --git a/App/System.Threading.Timer.dll b/App/System.Threading.Timer.dll index 4d6afe6b..07160f65 100644 Binary files a/App/System.Threading.Timer.dll and b/App/System.Threading.Timer.dll differ diff --git a/App/System.Threading.dll b/App/System.Threading.dll index ce9de21d..be2e7514 100644 Binary files a/App/System.Threading.dll and b/App/System.Threading.dll differ diff --git a/App/System.Transactions.Local.dll b/App/System.Transactions.Local.dll index 20f2199c..651283da 100644 Binary files a/App/System.Transactions.Local.dll and b/App/System.Transactions.Local.dll differ diff --git a/App/System.Transactions.dll b/App/System.Transactions.dll index 3b326e30..d7c1cc16 100644 Binary files a/App/System.Transactions.dll and b/App/System.Transactions.dll differ diff --git a/App/System.ValueTuple.dll b/App/System.ValueTuple.dll index 331b6607..e7f4246e 100644 Binary files a/App/System.ValueTuple.dll and b/App/System.ValueTuple.dll differ diff --git a/App/System.Web.HttpUtility.dll b/App/System.Web.HttpUtility.dll index c120f128..f922fe88 100644 Binary files a/App/System.Web.HttpUtility.dll and b/App/System.Web.HttpUtility.dll differ diff --git a/App/System.Web.dll b/App/System.Web.dll index b582c015..b7714db7 100644 Binary files a/App/System.Web.dll and b/App/System.Web.dll differ diff --git a/App/System.Windows.Controls.Ribbon.dll b/App/System.Windows.Controls.Ribbon.dll index e5345b6a..15510e9b 100644 Binary files a/App/System.Windows.Controls.Ribbon.dll and b/App/System.Windows.Controls.Ribbon.dll differ diff --git a/App/System.Windows.Extensions.dll b/App/System.Windows.Extensions.dll index b5c415b1..2421fa32 100644 Binary files a/App/System.Windows.Extensions.dll and b/App/System.Windows.Extensions.dll differ diff --git a/App/System.Windows.Forms.Design.Editors.dll b/App/System.Windows.Forms.Design.Editors.dll index b0d64880..7b16b6ac 100644 Binary files a/App/System.Windows.Forms.Design.Editors.dll and b/App/System.Windows.Forms.Design.Editors.dll differ diff --git a/App/System.Windows.Forms.Design.dll b/App/System.Windows.Forms.Design.dll index 733b59fa..a6ec4a58 100644 Binary files a/App/System.Windows.Forms.Design.dll and b/App/System.Windows.Forms.Design.dll differ diff --git a/App/System.Windows.Forms.Primitives.dll b/App/System.Windows.Forms.Primitives.dll index ba6fcc90..635b39ef 100644 Binary files a/App/System.Windows.Forms.Primitives.dll and b/App/System.Windows.Forms.Primitives.dll differ diff --git a/App/System.Windows.Forms.dll b/App/System.Windows.Forms.dll index c7095852..ef13ffc1 100644 Binary files a/App/System.Windows.Forms.dll and b/App/System.Windows.Forms.dll differ diff --git a/App/System.Windows.Input.Manipulations.dll b/App/System.Windows.Input.Manipulations.dll index a9359045..29d5cf2f 100644 Binary files a/App/System.Windows.Input.Manipulations.dll and b/App/System.Windows.Input.Manipulations.dll differ diff --git a/App/System.Windows.Presentation.dll b/App/System.Windows.Presentation.dll index 037696c2..1d16623e 100644 Binary files a/App/System.Windows.Presentation.dll and b/App/System.Windows.Presentation.dll differ diff --git a/App/System.Windows.dll b/App/System.Windows.dll index 3d029df1..81430703 100644 Binary files a/App/System.Windows.dll and b/App/System.Windows.dll differ diff --git a/App/System.Xaml.dll b/App/System.Xaml.dll index ef218968..bae644ec 100644 Binary files a/App/System.Xaml.dll and b/App/System.Xaml.dll differ diff --git a/App/System.Xml.Linq.dll b/App/System.Xml.Linq.dll index 0979d616..b6c5f4bf 100644 Binary files a/App/System.Xml.Linq.dll and b/App/System.Xml.Linq.dll differ diff --git a/App/System.Xml.ReaderWriter.dll b/App/System.Xml.ReaderWriter.dll index 124d8189..58b9c89c 100644 Binary files a/App/System.Xml.ReaderWriter.dll and b/App/System.Xml.ReaderWriter.dll differ diff --git a/App/System.Xml.Serialization.dll b/App/System.Xml.Serialization.dll index 9237f194..e107ca4e 100644 Binary files a/App/System.Xml.Serialization.dll and b/App/System.Xml.Serialization.dll differ diff --git a/App/System.Xml.XDocument.dll b/App/System.Xml.XDocument.dll index 067f1389..59abd0d9 100644 Binary files a/App/System.Xml.XDocument.dll and b/App/System.Xml.XDocument.dll differ diff --git a/App/System.Xml.XPath.XDocument.dll b/App/System.Xml.XPath.XDocument.dll index 5466e3ee..b7ab2f85 100644 Binary files a/App/System.Xml.XPath.XDocument.dll and b/App/System.Xml.XPath.XDocument.dll differ diff --git a/App/System.Xml.XPath.dll b/App/System.Xml.XPath.dll index 738f5a65..8fb57f18 100644 Binary files a/App/System.Xml.XPath.dll and b/App/System.Xml.XPath.dll differ diff --git a/App/System.Xml.XmlDocument.dll b/App/System.Xml.XmlDocument.dll index e7679233..f05ea055 100644 Binary files a/App/System.Xml.XmlDocument.dll and b/App/System.Xml.XmlDocument.dll differ diff --git a/App/System.Xml.XmlSerializer.dll b/App/System.Xml.XmlSerializer.dll index 23a97bd7..02194c0f 100644 Binary files a/App/System.Xml.XmlSerializer.dll and b/App/System.Xml.XmlSerializer.dll differ diff --git a/App/System.Xml.dll b/App/System.Xml.dll index fe06d515..6c843339 100644 Binary files a/App/System.Xml.dll and b/App/System.Xml.dll differ diff --git a/App/System.dll b/App/System.dll index 60d41631..20baf605 100644 Binary files a/App/System.dll and b/App/System.dll differ diff --git a/App/UIAutomationClient.dll b/App/UIAutomationClient.dll index d65ebc3a..86e47154 100644 Binary files a/App/UIAutomationClient.dll and b/App/UIAutomationClient.dll differ diff --git a/App/UIAutomationClientSideProviders.dll b/App/UIAutomationClientSideProviders.dll index 6393dd16..fda11245 100644 Binary files a/App/UIAutomationClientSideProviders.dll and b/App/UIAutomationClientSideProviders.dll differ diff --git a/App/UIAutomationProvider.dll b/App/UIAutomationProvider.dll index ab33ecfb..d812873d 100644 Binary files a/App/UIAutomationProvider.dll and b/App/UIAutomationProvider.dll differ diff --git a/App/UIAutomationTypes.dll b/App/UIAutomationTypes.dll index c8739d38..eb61b2c3 100644 Binary files a/App/UIAutomationTypes.dll and b/App/UIAutomationTypes.dll differ diff --git a/App/WindowsBase.dll b/App/WindowsBase.dll index a6b5f6b0..6d2a9942 100644 Binary files a/App/WindowsBase.dll and b/App/WindowsBase.dll differ diff --git a/App/WindowsFormsIntegration.dll b/App/WindowsFormsIntegration.dll index 8eb211c1..58b065a3 100644 Binary files a/App/WindowsFormsIntegration.dll and b/App/WindowsFormsIntegration.dll differ diff --git a/App/aspnetcorev2_inprocess.dll b/App/aspnetcorev2_inprocess.dll index 7c928426..9070b9f2 100644 Binary files a/App/aspnetcorev2_inprocess.dll and b/App/aspnetcorev2_inprocess.dll differ diff --git a/App/clretwrc.dll b/App/clretwrc.dll index c672aaa3..6c3ab5f5 100644 Binary files a/App/clretwrc.dll and b/App/clretwrc.dll differ diff --git a/App/clrgc.dll b/App/clrgc.dll index 02870ca3..309d9e7c 100644 Binary files a/App/clrgc.dll and b/App/clrgc.dll differ diff --git a/App/clrgcexp.dll b/App/clrgcexp.dll index 6cb31299..5da640a7 100644 Binary files a/App/clrgcexp.dll and b/App/clrgcexp.dll differ diff --git a/App/clrjit.dll b/App/clrjit.dll index 7af2c3b1..77da7b9b 100644 Binary files a/App/clrjit.dll and b/App/clrjit.dll differ diff --git a/App/core.dll b/App/core.dll index bd7ff437..1c21dabe 100644 Binary files a/App/core.dll and b/App/core.dll differ diff --git a/App/coreclr.dll b/App/coreclr.dll index 0234259a..c0e281b0 100644 Binary files a/App/coreclr.dll and b/App/coreclr.dll differ diff --git a/App/createdump.exe b/App/createdump.exe index d5e63537..ec4e2b92 100644 Binary files a/App/createdump.exe and b/App/createdump.exe differ diff --git a/App/cs/Microsoft.VisualBasic.Forms.resources.dll b/App/cs/Microsoft.VisualBasic.Forms.resources.dll index 03978861..b4c259ba 100644 Binary files a/App/cs/Microsoft.VisualBasic.Forms.resources.dll and b/App/cs/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/cs/PresentationCore.resources.dll b/App/cs/PresentationCore.resources.dll index f6c7ce87..8ab50474 100644 Binary files a/App/cs/PresentationCore.resources.dll and b/App/cs/PresentationCore.resources.dll differ diff --git a/App/cs/PresentationFramework.resources.dll b/App/cs/PresentationFramework.resources.dll index ab219541..6d1abf5a 100644 Binary files a/App/cs/PresentationFramework.resources.dll and b/App/cs/PresentationFramework.resources.dll differ diff --git a/App/cs/PresentationUI.resources.dll b/App/cs/PresentationUI.resources.dll index 52fd82aa..a2a213a2 100644 Binary files a/App/cs/PresentationUI.resources.dll and b/App/cs/PresentationUI.resources.dll differ diff --git a/App/cs/ReachFramework.resources.dll b/App/cs/ReachFramework.resources.dll index 460745f4..30190039 100644 Binary files a/App/cs/ReachFramework.resources.dll and b/App/cs/ReachFramework.resources.dll differ diff --git a/App/cs/System.Windows.Controls.Ribbon.resources.dll b/App/cs/System.Windows.Controls.Ribbon.resources.dll index 8fd60db6..49a17afc 100644 Binary files a/App/cs/System.Windows.Controls.Ribbon.resources.dll and b/App/cs/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/cs/System.Windows.Forms.Design.resources.dll b/App/cs/System.Windows.Forms.Design.resources.dll index 392d317f..ecf00a30 100644 Binary files a/App/cs/System.Windows.Forms.Design.resources.dll and b/App/cs/System.Windows.Forms.Design.resources.dll differ diff --git a/App/cs/System.Windows.Forms.Primitives.resources.dll b/App/cs/System.Windows.Forms.Primitives.resources.dll index db392662..46c36dd3 100644 Binary files a/App/cs/System.Windows.Forms.Primitives.resources.dll and b/App/cs/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/cs/System.Windows.Forms.resources.dll b/App/cs/System.Windows.Forms.resources.dll index c2c34915..e744ad89 100644 Binary files a/App/cs/System.Windows.Forms.resources.dll and b/App/cs/System.Windows.Forms.resources.dll differ diff --git a/App/cs/System.Windows.Input.Manipulations.resources.dll b/App/cs/System.Windows.Input.Manipulations.resources.dll index 91f800df..69dbaab9 100644 Binary files a/App/cs/System.Windows.Input.Manipulations.resources.dll and b/App/cs/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/cs/System.Xaml.resources.dll b/App/cs/System.Xaml.resources.dll index c586dc9e..3e0ba3e4 100644 Binary files a/App/cs/System.Xaml.resources.dll and b/App/cs/System.Xaml.resources.dll differ diff --git a/App/cs/UIAutomationClient.resources.dll b/App/cs/UIAutomationClient.resources.dll index 55731988..1934528c 100644 Binary files a/App/cs/UIAutomationClient.resources.dll and b/App/cs/UIAutomationClient.resources.dll differ diff --git a/App/cs/UIAutomationClientSideProviders.resources.dll b/App/cs/UIAutomationClientSideProviders.resources.dll index 2103ba81..e8518f40 100644 Binary files a/App/cs/UIAutomationClientSideProviders.resources.dll and b/App/cs/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/cs/UIAutomationProvider.resources.dll b/App/cs/UIAutomationProvider.resources.dll index cf9b17e7..569cc303 100644 Binary files a/App/cs/UIAutomationProvider.resources.dll and b/App/cs/UIAutomationProvider.resources.dll differ diff --git a/App/cs/UIAutomationTypes.resources.dll b/App/cs/UIAutomationTypes.resources.dll index 89913a68..11445eba 100644 Binary files a/App/cs/UIAutomationTypes.resources.dll and b/App/cs/UIAutomationTypes.resources.dll differ diff --git a/App/cs/WindowsBase.resources.dll b/App/cs/WindowsBase.resources.dll index f46fe2c8..bb987bc5 100644 Binary files a/App/cs/WindowsBase.resources.dll and b/App/cs/WindowsBase.resources.dll differ diff --git a/App/cs/WindowsFormsIntegration.resources.dll b/App/cs/WindowsFormsIntegration.resources.dll index 7fc5a458..80f2d5bf 100644 Binary files a/App/cs/WindowsFormsIntegration.resources.dll and b/App/cs/WindowsFormsIntegration.resources.dll differ diff --git a/App/de/Microsoft.VisualBasic.Forms.resources.dll b/App/de/Microsoft.VisualBasic.Forms.resources.dll index 07687e46..da490018 100644 Binary files a/App/de/Microsoft.VisualBasic.Forms.resources.dll and b/App/de/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/de/PresentationCore.resources.dll b/App/de/PresentationCore.resources.dll index 9cabaa23..26e684e5 100644 Binary files a/App/de/PresentationCore.resources.dll and b/App/de/PresentationCore.resources.dll differ diff --git a/App/de/PresentationFramework.resources.dll b/App/de/PresentationFramework.resources.dll index 90573e65..effdc069 100644 Binary files a/App/de/PresentationFramework.resources.dll and b/App/de/PresentationFramework.resources.dll differ diff --git a/App/de/PresentationUI.resources.dll b/App/de/PresentationUI.resources.dll index 88e4ea12..68ff6c24 100644 Binary files a/App/de/PresentationUI.resources.dll and b/App/de/PresentationUI.resources.dll differ diff --git a/App/de/ReachFramework.resources.dll b/App/de/ReachFramework.resources.dll index 9c44496e..c1267998 100644 Binary files a/App/de/ReachFramework.resources.dll and b/App/de/ReachFramework.resources.dll differ diff --git a/App/de/System.Windows.Controls.Ribbon.resources.dll b/App/de/System.Windows.Controls.Ribbon.resources.dll index 9def3af1..804f7a39 100644 Binary files a/App/de/System.Windows.Controls.Ribbon.resources.dll and b/App/de/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/de/System.Windows.Forms.Design.resources.dll b/App/de/System.Windows.Forms.Design.resources.dll index 3cd77323..461bb376 100644 Binary files a/App/de/System.Windows.Forms.Design.resources.dll and b/App/de/System.Windows.Forms.Design.resources.dll differ diff --git a/App/de/System.Windows.Forms.Primitives.resources.dll b/App/de/System.Windows.Forms.Primitives.resources.dll index f731d0f8..eadb3a79 100644 Binary files a/App/de/System.Windows.Forms.Primitives.resources.dll and b/App/de/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/de/System.Windows.Forms.resources.dll b/App/de/System.Windows.Forms.resources.dll index 296ce3fa..517c8dab 100644 Binary files a/App/de/System.Windows.Forms.resources.dll and b/App/de/System.Windows.Forms.resources.dll differ diff --git a/App/de/System.Windows.Input.Manipulations.resources.dll b/App/de/System.Windows.Input.Manipulations.resources.dll index 6d1846a5..29aed1f1 100644 Binary files a/App/de/System.Windows.Input.Manipulations.resources.dll and b/App/de/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/de/System.Xaml.resources.dll b/App/de/System.Xaml.resources.dll index 6cbfd734..aa3e9f10 100644 Binary files a/App/de/System.Xaml.resources.dll and b/App/de/System.Xaml.resources.dll differ diff --git a/App/de/UIAutomationClient.resources.dll b/App/de/UIAutomationClient.resources.dll index d01b66af..1093a886 100644 Binary files a/App/de/UIAutomationClient.resources.dll and b/App/de/UIAutomationClient.resources.dll differ diff --git a/App/de/UIAutomationClientSideProviders.resources.dll b/App/de/UIAutomationClientSideProviders.resources.dll index 22c1f3c6..33fce7c2 100644 Binary files a/App/de/UIAutomationClientSideProviders.resources.dll and b/App/de/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/de/UIAutomationProvider.resources.dll b/App/de/UIAutomationProvider.resources.dll index f60bd64d..918ca302 100644 Binary files a/App/de/UIAutomationProvider.resources.dll and b/App/de/UIAutomationProvider.resources.dll differ diff --git a/App/de/UIAutomationTypes.resources.dll b/App/de/UIAutomationTypes.resources.dll index 7a988ab6..37ded445 100644 Binary files a/App/de/UIAutomationTypes.resources.dll and b/App/de/UIAutomationTypes.resources.dll differ diff --git a/App/de/WindowsBase.resources.dll b/App/de/WindowsBase.resources.dll index d86e50f3..f4e24891 100644 Binary files a/App/de/WindowsBase.resources.dll and b/App/de/WindowsBase.resources.dll differ diff --git a/App/de/WindowsFormsIntegration.resources.dll b/App/de/WindowsFormsIntegration.resources.dll index 1fb28680..92923552 100644 Binary files a/App/de/WindowsFormsIntegration.resources.dll and b/App/de/WindowsFormsIntegration.resources.dll differ diff --git a/App/en/HiGeom.resources.dll b/App/en/HiGeom.resources.dll index 19c694b8..8a837da5 100644 Binary files a/App/en/HiGeom.resources.dll and b/App/en/HiGeom.resources.dll differ diff --git a/App/en/HiMech.resources.dll b/App/en/HiMech.resources.dll index 6446246b..422f8988 100644 Binary files a/App/en/HiMech.resources.dll and b/App/en/HiMech.resources.dll differ diff --git a/App/es/Microsoft.VisualBasic.Forms.resources.dll b/App/es/Microsoft.VisualBasic.Forms.resources.dll index 822596b6..cfa9eb32 100644 Binary files a/App/es/Microsoft.VisualBasic.Forms.resources.dll and b/App/es/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/es/PresentationCore.resources.dll b/App/es/PresentationCore.resources.dll index 4d7bfeaf..045da2df 100644 Binary files a/App/es/PresentationCore.resources.dll and b/App/es/PresentationCore.resources.dll differ diff --git a/App/es/PresentationFramework.resources.dll b/App/es/PresentationFramework.resources.dll index 8270c717..f5c02f51 100644 Binary files a/App/es/PresentationFramework.resources.dll and b/App/es/PresentationFramework.resources.dll differ diff --git a/App/es/PresentationUI.resources.dll b/App/es/PresentationUI.resources.dll index 6efa374e..21e3d3f0 100644 Binary files a/App/es/PresentationUI.resources.dll and b/App/es/PresentationUI.resources.dll differ diff --git a/App/es/ReachFramework.resources.dll b/App/es/ReachFramework.resources.dll index fa9e6291..2a51bbe9 100644 Binary files a/App/es/ReachFramework.resources.dll and b/App/es/ReachFramework.resources.dll differ diff --git a/App/es/System.Windows.Controls.Ribbon.resources.dll b/App/es/System.Windows.Controls.Ribbon.resources.dll index 4075e9e7..2e7d37a0 100644 Binary files a/App/es/System.Windows.Controls.Ribbon.resources.dll and b/App/es/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/es/System.Windows.Forms.Design.resources.dll b/App/es/System.Windows.Forms.Design.resources.dll index 7266892d..0cfd899c 100644 Binary files a/App/es/System.Windows.Forms.Design.resources.dll and b/App/es/System.Windows.Forms.Design.resources.dll differ diff --git a/App/es/System.Windows.Forms.Primitives.resources.dll b/App/es/System.Windows.Forms.Primitives.resources.dll index f64b340e..f5fc2a30 100644 Binary files a/App/es/System.Windows.Forms.Primitives.resources.dll and b/App/es/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/es/System.Windows.Forms.resources.dll b/App/es/System.Windows.Forms.resources.dll index 6d7f4fed..9c77fc14 100644 Binary files a/App/es/System.Windows.Forms.resources.dll and b/App/es/System.Windows.Forms.resources.dll differ diff --git a/App/es/System.Windows.Input.Manipulations.resources.dll b/App/es/System.Windows.Input.Manipulations.resources.dll index f503b2ab..df546f0a 100644 Binary files a/App/es/System.Windows.Input.Manipulations.resources.dll and b/App/es/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/es/System.Xaml.resources.dll b/App/es/System.Xaml.resources.dll index d2364bdb..17e8ae1f 100644 Binary files a/App/es/System.Xaml.resources.dll and b/App/es/System.Xaml.resources.dll differ diff --git a/App/es/UIAutomationClient.resources.dll b/App/es/UIAutomationClient.resources.dll index 25fd410e..f33cc32c 100644 Binary files a/App/es/UIAutomationClient.resources.dll and b/App/es/UIAutomationClient.resources.dll differ diff --git a/App/es/UIAutomationClientSideProviders.resources.dll b/App/es/UIAutomationClientSideProviders.resources.dll index 8d66edc7..e12d6d6e 100644 Binary files a/App/es/UIAutomationClientSideProviders.resources.dll and b/App/es/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/es/UIAutomationProvider.resources.dll b/App/es/UIAutomationProvider.resources.dll index 75fb56eb..3f2b932a 100644 Binary files a/App/es/UIAutomationProvider.resources.dll and b/App/es/UIAutomationProvider.resources.dll differ diff --git a/App/es/UIAutomationTypes.resources.dll b/App/es/UIAutomationTypes.resources.dll index d341a6d5..3f1c4081 100644 Binary files a/App/es/UIAutomationTypes.resources.dll and b/App/es/UIAutomationTypes.resources.dll differ diff --git a/App/es/WindowsBase.resources.dll b/App/es/WindowsBase.resources.dll index 93c77dd3..a1fd3722 100644 Binary files a/App/es/WindowsBase.resources.dll and b/App/es/WindowsBase.resources.dll differ diff --git a/App/es/WindowsFormsIntegration.resources.dll b/App/es/WindowsFormsIntegration.resources.dll index 7520551e..fdea93db 100644 Binary files a/App/es/WindowsFormsIntegration.resources.dll and b/App/es/WindowsFormsIntegration.resources.dll differ diff --git a/App/fr/Microsoft.VisualBasic.Forms.resources.dll b/App/fr/Microsoft.VisualBasic.Forms.resources.dll index b667a23d..ddd49d05 100644 Binary files a/App/fr/Microsoft.VisualBasic.Forms.resources.dll and b/App/fr/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/fr/PresentationCore.resources.dll b/App/fr/PresentationCore.resources.dll index 29d11c41..5137f04e 100644 Binary files a/App/fr/PresentationCore.resources.dll and b/App/fr/PresentationCore.resources.dll differ diff --git a/App/fr/PresentationFramework.resources.dll b/App/fr/PresentationFramework.resources.dll index bdb9c1fa..ebc0a921 100644 Binary files a/App/fr/PresentationFramework.resources.dll and b/App/fr/PresentationFramework.resources.dll differ diff --git a/App/fr/PresentationUI.resources.dll b/App/fr/PresentationUI.resources.dll index 251ee120..9798fe31 100644 Binary files a/App/fr/PresentationUI.resources.dll and b/App/fr/PresentationUI.resources.dll differ diff --git a/App/fr/ReachFramework.resources.dll b/App/fr/ReachFramework.resources.dll index a9fd06af..346434b0 100644 Binary files a/App/fr/ReachFramework.resources.dll and b/App/fr/ReachFramework.resources.dll differ diff --git a/App/fr/System.Windows.Controls.Ribbon.resources.dll b/App/fr/System.Windows.Controls.Ribbon.resources.dll index 51c19d68..8dbc17ea 100644 Binary files a/App/fr/System.Windows.Controls.Ribbon.resources.dll and b/App/fr/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/fr/System.Windows.Forms.Design.resources.dll b/App/fr/System.Windows.Forms.Design.resources.dll index ec6b5424..768492c2 100644 Binary files a/App/fr/System.Windows.Forms.Design.resources.dll and b/App/fr/System.Windows.Forms.Design.resources.dll differ diff --git a/App/fr/System.Windows.Forms.Primitives.resources.dll b/App/fr/System.Windows.Forms.Primitives.resources.dll index f1d31a31..0ed2fbaf 100644 Binary files a/App/fr/System.Windows.Forms.Primitives.resources.dll and b/App/fr/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/fr/System.Windows.Forms.resources.dll b/App/fr/System.Windows.Forms.resources.dll index e5f3d957..d1a267ea 100644 Binary files a/App/fr/System.Windows.Forms.resources.dll and b/App/fr/System.Windows.Forms.resources.dll differ diff --git a/App/fr/System.Windows.Input.Manipulations.resources.dll b/App/fr/System.Windows.Input.Manipulations.resources.dll index 28e3d63a..f6cd81b3 100644 Binary files a/App/fr/System.Windows.Input.Manipulations.resources.dll and b/App/fr/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/fr/System.Xaml.resources.dll b/App/fr/System.Xaml.resources.dll index eb1f6609..08a5c40b 100644 Binary files a/App/fr/System.Xaml.resources.dll and b/App/fr/System.Xaml.resources.dll differ diff --git a/App/fr/UIAutomationClient.resources.dll b/App/fr/UIAutomationClient.resources.dll index 2ceca1a5..19f90f31 100644 Binary files a/App/fr/UIAutomationClient.resources.dll and b/App/fr/UIAutomationClient.resources.dll differ diff --git a/App/fr/UIAutomationClientSideProviders.resources.dll b/App/fr/UIAutomationClientSideProviders.resources.dll index affea8f7..87c75090 100644 Binary files a/App/fr/UIAutomationClientSideProviders.resources.dll and b/App/fr/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/fr/UIAutomationProvider.resources.dll b/App/fr/UIAutomationProvider.resources.dll index ef80f1ee..44c1ff6e 100644 Binary files a/App/fr/UIAutomationProvider.resources.dll and b/App/fr/UIAutomationProvider.resources.dll differ diff --git a/App/fr/UIAutomationTypes.resources.dll b/App/fr/UIAutomationTypes.resources.dll index ed195478..f46f5aea 100644 Binary files a/App/fr/UIAutomationTypes.resources.dll and b/App/fr/UIAutomationTypes.resources.dll differ diff --git a/App/fr/WindowsBase.resources.dll b/App/fr/WindowsBase.resources.dll index a79c1963..7e6dcc49 100644 Binary files a/App/fr/WindowsBase.resources.dll and b/App/fr/WindowsBase.resources.dll differ diff --git a/App/fr/WindowsFormsIntegration.resources.dll b/App/fr/WindowsFormsIntegration.resources.dll index 616d02d1..c9fe9580 100644 Binary files a/App/fr/WindowsFormsIntegration.resources.dll and b/App/fr/WindowsFormsIntegration.resources.dll differ diff --git a/App/hostfxr.dll b/App/hostfxr.dll index 7ab57300..ce37eead 100644 Binary files a/App/hostfxr.dll and b/App/hostfxr.dll differ diff --git a/App/hostpolicy.dll b/App/hostpolicy.dll index bab1d954..3c54e79e 100644 Binary files a/App/hostpolicy.dll and b/App/hostpolicy.dll differ diff --git a/App/it/Microsoft.VisualBasic.Forms.resources.dll b/App/it/Microsoft.VisualBasic.Forms.resources.dll index 4b67e456..a548ae6e 100644 Binary files a/App/it/Microsoft.VisualBasic.Forms.resources.dll and b/App/it/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/it/PresentationCore.resources.dll b/App/it/PresentationCore.resources.dll index b720e6a1..40ea4749 100644 Binary files a/App/it/PresentationCore.resources.dll and b/App/it/PresentationCore.resources.dll differ diff --git a/App/it/PresentationFramework.resources.dll b/App/it/PresentationFramework.resources.dll index a6b52546..2d20fb48 100644 Binary files a/App/it/PresentationFramework.resources.dll and b/App/it/PresentationFramework.resources.dll differ diff --git a/App/it/PresentationUI.resources.dll b/App/it/PresentationUI.resources.dll index 70e906ee..e125887e 100644 Binary files a/App/it/PresentationUI.resources.dll and b/App/it/PresentationUI.resources.dll differ diff --git a/App/it/ReachFramework.resources.dll b/App/it/ReachFramework.resources.dll index 3cfc1300..80ffb909 100644 Binary files a/App/it/ReachFramework.resources.dll and b/App/it/ReachFramework.resources.dll differ diff --git a/App/it/System.Windows.Controls.Ribbon.resources.dll b/App/it/System.Windows.Controls.Ribbon.resources.dll index b054e973..51be1d14 100644 Binary files a/App/it/System.Windows.Controls.Ribbon.resources.dll and b/App/it/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/it/System.Windows.Forms.Design.resources.dll b/App/it/System.Windows.Forms.Design.resources.dll index 304c71ec..fa381a04 100644 Binary files a/App/it/System.Windows.Forms.Design.resources.dll and b/App/it/System.Windows.Forms.Design.resources.dll differ diff --git a/App/it/System.Windows.Forms.Primitives.resources.dll b/App/it/System.Windows.Forms.Primitives.resources.dll index 4f482652..0720187b 100644 Binary files a/App/it/System.Windows.Forms.Primitives.resources.dll and b/App/it/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/it/System.Windows.Forms.resources.dll b/App/it/System.Windows.Forms.resources.dll index 7ebd1e52..aeb0caae 100644 Binary files a/App/it/System.Windows.Forms.resources.dll and b/App/it/System.Windows.Forms.resources.dll differ diff --git a/App/it/System.Windows.Input.Manipulations.resources.dll b/App/it/System.Windows.Input.Manipulations.resources.dll index 0297e02a..895e73e7 100644 Binary files a/App/it/System.Windows.Input.Manipulations.resources.dll and b/App/it/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/it/System.Xaml.resources.dll b/App/it/System.Xaml.resources.dll index 516bd05c..146a645f 100644 Binary files a/App/it/System.Xaml.resources.dll and b/App/it/System.Xaml.resources.dll differ diff --git a/App/it/UIAutomationClient.resources.dll b/App/it/UIAutomationClient.resources.dll index 08c84113..84abadca 100644 Binary files a/App/it/UIAutomationClient.resources.dll and b/App/it/UIAutomationClient.resources.dll differ diff --git a/App/it/UIAutomationClientSideProviders.resources.dll b/App/it/UIAutomationClientSideProviders.resources.dll index b1823272..0c9c6cd1 100644 Binary files a/App/it/UIAutomationClientSideProviders.resources.dll and b/App/it/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/it/UIAutomationProvider.resources.dll b/App/it/UIAutomationProvider.resources.dll index ae9e37d5..6a10b3c1 100644 Binary files a/App/it/UIAutomationProvider.resources.dll and b/App/it/UIAutomationProvider.resources.dll differ diff --git a/App/it/UIAutomationTypes.resources.dll b/App/it/UIAutomationTypes.resources.dll index ef3e51dc..e64d468c 100644 Binary files a/App/it/UIAutomationTypes.resources.dll and b/App/it/UIAutomationTypes.resources.dll differ diff --git a/App/it/WindowsBase.resources.dll b/App/it/WindowsBase.resources.dll index 07a79ae3..e45bafa5 100644 Binary files a/App/it/WindowsBase.resources.dll and b/App/it/WindowsBase.resources.dll differ diff --git a/App/it/WindowsFormsIntegration.resources.dll b/App/it/WindowsFormsIntegration.resources.dll index c32f6ce4..b09c0c50 100644 Binary files a/App/it/WindowsFormsIntegration.resources.dll and b/App/it/WindowsFormsIntegration.resources.dll differ diff --git a/App/ja/Microsoft.VisualBasic.Forms.resources.dll b/App/ja/Microsoft.VisualBasic.Forms.resources.dll index 95e08083..84993234 100644 Binary files a/App/ja/Microsoft.VisualBasic.Forms.resources.dll and b/App/ja/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/ja/PresentationCore.resources.dll b/App/ja/PresentationCore.resources.dll index 4d3b832c..a42af3f0 100644 Binary files a/App/ja/PresentationCore.resources.dll and b/App/ja/PresentationCore.resources.dll differ diff --git a/App/ja/PresentationFramework.resources.dll b/App/ja/PresentationFramework.resources.dll index ecf4519f..e32dd662 100644 Binary files a/App/ja/PresentationFramework.resources.dll and b/App/ja/PresentationFramework.resources.dll differ diff --git a/App/ja/PresentationUI.resources.dll b/App/ja/PresentationUI.resources.dll index bc396dc8..34b82312 100644 Binary files a/App/ja/PresentationUI.resources.dll and b/App/ja/PresentationUI.resources.dll differ diff --git a/App/ja/ReachFramework.resources.dll b/App/ja/ReachFramework.resources.dll index 62d465b3..dd59e8cc 100644 Binary files a/App/ja/ReachFramework.resources.dll and b/App/ja/ReachFramework.resources.dll differ diff --git a/App/ja/System.Windows.Controls.Ribbon.resources.dll b/App/ja/System.Windows.Controls.Ribbon.resources.dll index 61ae2e07..88f0ad5d 100644 Binary files a/App/ja/System.Windows.Controls.Ribbon.resources.dll and b/App/ja/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/ja/System.Windows.Forms.Design.resources.dll b/App/ja/System.Windows.Forms.Design.resources.dll index c3209911..f99458f7 100644 Binary files a/App/ja/System.Windows.Forms.Design.resources.dll and b/App/ja/System.Windows.Forms.Design.resources.dll differ diff --git a/App/ja/System.Windows.Forms.Primitives.resources.dll b/App/ja/System.Windows.Forms.Primitives.resources.dll index 8b3fcae9..aede5bcd 100644 Binary files a/App/ja/System.Windows.Forms.Primitives.resources.dll and b/App/ja/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/ja/System.Windows.Forms.resources.dll b/App/ja/System.Windows.Forms.resources.dll index 96637f45..d49bc222 100644 Binary files a/App/ja/System.Windows.Forms.resources.dll and b/App/ja/System.Windows.Forms.resources.dll differ diff --git a/App/ja/System.Windows.Input.Manipulations.resources.dll b/App/ja/System.Windows.Input.Manipulations.resources.dll index 156694cb..d640179f 100644 Binary files a/App/ja/System.Windows.Input.Manipulations.resources.dll and b/App/ja/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/ja/System.Xaml.resources.dll b/App/ja/System.Xaml.resources.dll index be632355..250469d1 100644 Binary files a/App/ja/System.Xaml.resources.dll and b/App/ja/System.Xaml.resources.dll differ diff --git a/App/ja/UIAutomationClient.resources.dll b/App/ja/UIAutomationClient.resources.dll index 7c8cd5c1..9c1df2af 100644 Binary files a/App/ja/UIAutomationClient.resources.dll and b/App/ja/UIAutomationClient.resources.dll differ diff --git a/App/ja/UIAutomationClientSideProviders.resources.dll b/App/ja/UIAutomationClientSideProviders.resources.dll index 17263f82..1de65a28 100644 Binary files a/App/ja/UIAutomationClientSideProviders.resources.dll and b/App/ja/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/ja/UIAutomationProvider.resources.dll b/App/ja/UIAutomationProvider.resources.dll index aa6bca58..5180cc52 100644 Binary files a/App/ja/UIAutomationProvider.resources.dll and b/App/ja/UIAutomationProvider.resources.dll differ diff --git a/App/ja/UIAutomationTypes.resources.dll b/App/ja/UIAutomationTypes.resources.dll index 81d3964f..7090f141 100644 Binary files a/App/ja/UIAutomationTypes.resources.dll and b/App/ja/UIAutomationTypes.resources.dll differ diff --git a/App/ja/WindowsBase.resources.dll b/App/ja/WindowsBase.resources.dll index d57970c0..3765479a 100644 Binary files a/App/ja/WindowsBase.resources.dll and b/App/ja/WindowsBase.resources.dll differ diff --git a/App/ja/WindowsFormsIntegration.resources.dll b/App/ja/WindowsFormsIntegration.resources.dll index d109b7e1..765e0558 100644 Binary files a/App/ja/WindowsFormsIntegration.resources.dll and b/App/ja/WindowsFormsIntegration.resources.dll differ diff --git a/App/ko/Microsoft.VisualBasic.Forms.resources.dll b/App/ko/Microsoft.VisualBasic.Forms.resources.dll index 5915e073..cfdff23d 100644 Binary files a/App/ko/Microsoft.VisualBasic.Forms.resources.dll and b/App/ko/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/ko/PresentationCore.resources.dll b/App/ko/PresentationCore.resources.dll index 152fddb7..c37723ff 100644 Binary files a/App/ko/PresentationCore.resources.dll and b/App/ko/PresentationCore.resources.dll differ diff --git a/App/ko/PresentationFramework.resources.dll b/App/ko/PresentationFramework.resources.dll index 31f80ecf..7d503a57 100644 Binary files a/App/ko/PresentationFramework.resources.dll and b/App/ko/PresentationFramework.resources.dll differ diff --git a/App/ko/PresentationUI.resources.dll b/App/ko/PresentationUI.resources.dll index 658996c5..46f3770c 100644 Binary files a/App/ko/PresentationUI.resources.dll and b/App/ko/PresentationUI.resources.dll differ diff --git a/App/ko/ReachFramework.resources.dll b/App/ko/ReachFramework.resources.dll index 8f92e416..6fd270ca 100644 Binary files a/App/ko/ReachFramework.resources.dll and b/App/ko/ReachFramework.resources.dll differ diff --git a/App/ko/System.Windows.Controls.Ribbon.resources.dll b/App/ko/System.Windows.Controls.Ribbon.resources.dll index 86c430e4..5ea8dec5 100644 Binary files a/App/ko/System.Windows.Controls.Ribbon.resources.dll and b/App/ko/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/ko/System.Windows.Forms.Design.resources.dll b/App/ko/System.Windows.Forms.Design.resources.dll index fd921cfa..29319b65 100644 Binary files a/App/ko/System.Windows.Forms.Design.resources.dll and b/App/ko/System.Windows.Forms.Design.resources.dll differ diff --git a/App/ko/System.Windows.Forms.Primitives.resources.dll b/App/ko/System.Windows.Forms.Primitives.resources.dll index 917febbb..2732e7a2 100644 Binary files a/App/ko/System.Windows.Forms.Primitives.resources.dll and b/App/ko/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/ko/System.Windows.Forms.resources.dll b/App/ko/System.Windows.Forms.resources.dll index 57b2f166..462a092b 100644 Binary files a/App/ko/System.Windows.Forms.resources.dll and b/App/ko/System.Windows.Forms.resources.dll differ diff --git a/App/ko/System.Windows.Input.Manipulations.resources.dll b/App/ko/System.Windows.Input.Manipulations.resources.dll index e005d362..13c3dc54 100644 Binary files a/App/ko/System.Windows.Input.Manipulations.resources.dll and b/App/ko/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/ko/System.Xaml.resources.dll b/App/ko/System.Xaml.resources.dll index 1737c68b..32258b2d 100644 Binary files a/App/ko/System.Xaml.resources.dll and b/App/ko/System.Xaml.resources.dll differ diff --git a/App/ko/UIAutomationClient.resources.dll b/App/ko/UIAutomationClient.resources.dll index 47e338a2..6f4792dd 100644 Binary files a/App/ko/UIAutomationClient.resources.dll and b/App/ko/UIAutomationClient.resources.dll differ diff --git a/App/ko/UIAutomationClientSideProviders.resources.dll b/App/ko/UIAutomationClientSideProviders.resources.dll index bec0015b..dc0cf652 100644 Binary files a/App/ko/UIAutomationClientSideProviders.resources.dll and b/App/ko/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/ko/UIAutomationProvider.resources.dll b/App/ko/UIAutomationProvider.resources.dll index 8c9cdeb8..a43c0473 100644 Binary files a/App/ko/UIAutomationProvider.resources.dll and b/App/ko/UIAutomationProvider.resources.dll differ diff --git a/App/ko/UIAutomationTypes.resources.dll b/App/ko/UIAutomationTypes.resources.dll index 2891dad6..8dd771f4 100644 Binary files a/App/ko/UIAutomationTypes.resources.dll and b/App/ko/UIAutomationTypes.resources.dll differ diff --git a/App/ko/WindowsBase.resources.dll b/App/ko/WindowsBase.resources.dll index f291d6e2..8e519a77 100644 Binary files a/App/ko/WindowsBase.resources.dll and b/App/ko/WindowsBase.resources.dll differ diff --git a/App/ko/WindowsFormsIntegration.resources.dll b/App/ko/WindowsFormsIntegration.resources.dll index e641b19f..6e61480d 100644 Binary files a/App/ko/WindowsFormsIntegration.resources.dll and b/App/ko/WindowsFormsIntegration.resources.dll differ diff --git a/App/mscordaccore.dll b/App/mscordaccore.dll index 9661e6b1..331776c6 100644 Binary files a/App/mscordaccore.dll and b/App/mscordaccore.dll differ diff --git a/App/mscordaccore_amd64_amd64_9.0.525.21509.dll b/App/mscordaccore_amd64_amd64_9.0.525.21509.dll deleted file mode 100644 index 9661e6b1..00000000 Binary files a/App/mscordaccore_amd64_amd64_9.0.525.21509.dll and /dev/null differ diff --git a/App/mscordaccore_amd64_amd64_9.0.725.31616.dll b/App/mscordaccore_amd64_amd64_9.0.725.31616.dll new file mode 100644 index 00000000..331776c6 Binary files /dev/null and b/App/mscordaccore_amd64_amd64_9.0.725.31616.dll differ diff --git a/App/mscordbi.dll b/App/mscordbi.dll index b01a04d3..2df3e2f3 100644 Binary files a/App/mscordbi.dll and b/App/mscordbi.dll differ diff --git a/App/mscorlib.dll b/App/mscorlib.dll index 44ff5855..9eed42e4 100644 Binary files a/App/mscorlib.dll and b/App/mscorlib.dll differ diff --git a/App/mscorrc.dll b/App/mscorrc.dll index 5f8f8942..8c028a8f 100644 Binary files a/App/mscorrc.dll and b/App/mscorrc.dll differ diff --git a/App/netstandard.dll b/App/netstandard.dll index 7b849af0..aadf049b 100644 Binary files a/App/netstandard.dll and b/App/netstandard.dll differ diff --git a/App/pl/Microsoft.VisualBasic.Forms.resources.dll b/App/pl/Microsoft.VisualBasic.Forms.resources.dll index c3c60f93..e6001f4f 100644 Binary files a/App/pl/Microsoft.VisualBasic.Forms.resources.dll and b/App/pl/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/pl/PresentationCore.resources.dll b/App/pl/PresentationCore.resources.dll index ec22f845..f67efc21 100644 Binary files a/App/pl/PresentationCore.resources.dll and b/App/pl/PresentationCore.resources.dll differ diff --git a/App/pl/PresentationFramework.resources.dll b/App/pl/PresentationFramework.resources.dll index 6cd64056..45eef691 100644 Binary files a/App/pl/PresentationFramework.resources.dll and b/App/pl/PresentationFramework.resources.dll differ diff --git a/App/pl/PresentationUI.resources.dll b/App/pl/PresentationUI.resources.dll index 809b6521..11b45166 100644 Binary files a/App/pl/PresentationUI.resources.dll and b/App/pl/PresentationUI.resources.dll differ diff --git a/App/pl/ReachFramework.resources.dll b/App/pl/ReachFramework.resources.dll index 48223fb4..a8fdeaaa 100644 Binary files a/App/pl/ReachFramework.resources.dll and b/App/pl/ReachFramework.resources.dll differ diff --git a/App/pl/System.Windows.Controls.Ribbon.resources.dll b/App/pl/System.Windows.Controls.Ribbon.resources.dll index 9e71594c..e6994621 100644 Binary files a/App/pl/System.Windows.Controls.Ribbon.resources.dll and b/App/pl/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/pl/System.Windows.Forms.Design.resources.dll b/App/pl/System.Windows.Forms.Design.resources.dll index 667ff4f0..b6567efb 100644 Binary files a/App/pl/System.Windows.Forms.Design.resources.dll and b/App/pl/System.Windows.Forms.Design.resources.dll differ diff --git a/App/pl/System.Windows.Forms.Primitives.resources.dll b/App/pl/System.Windows.Forms.Primitives.resources.dll index 19c7f60b..1be08533 100644 Binary files a/App/pl/System.Windows.Forms.Primitives.resources.dll and b/App/pl/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/pl/System.Windows.Forms.resources.dll b/App/pl/System.Windows.Forms.resources.dll index 2725fedf..3a26777f 100644 Binary files a/App/pl/System.Windows.Forms.resources.dll and b/App/pl/System.Windows.Forms.resources.dll differ diff --git a/App/pl/System.Windows.Input.Manipulations.resources.dll b/App/pl/System.Windows.Input.Manipulations.resources.dll index 6708ed0e..b4dd6b78 100644 Binary files a/App/pl/System.Windows.Input.Manipulations.resources.dll and b/App/pl/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/pl/System.Xaml.resources.dll b/App/pl/System.Xaml.resources.dll index a29e1ac2..2bf6731b 100644 Binary files a/App/pl/System.Xaml.resources.dll and b/App/pl/System.Xaml.resources.dll differ diff --git a/App/pl/UIAutomationClient.resources.dll b/App/pl/UIAutomationClient.resources.dll index 8b7af3a9..72355bac 100644 Binary files a/App/pl/UIAutomationClient.resources.dll and b/App/pl/UIAutomationClient.resources.dll differ diff --git a/App/pl/UIAutomationClientSideProviders.resources.dll b/App/pl/UIAutomationClientSideProviders.resources.dll index 5d2dc0ee..728421db 100644 Binary files a/App/pl/UIAutomationClientSideProviders.resources.dll and b/App/pl/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/pl/UIAutomationProvider.resources.dll b/App/pl/UIAutomationProvider.resources.dll index 8f59f979..ff5460a3 100644 Binary files a/App/pl/UIAutomationProvider.resources.dll and b/App/pl/UIAutomationProvider.resources.dll differ diff --git a/App/pl/UIAutomationTypes.resources.dll b/App/pl/UIAutomationTypes.resources.dll index 17155145..851b7200 100644 Binary files a/App/pl/UIAutomationTypes.resources.dll and b/App/pl/UIAutomationTypes.resources.dll differ diff --git a/App/pl/WindowsBase.resources.dll b/App/pl/WindowsBase.resources.dll index a6e15b19..2b0bc674 100644 Binary files a/App/pl/WindowsBase.resources.dll and b/App/pl/WindowsBase.resources.dll differ diff --git a/App/pl/WindowsFormsIntegration.resources.dll b/App/pl/WindowsFormsIntegration.resources.dll index 072cc336..a98d6702 100644 Binary files a/App/pl/WindowsFormsIntegration.resources.dll and b/App/pl/WindowsFormsIntegration.resources.dll differ diff --git a/App/pt-BR/Microsoft.VisualBasic.Forms.resources.dll b/App/pt-BR/Microsoft.VisualBasic.Forms.resources.dll index ecd5ffaa..0e8c98db 100644 Binary files a/App/pt-BR/Microsoft.VisualBasic.Forms.resources.dll and b/App/pt-BR/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/pt-BR/PresentationCore.resources.dll b/App/pt-BR/PresentationCore.resources.dll index e1fd2bce..6046f549 100644 Binary files a/App/pt-BR/PresentationCore.resources.dll and b/App/pt-BR/PresentationCore.resources.dll differ diff --git a/App/pt-BR/PresentationFramework.resources.dll b/App/pt-BR/PresentationFramework.resources.dll index cf8c737f..a63700e6 100644 Binary files a/App/pt-BR/PresentationFramework.resources.dll and b/App/pt-BR/PresentationFramework.resources.dll differ diff --git a/App/pt-BR/PresentationUI.resources.dll b/App/pt-BR/PresentationUI.resources.dll index 949586d1..03a7c36f 100644 Binary files a/App/pt-BR/PresentationUI.resources.dll and b/App/pt-BR/PresentationUI.resources.dll differ diff --git a/App/pt-BR/ReachFramework.resources.dll b/App/pt-BR/ReachFramework.resources.dll index be02c571..bc7a7f4b 100644 Binary files a/App/pt-BR/ReachFramework.resources.dll and b/App/pt-BR/ReachFramework.resources.dll differ diff --git a/App/pt-BR/System.Windows.Controls.Ribbon.resources.dll b/App/pt-BR/System.Windows.Controls.Ribbon.resources.dll index e91c4f5c..f91ad7ff 100644 Binary files a/App/pt-BR/System.Windows.Controls.Ribbon.resources.dll and b/App/pt-BR/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/pt-BR/System.Windows.Forms.Design.resources.dll b/App/pt-BR/System.Windows.Forms.Design.resources.dll index 37b308f8..a427ed71 100644 Binary files a/App/pt-BR/System.Windows.Forms.Design.resources.dll and b/App/pt-BR/System.Windows.Forms.Design.resources.dll differ diff --git a/App/pt-BR/System.Windows.Forms.Primitives.resources.dll b/App/pt-BR/System.Windows.Forms.Primitives.resources.dll index dad9d0a4..77f68590 100644 Binary files a/App/pt-BR/System.Windows.Forms.Primitives.resources.dll and b/App/pt-BR/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/pt-BR/System.Windows.Forms.resources.dll b/App/pt-BR/System.Windows.Forms.resources.dll index ace441c8..8aa3833b 100644 Binary files a/App/pt-BR/System.Windows.Forms.resources.dll and b/App/pt-BR/System.Windows.Forms.resources.dll differ diff --git a/App/pt-BR/System.Windows.Input.Manipulations.resources.dll b/App/pt-BR/System.Windows.Input.Manipulations.resources.dll index 43abbf5e..81c1ffce 100644 Binary files a/App/pt-BR/System.Windows.Input.Manipulations.resources.dll and b/App/pt-BR/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/pt-BR/System.Xaml.resources.dll b/App/pt-BR/System.Xaml.resources.dll index 024b0617..60ed9869 100644 Binary files a/App/pt-BR/System.Xaml.resources.dll and b/App/pt-BR/System.Xaml.resources.dll differ diff --git a/App/pt-BR/UIAutomationClient.resources.dll b/App/pt-BR/UIAutomationClient.resources.dll index 7a9ced87..8a9c71e1 100644 Binary files a/App/pt-BR/UIAutomationClient.resources.dll and b/App/pt-BR/UIAutomationClient.resources.dll differ diff --git a/App/pt-BR/UIAutomationClientSideProviders.resources.dll b/App/pt-BR/UIAutomationClientSideProviders.resources.dll index d4006d5a..0d76f72d 100644 Binary files a/App/pt-BR/UIAutomationClientSideProviders.resources.dll and b/App/pt-BR/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/pt-BR/UIAutomationProvider.resources.dll b/App/pt-BR/UIAutomationProvider.resources.dll index 4727b06a..f33f3b5d 100644 Binary files a/App/pt-BR/UIAutomationProvider.resources.dll and b/App/pt-BR/UIAutomationProvider.resources.dll differ diff --git a/App/pt-BR/UIAutomationTypes.resources.dll b/App/pt-BR/UIAutomationTypes.resources.dll index 0e496aad..eb893e1a 100644 Binary files a/App/pt-BR/UIAutomationTypes.resources.dll and b/App/pt-BR/UIAutomationTypes.resources.dll differ diff --git a/App/pt-BR/WindowsBase.resources.dll b/App/pt-BR/WindowsBase.resources.dll index 256d297b..54e03842 100644 Binary files a/App/pt-BR/WindowsBase.resources.dll and b/App/pt-BR/WindowsBase.resources.dll differ diff --git a/App/pt-BR/WindowsFormsIntegration.resources.dll b/App/pt-BR/WindowsFormsIntegration.resources.dll index a5765503..03012d65 100644 Binary files a/App/pt-BR/WindowsFormsIntegration.resources.dll and b/App/pt-BR/WindowsFormsIntegration.resources.dll differ diff --git a/App/ru/Microsoft.VisualBasic.Forms.resources.dll b/App/ru/Microsoft.VisualBasic.Forms.resources.dll index e7d9d13e..d2f65176 100644 Binary files a/App/ru/Microsoft.VisualBasic.Forms.resources.dll and b/App/ru/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/ru/PresentationCore.resources.dll b/App/ru/PresentationCore.resources.dll index 1dc578e0..4e544a80 100644 Binary files a/App/ru/PresentationCore.resources.dll and b/App/ru/PresentationCore.resources.dll differ diff --git a/App/ru/PresentationFramework.resources.dll b/App/ru/PresentationFramework.resources.dll index 154f07c6..5fc84a43 100644 Binary files a/App/ru/PresentationFramework.resources.dll and b/App/ru/PresentationFramework.resources.dll differ diff --git a/App/ru/PresentationUI.resources.dll b/App/ru/PresentationUI.resources.dll index e7b5b8e2..de7d5bcf 100644 Binary files a/App/ru/PresentationUI.resources.dll and b/App/ru/PresentationUI.resources.dll differ diff --git a/App/ru/ReachFramework.resources.dll b/App/ru/ReachFramework.resources.dll index f4906115..ccef1d8e 100644 Binary files a/App/ru/ReachFramework.resources.dll and b/App/ru/ReachFramework.resources.dll differ diff --git a/App/ru/System.Windows.Controls.Ribbon.resources.dll b/App/ru/System.Windows.Controls.Ribbon.resources.dll index fa7c1d8f..bb24185b 100644 Binary files a/App/ru/System.Windows.Controls.Ribbon.resources.dll and b/App/ru/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/ru/System.Windows.Forms.Design.resources.dll b/App/ru/System.Windows.Forms.Design.resources.dll index b688f8c6..edd43b98 100644 Binary files a/App/ru/System.Windows.Forms.Design.resources.dll and b/App/ru/System.Windows.Forms.Design.resources.dll differ diff --git a/App/ru/System.Windows.Forms.Primitives.resources.dll b/App/ru/System.Windows.Forms.Primitives.resources.dll index 82bc27b1..1c2a2a11 100644 Binary files a/App/ru/System.Windows.Forms.Primitives.resources.dll and b/App/ru/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/ru/System.Windows.Forms.resources.dll b/App/ru/System.Windows.Forms.resources.dll index dd783b18..a45ac7f9 100644 Binary files a/App/ru/System.Windows.Forms.resources.dll and b/App/ru/System.Windows.Forms.resources.dll differ diff --git a/App/ru/System.Windows.Input.Manipulations.resources.dll b/App/ru/System.Windows.Input.Manipulations.resources.dll index 6bc32cb4..711083e2 100644 Binary files a/App/ru/System.Windows.Input.Manipulations.resources.dll and b/App/ru/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/ru/System.Xaml.resources.dll b/App/ru/System.Xaml.resources.dll index e762deb7..86962b12 100644 Binary files a/App/ru/System.Xaml.resources.dll and b/App/ru/System.Xaml.resources.dll differ diff --git a/App/ru/UIAutomationClient.resources.dll b/App/ru/UIAutomationClient.resources.dll index e34f3145..51b02dd9 100644 Binary files a/App/ru/UIAutomationClient.resources.dll and b/App/ru/UIAutomationClient.resources.dll differ diff --git a/App/ru/UIAutomationClientSideProviders.resources.dll b/App/ru/UIAutomationClientSideProviders.resources.dll index 7d39f879..a8dec4c9 100644 Binary files a/App/ru/UIAutomationClientSideProviders.resources.dll and b/App/ru/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/ru/UIAutomationProvider.resources.dll b/App/ru/UIAutomationProvider.resources.dll index a9c23516..55f3f7fc 100644 Binary files a/App/ru/UIAutomationProvider.resources.dll and b/App/ru/UIAutomationProvider.resources.dll differ diff --git a/App/ru/UIAutomationTypes.resources.dll b/App/ru/UIAutomationTypes.resources.dll index 2a90414b..b6c0a824 100644 Binary files a/App/ru/UIAutomationTypes.resources.dll and b/App/ru/UIAutomationTypes.resources.dll differ diff --git a/App/ru/WindowsBase.resources.dll b/App/ru/WindowsBase.resources.dll index c05eaf1b..3dd32237 100644 Binary files a/App/ru/WindowsBase.resources.dll and b/App/ru/WindowsBase.resources.dll differ diff --git a/App/ru/WindowsFormsIntegration.resources.dll b/App/ru/WindowsFormsIntegration.resources.dll index 007c7ec7..23df37de 100644 Binary files a/App/ru/WindowsFormsIntegration.resources.dll and b/App/ru/WindowsFormsIntegration.resources.dll differ diff --git a/App/tr/Microsoft.VisualBasic.Forms.resources.dll b/App/tr/Microsoft.VisualBasic.Forms.resources.dll index 6276a569..aab33866 100644 Binary files a/App/tr/Microsoft.VisualBasic.Forms.resources.dll and b/App/tr/Microsoft.VisualBasic.Forms.resources.dll differ diff --git a/App/tr/PresentationCore.resources.dll b/App/tr/PresentationCore.resources.dll index fbb870a8..6e31bc61 100644 Binary files a/App/tr/PresentationCore.resources.dll and b/App/tr/PresentationCore.resources.dll differ diff --git a/App/tr/PresentationFramework.resources.dll b/App/tr/PresentationFramework.resources.dll index 4ffd6c69..7e240987 100644 Binary files a/App/tr/PresentationFramework.resources.dll and b/App/tr/PresentationFramework.resources.dll differ diff --git a/App/tr/PresentationUI.resources.dll b/App/tr/PresentationUI.resources.dll index 23cf489d..e5ce0e99 100644 Binary files a/App/tr/PresentationUI.resources.dll and b/App/tr/PresentationUI.resources.dll differ diff --git a/App/tr/ReachFramework.resources.dll b/App/tr/ReachFramework.resources.dll index 1f6966ee..ab532b04 100644 Binary files a/App/tr/ReachFramework.resources.dll and b/App/tr/ReachFramework.resources.dll differ diff --git a/App/tr/System.Windows.Controls.Ribbon.resources.dll b/App/tr/System.Windows.Controls.Ribbon.resources.dll index b48ac389..bf42c6f2 100644 Binary files a/App/tr/System.Windows.Controls.Ribbon.resources.dll and b/App/tr/System.Windows.Controls.Ribbon.resources.dll differ diff --git a/App/tr/System.Windows.Forms.Design.resources.dll b/App/tr/System.Windows.Forms.Design.resources.dll index a66301ca..1c773c85 100644 Binary files a/App/tr/System.Windows.Forms.Design.resources.dll and b/App/tr/System.Windows.Forms.Design.resources.dll differ diff --git a/App/tr/System.Windows.Forms.Primitives.resources.dll b/App/tr/System.Windows.Forms.Primitives.resources.dll index 10a4774a..f146aa54 100644 Binary files a/App/tr/System.Windows.Forms.Primitives.resources.dll and b/App/tr/System.Windows.Forms.Primitives.resources.dll differ diff --git a/App/tr/System.Windows.Forms.resources.dll b/App/tr/System.Windows.Forms.resources.dll index 75adb527..eceac417 100644 Binary files a/App/tr/System.Windows.Forms.resources.dll and b/App/tr/System.Windows.Forms.resources.dll differ diff --git a/App/tr/System.Windows.Input.Manipulations.resources.dll b/App/tr/System.Windows.Input.Manipulations.resources.dll index 93b29a5d..e3864076 100644 Binary files a/App/tr/System.Windows.Input.Manipulations.resources.dll and b/App/tr/System.Windows.Input.Manipulations.resources.dll differ diff --git a/App/tr/System.Xaml.resources.dll b/App/tr/System.Xaml.resources.dll index bd3ddc3c..e89db6ff 100644 Binary files a/App/tr/System.Xaml.resources.dll and b/App/tr/System.Xaml.resources.dll differ diff --git a/App/tr/UIAutomationClient.resources.dll b/App/tr/UIAutomationClient.resources.dll index ee1ae15b..8ad09eb1 100644 Binary files a/App/tr/UIAutomationClient.resources.dll and b/App/tr/UIAutomationClient.resources.dll differ diff --git a/App/tr/UIAutomationClientSideProviders.resources.dll b/App/tr/UIAutomationClientSideProviders.resources.dll index 0d68a1a4..e8c3bcd0 100644 Binary files a/App/tr/UIAutomationClientSideProviders.resources.dll and b/App/tr/UIAutomationClientSideProviders.resources.dll differ diff --git a/App/tr/UIAutomationProvider.resources.dll b/App/tr/UIAutomationProvider.resources.dll index 63916b0f..648ae711 100644 Binary files a/App/tr/UIAutomationProvider.resources.dll and b/App/tr/UIAutomationProvider.resources.dll differ diff --git a/App/tr/UIAutomationTypes.resources.dll b/App/tr/UIAutomationTypes.resources.dll index a66c842c..18195425 100644 Binary files a/App/tr/UIAutomationTypes.resources.dll and b/App/tr/UIAutomationTypes.resources.dll differ diff --git a/App/tr/WindowsBase.resources.dll b/App/tr/WindowsBase.resources.dll index 21f168c6..88b7ff13 100644 Binary files a/App/tr/WindowsBase.resources.dll and b/App/tr/WindowsBase.resources.dll differ diff --git a/App/tr/WindowsFormsIntegration.resources.dll b/App/tr/WindowsFormsIntegration.resources.dll index 3c6f97f7..8ee2e6bd 100644 Binary files a/App/tr/WindowsFormsIntegration.resources.dll and b/App/tr/WindowsFormsIntegration.resources.dll differ diff --git a/App/vcruntime140_cor3.dll b/App/vcruntime140_cor3.dll index 7e7fadf7..8edab904 100644 Binary files a/App/vcruntime140_cor3.dll and b/App/vcruntime140_cor3.dll differ diff --git a/App/wpfgfx_cor3.dll b/App/wpfgfx_cor3.dll index 2c3e7a80..719ae4e4 100644 Binary files a/App/wpfgfx_cor3.dll and b/App/wpfgfx_cor3.dll differ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CachedTris.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CachedTris.html index ee1f4745..e3f2de8d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CachedTris.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CachedTris.html @@ -164,6 +164,9 @@ Class CachedTris
InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
+
+ DispUtil.Display(IDisplayee, Bind, Mat4d) +
ColorUtil.GetGloomyColor(object, double, double)
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CbtrPickable.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CbtrPickable.html index 1d5f9c35..6be3e345 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CbtrPickable.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CbtrPickable.html @@ -102,7 +102,7 @@ Class CbtrPickable
- 
public class CbtrPickable : Pickable, IPickableGetter, IDisposable
+ 
public class CbtrPickable : Pickable, IGetPickable, IDisposable
@@ -120,7 +120,7 @@ Class CbtrPickable
Implements
-
IPickableGetter
+
IGetPickable
IDisposable
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTree.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTree.html index c2dcef33..850ccb64 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTree.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTree.html @@ -176,6 +176,9 @@ Class CubeTree
CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int)
+
+ DispUtil.Display(IDisplayee, Bind, Mat4d) +
ColorUtil.GetGloomyColor(object, double, double)
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTreeFile.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTreeFile.html index 4fda94ac..901884ee 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTreeFile.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.CubeTreeFile.html @@ -421,8 +421,8 @@ Class CubeTreeFile -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -432,7 +432,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -442,6 +442,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -458,6 +461,11 @@ This method may also generate additional resources such as related files.

+

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.Cbtr.DiffAttachment.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.DiffAttachment.html index 9e0f7a6a..92917d5b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.DiffAttachment.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.DiffAttachment.html @@ -102,7 +102,7 @@ Class DiffAttachment
- 
public class DiffAttachment : CbtrPickable, IPickableGetter, IDisposable
+ 
public class DiffAttachment : CbtrPickable, IGetPickable, IDisposable
@@ -121,7 +121,7 @@ Class DiffAttachment
Implements
-
IPickableGetter
+
IGetPickable
IDisposable
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.Substraction.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.Substraction.html index 12ec7883..6774889c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.Substraction.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.Substraction.html @@ -165,7 +165,7 @@ public class Substraction : IWriteBin, IExpandToBox3d InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- MillingRemovalUtil.GetContoursOnToolRunningCoordinate(Substraction, MachineMotionStep) + MillingRemovalUtil.GetContoursOnToolRunningCoordinate(Substraction, MachineMotionStep)
ColorUtil.GetGloomyColor(object, double, double) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnhighlightablePickable.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnhighlightablePickable.html index f39bc4a2..2f220032 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnhighlightablePickable.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnhighlightablePickable.html @@ -103,7 +103,7 @@ For initailizing purpose by
- 
public class UnhighlightablePickable : CbtrPickable, IPickableGetter, IDisposable
+ 
public class UnhighlightablePickable : CbtrPickable, IGetPickable, IDisposable
@@ -122,7 +122,7 @@ For initailizing purpose by
Implements
-
IPickableGetter
+
IGetPickable
IDisposable
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnmanagedSubstraction.html b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnmanagedSubstraction.html index 84fc5b3b..9852449d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnmanagedSubstraction.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Cbtr.UnmanagedSubstraction.html @@ -164,6 +164,9 @@ Class UnmanagedSubstraction
InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
+
+ DispUtil.Display(IDisplayee, Bind, Mat4d) +
ColorUtil.GetGloomyColor(object, double, double)
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.AnchoredCollidablePair.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.AnchoredCollidablePair.html index 8454af57..4ced93b8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.AnchoredCollidablePair.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.AnchoredCollidablePair.html @@ -601,8 +601,8 @@ Class AnchoredCollidablePair -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -612,7 +612,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -622,6 +622,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -638,6 +641,11 @@ This method may also generate additional resources such as related files.

+

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.Collision.CollisionFlag.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.CollisionFlag.html index a63a3e8c..aaa47dbb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.CollisionFlag.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.CollisionFlag.html @@ -146,7 +146,7 @@ The definition is the same as native collision_flag.

Fields

-
COLLISION = 0
+
Collision = 0

Collision.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.CollisionIndexPair.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.CollisionIndexPair.html index 9cd1a041..353aa73d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.CollisionIndexPair.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.CollisionIndexPair.html @@ -530,8 +530,8 @@ Class CollisionIndexPair -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -541,7 +541,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -551,6 +551,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -567,6 +570,11 @@ This method may also generate additional resources such as related files.

+

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.Collision.ICollisionArena.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.ICollisionArena.html index c3998758..37979d8c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.ICollisionArena.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.ICollisionArena.html @@ -102,7 +102,7 @@ Interface ICollisionArena
- 
public interface ICollisionArena : IGetCollisionIndexPairs, IGetAsmb, IGetTopoIndex, IGetRootAnchor
+ 
public interface ICollisionArena : IGetCollisionIndexPairs, IGetAsmb, IGetAnchor, IGetTopoIndex
@@ -121,7 +121,7 @@ Interface ICollisionArena IGetAsmb.GetAsmb()
- IGetRootAnchor.GetRootAnchor() + IGetAnchor.GetAnchor()
@@ -137,6 +137,12 @@ Interface ICollisionArena
InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
+
+ TopoUtil.Display(IGetAnchor, Bind, Dictionary<Anchor, Mat4d>) +
+
+ TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary<Anchor, Mat4d>) +
ColorUtil.GetGloomyColor(object, double, double)
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.ICollisionIndex.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.ICollisionIndex.html index 9c66d4f7..88b01977 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Collision.ICollisionIndex.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collision.ICollisionIndex.html @@ -118,7 +118,7 @@ Interface ICollisionIndex IGetCollidable.GetCollidable()
- IMakeXmlSource.MakeXmlSource(string, string) + IMakeXmlSource.MakeXmlSource(string, string, bool)
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.AnchoredCollidabled.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.AnchoredCollidabled.html new file mode 100644 index 00000000..b1e2dd64 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.AnchoredCollidabled.html @@ -0,0 +1,445 @@ + + + + + Class AnchoredCollidabled | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class AnchoredCollidabled +

+ +
+
Namespace
Hi.Collisions
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public class AnchoredCollidabled : IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex
+
+ + + + +
+
Inheritance
+
+ +
AnchoredCollidabled
+
+
+ +
+
Implements
+
+ + + + +
+
+ + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ AnchoredCollidabled() + +

+ +
+
+ +
+ 
public AnchoredCollidabled()
+
+ + + + + + + + + + + + + + + +

+ AnchoredCollidabled(Anchor, ICollidable) + +

+ +
+
+ +
+ 
public AnchoredCollidabled(Anchor anchor, ICollidable collidable)
+
+ +

Parameters

+
+
anchor Anchor
+
+
collidable ICollidable
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ Anchor + +

+ +
+
+ +
+ 
public Anchor Anchor { get; set; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + + + + +

+ Collidable + +

+ +
+
+ +
+ 
public ICollidable Collidable { get; set; }
+
+ + + + + +

Property Value

+
+
ICollidable
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + + + + +

+ GetCollidable() + +

+ +

Get ICollidable.

+
+
+ +
+ 
public ICollidable GetCollidable()
+
+ + +

Returns

+
+
ICollidable
+

The collidable object.

+
+
+ + + + + + + + + + + + + +

+ GetCollidableAnchor() + +

+ +
+
+ +
+ 
public Anchor GetCollidableAnchor()
+
+ + +

Returns

+
+
Anchor
+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.IAnchoredCollidabled.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.IAnchoredCollidabled.html new file mode 100644 index 00000000..7f1316d3 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.IAnchoredCollidabled.html @@ -0,0 +1,219 @@ + + + + + Interface IAnchoredCollidabled | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IAnchoredCollidabled +

+ +
+
Namespace
Hi.Collisions
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public interface IAnchoredCollidabled : IGetCollidable, IGetAnchor, IGetTopoIndex
+
+ + + + + + + +
+
Inherited Members
+
+ + +
+ +
+
Extension Methods
+
+ + + + + + + + + +
+ + + + + +

Methods +

+ + + + +

+ GetCollidableAnchor() + +

+ +
+
+ +
+ 
Anchor GetCollidableAnchor()
+
+ + +

Returns

+
+
Anchor
+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.html b/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.html new file mode 100644 index 00000000..14ae713c --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Collisions.html @@ -0,0 +1,133 @@ + + + + + Namespace Hi.Collisions | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ + + +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DictionaryColorGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DictionaryColorGuide.html index bc827f8e..36ebca88 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DictionaryColorGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DictionaryColorGuide.html @@ -535,8 +535,8 @@ Only effect on CubeTree.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -546,7 +546,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -556,6 +556,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -572,6 +575,11 @@ This method may also generate additional resources such as related files.

+

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.Coloring.DiscreteQuantityColorGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DiscreteQuantityColorGuide.html index 6894e69f..3fb67c2a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DiscreteQuantityColorGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.DiscreteQuantityColorGuide.html @@ -465,8 +465,8 @@ Only effect on CubeTree.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -476,7 +476,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -486,6 +486,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -502,6 +505,11 @@ This method may also generate additional resources such as related files.

+

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.Coloring.FilteredColorGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FilteredColorGuide.html index 7b8756dd..ac66c2d6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FilteredColorGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FilteredColorGuide.html @@ -470,8 +470,8 @@ Only effect on CubeTree.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -481,7 +481,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -491,6 +491,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -507,6 +510,11 @@ This method may also generate additional resources such as related files.

+

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.Coloring.FuncRangeColorGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FuncRangeColorGuide.html index ae535219..9f507ce6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FuncRangeColorGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.FuncRangeColorGuide.html @@ -510,8 +510,8 @@ Only effect on CubeTree.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -521,7 +521,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -531,6 +531,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -547,6 +550,11 @@ This method may also generate additional resources such as related files.

+

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.Coloring.IColorGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.IColorGuide.html index c636540c..0a69730e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.IColorGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.IColorGuide.html @@ -115,7 +115,7 @@ Interface IColorGuide
Inherited Members
- IMakeXmlSource.MakeXmlSource(string, string) + IMakeXmlSource.MakeXmlSource(string, string, bool)
IGetColorGuide.GetColorGuide() diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.PlainColorGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.PlainColorGuide.html index 700e02d3..e6682860 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.PlainColorGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.PlainColorGuide.html @@ -432,8 +432,8 @@ Only effect on CubeTree.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -443,7 +443,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -453,6 +453,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -469,6 +472,11 @@ This method may also generate additional resources such as related files.

+

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.Coloring.QuantityColorGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.QuantityColorGuide.html index dd8ab00a..8944f8fc 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.QuantityColorGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.QuantityColorGuide.html @@ -534,8 +534,8 @@ Only effect on CubeTree.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -545,7 +545,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -555,6 +555,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -571,6 +574,11 @@ This method may also generate additional resources such as related files.

+

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.Coloring.RangeColorRule.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.RangeColorRule.html index 35898ae0..730112cb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.RangeColorRule.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.RangeColorRule.html @@ -164,10 +164,10 @@ Class RangeColorRule InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) + XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)
- XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) + XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -506,8 +506,8 @@ Class RangeColorRule -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -517,7 +517,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -527,6 +527,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -543,6 +546,11 @@ This method may also generate additional resources such as related files.

+

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.Coloring.RgbSeed.html b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.RgbSeed.html index e98bae27..6ea65846 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.RgbSeed.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Coloring.RgbSeed.html @@ -164,10 +164,10 @@ Class RgbSeed InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) + XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)
- XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) + XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -394,8 +394,8 @@ Class RgbSeed -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -405,7 +405,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -415,6 +415,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -431,6 +434,11 @@ This method may also generate additional resources such as related files.

+

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.Common.BlockingTimer.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.BlockingTimer.html index 17e13c8f..86d65314 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.BlockingTimer.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.BlockingTimer.html @@ -167,10 +167,10 @@ If the execution time is over the InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) + XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)
- XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) + XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -490,8 +490,8 @@ If the execution time is over the -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -501,7 +501,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -511,6 +511,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -527,6 +530,11 @@ This method may also generate additional resources such as related files.

+

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.Common.ExceptionUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.ExceptionUtil.html index 06bea964..6e055ec8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.ExceptionUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.ExceptionUtil.html @@ -198,6 +198,39 @@ Class ExceptionUtil + + +

+ Default_OnShown(object, Exception) + +

+ +
+
+ +
+ 
public static void Default_OnShown(object sender, Exception e)
+
+ +

Parameters

+
+
sender object
+
+
e Exception
+
+
+ + + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.FileLines.FileLineIndex.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.FileLines.FileLineIndex.html index 9b60673a..aa61e421 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.FileLines.FileLineIndex.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.FileLines.FileLineIndex.html @@ -102,7 +102,7 @@ Class FileLineIndex
- 
public class FileLineIndex : IFileLineIndex, IGetFileLineIndex, IComparable<IFileLineIndex>, IMakeXmlSource
+ 
public class FileLineIndex : IFileLineIndex, IGetFileLineIndex, IComparable<IFileLineIndex>, IMakeXmlSource, IToXElement
@@ -123,6 +123,7 @@ Class FileLineIndex
IGetFileLineIndex
IComparable<IFileLineIndex>
IMakeXmlSource
+
IToXElement
@@ -169,10 +170,10 @@ Class FileLineIndex FileLineUtil.MixedIndex(IGetFileLineIndex)

- XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) + XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)
- XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) + XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -645,8 +646,8 @@ Start on 0.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -656,7 +657,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -666,6 +667,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -682,6 +686,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -752,6 +761,39 @@ This method may also generate additional resources such as related files.

+ + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.INameNote.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.INameNote.html similarity index 89% rename from App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.INameNote.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Common.INameNote.html index 665fa902..6088c502 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.INameNote.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.INameNote.html @@ -84,16 +84,16 @@
-
+
-

+

Interface INameNote

-
Namespace
Hi.Common.XmlUtils
+
Namespace
Hi.Common
Assembly
HiGeom.dll
@@ -125,10 +125,10 @@ Interface INameNote InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- XmlUtil.GetNameNoteXElementList(INameNote) + XmlUtil.GetNameNoteXElementList(INameNote)
- XmlUtil.SetNameNote(INameNote, XElement) + XmlUtil.SetNameNote(INameNote, XElement)
ColorUtil.GetGloomyColor(object, double, double) @@ -152,9 +152,9 @@ Interface INameNote - + -

+

Name

@@ -184,9 +184,9 @@ Interface INameNote - + -

+

Note

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.IndexSegment.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.IndexSegment.html index adc18f94..a93618ba 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.IndexSegment.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.IndexSegment.html @@ -156,10 +156,10 @@ Used for defining ranges of data in collections or arrays.

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) + XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)
- XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) + XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -821,33 +821,37 @@ Used for defining ranges of data in collections or arrays.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML element representing this index segment.

+

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)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string
-

The base directory for relative paths.

+

The base directory for resolving relative paths

relFile string
-

The relative file path.

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element representing this index segment.

+

An XML element representing the object's state

@@ -857,6 +861,11 @@ Used for defining ranges of data in collections or arrays.

+

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.Common.IntegerKeyDictionaryConverter-1.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.IntegerKeyDictionaryConverter-1.html index 3ff339c8..34a49e10 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.IntegerKeyDictionaryConverter-1.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.IntegerKeyDictionaryConverter-1.html @@ -169,10 +169,10 @@ Class IntegerKeyDictionaryConverter<TValue> InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) + XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)
- XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) + XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -443,8 +443,8 @@ Class IntegerKeyDictionaryConverter<TValue> -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -454,7 +454,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -464,6 +464,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -480,6 +483,11 @@ This method may also generate additional resources such as related files.

+

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.Common.IntegerKeyDictionaryConverter.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.IntegerKeyDictionaryConverter.html index a7c7a4d0..3fbab892 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.IntegerKeyDictionaryConverter.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.IntegerKeyDictionaryConverter.html @@ -163,10 +163,10 @@ Class IntegerKeyDictionaryConverter InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
- XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) + XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool)
- XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) + XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -437,8 +437,8 @@ Class IntegerKeyDictionaryConverter -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -448,7 +448,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -458,6 +458,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -474,6 +477,11 @@ This method may also generate additional resources such as related files.

+

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.Common.JsonUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.JsonUtil.html new file mode 100644 index 00000000..8a3742ae --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.JsonUtil.html @@ -0,0 +1,219 @@ + + + + + Class JsonUtil | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class JsonUtil +

+ +
+
Namespace
Hi.Common
+
Assembly
HiGeom.dll
+
+ +
+
+ +
+ 
public static class JsonUtil
+
+ + + + +
+
Inheritance
+
+ +
JsonUtil
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + +
+ + + + + + +

Methods +

+ + + + +

+ WritePartialJson<TConfig>(string, string, TConfig) + +

+ +
+
+ +
+ 
public static void WritePartialJson<TConfig>(string filePath, string configName, TConfig config)
+
+ +

Parameters

+
+
filePath string
+
+
configName string
+
+
config TConfig
+
+
+ + +

Type Parameters

+
+
TConfig
+
+
+ + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.LooseRunner.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.LooseRunner.html index cc1c78a0..cab6589f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.LooseRunner.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.LooseRunner.html @@ -6,7 +6,7 @@ - + @@ -97,8 +97,8 @@ Class LooseRunner
Assembly
HiGeom.dll
-

Provides a mechanism for running actions asynchronously in a loose manner, -where only the most recent action is executed and previous pending actions are discarded.

+

Provides a mechanism for running actions asynchronously in a loose manner. +Only the most recent action is executed and previous pending actions are discarded.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.FilteringMultiTagMessageQueue.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.FilteringMultiTagMessageQueue.html deleted file mode 100644 index 525cf30c..00000000 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.FilteringMultiTagMessageQueue.html +++ /dev/null @@ -1,543 +0,0 @@ - - - - - Class FilteringMultiTagMessageQueue | HiAPI-C# 2025 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
-
-
-
-
Table of Contents
- -
-
- -
-
-
- -
-
- - - -
- -
- - - -

-Class FilteringMultiTagMessageQueue -

- -
-
Namespace
Hi.Common.Messages
-
Assembly
HiGeom.dll
-
- -

Implementation of IMultiTagMessageQueue that supports filtering messages by tags.

-
-
- -
- 
public class FilteringMultiTagMessageQueue : IMultiTagMessageQueue
-
- - - - -
-
Inheritance
-
- -
FilteringMultiTagMessageQueue
-
-
- -
-
Implements
-
- -
-
- - -
-
Inherited Members
-
- - - - - - - -
- -
-
Extension Methods
-
- - - - - - - - - - - - - -
- - - - - -

Constructors -

- - - - -

- FilteringMultiTagMessageQueue() - -

- -

Initializes a new instance of the FilteringMultiTagMessageQueue class.

-
-
- -
- 
public FilteringMultiTagMessageQueue()
-
- - - - - - - - - - - - - - - -

- FilteringMultiTagMessageQueue(int) - -

- -

Initializes a new instance of the FilteringMultiTagMessageQueue class with the specified buffer capacity.

-
-
- -
- 
public FilteringMultiTagMessageQueue(int bufferCapacity)
-
- -

Parameters

-
-
bufferCapacity int
-

The maximum capacity of the message buffer

-
-
- - - - - - - - - - - - -

Properties -

- - - - -

- BufferCapacity - -

- -

Gets or sets the maximum capacity of the message buffer.

-
-
- -
- 
public int BufferCapacity { get; set; }
-
- - - - - -

Property Value

-
-
int
-
-
- - - - - - - - - - -

- HiddenTagSet - -

- -

Gets or sets the set of tags that should be hidden when filtering messages.

-
-
- -
- 
public HashSet<string> HiddenTagSet { get; set; }
-
- - - - - -

Property Value

-
-
HashSet<string>
-
-
- - - - - - - - - - -

- MessageLinkedList - -

- -

Gets the linked list that stores the messages.

-
-
- -
- 
public LinkedList<MultiTagMessage> MessageLinkedList { get; }
-
- - - - - -

Property Value

-
-
LinkedList<MultiTagMessage>
-
-
- - - - - - - - -

Methods -

- - - - -

- Enqueue(MultiTagMessage) - -

- -

Thread-safe method to enqueue a message with multiple tags.

-
-
- -
- 
public MultiTagMessage Enqueue(MultiTagMessage multiTagMessage)
-
- -

Parameters

-
-
multiTagMessage MultiTagMessage
-

The message to enqueue

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message

-
-
- - - - - - - - - - - - - -

- GetFilteredMessagesByHiddenTagSet() - -

- -

Gets messages filtered by the hidden tag set.

-
-
- -
- 
public IEnumerable<MultiTagMessage> GetFilteredMessagesByHiddenTagSet()
-
- - -

Returns

-
-
IEnumerable<MultiTagMessage>
-

An enumerable collection of filtered messages

-
-
- - - - - - - - - - - - - -

- GetFilteredMessagesByPreservedTag(IEnumerable<string>) - -

- -

Gets messages that contain any of the specified preserved tags.

-
-
- -
- 
public IEnumerable<MultiTagMessage> GetFilteredMessagesByPreservedTag(IEnumerable<string> preservedTags)
-
- -

Parameters

-
-
preservedTags IEnumerable<string>
-

The collection of tags that messages may contain

-
-
- -

Returns

-
-
IEnumerable<MultiTagMessage>
-

An enumerable collection of filtered messages

-
-
- - - - - - - - - - - - - -

- GetFilteredMessagesByPreservedTag(string) - -

- -

Gets messages that contain a specific preserved tag.

-
-
- -
- 
public IEnumerable<MultiTagMessage> GetFilteredMessagesByPreservedTag(string preservedTag)
-
- -

Parameters

-
-
preservedTag string
-

The tag that messages must contain

-
-
- -

Returns

-
-
IEnumerable<MultiTagMessage>
-

An enumerable collection of filtered messages

-
-
- - - - - - - - - - - - -
- -
-
- - -
- -
- -
-
- -
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMessageHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMessageKit.html similarity index 81% rename from App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMessageHost.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMessageKit.html index 52f9774f..f1ec7bb5 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMessageHost.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMessageKit.html @@ -2,9 +2,9 @@ - Interface IMessageHost | HiAPI-C# 2025 + Interface IMessageKit | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@
-
+
-

-Interface IMessageHost +

+Interface IMessageKit

@@ -102,7 +102,7 @@ Interface IMessageHost
- 
public interface IMessageHost
+ 
public interface IMessageKit
@@ -125,19 +125,25 @@ Interface IMessageHost InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
+ +
ColorUtil.GetGloomyColor(object, double, double) @@ -161,9 +167,9 @@ Interface IMessageHost - + -

+

Add(object)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMultiTagMessageQueue.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMultiTagMessageQueue.html deleted file mode 100644 index 5625ab2c..00000000 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.IMultiTagMessageQueue.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - Interface IMultiTagMessageQueue | HiAPI-C# 2025 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
-
-
-
-
Table of Contents
- -
-
- -
-
-
- -
-
- - - -
- -
- - - -

-Interface IMultiTagMessageQueue -

- -
-
Namespace
Hi.Common.Messages
-
Assembly
HiGeom.dll
-
- -

Interface for a message queue that supports messages with multiple tags.

-
-
- -
- 
public interface IMultiTagMessageQueue
-
- - - - - - - - -
-
Extension Methods
-
- - - - - - - - - - - - - -
- - - - - -

Methods -

- - - - -

- Enqueue(MultiTagMessage) - -

- -

Enqueues a message with multiple tags into the queue.

-
-
- -
- 
MultiTagMessage Enqueue(MultiTagMessage multiTagMessage)
-
- -

Parameters

-
-
multiTagMessage MultiTagMessage
-

The message to enqueue

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message

-
-
- - - - - - - - - - - - -
- -
-
- - -
- -
- -
-
- -
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.LinkedListMultiTagMessageQueue.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.LinkedListMultiTagMessageQueue.html deleted file mode 100644 index 1862a862..00000000 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.LinkedListMultiTagMessageQueue.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - Class LinkedListMultiTagMessageQueue | HiAPI-C# 2025 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
-
-
-
-
Table of Contents
- -
-
- -
-
-
- -
-
- - - -
- -
- - - -

-Class LinkedListMultiTagMessageQueue -

- -
-
Namespace
Hi.Common.Messages
-
Assembly
HiGeom.dll
-
- -

Implementation of IMultiTagMessageQueue using a linked list to store messages.

-
-
- -
- 
public class LinkedListMultiTagMessageQueue : IMultiTagMessageQueue
-
- - - - -
-
Inheritance
-
- -
LinkedListMultiTagMessageQueue
-
-
- -
-
Implements
-
- -
-
- - -
-
Inherited Members
-
- - - - - - - -
- -
-
Extension Methods
-
- - - - - - - - - - - - - -
- - - - - -

Properties -

- - - - -

- LinkedList - -

- -

Gets or sets the linked list that stores the messages.

-
-
- -
- 
public LinkedList<MultiTagMessage> LinkedList { get; set; }
-
- - - - - -

Property Value

-
-
LinkedList<MultiTagMessage>
-
-
- - - - - - - - -

Methods -

- - - - -

- Enqueue(MultiTagMessage) - -

- -

Enqueues a message with multiple tags into the queue.

-
-
- -
- 
public MultiTagMessage Enqueue(MultiTagMessage multiTagMessage)
-
- -

Parameters

-
-
multiTagMessage MultiTagMessage
-

The message to enqueue

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message

-
-
- - - - - - - - - - - - - -

- GetMessages() - -

- -

Gets all messages in the queue.

-
-
- -
- 
public IEnumerable<MultiTagMessage> GetMessages()
-
- - -

Returns

-
-
IEnumerable<MultiTagMessage>
-

An enumerable collection of messages

-
-
- - - - - - - - - - - - -
- -
-
- - -
- -
- -
-
- -
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageFlag.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageFlag.html index 29a92687..53888bbd 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageFlag.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageFlag.html @@ -150,18 +150,31 @@ Enum MessageFlag

General error messages. For exception which is consciously handled.

-
Progress = 4
- -

Progress update messages

-
-
SysErr = 0
+
Exception = 0

System error messages. For exception which is not consciously handled.

+
+
Info = 7
+ +

System behavior that end user not need to know. +The message make help to tracing end user behavior.

+
+
Message = 6
+ +

Something else from the upper flags to tell the end user.

+
+
Progress = 4
+ +

Progress update messages.

+
+
Success = 5
+ +

Progress complete on success messages.

Warning = 2
-

Warning messages

+

Warning messages.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageHostUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageHostUtil.html index 2be7d58d..f4eead89 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageHostUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageHostUtil.html @@ -97,7 +97,7 @@ Class MessageHostUtil
Assembly
HiGeom.dll
-

Utility methods for working with IMessageHost implementations.

+

Utility methods for working with IMessageKit implementations.

@@ -155,22 +155,112 @@ Class MessageHostUtil -

- AddError(IMessageHost, string, params string[]) +

+ AddError(IMessageKit, string, params string[])

-

Adds an error message to the message host.

+

Adds an Error message to the message host.

- 
public static object AddError(this IMessageHost host, string message, params string[] otherTags)
+ 
public static object AddError(this IMessageKit host, string message, params string[] otherTags)

Parameters

-
host IMessageHost
+
host IMessageKit
+

The message host

+
+
message string
+

The message content

+
+
otherTags string[]
+

Additional tags to associate with the message

+
+
+ +

Returns

+
+
object
+

The result of adding the message

+
+
+ + + + + + + + + + + + + +

+ AddException(IMessageKit, Exception, params string[]) + +

+ +

Adds an Exception message to the message host.

+
+
+ +
+ 
public static object AddException(this IMessageKit host, Exception exception, params string[] otherTags)
+
+ +

Parameters

+
+
host IMessageKit
+

The message host

+
+
exception Exception
+

The exception to log

+
+
otherTags string[]
+

Additional tags to associate with the message

+
+
+ +

Returns

+
+
object
+

The result of adding the message

+
+
+ + + + + + + + + + + + + +

+ AddInfo(IMessageKit, string, params string[]) + +

+ +

Adds an Info message to the message host.

+
+
+ +
+ 
public static object AddInfo(this IMessageKit host, string message, params string[] otherTags)
+
+ +

Parameters

+
+
host IMessageKit

The message host

message string
@@ -200,8 +290,8 @@ Class MessageHostUtil -

- AddMessage(IMessageHost, string, params string[]) +

+ AddMessage(IMessageKit, string, params string[])

@@ -210,12 +300,12 @@ Class MessageHostUtil
- 
public static object AddMessage(this IMessageHost host, string msg, params string[] tags)
+ 
public static object AddMessage(this IMessageKit host, string msg, params string[] tags)

Parameters

-
host IMessageHost
+
host IMessageKit

The message host

msg string
@@ -245,22 +335,22 @@ Class MessageHostUtil -

- AddProgress(IMessageHost, string, params string[]) +

+ AddProgress(IMessageKit, string, params string[])

-

Adds a progress message to the message host.

+

Adds a Progress message to the message host.

- 
public static object AddProgress(this IMessageHost host, string message, params string[] otherTags)
+ 
public static object AddProgress(this IMessageKit host, string message, params string[] otherTags)

Parameters

-
host IMessageHost
+
host IMessageKit

The message host

message string
@@ -288,24 +378,24 @@ Class MessageHostUtil - + -

- AddSysErr(IMessageHost, string, params string[]) +

+ AddSuccess(IMessageKit, string, params string[])

-

Adds a system error message to the message host.

+

Adds a Success message to the message host.

- 
public static object AddSysErr(this IMessageHost host, string message, params string[] otherTags)
+ 
public static object AddSuccess(this IMessageKit host, string message, params string[] otherTags)

Parameters

-
host IMessageHost
+
host IMessageKit

The message host

message string
@@ -335,8 +425,8 @@ Class MessageHostUtil -

- AddWarning(IMessageHost, string, params string[]) +

+ AddWarning(IMessageKit, string, params string[])

@@ -345,12 +435,12 @@ Class MessageHostUtil
- 
public static object AddWarning(this IMessageHost host, string message, params string[] otherTags)
+ 
public static object AddWarning(this IMessageKit host, string message, params string[] otherTags)

Parameters

-
host IMessageHost
+
host IMessageKit

The message host

message string
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageKit.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageKit.html index df47c86b..c3e9ba78 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageKit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MessageKit.html @@ -102,7 +102,7 @@ Class MessageKit
- 
public class MessageKit : IMessageHost
+ 
public class MessageKit : IMessageKit
@@ -119,7 +119,7 @@ Class MessageKit
Implements
- +
@@ -154,19 +154,25 @@ Class MessageKit
Extension Methods
+ +
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -211,7 +217,7 @@ Class MessageKit
- 
public static MessageKit Default { get; }
+ 
public static MessageKit Default { get; set; }
@@ -281,7 +287,8 @@ Class MessageKit -

Adds an error message to the default message kit.

+

Adds an error message to the default message kit. +Apply ExceptionUtil.ShowException(Exception, object) if the error message comes from exception for better treatment.

@@ -307,6 +314,72 @@ Class MessageKit + + +

+ AddException(Exception) + +

+ +

Adds an exception to the default message kit.

+
+
+ +
+ 
public static void AddException(Exception exception)
+
+ +

Parameters

+
+
exception Exception
+

The exception to add.

+
+
+ + + + + + + + + + + + + + +

+ AddInfo(string) + +

+ +

Adds an info message to the default message kit.

+
+
+ +
+ 
public static void AddInfo(string message)
+
+ +

Parameters

+
+
message string
+

The message to write.

+
+
+ + + + + + + + + + + +

@@ -339,6 +412,70 @@ Class MessageKit + + +

+ AddProgress(string) + +

+ +
+
+ +
+ 
public static void AddProgress(string message)
+
+ +

Parameters

+
+
message string
+
+
+ + + + + + + + + + + + + + +

+ AddSuccess(string) + +

+ +

Adds a success message to the default message kit.

+
+
+ +
+ 
public static void AddSuccess(string message)
+
+ +

Parameters

+
+
message string
+

The message to write.

+
+
+ + + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MultiTagMessageQueueUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MultiTagMessageQueueUtil.html deleted file mode 100644 index 5255ab87..00000000 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.MultiTagMessageQueueUtil.html +++ /dev/null @@ -1,447 +0,0 @@ - - - - - Class MultiTagMessageQueueUtil | HiAPI-C# 2025 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
-
-
-
-
Table of Contents
- -
-
- -
-
-
- -
-
- - - -
- -
- - - -

-Class MultiTagMessageQueueUtil -

- -
-
Namespace
Hi.Common.Messages
-
Assembly
HiGeom.dll
-
- -

Provides extension methods for working with multi-tag message queues.

-
-
- -
- 
public static class MultiTagMessageQueueUtil
-
- - - - -
-
Inheritance
-
- -
MultiTagMessageQueueUtil
-
-
- - - -
-
Inherited Members
-
- - - - - - - -
- - - - - - -

Methods -

- - - - -

- Enqueue(IMultiTagMessageQueue, string) - -

- -

Enqueues a message without tags to the message queue.

-
-
- -
- 
public static MultiTagMessage Enqueue(this IMultiTagMessageQueue src, string message)
-
- -

Parameters

-
-
src IMultiTagMessageQueue
-

The message queue.

-
-
message string
-

The message to enqueue.

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message.

-
-
- - - - - - - - - - - - - -

- Enqueue(IMultiTagMessageQueue, string, params MessageFlag[]) - -

- -

Enqueues a message with enum tags to the message queue.

-
-
- -
- 
public static MultiTagMessage Enqueue(this IMultiTagMessageQueue src, string message, params MessageFlag[] tags)
-
- -

Parameters

-
-
src IMultiTagMessageQueue
-

The message queue.

-
-
message string
-

The message to enqueue.

-
-
tags MessageFlag[]
-

The enum tags to associate with the message.

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message.

-
-
- - - - - - - - - - - - - -

- Enqueue(IMultiTagMessageQueue, string, params string[]) - -

- -

Enqueues a message with string tags to the message queue.

-
-
- -
- 
public static MultiTagMessage Enqueue(this IMultiTagMessageQueue src, string message, params string[] tags)
-
- -

Parameters

-
-
src IMultiTagMessageQueue
-

The message queue.

-
-
message string
-

The message to enqueue.

-
-
tags string[]
-

The string tags to associate with the message.

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message.

-
-
- - - - - - - - - - - - - -

- EnqueueError(IMultiTagMessageQueue, string, params string[]) - -

- -

Enqueues an error message to the message queue.

-
-
- -
- 
public static MultiTagMessage EnqueueError(this IMultiTagMessageQueue src, string message, params string[] otherTags)
-
- -

Parameters

-
-
src IMultiTagMessageQueue
-

The message queue.

-
-
message string
-

The message to enqueue.

-
-
otherTags string[]
-

Additional tags to associate with the message.

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message.

-
-
- - - - - - - - - - - - - -

- EnqueuePrograss(IMultiTagMessageQueue, string, params string[]) - -

- -

Enqueues a progress message to the message queue.

-
-
- -
- 
public static MultiTagMessage EnqueuePrograss(this IMultiTagMessageQueue src, string message, params string[] otherTags)
-
- -

Parameters

-
-
src IMultiTagMessageQueue
-

The message queue.

-
-
message string
-

The message to enqueue.

-
-
otherTags string[]
-

Additional tags to associate with the message.

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message.

-
-
- - - - - - - - - - - - - -

- EnqueueWarning(IMultiTagMessageQueue, string, params string[]) - -

- -

Enqueues a warning message to the message queue.

-
-
- -
- 
public static MultiTagMessage EnqueueWarning(this IMultiTagMessageQueue src, string message, params string[] otherTags)
-
- -

Parameters

-
-
src IMultiTagMessageQueue
-

The message queue.

-
-
message string
-

The message to enqueue.

-
-
otherTags string[]
-

Additional tags to associate with the message.

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message.

-
-
- - - - - - - - - - - - -
- -
-
- - -
- -
- -
-
- -
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.html index 813f486f..abd7eb23 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.html @@ -94,21 +94,6 @@

Classes

-
-
FilteringMultiTagMessageQueue
-

Implementation of IMultiTagMessageQueue that supports filtering messages by tags.

-
-
-
-
LinkedListMultiTagMessageQueue
-

Implementation of IMultiTagMessageQueue using a linked list to store messages.

-
-
-
-
LoggingMessageQueue
-

A queue for logging messages with multi-tag support and file output capabilities.

-
-
MessageBoardUtil

Utility class for displaying messages on a message board.

@@ -116,7 +101,7 @@ Classes
MessageHostUtil
-

Utility methods for working with IMessageHost implementations.

+

Utility methods for working with IMessageKit implementations.

@@ -127,24 +112,14 @@ Classes
MultiTagMessage

Represents a message with multiple tags for categorization and filtering.

-
-
-
-
MultiTagMessageQueueUtil
-

Provides extension methods for working with multi-tag message queues.

Interfaces

-
IMessageHost
+
IMessageKit

Interface for objects that can host and manage messages.

-
-
-
-
IMultiTagMessageQueue
-

Interface for a message queue that supports messages with multiple tags.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.PacePlayer.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.PacePlayer.html index 9d21c570..372ce7da 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.PacePlayer.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.PacePlayer.html @@ -605,8 +605,39 @@ The property is true if a task started and the task has not yet finished and - IsLockedEventHandler +

+ IsFinishedChangedEvent + +

+ +

Event triggered when the IsFinished state changes.

+
+
+ +
+ 
public event Action<bool> IsFinishedChangedEvent
+
+ + + + + + +

Event Type

+
+
Action<bool>
+
+
+ + + + + + + + +

+ IsLockedChangedEvent

@@ -615,7 +646,7 @@ The property is true if a task started and the task has not yet finished and
- 
public event Action<bool> IsLockedEventHandler
+ 
public event Action<bool> IsLockedChangedEvent
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.RoutineBlocker.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.RoutineBlocker.html index 2f57e9b1..16b450c8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.RoutineBlocker.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.RoutineBlocker.html @@ -164,10 +164,10 @@ Class RoutineBlocker InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -516,8 +516,8 @@ If the time between two -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -527,7 +527,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -537,6 +537,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -553,6 +556,11 @@ This method may also generate additional resources such as related files.

+

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.Common.RoutineBlocker0.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.RoutineBlocker0.html index dfd424b9..7341b3f8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.RoutineBlocker0.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.RoutineBlocker0.html @@ -163,10 +163,10 @@ Class RoutineBlocker0 InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -424,8 +424,8 @@ If the time between two -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -435,7 +435,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -445,6 +445,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -461,6 +464,11 @@ This method may also generate additional resources such as related files.

+

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.Common.XmlUtils.IMakeXmlSource.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.IMakeXmlSource.html index 94ac1843..518b10b1 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.IMakeXmlSource.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.IMakeXmlSource.html @@ -125,10 +125,10 @@ Interface IMakeXmlSource InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -157,8 +157,8 @@ Interface IMakeXmlSource -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -168,7 +168,7 @@ This method may also generate additional resources such as related files.

- 
XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -178,6 +178,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -194,6 +197,11 @@ This method may also generate additional resources such as related files.

+

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.Common.XmlUtils.IToXElement.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.IToXElement.html new file mode 100644 index 00000000..dd69a07e --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.IToXElement.html @@ -0,0 +1,211 @@ + + + + + Interface IToXElement | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IToXElement +

+ +
+
Namespace
Hi.Common.XmlUtils
+
Assembly
HiGeom.dll
+
+ +

Interface of ToXElement(). +Which can be represented by a single XElement.

+
+
+ +
+ 
public interface IToXElement
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + +
+ + + +

Remarks

+

Relative to IMakeXmlSource, the IToXElement don't export file. So no directory information is required. +A single XElement represent the object.

+
+ + +

Methods +

+ + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html index 46ba110f..09ea282c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html @@ -161,6 +161,10 @@ Delegate XFactory.GenByXElementDelegate +

Remarks

+

Note that the design pattern of seperating BaseDirectory and RelativePath is for easy data package moving. +The pattern assume the BaseDirectory can be changed if all the content in the BaseDirectory is changed to the destinate directory.

+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.html index 9b379e62..0641aa79 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XFactory.html @@ -102,7 +102,7 @@ Class XFactory
- 
public class XFactory
+ 
public static class XFactory
@@ -144,31 +144,6 @@ Class XFactory
-
-
Extension Methods
-
- - - - - - - -
@@ -177,72 +152,6 @@ Class XFactory
-

Constructors -

- - - - -

- XFactory() - -

- -

Initializes a new instance of the XFactory class.

-
-
- -
- 
public XFactory()
-
- - - - - - - - - - - - - -

Fields -

- - - -

- Default - -

- -

Gets the global default instance of XFactory.

-
-
- -
- 
public static XFactory Default
-
- - - - -

Field Value

-
-
XFactory
-
-
- - - - - - - - -

Properties

@@ -259,7 +168,7 @@ Class XFactory
- 
public Dictionary<string, XFactory.GenByXElementDelegate> Regs { get; set; }
+ 
public static Dictionary<string, XFactory.GenByXElementDelegate> Regs { get; set; }
@@ -295,7 +204,7 @@ Class XFactory
- 
public T GenByChild<T>(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class
+ 
public static T GenByChild<T>(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class

Parameters

@@ -352,7 +261,7 @@ Class XFactory
- 
public T GenByFile<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class
+ 
public static T GenByFile<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class

Parameters

@@ -406,7 +315,7 @@ Class XFactory
- 
public XmlSourceAndFile<T> GenXmlFileSourceByChild<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) where T : class, IMakeXmlSource
+ 
public static XmlSourceAndFile<T> GenXmlFileSourceByChild<T>(XElement src, string baseDirectory, GenMode genMode, params object[] res) where T : class, IMakeXmlSource

Parameters

@@ -460,7 +369,7 @@ Class XFactory
- 
public XmlSourceAndFile<T> GenXmlFileSourceByFile<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class, IMakeXmlSource
+ 
public static XmlSourceAndFile<T> GenXmlFileSourceByFile<T>(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class, IMakeXmlSource

Parameters

@@ -514,7 +423,7 @@ Class XFactory
- 
public XmlSourceAndFile<T> GenXmlSourceAndFile<T>(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class, IMakeXmlSource
+ 
public static XmlSourceAndFile<T> GenXmlSourceAndFile<T>(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class, IMakeXmlSource

Parameters

@@ -571,7 +480,7 @@ Class XFactory
- 
public T Gen<T>(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode mode, params object[] res) where T : class
+ 
public static T Gen<T>(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode mode, params object[] res) where T : class

Parameters

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XmlUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XmlUtil.html index 84a731d4..12dd2cb8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XmlUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.XmlUtil.html @@ -349,8 +349,8 @@ otherwise, returns the original element

-

- GetFileWrappedXElement(XElement, string, string) +

+ GetFileWrappedXElement(XElement, string, string, bool)

@@ -359,7 +359,7 @@ otherwise, returns the original element

- 
public static XElement GetFileWrappedXElement(this XElement src, string baseDirectory, string sourceFile)
+ 
public static XElement GetFileWrappedXElement(this XElement src, string baseDirectory, string sourceFile, bool exhibitionOnly)

Parameters

@@ -372,6 +372,9 @@ otherwise, returns the original element

sourceFile string

The relative file path to save the element to, or null to return the element as-is

+
+
exhibitionOnly bool
+

See MakeXmlSource(string, string, bool) for parameter description.

@@ -434,7 +437,7 @@ otherwise, saves the element to the specified file and returns a file reference -

+

GetNameNoteXElementList(INameNote)

@@ -449,7 +452,7 @@ otherwise, saves the element to the specified file and returns a file reference

Parameters

-
src INameNote
+
src INameNote

The source INameNote object

@@ -527,8 +530,8 @@ otherwise, saves the element to the specified file and returns a file reference -

- MakeXmlSourceFile(IMakeXmlSource, string) +

+ MakeXmlSourceFile(IMakeXmlSource, string, bool)

@@ -537,7 +540,7 @@ otherwise, saves the element to the specified file and returns a file reference
- 
public static void MakeXmlSourceFile(this IMakeXmlSource src, string filePath)
+ 
public static void MakeXmlSourceFile(this IMakeXmlSource src, string filePath, bool exhibitionOnly = false)

Parameters

@@ -547,6 +550,9 @@ otherwise, saves the element to the specified file and returns a file reference
filePath string

The path where the XML file will be created.

+
+
exhibitionOnly bool
+

See MakeXmlSource(string, string, bool) for parameter description.

@@ -563,8 +569,8 @@ otherwise, saves the element to the specified file and returns a file reference -

- MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) +

+ MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool)

@@ -573,7 +579,7 @@ otherwise, saves the element to the specified file and returns a file reference
- 
public static XElement MakeXmlSourceWithRebaseFile(this IMakeXmlSource src, string baseDirectory, string relFile)
+ 
public static XElement MakeXmlSourceWithRebaseFile(this IMakeXmlSource src, string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -586,6 +592,9 @@ otherwise, saves the element to the specified file and returns a file reference
relFile string

The relative file path to save the XML to, or null to not save to a file

+
+
exhibitionOnly bool
+

See MakeXmlSource(string, string, bool) for parameter description.

@@ -609,8 +618,8 @@ otherwise, saves the XML to the specified file and returns a file reference elem -

- MakeXmlSource<T>(IDictionary<string, T>, string) +

+ MakeXmlSource<T>(IDictionary<string, T>, string, bool)

@@ -619,7 +628,7 @@ otherwise, saves the XML to the specified file and returns a file reference elem
- 
public static XElement MakeXmlSource<T>(this IDictionary<string, T> dictionary, string baseDirectory) where T : IMakeXmlSource
+ 
public static XElement MakeXmlSource<T>(this IDictionary<string, T> dictionary, string baseDirectory, bool exhibitionOnly) where T : IMakeXmlSource

Parameters

@@ -629,6 +638,9 @@ otherwise, saves the XML to the specified file and returns a file reference elem
baseDirectory string

The base directory for resolving paths

+
+
exhibitionOnly bool
+

See MakeXmlSource(string, string, bool) for parameter description.

@@ -699,7 +711,7 @@ otherwise, saves the XML to the specified file and returns a file reference elem -

+

SetNameNote(INameNote, XElement)

@@ -714,7 +726,7 @@ otherwise, saves the XML to the specified file and returns a file reference elem

Parameters

-
dst INameNote
+
dst INameNote

The destination INameNote object to update

src XElement
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.html index c19bd1ed..b8eea0f7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.XmlUtils.html @@ -118,8 +118,9 @@ Interfaces
-
INameNote
-

Interface for objects that have a name and note property.

+
IToXElement
+

Interface of ToXElement(). +Which can be represented by a single XElement.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.html b/App/wwwroot/HiAPI-docsite/api/Hi.Common.html index eb51182d..9eeddabb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Common.html @@ -160,11 +160,6 @@ If the execution time is over the
ExceptionUtil

Provides utility methods for handling exceptions.

-
- -
-
HiLog
-

Logging utility class that provides logging functionality with timestamp.

@@ -194,10 +189,14 @@ Used to indicate programming errors or unexpected states that require developer

Utility class for method invocation operations.

+
+
JsonUtil
+
+
LooseRunner
-

Provides a mechanism for running actions asynchronously in a loose manner, -where only the most recent action is executed and previous pending actions are discarded.

+

Provides a mechanism for running actions asynchronously in a loose manner. +Only the most recent action is executed and previous pending actions are discarded.

@@ -263,11 +262,6 @@ Used to track sequential state changes of a value.

ServerFileExplorerConfig

Configuration for server file explorer functionality.

-
-
-
-
SessionLogger
-

Provides logging functionality for sessions with file output capabilities.

@@ -329,6 +323,11 @@ Extends IWriteBin to provide
IGetSelectionName

Interface for objects that can provide a name for selection purposes.

+
+
+
+
INameNote
+

Interface for objects that have a name and note property.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStrip.html b/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStrip.html index e67c14a8..9f962233 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStrip.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStrip.html @@ -168,6 +168,9 @@ This class manages the display and interaction of cutter location points and lin + @@ -761,10 +764,10 @@ A value of -1 indicates that the display should follow the end of the strip.

- + -

- GetScaledFittingViewByStripDispRange(Mat4d, Mat4d) +

+ GetFittingView(Mat4d, Mat4d)

@@ -773,7 +776,7 @@ A value of -1 indicates that the display should follow the end of the strip.

- 
public Mat4d GetScaledFittingViewByStripDispRange(Mat4d sketchView, Mat4d clStripZeroToRoot = null)
+ 
public Mat4d GetFittingView(Mat4d sketchView, Mat4d clStripZeroToRoot = null)

Parameters

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStripPos.html b/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStripPos.html index 43cf7d20..726bcb64 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStripPos.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.CutterLocations.ClStrips.ClStripPos.html @@ -102,7 +102,7 @@ Class ClStripPos
- 
public class ClStripPos : CbtrPickable, IPickableGetter, IDisposable, IGetProgramCl
+ 
public class ClStripPos : CbtrPickable, IGetPickable, IDisposable, IGetProgramCl
@@ -121,7 +121,7 @@ Class ClStripPos
Implements
- +
@@ -269,7 +269,7 @@ This is a convenience property that casts the State to MillingStep.

Property Value

-
MachiningStep
+
MachiningStep
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Bind.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Bind.html index e5b0ff6f..4445c487 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Bind.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Bind.html @@ -482,38 +482,6 @@ Projection matrix = - -

- RGB - -

- -

External RGB Color for the Drawing which the KeyStamp does not contains C.

-
-
- -
- 
public Vec3d RGB { get; set; }
-
- - - - - -

Property Value

-
-
Vec3d
-
-
- - - - - - - -

@@ -546,6 +514,38 @@ Projection matrix = + +

+ Rgb + +

+ +

External RGB Color for the Drawing which the KeyStamp does not contains C.

+
+
+ +
+ 
public Vec3d Rgb { get; set; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + +

@@ -1119,6 +1119,72 @@ If rgb is null, ignore the + + +

+ PushColorByRgbOffset(Vec3d) + +

+ +
+
+ +
+ 
public void PushColorByRgbOffset(Vec3d rgbOffset)
+
+ +

Parameters

+
+
rgbOffset Vec3d
+
+
+ + + + + + + + + + + + + + +

+ PushColorByRgbOffset(double, double, double) + +

+ +
+
+ +
+ 
public void PushColorByRgbOffset(double rOffset, double gOffset, double bOffset)
+
+ +

Parameters

+
+
rOffset double
+
+
gOffset double
+
+
bOffset double
+
+
+ + + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel.html similarity index 92% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel.html index 54202b91..f38d0169 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel.html @@ -2,9 +2,9 @@ - Delegate Box3dUtil.BoxableExpandToBox3dDel | HiAPI-C# 2025 + Delegate Box3dDispUtil.BoxableExpandToBox3dDel | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@

-
+
-

-Delegate Box3dUtil.BoxableExpandToBox3dDel +

+Delegate Box3dDispUtil.BoxableExpandToBox3dDel

@@ -102,7 +102,7 @@ Delegate Box3dUtil.BoxableExpandToBox3dDel
- 
public delegate void Box3dUtil.BoxableExpandToBox3dDel(nint boxablePtr, ref box3d box)
+ 
public delegate void Box3dDispUtil.BoxableExpandToBox3dDel(nint boxablePtr, ref box3d box)

Parameters

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dDispUtil.html similarity index 79% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dUtil.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dDispUtil.html index 8af537ba..01b2e8e3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Box3dDispUtil.html @@ -2,9 +2,9 @@ - Class Box3dUtil | HiAPI-C# 2025 + Class Box3dDispUtil | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@
-
+
-

-Class Box3dUtil +

+Class Box3dDispUtil

@@ -102,7 +102,7 @@ Class Box3dUtil
- 
public static class Box3dUtil
+ 
public static class Box3dDispUtil
@@ -112,7 +112,7 @@ Class Box3dUtil
Inheritance
-
Box3dUtil
+
Box3dDispUtil
@@ -153,14 +153,14 @@ Class Box3dUtil - + -

+

Display(Box3d, Bind)

-

Call DisplayLine(Box3d, Bind).

+

Call DisplayLine(Box3d, Bind).

@@ -189,9 +189,9 @@ Class Box3dUtil - + -

+

DisplayFace(Box3d, Bind)

@@ -225,9 +225,9 @@ Class Box3dUtil - + -

+

DisplayLine(Box3d, Bind)

@@ -261,9 +261,9 @@ Class Box3dUtil - + -

+

ExpandToBox3d(nint, BoxableExpandToBox3dDel, Box3d)

@@ -273,7 +273,7 @@ Class Box3dUtil
- 
public static void ExpandToBox3d(nint boxablePtr, Box3dUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel, Box3d dst)
+ 
public static void ExpandToBox3d(nint boxablePtr, Box3dDispUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel, Box3d dst)

Parameters

@@ -281,7 +281,7 @@ Class Box3dUtil
boxablePtr nint

Pointer to the boxable object.

-
boxableExpandToBox3dDel Box3dUtil.BoxableExpandToBox3dDel
+
boxableExpandToBox3dDel Box3dDispUtil.BoxableExpandToBox3dDel

Delegate to expand the boxable to a box3d.

dst Box3d
@@ -300,9 +300,9 @@ Class Box3dUtil - + -

+

GetBox(nint, BoxableExpandToBox3dDel)

@@ -312,7 +312,7 @@ Class Box3dUtil
- 
public static Box3d GetBox(nint boxablePtr, Box3dUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel)
+ 
public static Box3d GetBox(nint boxablePtr, Box3dDispUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel)

Parameters

@@ -320,7 +320,7 @@ Class Box3dUtil
boxablePtr nint

Pointer to the boxable object.

-
boxableExpandToBox3dDel Box3dUtil.BoxableExpandToBox3dDel
+
boxableExpandToBox3dDel Box3dDispUtil.BoxableExpandToBox3dDel

Delegate to expand the boxable to a box3d.

@@ -342,9 +342,9 @@ Class Box3dUtil - + -

+

GetFaceDraw(params Box3d[])

@@ -381,9 +381,9 @@ Class Box3dUtil - + -

+

GetLineDraw(params Box3d[])

@@ -420,14 +420,14 @@ Class Box3dUtil - + -

+

ToDraw(Box3d)

-

Equivalent to ToDraw_Face(Box3d)

+

Equivalent to ToDraw_Face(Box3d)

@@ -459,9 +459,9 @@ Class Box3dUtil - + -

+

ToDraw_Face(Box3d)

@@ -498,9 +498,9 @@ Class Box3dUtil - + -

+

ToDraw_Line(Box3d)

@@ -537,9 +537,9 @@ Class Box3dUtil - + -

+

ToLineBuf(Box3d, double[], ref int)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DelegateFuncDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DelegateFuncDisplayee.html index 49d22bcf..ba0175b2 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DelegateFuncDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DelegateFuncDisplayee.html @@ -163,6 +163,9 @@ Class DelegateFuncDisplayee + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispEngine.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispEngine.html index 81672037..5dd651a1 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispEngine.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispEngine.html @@ -183,8 +183,8 @@ Class DispEngine

The DispEngine is the core rendering and interaction engine for HiAPI applications.

The DispEngine provides a unified API for handling rendering, user interaction, and touch gestures across different UI frameworks.

@@ -1406,7 +1406,7 @@ This function is typically called in the GUI implementation for keyboard interac

Transform SketchView by key. Home, F1, F2, F3, F4 -call SetViewToHomeView(), SetViewToFrontView(), SetViewToSideView(), SetViewToTopView(), SetViewToIsometricView() respectively. +call SetViewToHomeView(), SetViewToFrontView(), SetViewToRightView(), SetViewToTopView(), SetViewToIsometricView() respectively. PageDown and PageUp scale the SketchView. Left, Right, Down, Up translate the SketchView; Press Shift make these keys to rotate the SketchView.

@@ -1993,10 +1993,10 @@ This is the same as + -

- SetViewToSideView() +

+ SetViewToRightView()

@@ -2005,7 +2005,7 @@ This is the same as
- 
public void SetViewToSideView()
+ 
public void SetViewToRightView()
@@ -2352,6 +2352,32 @@ Where h is window height.

+ + +

+ TurnBackView() + +

+ +
+
+ +
+ 
public void TurnBackView()
+
+ + + + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispList.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispList.html index 2e76042b..1aff7424 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispList.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispList.html @@ -213,6 +213,9 @@ Class DispList + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispUtil.html index 41ecf587..8a90edfa 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.DispUtil.html @@ -234,8 +234,8 @@ Class DispUtil -

- Display(Mat4d, Bind) +

+ Display(IDisplayee, Bind, Mat4d)

@@ -244,17 +244,18 @@ Class DispUtil
- 
public static void Display(this Mat4d src, Bind bind)
+ 
public static void Display(this IDisplayee displayee, Bind bind, Mat4d mat)

Parameters

-
src Mat4d
-

src

-
+
displayee IDisplayee
+
bind Bind

bind

+
mat Mat4d
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Drawing.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Drawing.html index b58d094a..2224c168 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Drawing.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Drawing.html @@ -164,6 +164,9 @@ Class Drawing + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.ColorScaleBar.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.ColorScaleBar.html index 10197751..65a4c506 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.ColorScaleBar.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.ColorScaleBar.html @@ -164,6 +164,9 @@ For Covering mode.

+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.CoordinateDrawing.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.CoordinateDrawing.html index be67de6b..1ef64249 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.CoordinateDrawing.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.CoordinateDrawing.html @@ -165,6 +165,9 @@ Class CoordinateDrawing + @@ -579,8 +582,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -590,7 +593,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -600,6 +603,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -616,6 +622,11 @@ This method may also generate additional resources such as related files.

+

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.Disp.Flag.CubicalFlagDrawing.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.CubicalFlagDrawing.html index 55923c46..43ed6e6a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.CubicalFlagDrawing.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.CubicalFlagDrawing.html @@ -163,6 +163,9 @@ Class CubicalFlagDrawing + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.DimensionBar.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.DimensionBar.html index 56b49fe2..4a561bd9 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.DimensionBar.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Flag.DimensionBar.html @@ -164,6 +164,9 @@ For Covering mode.

+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.RawFuncDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.FuncDisplayee.html similarity index 82% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.RawFuncDisplayee.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Disp.FuncDisplayee.html index 6ff88ae7..19adc52b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.RawFuncDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.FuncDisplayee.html @@ -2,9 +2,9 @@ - Class RawFuncDisplayee | HiAPI-C# 2025 + Class FuncDisplayee | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@
-
+
-

-Class RawFuncDisplayee +

+Class FuncDisplayee

@@ -102,7 +102,7 @@ Class RawFuncDisplayee
- 
public class RawFuncDisplayee : IDisplayee, IExpandToBox3d
+ 
public class FuncDisplayee : IDisplayee, IExpandToBox3d
@@ -112,7 +112,7 @@ Class RawFuncDisplayee
Inheritance
-
RawFuncDisplayee
+
FuncDisplayee
@@ -163,6 +163,9 @@ Class RawFuncDisplayee + @@ -185,19 +188,19 @@ Class RawFuncDisplayee - + -

- RawFuncDisplayee() +

+ FuncDisplayee()

-

Initializes a new instance of the RawFuncDisplayee class.

+

Initializes a new instance of the FuncDisplayee class.

- 
public RawFuncDisplayee()
+ 
public FuncDisplayee()
@@ -212,19 +215,19 @@ Class RawFuncDisplayee - + -

- RawFuncDisplayee(Action<Bind>, Action<Box3d>) +

+ FuncDisplayee(Action<Bind>, Action<Box3d>)

-

Initializes a new instance of the RawFuncDisplayee class with display and expand delegates.

+

Initializes a new instance of the FuncDisplayee class with display and expand delegates.

- 
public RawFuncDisplayee(Action<Bind> displayDelegate, Action<Box3d> expandToBox3dDelegate)
+ 
public FuncDisplayee(Action<Bind> displayDelegate, Action<Box3d> expandToBox3dDelegate)

Parameters

@@ -252,9 +255,9 @@ Class RawFuncDisplayee - + -

+

DisplayDelegate

@@ -284,9 +287,9 @@ Class RawFuncDisplayee - + -

+

ExpandToBox3dDelegate

@@ -320,9 +323,9 @@ Class RawFuncDisplayee - + -

+

Display(Bind)

@@ -353,9 +356,9 @@ Class RawFuncDisplayee - + -

+

ExpandToBox3d(Box3d)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IDisplayee.html index 44eeb967..a4588b1d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IDisplayee.html @@ -131,6 +131,9 @@ Interface IDisplayee + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IPickableGetter.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IGetPickable.html similarity index 91% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.IPickableGetter.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Disp.IGetPickable.html index c31740da..35c84479 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IPickableGetter.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.IGetPickable.html @@ -2,9 +2,9 @@ - Interface IPickableGetter | HiAPI-C# 2025 + Interface IGetPickable | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@
-
+
-

-Interface IPickableGetter +

+Interface IGetPickable

@@ -102,7 +102,7 @@ Interface IPickableGetter
- 
public interface IPickableGetter
+ 
public interface IGetPickable
@@ -146,9 +146,9 @@ Interface IPickableGetter - + -

+

GetPickable()

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Pickable.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Pickable.html index 54679bf3..a01956fb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Pickable.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Pickable.html @@ -103,7 +103,7 @@ Note that it has to be disposed manually or the object occurs memory leak.

- 
public class Pickable : IPickableGetter, IDisposable
+ 
public class Pickable : IGetPickable, IDisposable
@@ -120,7 +120,7 @@ Note that it has to be disposed manually or the object occurs memory leak.

Implements
- +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PopModelMat.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PopModelMat.html index 3980a6a9..c6248042 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PopModelMat.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PopModelMat.html @@ -157,6 +157,9 @@ This function should be use with
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PushModelMat.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PushModelMat.html index 8e655ae4..b825ebb2 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PushModelMat.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.PushModelMat.html @@ -157,6 +157,9 @@ This function should be use with
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Segment3dDispUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Segment3dDispUtil.html new file mode 100644 index 00000000..7d66d22c --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Segment3dDispUtil.html @@ -0,0 +1,215 @@ + + + + + Class Segment3dDispUtil | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class Segment3dDispUtil +

+ +
+
Namespace
Hi.Disp
+
Assembly
HiDisp.dll
+
+ +
+
+ +
+ 
public static class Segment3dDispUtil
+
+ + + + +
+
Inheritance
+
+ +
Segment3dDispUtil
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + +
+ + + + + + +

Methods +

+ + + + +

+ ToDrawing(IEnumerable<Segment3d>) + +

+ +
+
+ +
+ 
public static Drawing ToDrawing(this IEnumerable<Segment3d> segments)
+
+ +

Parameters

+
+
segments IEnumerable<Segment3d>
+
+
+ +

Returns

+
+
Drawing
+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.ShowEventPickable.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.ShowEventPickable.html index 48bf36d1..1221b92e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.ShowEventPickable.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.ShowEventPickable.html @@ -102,7 +102,7 @@ Class ShowEventPickable
- 
public class ShowEventPickable : Pickable, IPickableGetter, IDisposable
+ 
public class ShowEventPickable : Pickable, IGetPickable, IDisposable
@@ -120,7 +120,7 @@ Class ShowEventPickable
Implements
- +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.StringDrawing.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.StringDrawing.html index 2656d3b0..4d6848e9 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.StringDrawing.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.StringDrawing.html @@ -155,6 +155,9 @@ Class StringDrawing
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.LineWidthTreat.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.LineWidthTreat.html index 1338291f..e1fdfcb6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.LineWidthTreat.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.LineWidthTreat.html @@ -154,6 +154,9 @@ Class LineWidthTreat
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.PointSizeTreat.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.PointSizeTreat.html index 3b17ec7e..d94a5149 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.PointSizeTreat.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.PointSizeTreat.html @@ -154,6 +154,9 @@ Class PointSizeTreat
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbTreat.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbTreat.html index 37c6a46d..e3d3cb72 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbTreat.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbTreat.html @@ -154,6 +154,9 @@ Class RgbTreat
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbWrapper.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbWrapper.html index 501fbb65..f281bf55 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbWrapper.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.RgbWrapper.html @@ -154,6 +154,9 @@ Class RgbWrapper
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.TransformationWrapper.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.TransformationWrapper.html index 0e3e0d58..bee5b04a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.TransformationWrapper.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Treat.TransformationWrapper.html @@ -154,6 +154,9 @@ Class TransformationWrapper
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Tri3dUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Tri3dDispUtil.html similarity index 83% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.Tri3dUtil.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Disp.Tri3dDispUtil.html index e2b1882b..aa46d06d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Tri3dUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.Tri3dDispUtil.html @@ -2,9 +2,9 @@ - Class Tri3dUtil | HiAPI-C# 2025 + Class Tri3dDispUtil | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@
-
+
-

-Class Tri3dUtil +

+Class Tri3dDispUtil

@@ -102,7 +102,7 @@ Class Tri3dUtil
- 
public static class Tri3dUtil
+ 
public static class Tri3dDispUtil
@@ -112,7 +112,7 @@ Class Tri3dUtil
Inheritance
-
Tri3dUtil
+
Tri3dDispUtil
@@ -153,9 +153,9 @@ Class Tri3dUtil - + -

+

Display(Tri3d, Bind)

@@ -189,9 +189,9 @@ Class Tri3dUtil - + -

+

GetFaceDrawing(IEnumerable<Tri3d>)

@@ -228,9 +228,9 @@ Class Tri3dUtil - + -

+

GetLineDrawing(IEnumerable<Tri3d>)

@@ -267,14 +267,14 @@ Class Tri3dUtil - + -

+

ToDrawing(Tri3d)

-

Equivalent to ToDrawing_Face(Tri3d)

+

Equivalent to ToDrawing_Face(Tri3d)

@@ -306,9 +306,9 @@ Class Tri3dUtil - + -

+

ToDrawing_Face(Tri3d)

@@ -345,9 +345,9 @@ Class Tri3dUtil - + -

+

ToDrawing_Line(Tri3d)

@@ -384,9 +384,9 @@ Class Tri3dUtil - + -

+

ToFaceBuf(Tri3d, double[], ref int)

@@ -429,9 +429,9 @@ Class Tri3dUtil - + -

+

ToLineBuf(Tri3d, double[], ref int)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.WrappedDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.WrappedDisplayee.html index b65b8e05..a2894413 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.WrappedDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.WrappedDisplayee.html @@ -154,6 +154,9 @@ Class WrappedDisplayee
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.html b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.html index 88e25f7c..3e868a2b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Disp.html @@ -103,7 +103,7 @@ A bind_t object is generated by rendering in the every beginning of each renderi
-
Box3dUtil
+
Box3dDispUtil

Utility and Extension of Box3d.

@@ -140,6 +140,11 @@ A bind_t object is generated by rendering in the every beginning of each renderi
Drawing

The most efficient elemental 3D rendering unit.

+
+
+
+
FuncDisplayee
+

A displayee implementation that delegates display functionality to function delegates.

@@ -180,9 +185,8 @@ This function should be use with
-
RawFuncDisplayee
-

A displayee implementation that delegates display functionality to function delegates.

-
+
Segment3dDispUtil
+
ShowEventPickable
@@ -195,17 +199,7 @@ This function should be use with
-
TopoDisplayee
-

Implements a displayable topological element that manages a collection of anchored displayees within an assembly.

-
-
-
-
TopoDisplayeeUtil
-

Provides utility methods for displaying and manipulating topological displayees.

-
-
-
-
Tri3dUtil
+
Tri3dDispUtil

Utility and Extension of Tri3d.

@@ -228,18 +222,13 @@ Interfaces
-
IGlContextDirver
-

Bridge of Native OpenGL Context.

-
-
-
-
IPickableGetter
+
IGetPickable

Get Pickable interface.

-
ITopoDisplayee
-

Defines an interface for displaying topological elements that combines assembly, anchoring, and display capabilities.

+
IGlContextDirver
+

Bridge of Native OpenGL Context.

@@ -259,7 +248,7 @@ Enums Delegates

-
Box3dUtil.BoxableExpandToBox3dDel
+
Box3dDispUtil.BoxableExpandToBox3dDel

Delegate for expanding a native boxable object to a box3d.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.AxisAngle4d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.AxisAngle4d.html index 6eb6059e..085c1a62 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.AxisAngle4d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.AxisAngle4d.html @@ -102,7 +102,7 @@ Class AxisAngle4d
- 
public class AxisAngle4d
+ 
public class AxisAngle4d : IFormattable
@@ -116,6 +116,12 @@ Class AxisAngle4d +
+
Implements
+
+ +
+
@@ -349,6 +355,52 @@ Class AxisAngle4d + + +

+ ToString(string, IFormatProvider) + +

+ +

Formats the value of the current instance using the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use.

+

-or-

+

A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

+
+
formatProvider IFormatProvider
+

The provider to use to format the value.

+

-or-

+

A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

+
+
+ +

Returns

+
+
string
+

The value of the current instance in the specified format.

+
+
+ + + + + + + + + + +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box2d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box2d.html index edef0445..83cf5e7c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box2d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box2d.html @@ -104,7 +104,7 @@ The data contains in a Box2d is
- 
public class Box2d : IExpandToBox2d, IEquatable<Box2d>, IBinaryIo, IWriteBin
+ 
public class Box2d : IExpandToBox2d, IEquatable<Box2d>, IBinaryIo, IWriteBin, IFormattable
@@ -125,6 +125,7 @@ The data contains in a Box2d is IEquatable<Box2d>
+ @@ -1648,6 +1649,48 @@ The Min and + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the box formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the box

+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box3d.html index acad81f8..c0715a83 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Box3d.html @@ -104,7 +104,7 @@ The data contains in a Box3d is

- 
public class Box3d : IExpandToBox3d, IEquatable<Box3d>, IStlSource, IGetStl, IMakeXmlSource, IBinaryIo, IWriteBin, IDuplicate
+ 
public class Box3d : IExpandToBox3d, IEquatable<Box3d>, IStlSource, IGetStl, IMakeXmlSource, IBinaryIo, IWriteBin, IDuplicate, IFormattable
@@ -129,6 +129,7 @@ The data contains in a Box3d is IBinaryIo
+ @@ -157,10 +158,10 @@ The data contains in a Box3d is BinIoUtil.ToBytes(IWriteBin) + @@ -771,6 +775,38 @@ The Ctor keeps Min + +

+ InfiniteBox + +

+ +

Generate a infinite box which min~max is (-∞,-∞,-∞)~(∞,∞,∞).

+
+
+ +
+ 
public static Box3d InfiniteBox { get; }
+
+ + + + + +

Property Value

+
+
Box3d
+
+
+ + + + + + + +

@@ -1802,8 +1838,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1813,7 +1849,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1823,6 +1859,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1839,6 +1878,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -2160,6 +2204,48 @@ The Min and + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the box formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the box

+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Cylindroid.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Cylindroid.html index faa4c4e3..53841c29 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Cylindroid.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Cylindroid.html @@ -102,7 +102,7 @@ Class Cylindroid
- 
public class Cylindroid : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList
+ 
public class Cylindroid : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList, IGenStl
@@ -126,6 +126,7 @@ Class Cylindroid + @@ -160,10 +161,10 @@ Class Cylindroid
Extension Methods
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -177,6 +178,9 @@ Class Cylindroid + @@ -270,8 +274,8 @@ Class Cylindroid -

- Cylindroid(int, params PairZr[]) +

+ Cylindroid(params PairZr[])

@@ -281,14 +285,11 @@ The order of z values should be from small to large in general case.

- 
public Cylindroid(int longitudeNum = 12, params PairZr[] pairZRs)
+ 
public Cylindroid(params PairZr[] pairZRs)

Parameters

-
longitudeNum int
-

See LongitudeNum.

-
pairZRs PairZr[]

See PairZrs.

@@ -342,19 +343,18 @@ The order of z values should be from small to large in general case.

- + -

- AngleResolution_deg +

+ DefaultPolarResolution2d

-

Gets or sets the angular resolution in degrees.

-
+
- 
public double AngleResolution_deg { get; set; }
+ 
public static IPolarResolution2d DefaultPolarResolution2d { get; set; }
@@ -363,71 +363,7 @@ The order of z values should be from small to large in general case.

Property Value

-
double
-
-
- - - - - - - - - - -

- AngleResolution_rad - -

- -

Gets or sets the angular resolution in radians.

-
-
- -
- 
public double AngleResolution_rad { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- LongitudeNum - -

- -

Longtitude number.

-
-
- -
- 
public int LongitudeNum { get; set; }
-
- - - - - -

Property Value

-
-
int
+
IPolarResolution2d
@@ -614,8 +550,8 @@ This function is usually used to compute the bounding box of elements.

-

- GenCylinder(double, double, int) +

+ GenCylinder(double, double)

@@ -624,7 +560,7 @@ This function is usually used to compute the bounding box of elements.

- 
public static Cylindroid GenCylinder(double height, double r, int longtitudeNum = 12)
+ 
public static Cylindroid GenCylinder(double height, double r)

Parameters

@@ -634,9 +570,6 @@ This function is usually used to compute the bounding box of elements.

r double

The radius of the cylinder.

-
-
longtitudeNum int
-

The number of longitude divisions.

@@ -659,8 +592,8 @@ This function is usually used to compute the bounding box of elements.

-

- GenStl() +

+ GenStl(IPolarResolution2d)

@@ -669,9 +602,14 @@ This function is usually used to compute the bounding box of elements.

- 
public Stl GenStl()
+ 
public Stl GenStl(IPolarResolution2d resolution)
+

Parameters

+
+
resolution IPolarResolution2d
+
+

Returns

@@ -690,48 +628,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GenStl(int, params PairZr[]) - -

- -

Generate a cylindroid stl.

-
-
- -
- 
public static Stl GenStl(int longtitudeNum = 12, params PairZr[] pairZRs)
-
- -

Parameters

-
-
longtitudeNum int
-

longtitude number

-
-
pairZRs PairZr[]
-

zr values

-
-
- -

Returns

-
-
Stl
-

cylindroid stl

-
-
- - - - - - - - - - -

@@ -840,8 +736,8 @@ The Z values should generally be ordered from smallest to largest.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -851,7 +747,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -861,6 +757,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -877,6 +776,11 @@ This method may also generate additional resources such as related files.

+

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.Geom.DVec3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.DVec3d.html index 4b7c728f..113285ba 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.DVec3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.DVec3d.html @@ -102,7 +102,7 @@ Class DVec3d
- 
public class DVec3d : IEquatable<DVec3d>, IWriteBin, IEqualityOperators<DVec3d, DVec3d, bool>, IAdditionOperators<DVec3d, DVec3d, DVec3d>, ISubtractionOperators<DVec3d, DVec3d, DVec3d>, IMultiplyOperators<DVec3d, double, DVec3d>, IMultiplyOperators<DVec3d, Mat4d, DVec3d>, IDivisionOperators<DVec3d, double, DVec3d>, IVec<double>
+ 
public class DVec3d : IEquatable<DVec3d>, IWriteBin, IEqualityOperators<DVec3d, DVec3d, bool>, IAdditionOperators<DVec3d, DVec3d, DVec3d>, ISubtractionOperators<DVec3d, DVec3d, DVec3d>, IMultiplyOperators<DVec3d, double, DVec3d>, IMultiplyOperators<DVec3d, Mat4d, DVec3d>, IDivisionOperators<DVec3d, double, DVec3d>, IVec<double>, IFormattable
@@ -128,6 +128,7 @@ Class DVec3d + @@ -1370,6 +1371,48 @@ to set the values.

+ + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the dual vector formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the dual vector

+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ExtendedCylinder.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ExtendedCylinder.html new file mode 100644 index 00000000..8804a82b --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ExtendedCylinder.html @@ -0,0 +1,765 @@ + + + + + Class ExtendedCylinder | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class ExtendedCylinder +

+ +
+
Namespace
Hi.Geom
+
Assembly
HiGeom.dll
+
+ +
+
+ +
+ 
public class ExtendedCylinder : IStlSource, IGetStl, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList, IGenStl, IMakeXmlSource, IToXElement
+
+ + + + +
+
Inheritance
+
+ +
ExtendedCylinder
+
+
+ +
+
Implements
+
+ + + + + + + + + +
+
+ + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + + + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ ExtendedCylinder() + +

+ +
+
+ +
+ 
public ExtendedCylinder()
+
+ + + + + + + + + + + + + + + +

+ ExtendedCylinder(double, Func<PairZr>) + +

+ +
+
+ +
+ 
public ExtendedCylinder(double fullLength, Func<PairZr> beginPairZrSource = null)
+
+ +

Parameters

+
+
fullLength double
+
+
beginPairZrSource Func<PairZr>
+
+
+ + + + + + + + + + + + + + +

+ ExtendedCylinder(XElement) + +

+ +

Initializes a new instance of the ExtendedCylinder class from XML data.

+
+
+ +
+ 
public ExtendedCylinder(XElement src)
+
+ +

Parameters

+
+
src XElement
+

The XML element containing extended cylinder data.

+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ BeginPairZrSource + +

+ +
+
+ +
+ 
public Func<PairZr> BeginPairZrSource { get; set; }
+
+ + + + + +

Property Value

+
+
Func<PairZr>
+
+
+ + + + + + + + + + +

+ Cylindroid + +

+ +
+
+ +
+ 
public Cylindroid Cylindroid { get; }
+
+ + + + + +

Property Value

+
+
Cylindroid
+
+
+ + + + + + + + + + +

+ FullLength + +

+ +
+
+ +
+ 
public double FullLength { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ XName + +

+ +

Name for XML IO.

+
+
+ +
+ 
public static string XName { get; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ Duplicate(params object[]) + +

+ +

Creates a deep copy of the object, excluding any source file references.

+
+
+ +
+ 
public object Duplicate(params object[] res)
+
+ +

Parameters

+
+
res object[]
+

Optional parameters that may be needed during the duplication process

+
+
+ +

Returns

+
+
object
+

A new instance that is a deep copy of the original object

+
+
+ + + + + + + + + + + + + +

+ ExpandToBox3d(Box3d) + +

+ +

Expands the destination box. +This function is usually used to compute the bounding box of elements.

+
+
+ +
+ 
public void ExpandToBox3d(Box3d dst)
+
+ +

Parameters

+
+
dst Box3d
+

Destination box

+
+
+ + + + + + + + + + + + + + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
public Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + + + + +

+ GetStl() + +

+ +

Gets the STL geometry data.

+
+
+ +
+ 
public Stl GetStl()
+
+ + +

Returns

+
+
Stl
+

The STL geometry object

+
+
+ + + + + + + + + + + + + +

+ GetZrContour(double) + +

+ +

Gets Z-R contour data as a list of PairZr objects. +The Z values should generally be ordered from smallest to largest.

+
+
+ +
+ 
public IList<PairZr> GetZrContour(double latitudeAngleResolution_rad)
+
+ +

Parameters

+
+
latitudeAngleResolution_rad double
+

Resolution of latitude angle in radians

+
+
+ +

Returns

+
+
IList<PairZr>
+

Z-R contour data as a list of PairZr objects

+
+
+ + + + + + + + + + + + + +

+ GetZrList() + +

+ +

Gets a list of Z-R coordinate pairs.

+
+
+ +
+ 
public List<PairZr> GetZrList()
+
+ + +

Returns

+
+
List<PairZr>
+

A list of PairZr objects representing Z-R coordinates.

+
+
+ + + + + + + + + + + + + +

+ 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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Flat3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Flat3d.html new file mode 100644 index 00000000..dc172c2a --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Flat3d.html @@ -0,0 +1,803 @@ + + + + + Class Flat3d | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class Flat3d +

+ +
+
Namespace
Hi.Geom
+
Assembly
HiGeom.dll
+
+ +

Represents a 3D plane defined by a unit normal vector and its signed distance from the origin. +The plane equation is: Ax + By + Cz + d = 0, where (A,B,C) is the normal vector and d is the distance to origin.

+
+
+ +
+ 
public class Flat3d : IFlat3d, IBinaryIo, IWriteBin, IEquatable<Flat3d>
+
+ + + + +
+
Inheritance
+
+ +
Flat3d
+
+
+ +
+
Implements
+
+ + + + +
+
+ + +
+
Inherited Members
+
+ + + + +
+ +
+
Extension Methods
+
+ + + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ Flat3d() + +

+ +

Initializes a new instance of the Flat3d class.

+
+
+ +
+ 
public Flat3d()
+
+ + + + + + + + + + + + + + + +

+ Flat3d(IFlat3d) + +

+ +
+
+ +
+ 
public Flat3d(IFlat3d src)
+
+ +

Parameters

+
+
src IFlat3d
+
+
+ + + + + + + + + + + + + + +

+ Flat3d(Vec3d, double) + +

+ +

Initializes a new instance of the Flat3d class with a normal vector and distance to origin.

+
+
+ +
+ 
public Flat3d(Vec3d normal, double distanceToOrigin)
+
+ +

Parameters

+
+
normal Vec3d
+

The unit normal vector of the plane.

+
+
distanceToOrigin double
+

The signed distance from origin to the plane.

+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ DistanceToOrigin + +

+ +

The signed distance from the origin (0,0,0) to this plane. +A positive distance means the origin is on the same side as the normal vector.

+
+
+ +
+ 
public double DistanceToOrigin { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Normal + +

+ +

The unit normal to the plane.

+
+
+ +
+ 
public Vec3d Normal { get; set; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ DistanceTo(Vec3d) + +

+ +

Gets the distance from a point to this plane.

+
+
+ +
+ 
public double DistanceTo(Vec3d point)
+
+ +

Parameters

+
+
point Vec3d
+

The point to calculate distance to.

+
+
+ +

Returns

+
+
double
+

The signed distance from the point to the plane.

+
+
+ + + + + + + + + + + + + +

+ Equals(Flat3d) + +

+ +

Indicates whether the current object is equal to another object of the same type.

+
+
+ +
+ 
public bool Equals(Flat3d other)
+
+ +

Parameters

+
+
other Flat3d
+

An object to compare with this object.

+
+
+ +

Returns

+
+
bool
+

true if the current object is equal to the other parameter; otherwise, false.

+
+
+ + + + + + + + + + + + + +

+ 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.

+
+
+ + + + + + + + + + + + + +

+ FromPointAndNormal(Vec3d, Vec3d) + +

+ +

Creates a plane from a point and normal vector.

+
+
+ +
+ 
public static Flat3d FromPointAndNormal(Vec3d point, Vec3d normal)
+
+ +

Parameters

+
+
point Vec3d
+

A point on the plane.

+
+
normal Vec3d
+

The normal vector of the plane.

+
+
+ +

Returns

+
+
Flat3d
+

A new plane instance.

+
+
+ + + + + + + + + + + + + +

+ GetDistanceToOrigin() + +

+ +

Signed Distance To Origin.

+
+
+ +
+ 
public double GetDistanceToOrigin()
+
+ + +

Returns

+
+
double
+

Signed Distance To Origin.

+
+
+ + + + + + + + + + + + + +

+ GetHashCode() + +

+ +

Serves as the default hash function.

+
+
+ +
+ 
public override int GetHashCode()
+
+ + +

Returns

+
+
int
+

A hash code for the current object.

+
+
+ + + + + + + + + + + + + +

+ GetLocate() + +

+ +

Gets a point on the plane closest to the origin.

+
+
+ +
+ 
public Vec3d GetLocate()
+
+ + +

Returns

+
+
Vec3d
+
+
+ + + + + + + + + + + + + +

+ GetNormal() + +

+ +

Gets the normal vector of the flat surface.

+
+
+ +
+ 
public Vec3d GetNormal()
+
+ + +

Returns

+
+
Vec3d
+

The unit normal vector

+
+
+ + + + + + + + + + + + + +

+ ProjectPoint(Vec3d) + +

+ +

Projects a point onto this plane.

+
+
+ +
+ 
public Vec3d ProjectPoint(Vec3d point)
+
+ +

Parameters

+
+
point Vec3d
+

The point to project.

+
+
+ +

Returns

+
+
Vec3d
+

The projected point on the plane.

+
+
+ + + + + + + + + + + + + +

+ ReadBin(BinaryReader) + +

+ +

Reads binary data to initialize the object.

+
+
+ +
+ 
public void ReadBin(BinaryReader reader)
+
+ +

Parameters

+
+
reader BinaryReader
+

The binary reader to read from

+
+
+ + + + + + + + + + + + + + +

+ ToString() + +

+ +

Returns a string representation of the plane.

+
+
+ +
+ 
public override string ToString()
+
+ + +

Returns

+
+
string
+
+
+ + + + + + + + + + + + + +

+ WriteBin(BinaryWriter) + +

+ +

Writes the object's data to a binary stream.

+
+
+ +
+ 
public void WriteBin(BinaryWriter writer)
+
+ +

Parameters

+
+
writer BinaryWriter
+

The binary writer to write to

+
+
+ + + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.GeomCombination.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.GeomCombination.html index 05e33521..96f470ca 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.GeomCombination.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.GeomCombination.html @@ -102,7 +102,7 @@ Class GeomCombination
- 
public class GeomCombination : IStlSource, IGetStl, IMakeXmlSource
+ 
public class GeomCombination : IStlSource, IGetStl, IMakeXmlSource, IGenStl
@@ -122,6 +122,7 @@ Class GeomCombination + @@ -156,10 +157,10 @@ Class GeomCombination
Extension Methods
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -225,6 +226,37 @@ Class GeomCombination + + +

+ GeomCombination(params IStlSource[]) + +

+ +
+
+ +
+ 
public GeomCombination(params IStlSource[] stlSources)
+
+ +

Parameters

+
+
stlSources IStlSource[]
+
+
+ + + + + + + + + + + +

@@ -399,6 +431,44 @@ Class GeomCombination + + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
public Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + +

@@ -434,8 +504,8 @@ Class GeomCombination -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -445,7 +515,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -455,6 +525,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -471,6 +544,11 @@ This method may also generate additional resources such as related files.

+

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.Geom.GeomUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.GeomUtil.html index 173456b6..f8c9b022 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.GeomUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.GeomUtil.html @@ -153,6 +153,41 @@ Class GeomUtil + + +

+ ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) + +

+ +
+
+ +
+ 
public static void ExpandToBox3d(this IExpandToBox3d src, Mat4d mat, Box3d dst)
+
+ +

Parameters

+
+
src IExpandToBox3d
+
+
mat Mat4d
+
+
dst Box3d
+
+
+ + + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IExpandToBox3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IExpandToBox3d.html index 20ecd5fa..e92932bd 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IExpandToBox3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IExpandToBox3d.html @@ -124,6 +124,9 @@ Interface IExpandToBox3d + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IFlat3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IFlat3d.html index 1056375e..456532ab 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IFlat3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IFlat3d.html @@ -146,6 +146,39 @@ Interface IFlat3d

+ + +

+ GetDistanceToOrigin() + +

+ +

Signed Distance To Origin.

+
+
+ +
+ 
double GetDistanceToOrigin()
+
+ + +

Returns

+
+
double
+

Signed Distance To Origin.

+
+
+ + + + + + + + + + +

@@ -179,6 +212,44 @@ Interface IFlat3d + + +

+ GetLocate(Vec3d, double) + +

+ +
+
+ +
+ 
public static Vec3d GetLocate(Vec3d normal, double distanceToOrigin)
+
+ +

Parameters

+
+
normal Vec3d
+
+
distanceToOrigin double
+
+
+ +

Returns

+
+
Vec3d
+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IGenStl.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IGenStl.html new file mode 100644 index 00000000..3c571dcf --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IGenStl.html @@ -0,0 +1,210 @@ + + + + + Interface IGenStl | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IGenStl +

+ +
+
Namespace
Hi.Geom
+
Assembly
HiGeom.dll
+
+ +
+
+ +
+ 
public interface IGenStl
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Methods +

+ + + + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IStlSource.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IStlSource.html index de6c562a..82c642eb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IStlSource.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IStlSource.html @@ -118,7 +118,7 @@ Interface IStlSource IGetStl.GetStl() @@ -126,10 +126,10 @@ Interface IStlSource
Extension Methods
XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ITri3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ITri3d.html index 9d69fd01..267cc2b0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ITri3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ITri3d.html @@ -114,12 +114,18 @@ Interface ITri3d
Inherited Members
+ + @@ -128,6 +134,9 @@ Interface ITri3d
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IZrListSourceProperty.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IZrListSourceProperty.html new file mode 100644 index 00000000..6a47b2ca --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.IZrListSourceProperty.html @@ -0,0 +1,203 @@ + + + + + Interface IZrListSourceProperty | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IZrListSourceProperty +

+ +
+
Namespace
Hi.Geom
+
Assembly
HiGeom.dll
+
+ +
+
+ +
+ 
public interface IZrListSourceProperty
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ ZrListSource + +

+ +
+
+ +
+ 
Func<IGetZrList> ZrListSource { get; set; }
+
+ + + + + +

Property Value

+
+
Func<IGetZrList>
+
+
+ + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStld.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStld.html index 98d28bfb..6bb20b04 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStld.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStld.html @@ -155,6 +155,9 @@ Class NativeTopoStld
Extension Methods
+ @@ -356,6 +359,39 @@ Class NativeTopoStld + + +

+ DisplaySharpEdges(Bind) + +

+ +

Renders only the edges of the topology.

+
+
+ +
+ 
public void DisplaySharpEdges(Bind bind)
+
+ +

Parameters

+
+
bind Bind
+

The binding context for rendering.

+
+
+ + + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStlfr.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStlfr.html index 62a9e866..46ceb423 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStlfr.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.NativeTopoStlfr.html @@ -155,6 +155,9 @@ Class NativeTopoStlfr
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.PairZr.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.PairZr.html index 669ef346..5329b3e3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.PairZr.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.PairZr.html @@ -102,7 +102,7 @@ Class PairZr
- 
public class PairZr : IMakeXmlSource, IExpandToBox3d, IEqualityOperators<PairZr, PairZr, bool>, IAdditionOperators<PairZr, PairZr, PairZr>, ISubtractionOperators<PairZr, PairZr, PairZr>, IMultiplyOperators<PairZr, double, PairZr>, IDivisionOperators<PairZr, double, PairZr>
+ 
public class PairZr : IMakeXmlSource, IExpandToBox3d, IEqualityOperators<PairZr, PairZr, bool>, IAdditionOperators<PairZr, PairZr, PairZr>, ISubtractionOperators<PairZr, PairZr, PairZr>, IMultiplyOperators<PairZr, double, PairZr>, IDivisionOperators<PairZr, double, PairZr>, IFormattable
@@ -126,6 +126,7 @@ Class PairZr +
@@ -151,14 +152,17 @@ Class PairZr
Extension Methods
+ @@ -711,8 +715,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -722,7 +726,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -732,6 +736,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -748,6 +755,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -785,6 +797,48 @@ This method may also generate additional resources such as related files.

+ + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the PairZr formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the PairZr

+
+
+ + + + + + + + + + +

Operators

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Polar3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Polar3d.html index e80921aa..d60df8a7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Polar3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Polar3d.html @@ -102,7 +102,7 @@ Class Polar3d
- 
public class Polar3d : IAdditionOperators<Polar3d, Polar3d, Polar3d>, ISubtractionOperators<Polar3d, Polar3d, Polar3d>, IMultiplyOperators<Polar3d, double, Polar3d>, IDivisionOperators<Polar3d, double, Polar3d>, ICsvRowIo
+ 
public class Polar3d : IAdditionOperators<Polar3d, Polar3d, Polar3d>, ISubtractionOperators<Polar3d, Polar3d, Polar3d>, IMultiplyOperators<Polar3d, double, Polar3d>, IDivisionOperators<Polar3d, double, Polar3d>, ICsvRowIo, IFormattable
@@ -124,6 +124,7 @@ Class Polar3d +
@@ -1564,6 +1565,48 @@ z = reader.ReadDouble();

+ + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the polar coordinates formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the polar coordinates

+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ILinearAndRoundStlResolutionHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.IPolarResolution2d.html similarity index 79% rename from App/wwwroot/HiAPI-docsite/api/Hi.Geom.ILinearAndRoundStlResolutionHost.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.IPolarResolution2d.html index 2d6714c0..8624b349 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.ILinearAndRoundStlResolutionHost.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.IPolarResolution2d.html @@ -2,9 +2,9 @@ - Interface ILinearAndRoundStlResolutionHost | HiAPI-C# 2025 + Interface IPolarResolution2d | HiAPI-C# 2025 - + @@ -84,16 +84,16 @@

-
+
-

-Interface ILinearAndRoundStlResolutionHost +

+Interface IPolarResolution2d

-
Namespace
Hi.Geom
+
Namespace
Hi.Geom.Resolution
Assembly
HiGeom.dll
@@ -102,7 +102,7 @@ Interface ILinearAndRoundStlResolutionHost
- 
public interface ILinearAndRoundStlResolutionHost
+ 
public interface IPolarResolution2d
@@ -146,9 +146,41 @@ Interface ILinearAndRoundStlResolutionHost

- + -

+

+ AngleResolution_deg + +

+ +

Gets or sets the angular resolution in degrees.

+
+
+ +
+ 
double AngleResolution_deg { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

AngleResolution_rad

@@ -178,9 +210,9 @@ Interface ILinearAndRoundStlResolutionHost - + -

+

LinearResolution_mm

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html new file mode 100644 index 00000000..0773d9d9 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html @@ -0,0 +1,203 @@ + + + + + Interface IPolarResolution2dSourceProperty | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IPolarResolution2dSourceProperty +

+ +
+
Namespace
Hi.Geom.Resolution
+
Assembly
HiGeom.dll
+
+ +
+
+ +
+ 
public interface IPolarResolution2dSourceProperty
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ PolarResolution2dSource + +

+ +
+
+ +
+ 
Func<IPolarResolution2d> PolarResolution2dSource { get; set; }
+
+ + + + + +

Property Value

+
+
Func<IPolarResolution2d>
+
+
+ + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.SessionLogger.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.PolarResolution2d.html similarity index 61% rename from App/wwwroot/HiAPI-docsite/api/Hi.Common.SessionLogger.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.PolarResolution2d.html index f9965549..03e01ef3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.SessionLogger.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.PolarResolution2d.html @@ -2,11 +2,11 @@ - Class SessionLogger | HiAPI-C# 2025 + Class PolarResolution2d | HiAPI-C# 2025 - + + - @@ -84,25 +84,24 @@ -
+
-

-Class SessionLogger +

+Class PolarResolution2d

-
Namespace
Hi.Common
+
Namespace
Hi.Geom.Resolution
Assembly
HiGeom.dll
-

Provides logging functionality for sessions with file output capabilities.

-
+
- 
public class SessionLogger : IDisposable, IMakeXmlSource
+ 
public class PolarResolution2d : IPolarResolution2d, IMakeXmlSource, IToXElement
@@ -112,15 +111,16 @@ Class SessionLogger
Inheritance
-
SessionLogger
+
PolarResolution2d
Implements
- + +
@@ -154,6 +154,15 @@ Class SessionLogger
Extension Methods
+ + + @@ -163,15 +172,6 @@ Class SessionLogger - - - @@ -194,19 +194,18 @@ Class SessionLogger - + -

- SessionLogger() +

+ PolarResolution2d()

-

Initializes a new instance of the SessionLogger class.

-
+
- 
public SessionLogger()
+ 
public PolarResolution2d()
@@ -221,25 +220,58 @@ Class SessionLogger - + -

- SessionLogger(XElement) +

+ PolarResolution2d(double, double)

-

Initializes a new instance of the SessionLogger class from an XML element.

+
+
+ +
+ 
public PolarResolution2d(double linearResolution_mm, double angleResolution_rad)
+
+ +

Parameters

+
+
linearResolution_mm double
+
+
angleResolution_rad double
+
+
+ + + + + + + + + + + + + + +

+ PolarResolution2d(XElement) + +

+ +

Initializes a new instance of the PolarResolution2d class from XML data.

- 
public SessionLogger(XElement src)
+ 
public PolarResolution2d(XElement src)

Parameters

src XElement
-

The XML element containing the logger configuration

+

The XML element containing polar resolution data.

@@ -254,58 +286,23 @@ Class SessionLogger -

Fields -

- - - -

- XName - -

- -

Gets the XML element name used for serialization.

-
-
- -
- 
public static string XName
-
- - - - -

Field Value

-
-
string
-
-
- - - - - - - - -

Properties

- + -

- SessionPath +

+ AngleResolution_deg

-

Gets the actual path of the current session log file.

+

Gets or sets the angular resolution in degrees.

- 
public string SessionPath { get; }
+ 
public double AngleResolution_deg { get; set; }
@@ -314,7 +311,7 @@ Class SessionLogger

Property Value

-
string
+
double
@@ -325,19 +322,83 @@ Class SessionLogger - + -

- SessionPathFormat +

+ AngleResolution_rad

-

Gets or sets the format string for the session log file path.

+

Gets or sets the angular resolution in radians.

- 
public string SessionPathFormat { get; set; }
+ 
public double AngleResolution_rad { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ LinearResolution_mm + +

+ +

Gets or sets the linear resolution in millimeters.

+
+
+ +
+ 
public double LinearResolution_mm { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ XName + +

+ +

Name for XML IO.

+
+
+ +
+ 
public static string XName { get; }
@@ -361,101 +422,10 @@ Class SessionLogger - + -

- Add(string) - -

- -

Adds a message to the session log.

-
-
- -
- 
public void Add(string msg)
-
- -

Parameters

-
-
msg string
-

The message to add to the log

-
-
- - - - - - - - - - - - - - -

- 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
-
-
- - - - - - - - - - - - - - -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -465,7 +435,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -475,6 +445,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -491,91 +464,36 @@ This method may also generate additional resources such as related files.

+

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.

+
- + -

- Prepare() +

+ ToXElement()

-

Prepare for the performance of first call of Add(string).

+

Get the XElement to represent the object.

- 
public void Prepare()
+ 
public XElement ToXElement()
- - - - - - - - - - - - - -

- Reset() - -

- -

Resets the logger, closing the current log file and triggering the session end event.

-
-
- -
- 
public void Reset()
-
- - - - - - - - - - - - - -

Events -

- - - -

- MessageEventHandler - -

- -

Event triggered when a message is added to the log.

-
-
- -
- 
public event EventHandler<string> MessageEventHandler
-
- - - - - - -

Event Type

+

Returns

-
EventHandler<string>
-
+
XElement
+

XElement to represent the object.

+
@@ -585,33 +503,6 @@ This method may also generate additional resources such as related files.

-

- SessionEndEventHandler - -

- -

Event triggered when the session ends.

-
-
- -
- 
public event EventHandler SessionEndEventHandler
-
- - - - - - -

Event Type

-
-
EventHandler
-
-
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.html new file mode 100644 index 00000000..c587d59b --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Resolution.html @@ -0,0 +1,138 @@ + + + + + Namespace Hi.Geom.Resolution | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ + + +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Segment3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Segment3d.html new file mode 100644 index 00000000..274b8f40 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Segment3d.html @@ -0,0 +1,867 @@ + + + + + Class Segment3d | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class Segment3d +

+ +
+
Namespace
Hi.Geom
+
Assembly
HiGeom.dll
+
+ +

Represents a 3D line segment defined by two endpoints.

+
+
+ +
+ 
public class Segment3d : IExpandToBox3d, IEquatable<Segment3d>, IBinaryIo, IWriteBin, IEnumerable<Vec3d>, IEnumerable
+
+ + + + +
+
Inheritance
+
+ +
Segment3d
+
+
+ +
+
Implements
+
+ + + + + + +
+
+ + +
+
Inherited Members
+
+ + + + +
+ +
+
Extension Methods
+
+ + + + + + + + + + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ Segment3d() + +

+ +
+
+ +
+ 
public Segment3d()
+
+ + + + + + + + + + + + + + + +

+ Segment3d(Vec3d, Vec3d) + +

+ +
+
+ +
+ 
public Segment3d(Vec3d begin, Vec3d end)
+
+ +

Parameters

+
+
begin Vec3d
+
+
end Vec3d
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ Arrow + +

+ +

Gets the arrow vector from Begin to End.

+
+
+ +
+ 
public Vec3d Arrow { get; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + + + + +

+ Begin + +

+ +
+
+ +
+ 
public Vec3d Begin { get; set; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + + + + +

+ Center + +

+ +

Gets the midpoint of the segment.

+
+
+ +
+ 
public Vec3d Center { get; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + + + + +

+ End + +

+ +
+
+ +
+ 
public Vec3d End { get; set; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + + + + +

+ Length + +

+ +

Gets the length of the segment.

+
+
+ +
+ 
public double Length { get; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ LengthSquare + +

+ +
+
+ +
+ 
public double LengthSquare { get; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ ClosestPoint(Vec3d) + +

+ +

Gets the closest point on the segment to the specified point.

+
+
+ +
+ 
public Vec3d ClosestPoint(Vec3d point)
+
+ +

Parameters

+
+
point Vec3d
+

Point to find closest point to.

+
+
+ +

Returns

+
+
Vec3d
+

Closest point on the segment.

+
+
+ + + + + + + + + + + + + +

+ Equals(Segment3d) + +

+ +

Indicates whether the current object is equal to another object of the same type.

+
+
+ +
+ 
public bool Equals(Segment3d other)
+
+ +

Parameters

+
+
other Segment3d
+

An object to compare with this object.

+
+
+ +

Returns

+
+
bool
+

true if the current object is equal to the other parameter; otherwise, false.

+
+
+ + + + + + + + + + + + + +

+ 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.

+
+
+ + + + + + + + + + + + + +

+ ExpandToBox3d(Box3d) + +

+ +

Expands the destination box. +This function is usually used to compute the bounding box of elements.

+
+
+ +
+ 
public void ExpandToBox3d(Box3d dst)
+
+ +

Parameters

+
+
dst Box3d
+

Destination box

+
+
+ + + + + + + + + + + + + + +

+ GetEnumerator() + +

+ +

Returns an enumerator that iterates through the collection.

+
+
+ +
+ 
public IEnumerator<Vec3d> GetEnumerator()
+
+ + +

Returns

+
+
IEnumerator<Vec3d>
+

An enumerator that can be used to iterate through the collection.

+
+
+ + + + + + + + + + + + + +

+ GetHashCode() + +

+ +

Serves as the default hash function.

+
+
+ +
+ 
public override int GetHashCode()
+
+ + +

Returns

+
+
int
+

A hash code for the current object.

+
+
+ + + + + + + + + + + + + +

+ PointAt(double) + +

+ +

Gets a point on the segment at the specified parameter t (0 <= t <= 1).

+
+
+ +
+ 
public Vec3d PointAt(double t)
+
+ +

Parameters

+
+
t double
+

Parameter value between 0 and 1.

+
+
+ +

Returns

+
+
Vec3d
+

Point on the segment.

+
+
+ + + + + + + + + + + + + +

+ ReadBin(BinaryReader) + +

+ +

Reads binary data to initialize the object.

+
+
+ +
+ 
public void ReadBin(BinaryReader reader)
+
+ +

Parameters

+
+
reader BinaryReader
+

The binary reader to read from

+
+
+ + + + + + + + + + + + + + +

+ Swap() + +

+ +
+
+ +
+ 
public void Swap()
+
+ + + + + + + + + + + + + + + +

+ ToString() + +

+ +

Returns a string representation of the segment.

+
+
+ +
+ 
public override string ToString()
+
+ + +

Returns

+
+
string
+
+
+ + + + + + + + + + + + + +

+ WriteBin(BinaryWriter) + +

+ +

Writes the object's data to a binary stream.

+
+
+ +
+ 
public void WriteBin(BinaryWriter writer)
+
+ +

Parameters

+
+
writer BinaryWriter
+

The binary writer to write to

+
+
+ + + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Stl.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Stl.html index 370a60fe..f9a8ab1a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Stl.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Stl.html @@ -155,6 +155,9 @@ Provide Stl File R/W.

Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.StlFile.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.StlFile.html index 19697718..d5c9fa28 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.StlFile.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.StlFile.html @@ -159,14 +159,17 @@ Class StlFile
Extension Methods
+ @@ -264,6 +267,39 @@ Class StlFile + + +

+ StlFile(string, string) + +

+ +
+
+ +
+ 
public StlFile(string filePath, string baseDirectory)
+
+ +

Parameters

+
+
filePath string
+
+
baseDirectory string
+
+
+ + + + + + + + + + + +

@@ -551,8 +587,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -562,7 +598,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -572,6 +608,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -588,10 +627,10 @@ This method may also generate additional resources such as related files.

-

Remarks

-

if the file does not exist, the cached Stl will be saved; -if the file existed, the file will not be overwrited. -The mechanism is for multi-base-directory setting.

+

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.Geom.TransformationGeom.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.TransformationGeom.html index 4562940c..293e12ca 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.TransformationGeom.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.TransformationGeom.html @@ -103,7 +103,7 @@ This class combines a transformer with a target geometry to produce transformed
- 
public class TransformationGeom : IStlSource, IGetStl, IMakeXmlSource, IGeomProperty, IExpandToBox3d, IDuplicate
+ 
public class TransformationGeom : IStlSource, IGetStl, IMakeXmlSource, IGeomProperty, IGenStl, IExpandToBox3d, IDuplicate
@@ -124,6 +124,7 @@ This class combines a transformer with a target geometry to produce transformed + @@ -151,9 +152,6 @@ This class combines a transformer with a target geometry to produce transformed -
@@ -426,7 +424,7 @@ with the target geometry being on the left side.

-

Creates a deep copy of the current TransformationGeom instance.

+

Creates a deep copy of the object, excluding any source file references.

@@ -437,14 +435,14 @@ with the target geometry being on the left side.

Parameters

res object[]
-

Additional resources for duplication (not used in current implementation).

+

Optional parameters that may be needed during the duplication process

Returns

object
-

A new TransformationGeom instance with copied transformer and geometry data.

+

A new instance that is a deep copy of the original object

@@ -499,6 +497,44 @@ If the geometry or its STL representation is null, no expansion occurs.

+ + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
public Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + +

@@ -540,33 +576,37 @@ If the geometry is null or produces a null STL, the method returns null.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML representation of the current TransformationGeom instance.

+

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)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string
-

The base directory for resolving relative paths.

+

The base directory for resolving relative paths

relFile string
-

The relative file path (not used in current implementation).

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XElement containing the serialized data of this instance.

+

An XML element representing the object's state

@@ -576,14 +616,48 @@ If the geometry is null or produces a null STL, the method returns null.

-

Remarks

-

The generated XML includes both the transformer and geometry data if they are available. -Null properties are handled gracefully and will not cause errors in the XML generation.

+

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.

+
+
+ + + + + + + + + + +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3d.html index 2d9f0538..710530b3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3d.html @@ -152,6 +152,9 @@ Class Tri3d + @@ -761,6 +764,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetDistanceToOrigin() + +

+ +

Signed Distance To Origin.

+
+
+ +
+ 
public double GetDistanceToOrigin()
+
+ + +

Returns

+
+
double
+

Signed Distance To Origin.

+
+
+ + + + + + + + + + +

@@ -932,6 +968,45 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetSegmentsFromPlaneClip(IFlat3d) + +

+ +

Gets the line segments resulting from intersecting this triangle with a clipping plane.

+
+
+ +
+ 
public IEnumerable<Segment3d> GetSegmentsFromPlaneClip(IFlat3d clipPlane)
+
+ +

Parameters

+
+
clipPlane IFlat3d
+

The clipping plane

+
+
+ +

Returns

+
+
IEnumerable<Segment3d>
+

An enumerable of line segments representing the intersection

+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3dUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3dUtil.html index fb89ede6..4507db04 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3dUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Tri3dUtil.html @@ -432,6 +432,48 @@ Include generator of triangles from points.

+ + +

+ GetSegmentsFromPlaneClip(IEnumerable<Tri3d>, IFlat3d) + +

+ +

Gets line segments resulting from intersecting triangles with a clipping plane.

+
+
+ +
+ 
public static List<Segment3d> GetSegmentsFromPlaneClip(this IEnumerable<Tri3d> tris, IFlat3d clipPlane)
+
+ +

Parameters

+
+
tris IEnumerable<Tri3d>
+

The collection of triangles to clip

+
+
clipPlane IFlat3d
+

The clipping plane

+
+
+ +

Returns

+
+
List<Segment3d>
+

A list of line segments representing the intersection

+
+
+ + + + + + + + + + +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.StringValueAttribute.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.UnitUtils.StringValueAttribute.html similarity index 94% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.StringValueAttribute.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Geom.UnitUtils.StringValueAttribute.html index 1d7c23a0..0db33a09 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.StringValueAttribute.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.UnitUtils.StringValueAttribute.html @@ -84,16 +84,16 @@ -
+
-

+

Class StringValueAttribute

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.Geom.UnitUtils
Assembly
HiMech.dll
@@ -284,14 +284,14 @@ Class StringValueAttribute - + -

+

StringValueAttribute(string)

-

Initializes a new instance of the StringValueAttribute class with the specified value.

+

Initializes a new instance of the StringValueAttribute class with the specified value.

@@ -321,9 +321,9 @@ Class StringValueAttribute - + -

+

Value

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.UnitUtils.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.UnitUtils.html index 92e2125c..9795ab1a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.UnitUtils.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.UnitUtils.html @@ -94,6 +94,11 @@

Classes

+
+
StringValueAttribute
+

Attribute for associating a string value with an enum value or other element.

+
+
UnitConvertUtil

Provides utility methods for converting between different physical units and their string representations.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2d.html index 78565780..f1a2d603 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2d.html @@ -102,7 +102,7 @@ Class Vec2d
- 
public class Vec2d : IExpandToBox2d, IEquatable<Vec2d>, ICsvRowIo, IEqualityOperators<Vec2d, Vec2d, bool>, IAdditionOperators<Vec2d, Vec2d, Vec2d>, ISubtractionOperators<Vec2d, Vec2d, Vec2d>, IMultiplyOperators<Vec2d, double, Vec2d>, IDivisionOperators<Vec2d, double, Vec2d>, IVec<double>
+ 
public class Vec2d : IExpandToBox2d, IEquatable<Vec2d>, ICsvRowIo, IEqualityOperators<Vec2d, Vec2d, bool>, IAdditionOperators<Vec2d, Vec2d, Vec2d>, ISubtractionOperators<Vec2d, Vec2d, Vec2d>, IMultiplyOperators<Vec2d, double, Vec2d>, IDivisionOperators<Vec2d, double, Vec2d>, IVec<double>, IFormattable
@@ -128,6 +128,7 @@ Class Vec2d +
@@ -3115,6 +3116,48 @@ Direction 0,1,2 indicate x,y,z respectively.

+ + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the vector formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the vector

+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2i.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2i.html index 7951c3a5..ffcf9de7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2i.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec2i.html @@ -102,7 +102,7 @@ Class Vec2i
- 
public class Vec2i : IEquatable<Vec2i>
+ 
public class Vec2i : IEquatable<Vec2i>, IFormattable
@@ -120,6 +120,7 @@ Class Vec2i
Implements
+
@@ -1409,6 +1410,48 @@ Direction 0,1,2 indicate x,y,z respectively.

+ + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the vector formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the vector

+
+
+ + + + + + + + + + +

Operators

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec3d.html index 514e9b68..f682d880 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Vec3d.html @@ -103,7 +103,7 @@ Class Vec3d 
[BsonIgnoreExtraElements]
-public class Vec3d : IEquatable<Vec3d>, IExpandToBox3d, IBinaryIo, IWriteBin, ICsvRowIo, IEqualityOperators<Vec3d, Vec3d, bool>, IAdditionOperators<Vec3d, Vec3d, Vec3d>, ISubtractionOperators<Vec3d, Vec3d, Vec3d>, IMultiplyOperators<Vec3d, double, Vec3d>, IMultiplyOperators<Vec3d, Mat4d, Vec3d>, IDivisionOperators<Vec3d, double, Vec3d>, IVec<double>
+public class Vec3d : IEquatable<Vec3d>, IExpandToBox3d, IBinaryIo, IWriteBin, ICsvRowIo, IEqualityOperators<Vec3d, Vec3d, bool>, IAdditionOperators<Vec3d, Vec3d, Vec3d>, ISubtractionOperators<Vec3d, Vec3d, Vec3d>, IMultiplyOperators<Vec3d, double, Vec3d>, IMultiplyOperators<Vec3d, Mat4d, Vec3d>, IDivisionOperators<Vec3d, double, Vec3d>, IVec<double>, IFormattable
@@ -132,6 +132,7 @@ public class Vec3d : IEquatable<Vec3d>, IExpandToBox3d, IBinaryIo, IWriteB + @@ -159,6 +160,9 @@ public class Vec3d : IEquatable<Vec3d>, IExpandToBox3d, IBinaryIo, IWriteB + @@ -3807,6 +3811,48 @@ Direction 0,1,2 indicate x,y,z respectively.

+ + +

+ ToString(string, IFormatProvider) + +

+ +

Returns a string representation of the vector formatted according to the specified format.

+
+
+ +
+ 
public string ToString(string format, IFormatProvider formatProvider)
+
+ +

Parameters

+
+
format string
+

The format to use for each component

+
+
formatProvider IFormatProvider
+

The format provider to use

+
+
+ +

Returns

+
+
string
+

A formatted string representation of the vector

+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.html b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.html index 9f965b35..e18d190a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Geom.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Geom.html @@ -136,6 +136,16 @@ The data contains in a Box3d is
DVec3d

Dual Vec3d with p(Vec3d) and n(Vec3d).

+
+ +
+
ExtendedCylinder
+
+
+
+
Flat3d
+

Represents a 3D plane defined by a unit normal vector and its signed distance from the origin. +The plane equation is: Ax + By + Cz + d = 0, where (A,B,C) is the normal vector and d is the distance to origin.

@@ -191,6 +201,11 @@ The data contains in a Box3d is
Polar3d

Represents a point in 3D space using polar coordinates

+
+
+
+
Segment3d
+

Represents a 3D line segment defined by two endpoints.

@@ -274,6 +289,10 @@ Interfaces

Interface for a 3D flat surface that provides location and normal vector.

+
+
IGenStl
+
+
IGeomProperty

Interface for objects that have a geometry property.

@@ -292,11 +311,6 @@ Interfaces
IGetZrList

Interface for getting a list of Z-R pairs.

-
-
-
-
ILinearAndRoundStlResolutionHost
-

Interface for objects that control STL resolution parameters for both linear and angular measurements.

@@ -314,6 +328,10 @@ Interfaces

Interface for vector types with generic element type.

+
+
IZrListSourceProperty
+
+

Enums

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.HiNcHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.HiNcHost.html index cbc28e2c..0a2978ad 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.HiNcHost.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.HiNcHost.html @@ -6,7 +6,7 @@ - + @@ -97,7 +97,8 @@ Class HiNcHost
Assembly
HiNc.dll

-

Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration.

+

Rich HiNC Service. +Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.CommandEntry.html b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.HostConfig.html similarity index 70% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.CommandEntry.html rename to App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.HostConfig.html index 974a5926..2199afa8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.CommandEntry.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.HostConfig.html @@ -2,11 +2,11 @@ - Class CommandEntry | HiAPI-C# 2025 + Class HostConfig | HiAPI-C# 2025 - + + - @@ -84,25 +84,24 @@
-
+
-

-Class CommandEntry +

+Class HostConfig

-
Namespace
Hi.ShellCommandUtils
+
Namespace
Hi.HiNcKits
Assembly
HiNc.dll
-

Represents a command entry with enabled state in a command list.

-
+
- 
public class CommandEntry : IMakeXmlSource
+ 
public class HostConfig
@@ -112,16 +111,10 @@ Class CommandEntry
Inheritance
-
CommandEntry
+
HostConfig
-
-
Implements
-
- -
-
@@ -184,27 +177,20 @@ Class CommandEntry - + -

- CommandEntry(IShellCommand) +

+ HostConfig()

-

Creates a new command entry with the specified command.

-
+
- 
public CommandEntry(IShellCommand command)
+ 
public HostConfig()
-

Parameters

-
-
command IShellCommand
-

The command to associate with this entry.

-
-
@@ -217,28 +203,28 @@ Class CommandEntry - + -

- CommandEntry(XElement, string) +

+ HostConfig(XElement, string)

-

Creates a new command entry from XML.

+

Initializes a new instance of the HostConfig class from XML data.

- 
public CommandEntry(XElement src, string baseDirectory)
+ 
public HostConfig(XElement src, string baseDirectory)

Parameters

src XElement
-

Source XML element.

+

XML element containing configuration data

baseDirectory string
-

Base directory for relative paths.

+

Base directory for resolving relative paths

@@ -257,19 +243,18 @@ Class CommandEntry - + -

- Command +

+ MongoPort

-

Gets or sets the command associated with this entry.

-
+
- 
public IShellCommand Command { get; set; }
+ 
public int MongoPort { get; set; }
@@ -278,7 +263,7 @@ Class CommandEntry

Property Value

-
IShellCommand
+
int
@@ -289,19 +274,19 @@ Class CommandEntry - + -

- IsEnabled +

+ XName

-

Gets or sets whether this command entry is enabled.

+

Name for XML IO.

- 
public bool IsEnabled { get; set; }
+ 
public static string XName { get; }
@@ -310,7 +295,7 @@ Class CommandEntry

Property Value

-
bool
+
string
@@ -325,16 +310,14 @@ Class CommandEntry - + -

+

MakeXmlSource(string, string)

-

Creates an XML representation of the object. -This method may also generate additional resources such as related files.

-
+
@@ -344,18 +327,15 @@ This method may also generate additional resources such as related files.

Parameters

baseDirectory string
-

The base directory for resolving relative paths

-
+
relFile string
-

The relative file path for the XML source

-
+

Returns

XElement
-

An XML element representing the object's state

-
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.LocalApp.html b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.LocalApp.html new file mode 100644 index 00000000..bbd49ee3 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.LocalApp.html @@ -0,0 +1,444 @@ + + + + + Class LocalApp | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class LocalApp +

+ +
+
Namespace
Hi.HiNcKits
+
Assembly
HiNc.dll
+
+ +
+
+ +
+ 
public static class LocalApp
+
+ + + + +
+
Inheritance
+
+ +
LocalApp
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + +
+ + + + + + +

Fields +

+ + + +

+ HostConfigPath + +

+ +
+
+ +
+ 
public const string HostConfigPath = "hinc-host-config.xml"
+
+ + + + +

Field Value

+
+
string
+
+
+ + + + + + + + + + +

+ UserConfigPath + +

+ +
+
+ +
+ 
public const string UserConfigPath = "hinc-user-config.xml"
+
+ + + + +

Field Value

+
+
string
+
+
+ + + + + + + + + +

Properties +

+ + + + +

+ HostConfig + +

+ +
+
+ +
+ 
public static HostConfig HostConfig { get; set; }
+
+ + + + + +

Property Value

+
+
HostConfig
+
+
+ + + + + + + + + + +

+ UserConfig + +

+ +
+
+ +
+ 
public static UserConfig UserConfig { get; }
+
+ + + + + +

Property Value

+
+
UserConfig
+
+
+ + + + + + + + + + +

+ UserEnv + +

+ +
+
+ +
+ 
public static UserEnv UserEnv { get; }
+
+ + + + + +

Property Value

+
+
UserEnv
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ AppBegin() + +

+ +
+
+ +
+ 
public static void AppBegin()
+
+ + + + + + + + + + + + + + + +

+ AppEnd() + +

+ +
+
+ +
+ 
public static void AppEnd()
+
+ + + + + + + + + + + + + + + +

+ LooseSaveUserConfig() + +

+ +
+
+ +
+ 
public static void LooseSaveUserConfig()
+
+ + + + + + + + + + + + + + + +

+ SaveUserConfig() + +

+ +
+
+ +
+ 
public static void SaveUserConfig()
+
+ + + + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.UserConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.UserConfig.html new file mode 100644 index 00000000..21806bbd --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.UserConfig.html @@ -0,0 +1,615 @@ + + + + + Class UserConfig | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class UserConfig +

+ +
+
Namespace
Hi.HiNcKits
+
Assembly
HiNc.dll
+
+ +
+
+ +
+ 
public class UserConfig : IMakeXmlSource
+
+ + + + +
+
Inheritance
+
+ +
UserConfig
+
+
+ +
+
Implements
+
+ +
+
+ + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ UserConfig() + +

+ +

Default constructor

+
+
+ +
+ 
public UserConfig()
+
+ + + + + + + + + + + + + + + +

+ UserConfig(XElement, string) + +

+ +

Initializes a new instance of the UserConfig class from XML data.

+
+
+ +
+ 
public UserConfig(XElement src, string baseDirectory)
+
+ +

Parameters

+
+
src XElement
+

XML element containing configuration data

+
+
baseDirectory string
+

Base directory for resolving relative paths

+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ DisplayedStepPresentKeyList + +

+ +

Step infomation key list to show.

+
+
+ +
+ 
public List<string> DisplayedStepPresentKeyList { get; set; }
+
+ + + + + +

Property Value

+
+
List<string>
+
+
+ + + + + + + + + + +

+ EquipmentWorkpieceSetupDisplayeeConfig + +

+ +

Configuration for EquipmentWorkpieceSetupDisplayee

+
+
+ +
+ 
public WorkpieceEditorDisplayeeConfig EquipmentWorkpieceSetupDisplayeeConfig { get; set; }
+
+ + + + + +

Property Value

+
+
WorkpieceEditorDisplayeeConfig
+
+
+ + + + + + + + + + +

+ FixtureSetupDisplayeeConfig + +

+ +

Configuration for FixtureSetupDisplayee

+
+
+ +
+ 
public FixtureEditorDisplayeeConfig FixtureSetupDisplayeeConfig { get; set; }
+
+ + + + + +

Property Value

+
+
FixtureEditorDisplayeeConfig
+
+
+ + + + + + + + + + +

+ GraphicCacheLowerLimitMb + +

+ +
+
+ +
+ 
public double GraphicCacheLowerLimitMb { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ GraphicCacheMb + +

+ +
+
+ +
+ 
public long GraphicCacheMb { get; set; }
+
+ + + + + +

Property Value

+
+
long
+
+
+ + + + + + + + + + +

+ GraphicCacheUpperLimitMb + +

+ +
+
+ +
+ 
public double GraphicCacheUpperLimitMb { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ LanguageCode + +

+ +
+
+ +
+ 
public string LanguageCode { get; set; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + + + +

+ ShowPhysicsOptions + +

+ +
+
+ +
+ 
public bool ShowPhysicsOptions { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ XName + +

+ +

Name for XML IO.

+
+
+ +
+ 
public static string XName { get; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ 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.

+
+ + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.UserEnv.html b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.UserEnv.html new file mode 100644 index 00000000..d9a07a23 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.UserEnv.html @@ -0,0 +1,459 @@ + + + + + Class UserEnv | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class UserEnv +

+ +
+
Namespace
Hi.HiNcKits
+
Assembly
HiNc.dll
+
+ +

Environment of a HiNC user.

+
+
+ +
+ 
public class UserEnv
+
+ + + + +
+
Inheritance
+
+ +
UserEnv
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ AdditionalStepPresentAccess + +

+ +
+
+ +
+ 
public Dictionary<string, PresentAccess> AdditionalStepPresentAccess { get; set; }
+
+ + + + + +

Property Value

+
+
Dictionary<string, PresentAccess>
+
+
+ + + + + + + + + + +

+ CandidateStepPresentKeyList + +

+ +

Candidate Step Present Key List for display. +Read only.

+
+
+ +
+ 
public List<string> CandidateStepPresentKeyList { get; }
+
+ + + + + +

Property Value

+
+
List<string>
+
+
+ + + + + + + + + + +

+ DisplayedStepPresentAccessList + +

+ +

StepPresentAccessList for display. +Read only.

+
+
+ +
+ 
public List<KeyValuePair<string, PresentAccess>> DisplayedStepPresentAccessList { get; }
+
+ + + + + +

Property Value

+
+
List<KeyValuePair<string, PresentAccess>>
+
+
+ + + + + + + + + + +

+ EnablePhysics + +

+ +
+
+ +
+ 
public bool EnablePhysics { get; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ IsPhysicsLicensed + +

+ +
+
+ +
+ 
public bool IsPhysicsLicensed { get; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ SelectedItem + +

+ +
+
+ +
+ 
public object SelectedItem { get; set; }
+
+ + + + + +

Property Value

+
+
object
+
+
+ + + + + + + + + + +

+ StepPresentAccessDictionary + +

+ +

StepPresentAccessDictionary. +Read only.

+
+
+ +
+ 
public Dictionary<string, PresentAccess> StepPresentAccessDictionary { get; }
+
+ + + + + +

Property Value

+
+
Dictionary<string, PresentAccess>
+
+
+ + + + + + + + + + +

+ UserConfig + +

+ +
+
+ +
+ 
public UserConfig UserConfig { get; set; }
+
+ + + + + +

Property Value

+
+
UserConfig
+
+
+ + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.html b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.html index 400cf59d..c356db2f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.HiNcKits.html @@ -96,7 +96,25 @@ Classes
HiNcHost
-

Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration.

+

Rich HiNC Service. +Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration.

+
+
+
+
HostConfig
+
+
+
+
LocalApp
+
+
+
+
UserConfig
+
+
+
+
UserEnv
+

Environment of a HiNC user.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.FreeformCutter.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.FreeformRemover.html similarity index 63% rename from App/wwwroot/HiAPI-docsite/api/Hi.Machining.FreeformCutter.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Machining.FreeformRemover.html index 39237d08..6214c57e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.FreeformCutter.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.FreeformRemover.html @@ -2,9 +2,9 @@ - Class FreeformCutter | HiAPI-C# 2025 + Class FreeformRemover | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@

-
+
-

-Class FreeformCutter +

+Class FreeformRemover

@@ -103,7 +103,7 @@ This cutter type supports complex geometries for both the noble (upper) part and
- 
public class FreeformCutter : ICutter, IGetSweptable, IVolumeRemover, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache
+ 
public class FreeformRemover : ICutter, IGetSweptable, IVolumeRemover, IAnchoredDisplayee, IDisplayee, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache, INameNote
@@ -113,7 +113,7 @@ This cutter type supports complex geometries for both the noble (upper) part and
Inheritance
-
FreeformCutter
+
FreeformRemover
@@ -123,12 +123,12 @@ This cutter type supports complex geometries for both the noble (upper) part and - - - - + + + + @@ -140,6 +140,7 @@ This cutter type supports complex geometries for both the noble (upper) part and + @@ -174,10 +175,7 @@ This cutter type supports complex geometries for both the noble (upper) part and
Extension Methods
-
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -191,6 +189,18 @@ This cutter type supports complex geometries for both the noble (upper) part and + + + + @@ -207,8 +217,8 @@ This cutter type supports complex geometries for both the noble (upper) part and -

Remarks

-

The FreeformCutter class provides functionality for:

+

Remarks

+

The FreeformRemover class provides functionality for:

  • Managing complex cutting tool geometries
  • Supporting both spinning and non-spinning cutting operations
    • @@ -223,19 +233,19 @@ This cutter type supports complex geometries for both the noble (upper) part and - + -

    - FreeformCutter() +

    + FreeformRemover()

    -

    Initializes a new instance of the FreeformCutter class.

    +

    Initializes a new instance.

    - 
    public FreeformCutter()
    + 
    public FreeformRemover()
    @@ -246,7 +256,7 @@ This cutter type supports complex geometries for both the noble (upper) part and -

    Remarks

    +

    Remarks

    This constructor initializes the cutter with default settings and creates the necessary anchors and topology bricks for both the noble and shaper parts.

    @@ -254,19 +264,19 @@ and topology bricks for both the noble and shaper parts.

    - + -

    - FreeformCutter(XElement, string, string, params object[]) +

    + FreeformRemover(XElement, string, string, params object[])

    -

    Initializes a new instance of the FreeformCutter class from XML data.

    +

    Initializes a new instance from XML data.

    - 
    public FreeformCutter(XElement src, string baseDirectory, string relFile, params object[] res)
    + 
    public FreeformRemover(XElement src, string baseDirectory, string relFile, params object[] res)

    Parameters

    @@ -300,9 +310,9 @@ and topology bricks for both the noble and shaper parts.

    - + -

    +

    AbstractNote

    @@ -328,7 +338,7 @@ and topology bricks for both the noble and shaper parts.

    -

    Remarks

    +

    Remarks

    The abstract note includes the cutter type and its height dimension, formatted as "Freeform-H{height}".

    @@ -336,9 +346,9 @@ formatted as "Freeform-H{height}".

    - + -

    +

    CollidableName

    @@ -368,14 +378,15 @@ formatted as "Freeform-H{height}".

    - + -

    +

    CutterTip

    -

    Gets the cutter tip anchor point.

    +

    Gets the cutter tip anchor point. +On the same location of GeomAnchor.

    @@ -396,7 +407,7 @@ formatted as "Freeform-H{height}".

    -

    Remarks

    +

    Remarks

    The cutter tip represents the reference point for the cutting edge or surface. This point is used for positioning and orientation calculations during machining operations.

    @@ -404,9 +415,104 @@ This point is used for positioning and orientation calculations during machining - + -

    +

    + GeomAnchor + +

    + +

    StrutGeom and ShaperGeom locate on this anchor. +On the same location of CutterTip.

    +
    +
    + +
    + 
    public Anchor GeomAnchor { get; }
    +
    + + + + + +

    Property Value

    +
    +
    Anchor
    +
    +
    + + + + + + + + + + +

    + GeomToHolderBranch + +

    + +
    +
    + +
    + 
    public Branch GeomToHolderBranch { get; }
    +
    + + + + + +

    Property Value

    +
    +
    Branch
    +
    +
    + + + + + + + + + + +

    + GeomToHolderTransformer + +

    + +
    +
    + +
    + 
    public ITransformer GeomToHolderTransformer { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    ITransformer
    +
    +
    + + + + + + + + + + +

    IsSpinningCutter

    @@ -432,7 +538,7 @@ This point is used for positioning and orientation calculations during machining -

    Remarks

    +

    Remarks

    This property affects how the cutter interacts with the workpiece during machining operations. Spinning cutters typically perform rotary cutting operations, while non-spinning cutters may be used for other types of machining.

    @@ -440,19 +546,18 @@ Spinning cutters typically perform rotary cutting operations, while non-spinning - + -

    - NobleGeom +

    + KeepHolderBuckleOnTop

    -

    Gets or sets the noble (upper) part geometry of the cutter.

    -
    +
    - 
    public IGetStl NobleGeom { get; set; }
    + 
    public bool KeepHolderBuckleOnTop { get; set; }
    @@ -461,24 +566,84 @@ Spinning cutters typically perform rotary cutting operations, while non-spinning

    Property Value

    -
    IGetStl
    +
    bool
    -

    Remarks

    -

    The noble geometry represents the non-cutting portion of the tool, typically including -the tool holder and shank. This geometry is important for collision checking and visualization.

    + + + + + + +

    + Name + +

    + +

    Name.

    +
    + +
    + 
    public string Name { get; set; }
    +
    - -

    +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + Note + +

    + +

    Note.

    +
    +
    + +
    + 
    public string Note { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    ShaperGeom

    @@ -504,7 +669,7 @@ the tool holder and shank. This geometry is important for collision checking and -

    Remarks

    +

    Remarks

    The shaper geometry represents the cutting portion of the tool that directly interacts with the workpiece during machining operations.

    @@ -512,9 +677,9 @@ interacts with the workpiece during machining operations.

    - + -

    +

    ShaperTopoBrick

    @@ -544,10 +709,46 @@ interacts with the workpiece during machining operations.

    - + -

    - UpperBeamTopoBrick +

    + StrutGeom + +

    + +

    Gets or sets the strut (upper) part geometry of the cutter.

    +
    +
    + +
    + 
    public IGetStl StrutGeom { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    IGetStl
    +
    +
    + + + + +

    Remarks

    +

    The noble geometry represents the non-cutting portion of the tool, typically including +the tool holder and shank. This geometry is important for collision checking and visualization.

    +
    + + + + + + +

    + StrutTopoBrick

    @@ -556,7 +757,7 @@ interacts with the workpiece during machining operations.

    - 
    public ITopoBrick UpperBeamTopoBrick { get; }
    + 
    public ITopoBrick StrutTopoBrick { get; }
    @@ -576,9 +777,9 @@ interacts with the workpiece during machining operations.

    - + -

    +

    XName

    @@ -612,9 +813,9 @@ interacts with the workpiece during machining operations.

    - + -

    +

    ClearCache()

    @@ -635,7 +836,7 @@ interacts with the workpiece during machining operations.

    -

    Remarks

    +

    Remarks

    This includes clearing the cached sweptable and solid representations of both the noble and shaper parts of the cutter.

    @@ -643,9 +844,9 @@ the noble and shaper parts of the cutter.

    - + -

    +

    Display(Bind)

    @@ -676,9 +877,9 @@ the noble and shaper parts of the cutter.

    - + -

    +

    Dispose()

    @@ -703,14 +904,14 @@ the noble and shaper parts of the cutter.

    - + -

    +

    Dispose(bool)

    -

    Releases the unmanaged resources used by the FreeformCutter and optionally releases the managed resources.

    +

    Releases the unmanaged resources and optionally releases the managed resources.

    @@ -736,14 +937,14 @@ the noble and shaper parts of the cutter.

    - + -

    +

    Duplicate(params object[])

    -

    Creates a deep copy of the current FreeformCutter instance.

    +

    Creates a deep copy of the current instance.

    @@ -761,7 +962,7 @@ the noble and shaper parts of the cutter.

    Returns

    object
    -

    A new FreeformCutter instance with copied geometry data.

    +

    A new instance with copied geometry data.

    @@ -775,9 +976,9 @@ the noble and shaper parts of the cutter.

    - + -

    +

    ExpandToBox3d(Box3d)

    @@ -808,9 +1009,42 @@ the noble and shaper parts of the cutter.

    - + -

    +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + + + + +

    GetAnchoredCollidableNode()

    @@ -841,9 +1075,9 @@ the noble and shaper parts of the cutter.

    - + -

    +

    GetAnchoredCollidables()

    @@ -874,9 +1108,9 @@ the noble and shaper parts of the cutter.

    - + -

    +

    GetAnchoredDisplayeeList()

    @@ -907,9 +1141,9 @@ the noble and shaper parts of the cutter.

    - + -

    +

    GetAsmb()

    @@ -940,9 +1174,9 @@ the noble and shaper parts of the cutter.

    - + -

    +

    GetFletchBuckle()

    @@ -974,79 +1208,9 @@ the anchor that generally connect to fixed part such as ground and triggering(mo - + -

    - GetNobleAnchoredDisplayee() - -

    - -

    Gets the noble (upper) part displayee for visualization purposes.

    -
    -
    - -
    - 
    public AnchoredDisplayee GetNobleAnchoredDisplayee()
    -
    - - -

    Returns

    -
    -
    AnchoredDisplayee
    -

    An AnchoredDisplayee representing the noble part of the cutter with modified display properties.

    -
    -
    - - - - - - - -

    Remarks

    -

    This method creates a display representation of the noble geometry with slightly darker coloring -to distinguish it from the shaper part during visualization.

    -
    - - - - - - -

    - GetRootAnchor() - -

    - -

    Get root anchor.

    -
    -
    - -
    - 
    public Anchor GetRootAnchor()
    -
    - - -

    Returns

    -
    -
    Anchor
    -

    root anchor.

    -
    -
    - - - - - - - - - - - - - -

    +

    GetShaperDisplayee()

    @@ -1073,7 +1237,7 @@ to distinguish it from the shaper part during visualization.

    -

    Remarks

    +

    Remarks

    This method creates a display representation of the shaper geometry, which can be either the raw geometry if it implements IDisplayee, or the topology brick representation.

    @@ -1081,9 +1245,46 @@ the raw geometry if it implements IDisplayee, or the topology brick representati - + -

    +

    + GetStrutAnchoredDisplayee() + +

    + +

    Gets the noble (upper) part displayee for visualization purposes.

    +
    +
    + +
    + 
    public AnchoredDisplayee GetStrutAnchoredDisplayee()
    +
    + + +

    Returns

    +
    +
    AnchoredDisplayee
    +

    An AnchoredDisplayee representing the noble part of the cutter with modified display properties.

    +
    +
    + + + + + + + +

    Remarks

    +

    This method creates a display representation of the noble geometry with slightly darker coloring +to distinguish it from the shaper part during visualization.

    +
    + + + + + + +

    GetSweptable(double)

    @@ -1116,17 +1317,17 @@ the raw geometry if it implements IDisplayee, or the topology brick representati -

    Remarks

    +

    Remarks

    The sweptable representation is cached for performance. Use ClearCache to reset the cached data.

    - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -1136,7 +1337,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -1146,6 +1347,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1162,6 +1366,11 @@ This method may also generate additional resources such as related files.

+

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.Machining.ICutter.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.ICutter.html index e4641945..065e0014 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.ICutter.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.ICutter.html @@ -102,7 +102,7 @@ Interface ICutter
- 
public interface ICutter : IGetSweptable, IVolumeRemover, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache
+ 
public interface ICutter : IGetSweptable, IVolumeRemover, IAnchoredDisplayee, IDisplayee, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache, INameNote
@@ -117,14 +117,14 @@ Interface ICutter + -
IAbstractNote.AbstractNote @@ -159,16 +159,19 @@ Interface ICutter + +
Extension Methods
-
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -182,6 +185,18 @@ Interface ICutter + + + + @@ -204,6 +219,37 @@ Interface ICutter + + +

+ CutterThemeColor + +

+ +
+
+ +
+ 
public static Vec3d CutterThemeColor { get; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + +

@@ -275,6 +321,37 @@ calculations during machining operations.

+ + +

+ ShankThemeColor + +

+ +
+
+ +
+ 
public static Vec3d ShankThemeColor { get; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + +

@@ -308,10 +385,10 @@ the part cut the workpiece if overlapped.

- + -

- UpperBeamTopoBrick +

+ StrutTopoBrick

@@ -321,7 +398,7 @@ the part triggers collision to workpiece if overlapped.

- 
ITopoBrick UpperBeamTopoBrick { get; }
+ 
ITopoBrick StrutTopoBrick { get; }
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.IMachiningTool.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.IMachiningTool.html index 4f4fe813..cbda3211 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.IMachiningTool.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.IMachiningTool.html @@ -102,7 +102,7 @@ Interface IMachiningTool
- 
public interface IMachiningTool : ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache
+ 
public interface IMachiningTool : IDisplayee, IExpandToBox3d, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache, IGetFluteNum
@@ -114,18 +114,18 @@ Interface IMachiningTool
Inherited Members
- - + + @@ -133,7 +133,7 @@ Interface IMachiningTool IGetFletchBuckle.GetFletchBuckle()
IAbstractNote.AbstractNote @@ -144,16 +144,16 @@ Interface IMachiningTool +
Extension Methods
- + + +
ColorUtil.GetGloomyColor(object, double, double) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html index 80f90751..54e9ba70 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html @@ -102,7 +102,7 @@ Interface IMachiningEquipment
- 
public interface IMachiningEquipment : IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetMachiningChain, IGetSolidMachiningChain
+ 
public interface IMachiningEquipment : IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetMachiningChain
@@ -121,7 +121,7 @@ Interface IMachiningEquipment IExpandToBox3d.ExpandToBox3d(Box3d)
IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() @@ -133,19 +133,19 @@ Interface IMachiningEquipment IGetAsmb.GetAsmb()
-
Extension Methods
+ @@ -164,6 +164,12 @@ Interface IMachiningEquipment + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html index a776acf0..b0ffa58d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html @@ -102,7 +102,7 @@ Class MachiningEquipment
- 
public class MachiningEquipment : IMachiningEquipment, IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetMachiningChain, IGetSolidMachiningChain, IGetMachiningEquipment
+ 
public class MachiningEquipment : IMachiningEquipment, IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetMachiningChain, IGetMachiningEquipment
@@ -126,10 +126,9 @@ Class MachiningEquipment + - -
@@ -164,6 +163,9 @@ Class MachiningEquipment
Extension Methods
+ @@ -182,6 +184,12 @@ Class MachiningEquipment + + @@ -437,6 +445,71 @@ This includes coolant temperature and heat transfer coefficients.

+ + +

+ MachiningChain + +

+ +

Body of the equipment.

+
+
+ +
+ 
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
+
+
+ + + + + + + +

@@ -469,71 +542,6 @@ This includes coolant temperature and heat transfer coefficients.

- - -

- SolidMachiningChain - -

- -

Body of the equipment.

-
-
- -
- 
public ISolidMachiningChain SolidMachiningChain { get; set; }
-
- - - - - -

Property Value

-
-
ISolidMachiningChain
-
-
- - - - - - - - - - -

- SolidMachiningChainFile - -

- -

Gets or sets the file path of the solid machining chain. -This is used for XML serialization and file management.

-
-
- -
- 
public string SolidMachiningChainFile { get; set; }
-
- - - - - -

Property Value

-
-
string
-
-
- - - - - - - -

@@ -809,6 +817,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -975,72 +1016,6 @@ Where Point - - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - - - - -

- GetSolidMachiningChain() - -

- -

Get ISolidMachiningChain.

-
-
- -
- 
public ISolidMachiningChain GetSolidMachiningChain()
-
- - -

Returns

-
-
ISolidMachiningChain
-

ISolidMachiningChain

-
-
- - - - - - - - - - -

@@ -1110,8 +1085,8 @@ otherwise, return the XYZ from workpiece geomanchor to tool tip.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1121,7 +1096,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1131,6 +1106,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1147,6 +1125,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -1263,7 +1246,7 @@ Provides both the previous and new chain values.

- 
public event Action<SeqPair<ISolidMachiningChain>> MachiningChainChanged
+ 
public event Action<SeqPair<IMachiningChain>> MachiningChainChanged
@@ -1273,7 +1256,7 @@ Provides both the previous and new chain values.

Event Type

-
Action<SeqPair<ISolidMachiningChain>>
+
Action<SeqPair<IMachiningChain>>
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html index 8eac2729..f897cc77 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html @@ -103,7 +103,7 @@ This class manages collision detection between different parts of the machining
- 
public class MachiningEquipmentCollisionIndex : ICollisionIndex, IGetCollidable, IMakeXmlSource
+ 
public class MachiningEquipmentCollisionIndex : ICollisionIndex, IGetCollidable, IMakeXmlSource, IToXElement
@@ -123,6 +123,7 @@ This class manages collision detection between different parts of the machining + @@ -357,7 +358,7 @@ This class manages collision detection between different parts of the machining

The anchor point returned depends on the component key:

  • Workpiece: Geometry anchor
    • -
  • Fixture: Table buckle
    • +
  • Fixture: Geometry anchor
  • ToolHolder: Root anchor of the holder
  • CutterShank: Root anchor of the upper beam topo brick
  • CutterFlute: Root anchor of the shaper topo brick
    • @@ -553,33 +554,75 @@ The type of collidable returned depends on the component key:

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    -

    Creates an XML representation of this collision index.

    +

    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)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    baseDirectory string
    -

    The base directory for resolving relative paths.

    +

    The base directory for resolving relative paths

    relFile string
    -

    The relative file path for XML serialization.

    +

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    Returns

    XElement
    -

    An XML element containing the collision index data.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html index 86ba1da2..46cef564 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html @@ -189,8 +189,8 @@ The adjacent solids will not be added to the -

    - MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain, HashSet<CollisionIndexPair>) +

    + MachiningEquipmentCollisionIndexPairsSource(IMachiningChain, HashSet<CollisionIndexPair>)

    @@ -199,12 +199,12 @@ The adjacent solids will not be added to the
    - 
    public MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain src, HashSet<CollisionIndexPair> excludedPairs)
    + 
    public MachiningEquipmentCollisionIndexPairsSource(IMachiningChain src, HashSet<CollisionIndexPair> excludedPairs)

    Parameters

    -
    src ISolidMachiningChain
    +
    src IMachiningChain

    The solid machining chain to build collision pairs from.

    excludedPairs HashSet<CollisionIndexPair>
    @@ -219,7 +219,7 @@ The adjacent solids will not be added to the Remarks +

    Remarks

    This constructor builds the default collision index pairs from the provided machining chain and removes the specified excluded pairs from consideration.

    @@ -229,8 +229,8 @@ and removes the specified excluded pairs from consideration.

     -

    - MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain, string) +

    + MachiningEquipmentCollisionIndexPairsSource(IMachiningChain, string)

    @@ -239,12 +239,12 @@ and removes the specified excluded pairs from consideration.

    - 
    public MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain src, string excludedPairsString = "")
    + 
    public MachiningEquipmentCollisionIndexPairsSource(IMachiningChain src, string excludedPairsString = "")

    Parameters

    -
    src ISolidMachiningChain
    +
    src IMachiningChain

    The solid machining chain to build collision pairs from.

    excludedPairsString string
    @@ -259,7 +259,7 @@ and removes the specified excluded pairs from consideration.

    -

    Remarks

    +

    Remarks

    This constructor builds the default collision index pairs from the provided machining chain and removes the pairs specified in the excludedPairsString from consideration.

    @@ -269,8 +269,8 @@ and removes the pairs specified in the excludedPairsString from consideration. -

    - MachiningEquipmentCollisionIndexPairsSource(XElement, IGetSolidMachiningChain) +

    + MachiningEquipmentCollisionIndexPairsSource(XElement, IGetMachiningChain)

    @@ -279,7 +279,7 @@ and removes the pairs specified in the excludedPairsString from consideration.
- 
public MachiningEquipmentCollisionIndexPairsSource(XElement src, IGetSolidMachiningChain res)
+ 
public MachiningEquipmentCollisionIndexPairsSource(XElement src, IGetMachiningChain res)

Parameters

@@ -287,7 +287,7 @@ and removes the pairs specified in the excludedPairsString from consideration.src XElement

The XML element containing the collision index pairs configuration.

-
res IGetSolidMachiningChain
+
res IGetMachiningChain

The solid machining chain reference used to build default index pairs.

@@ -377,8 +377,8 @@ and removes the pairs specified in the excludedPairsString from consideration. -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -388,7 +388,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -398,6 +398,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -414,6 +417,11 @@ This method may also generate additional resources such as related files.

+

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.Machining.MachiningToolHouse.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningToolHouse.html index 727eca3e..1ab0221b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningToolHouse.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.MachiningToolHouse.html @@ -383,13 +383,13 @@ The tool ID is 1 if no tool existed; otherwise, the tool ID is the max tool ID p
- 
public KeyValuePair<int, StickMachiningTool> CreateStickMillingTool()
+ 
public KeyValuePair<int, MillingTool> CreateStickMillingTool()

Returns

-
KeyValuePair<int, StickMachiningTool>
+
KeyValuePair<int, MillingTool>

the generated tool id and the generated tool

@@ -406,8 +406,8 @@ The tool ID is 1 if no tool existed; otherwise, the tool ID is the max tool ID p -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -417,7 +417,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -427,6 +427,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -443,6 +446,11 @@ This method may also generate additional resources such as related files.

+

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.Machining.html b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.html index 68d97de0..fa507305 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Machining.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Machining.html @@ -95,7 +95,7 @@ Classes
-
FreeformCutter
+
FreeformRemover

Represents a freeform cutting tool that can be used in machining operations. This cutter type supports complex geometries for both the noble (upper) part and the shaper (cutting) part.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ConfigStepFunc.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ConfigStepFunc.html index 73fcd025..8d5ad103 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ConfigStepFunc.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ConfigStepFunc.html @@ -107,7 +107,7 @@ Delegate ConfigStepFunc

Parameters

-
millingStep MachiningStep
+
millingStep MachiningStep

The milling step to configure.

arg object
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html index 403dd0b6..2324075d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html @@ -102,7 +102,7 @@ Class DynamicMachiningProjectDisplayee
- 
public class DynamicMachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetRootAnchor
+ 
public class DynamicMachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex
@@ -121,7 +121,8 @@ Class DynamicMachiningProjectDisplayee
- + +
@@ -155,6 +156,9 @@ Class DynamicMachiningProjectDisplayee
Extension Methods
+ @@ -164,6 +168,12 @@ Class DynamicMachiningProjectDisplayee + + @@ -397,10 +407,10 @@ This function is usually used to compute the bounding box of elements.

- + -

- GetRootAnchor() +

+ GetAnchor()

@@ -409,7 +419,7 @@ This function is usually used to compute the bounding box of elements.

- 
public Anchor GetRootAnchor()
+ 
public Anchor GetAnchor()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IMachiningProjectGetter.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IMachiningProjectGetter.html new file mode 100644 index 00000000..2dd0ca36 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IMachiningProjectGetter.html @@ -0,0 +1,203 @@ + + + + + Interface IMachiningProjectGetter | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IMachiningProjectGetter +

+ +
+
Namespace
Hi.MachiningProcs
+
Assembly
HiNc.dll
+
+ +
+
+ +
+ 
public interface IMachiningProjectGetter
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Methods +

+ + + + +

+ GetMachiningProject() + +

+ +
+
+ +
+ 
MachiningProject GetMachiningProject()
+
+ + +

Returns

+
+
MachiningProject
+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IMachiningProjectHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IMachiningProjectHost.html new file mode 100644 index 00000000..81b98b0f --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IMachiningProjectHost.html @@ -0,0 +1,203 @@ + + + + + Interface IMachiningProjectHost | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IMachiningProjectHost +

+ +
+
Namespace
Hi.MachiningProcs
+
Assembly
HiNc.dll
+
+ +
+
+ +
+ 
public interface IMachiningProjectHost
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ MachiningProject + +

+ +
+
+ +
+ 
MachiningProject MachiningProject { get; set; }
+
+ + + + + +

Property Value

+
+
MachiningProject
+
+
+ + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IPathedMachiningProjectHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IPathedMachiningProjectHost.html new file mode 100644 index 00000000..69e64c1e --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.IPathedMachiningProjectHost.html @@ -0,0 +1,210 @@ + + + + + Interface IPathedMachiningProjectHost | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IPathedMachiningProjectHost +

+ +
+
Namespace
Hi.MachiningProcs
+
Assembly
HiNc.dll
+
+ +
+
+ +
+ 
public interface IPathedMachiningProjectHost : IMachiningProjectHost
+
+ + + + + + + +
+
Inherited Members
+
+ +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ MachiningProjectPath + +

+ +
+
+ +
+ 
string MachiningProjectPath { get; set; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html index ea7abdd1..d43d0455 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html @@ -107,10 +107,10 @@ Delegate MachiningActRunner.MachiningStepBuiltDelegate

Parameters

-
preStep MachiningStep
+
preStep MachiningStep

The previous milling step.

-
curStep MachiningStep
+
curStep MachiningStep

The current milling step.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.html index 1aac512d..88ac1cda 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningActRunner.html @@ -336,6 +336,39 @@ This property is provided as a member value getter and should not be modified. + +

+ EnablePhysics + +

+ +

Gets or sets whether milling force evaluation is enabled. +This is a runtime configuration and is not managed in XML IO.

+
+
+ +
+ 
public bool EnablePhysics { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + +

@@ -424,7 +457,7 @@ This is for internal use only.

Property Value

-
Action<MachiningStep>
+
Action<MachiningStep>
@@ -691,6 +724,37 @@ This is for internal use only.

+ + +

+ XyzabcChain + +

+ +
+
+ +
+ 
public IXyzabcChain XyzabcChain { get; }
+
+ + + + + +

Property Value

+
+
IXyzabcChain
+
+
+ + + + + + + +

Methods

@@ -856,8 +920,8 @@ This is for internal use only.

-

- ProcAct(IAct, ISourceCommand, MachiningSession, CancellationToken, IMachiningStepHost) +

+ ProcAct(IAct, MachiningSession, IMachiningStepHost, ISourceCommand, CancellationToken)

@@ -866,25 +930,25 @@ This is for internal use only.

- 
public IEnumerable<object> ProcAct(IAct act, ISourceCommand sourceCommand, MachiningSession millingSession, CancellationToken cancellationToken, IMachiningStepHost host)
+ 
public IEnumerable<object> ProcAct(IAct act, MachiningSession millingSession, IMachiningStepHost host, ISourceCommand sourceCommand, CancellationToken cancellationToken)

Parameters

act IAct

The act to process.

-
-
sourceCommand ISourceCommand
-

The source command.

millingSession MachiningSession

The milling session.

+
+
host IMachiningStepHost
+

The milling step host.

+
+
sourceCommand ISourceCommand
+

The source command.

cancellationToken CancellationToken

The cancellation token.

-
-
host IMachiningStepHost
-

The milling step host.

@@ -1045,7 +1109,7 @@ This is for internal use only.

Event Type

-
Action<MachiningStep>
+
Action<MachiningStep>
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html index 45cf625f..bfab5798 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html @@ -239,7 +239,7 @@ Class MachiningParallelProc.StepTaskBundle

Property Value

-
MachineMotionStep
+
MachineMotionStep
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProject.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProject.html index e8b88d9b..af90a452 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProject.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProject.html @@ -102,7 +102,7 @@ Class MachiningProject
- 
public class MachiningProject : IDisposable, IMachiningStepHost, IGetMachiningEquipment, IMakeXmlSource
+ 
public class MachiningProject : IDisposable, IMachiningStepHost, IGetMachiningEquipment, IMakeXmlSource, IMachiningProjectGetter
@@ -120,9 +120,10 @@ Class MachiningProject
Implements
- + +
@@ -432,6 +433,38 @@ Uses the default MongoDB connection.

+ + +

+ ClStrip + +

+ +

Gets the cutter location strip.

+
+
+ +
+ 
public ClStrip ClStrip { get; }
+
+ + + + + +

Property Value

+
+
ClStrip
+
+
+ + + + + + + +

@@ -561,20 +594,51 @@ When set to true, initializes collision detection mechanism.

- + -

- EnablePauseOnCollision +

+ EnablePauseOnFailure

-

Gets or sets whether to pause simulation when a collision is detected. -Only effective when collision detection is enabled.

+

Enable Pause On Failure Detected. +Only take effect if the EnableCollisionDetection or EnableStrokeLimitCheck is enabled.

- 
public bool EnablePauseOnCollision { get; set; }
+ 
public bool EnablePauseOnFailure { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ EnableStrokeLimitCheck + +

+ +
+
+ +
+ 
public bool EnableStrokeLimitCheck { get; set; }
@@ -601,7 +665,7 @@ Only effective when collision detection is enabled.

-

global variable for ShellApi. +

global variable for RuntimeController. Not save on XML.

@@ -681,39 +745,7 @@ When set, updates the inspecting quantity function.

Property Value

-
Func<MachiningStep, double?>
-
-
- - - - - - - - - - -

- KeyToAccessDictionary - -

- -

Gets the dictionary mapping property keys to their access methods.

-
-
- -
- 
public ConcurrentDictionary<string, StepPropertyAccess> KeyToAccessDictionary { get; }
-
- - - - - -

Property Value

-
-
ConcurrentDictionary<string, StepPropertyAccess>
+
Func<MachiningStep, double?>
@@ -981,6 +1013,68 @@ Updates related components when changed.

+ + +

+ NcEnv + +

+ +
+
+ +
+ 
public NcEnv NcEnv { get; }
+
+ + + + + +

Property Value

+
+
NcEnv
+
+
+ + + + + + + + + + +

+ NcOptOptionDictionary + +

+ +
+
+ +
+ 
public Dictionary<string, NcOptOption> NcOptOptionDictionary { get; set; }
+
+ + + + + +

Property Value

+
+
Dictionary<string, NcOptOption>
+
+
+ + + + + + + +

@@ -1089,7 +1183,7 @@ Updates related components when changed.

- 
public IShellCommand PlayerCommand { get; }
+ 
public IShellCommand PlayerCommand { get; set; }
@@ -1098,7 +1192,7 @@ Updates related components when changed.

Property Value

-
IShellCommand
+
IShellCommand
@@ -1141,6 +1235,38 @@ Updates related components when changed.

+ + +

+ RuntimeController + +

+ +

Gets the shell API for interacting with this machining process.

+
+
+ +
+ 
public RuntimeController RuntimeController { get; }
+
+ + + + + +

Property Value

+
+
RuntimeController
+
+
+ + + + + + + +

@@ -1173,19 +1299,19 @@ Updates related components when changed.

- + -

- ShellApi +

+ StepPropertyAccessDictionary

-

Gets the shell API for interacting with this machining process.

+

Gets the dictionary mapping property keys to their access methods.

- 
public ShellApi ShellApi { get; }
+ 
public ConcurrentDictionary<string, PropertyAccess<MachiningStep>> StepPropertyAccessDictionary { get; }
@@ -1194,7 +1320,7 @@ Updates related components when changed.

Property Value

-
ShellApi
+
ConcurrentDictionary<string, PropertyAccess<MachiningStep>>
@@ -1307,6 +1433,41 @@ Ensures proper initialization of workpiece properties.

+ + +

+ Act(IAct, ISourceCommand, CancellationToken?) + +

+ +
+
+ +
+ 
public void Act(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null)
+
+ +

Parameters

+
+
act IAct
+
+
sourceCommand ISourceCommand
+
+
cancellationToken CancellationToken?
+
+
+ + + + + + + + + + + +

@@ -1459,6 +1620,37 @@ Clear the state from previous session (if existed).

+ + +

+ GetMachiningProject() + +

+ +
+
+ +
+ 
public MachiningProject GetMachiningProject()
+
+ + +

Returns

+
+
MachiningProject
+
+
+ + + + + + + + + + +

@@ -1533,8 +1725,8 @@ Clear the state from previous session (if existed).

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1544,7 +1736,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1554,6 +1746,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1570,6 +1765,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -1646,6 +1846,46 @@ This method may also generate additional resources such as related files.

+ + +

+ ProcAct(IAct, ISourceCommand, CancellationToken?) + +

+ +
+
+ +
+ 
public IEnumerable<object> ProcAct(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null)
+
+ +

Parameters

+
+
act IAct
+
+
sourceCommand ISourceCommand
+
+
cancellationToken CancellationToken?
+
+
+ +

Returns

+
+
IEnumerable<object>
+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProjectDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProjectDisplayee.html index 62643581..a6f49dbe 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProjectDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningProjectDisplayee.html @@ -102,7 +102,7 @@ Class MachiningProjectDisplayee
- 
public class MachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetRootAnchor
+ 
public class MachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex
@@ -121,7 +121,8 @@ Class MachiningProjectDisplayee
- + +
@@ -155,6 +156,9 @@ Class MachiningProjectDisplayee
Extension Methods
+ @@ -164,6 +168,12 @@ Class MachiningProjectDisplayee + + @@ -257,6 +267,68 @@ Class MachiningProjectDisplayee

+ + +

+ HeidenhainCoordinateEntryDisplayee + +

+ +
+
+ +
+ 
public HeidenhainCoordinateEntryDisplayee HeidenhainCoordinateEntryDisplayee { get; }
+
+ + + + + +

Property Value

+
+
HeidenhainCoordinateEntryDisplayee
+
+
+ + + + + + + + + + +

+ IsoCoordinateEntryDisplayee + +

+ +
+
+ +
+ 
public IsoCoordinateEntryDisplayee IsoCoordinateEntryDisplayee { get; }
+
+ + + + + +

Property Value

+
+
IsoCoordinateEntryDisplayee
+
+
+ + + + + + + +

@@ -392,26 +464,26 @@ This function is usually used to compute the bounding box of elements.

- + -

- GetRootAnchor() +

+ GetAnchor()

-

Get root anchor.

+

Get key anchor. (i.e. root anchor)

- 
public Anchor GetRootAnchor()
+ 
public Anchor GetAnchor()

Returns

Anchor
-

root anchor.

+

key anchor

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningSession.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningSession.html index 456eae79..2b97cbba 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningSession.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningSession.html @@ -201,7 +201,7 @@ and managing session state.

Property Value

-
ISourceCommand
+
ISourceCommand
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MillingActRunnerConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MillingActRunnerConfig.html index 45c46d72..ddf6eadd 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MillingActRunnerConfig.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MillingActRunnerConfig.html @@ -349,39 +349,6 @@ Note: This feature is pending testing.

- - -

- EnableMillingForceEvaluation - -

- -

Gets or sets whether milling force evaluation is enabled. -This is a runtime configuration and is not managed in XML IO.

-
-
- -
- 
public bool EnableMillingForceEvaluation { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - -

@@ -485,33 +452,37 @@ The temperature is initialized when a working session is restarted or a new sess -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML representation of the configuration.

+

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)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string
-

The base directory for resolving relative paths.

+

The base directory for resolving relative paths

relFile string
-

The relative file path.

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element containing the configuration.

+

An XML element representing the object's state

@@ -521,6 +492,11 @@ The temperature is initialized when a working session is restarted or a new sess +

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.MachiningProcs.RenderingFlag.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RenderingFlag.html index 35f6594e..21cc676c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RenderingFlag.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RenderingFlag.html @@ -103,8 +103,7 @@ Enum RenderingFlag
- 
[Flags]
-public enum RenderingFlag
+ 
public enum RenderingFlag
@@ -150,30 +149,54 @@ public enum RenderingFlag

Cutter location strip rendering flag.

-
ColorScaleBar = ClStrip | DimensionBar
+
ColorScaleBar = 10
-

Color scale bar rendering flag.

+

Color scale bar rendering flag. +Category: Foreground.

-
DimensionBar = WorkpieceGeom | Fixture
+
DimensionBar = 9
-

Dimension bar rendering flag.

+

Dimension bar rendering flag. +Category: Foreground.

+
Dummy = 0
+ +
Fixture = 4
-

Fixture rendering flag.

+

Fixture rendering flag. +Category: Solid.

-
Mech = ClStrip | Fixture
+
HeidenhainCoordinate = 8
+ +

Heidenhain Coordinate rendering flag. +Category: Anchor (Coordinate Mark).

+
+
IsoCoordinate = 7
+ +

Iso Coordinate rendering flag. +Category: Anchor (Coordinate Mark).

+
+
Mech = 5

Mechanical components rendering flag. -This flag covers the flags WorkpieceGeom, Tool and Fixture.

+This flag covers the flags WorkpieceGeom, Tool and Fixture. +Category: Solid.

-
Tool = ClStrip | WorkpieceGeom
+
ProgramZero = 6
-

Tool rendering flag.

+

Program Zero rendering flag. +Category: Anchor (Coordinate Mark).

+
+
Tool = 3
+ +

Tool rendering flag. +Category: Solid.

WorkpieceGeom = 2
-

Workpiece geometry rendering flag.

+

Workpiece geometry rendering flag. +Category: Solid.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RuntimeController.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RuntimeController.html new file mode 100644 index 00000000..72613ec6 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.RuntimeController.html @@ -0,0 +1,4032 @@ + + + + + Class RuntimeController | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class RuntimeController +

+ +
+
Namespace
Hi.MachiningProcs
+
Assembly
HiNc.dll
+
+ +

Provides a C# scripting API for controlling and manipulating the milling course. +Allows for runtime control of milling operations, geometry manipulation, and data analysis.

+
+
+ +
+ 
[ApiController]
+[Route("api/[controller]/[action]")]
+public class RuntimeController : ControllerBase, ICsScriptApi
+
+ + + + +
+
Inheritance
+
+ + +
RuntimeController
+
+
+ +
+
Implements
+
+ +
+
+ + +
+
Inherited Members
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ RuntimeController(IMachiningProjectGetter) + +

+ +

Initializes a new instance.

+
+
+ +
+ 
public RuntimeController(IMachiningProjectGetter machiningProjectGetter)
+
+ +

Parameters

+
+
machiningProjectGetter IMachiningProjectGetter
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ DiffVisualRadius_mm + +

+ +

Gets or sets the visual radius in millimeters for difference visualization. +Controls the radius used for highlighting differences between workpiece states.

+
+
+ +
+ 
[JsAce]
+public double DiffVisualRadius_mm { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ DispCacheMb + +

+ +

Gets or sets the display cache size in megabytes.

+
+
+ +
+ 
public long DispCacheMb { get; set; }
+
+ + + + + +

Property Value

+
+
long
+
+
+ + + + + + + + + + +

+ DispCache_Mb + +

+ +

Gets or sets the display cache size in megabytes.

+
+
+ +
+ 
[JsAce]
+public long DispCache_Mb { get; set; }
+
+ + + + + +

Property Value

+
+
long
+
+
+ + + + + + + + + + +

+ EnableAutoMapOnSelectionEnd + +

+ +

Gets or sets whether to automatically map selections when they end.

+
+
+ +
+ 
[JsAce]
+public bool EnableAutoMapOnSelectionEnd { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ EnableCollisionDetection + +

+ +

Gets or sets whether collision detection is enabled.

+
+
+ +
+ 
[JsAce(DocContentHtml = "Enable Collision Detection.")]
+public bool EnableCollisionDetection { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ EnablePauseOnCollision + +

+ +

Obsoleted.

+

Gets or sets whether to pause execution when a collision is detected. +This property only has an effect if collision detection is enabled.

+
+
+ +
+ 
public bool EnablePauseOnCollision { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ EnablePauseOnFailure + +

+ +
+
+ +
+ 
[JsAce(DocContentHtml = "Enable Pause On Failure.")]
+public bool EnablePauseOnFailure { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ EnablePhysics + +

+ +

Gets or sets whether milling force evaluation is enabled.

+
+
+ +
+ 
[JsAce(DocContentHtml = "Enable milling force evaluation.")]
+public bool EnablePhysics { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ EnableWearEffect + +

+ +

Gets or sets whether tool wear effects are enabled in simulation.

+
+
+ +
+ 
[JsAce]
+public bool EnableWearEffect { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ FeedPerCycle + +

+ +

Gets a new feed per cycle machining motion resolution instance.

+
+
+ +
+ 
[JsAce]
+public FeedPerCycleMachiningMotionResolution FeedPerCycle { get; }
+
+ + + + + +

Property Value

+
+
FeedPerCycleMachiningMotionResolution
+
+
+ + + + + + + + + + +

+ FeedPerTooth + +

+ +

Gets a new feed per tooth machining motion resolution instance.

+
+
+ +
+ 
[JsAce]
+public FeedPerToothMachiningMotionResolution FeedPerTooth { get; }
+
+ + + + + +

Property Value

+
+
FeedPerToothMachiningMotionResolution
+
+
+ + + + + + + + + + +

+ Global + +

+ +

Global variables.

+
+
+ +
+ 
[JsAce("Global[$1key]")]
+public Dictionary<object, object> Global { get; }
+
+ + + + + +

Property Value

+
+
Dictionary<object, object>
+
+
+ + + + + + + + + + +

+ InitSpindleTemperature_C + +

+ +

Gets or sets the initial spindle temperature in degrees Celsius.

+
+
+ +
+ 
[JsAce(DocContentHtml = "Spindle Temperature on initialization.")]
+public double InitSpindleTemperature_C { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ JsAceCompletionProfileJsonArray + +

+ +

Internal used.

+
+
+ +
+ 
public static JsonArray JsAceCompletionProfileJsonArray { get; }
+
+ + + + + +

Property Value

+
+
JsonArray
+
+
+ + + + + + + + + + +

+ MachiningMotionResolution + +

+ +

Gets or sets the machining motion resolution.

+
+
+ +
+ 
[JsAce]
+public IMachiningMotionResolution MachiningMotionResolution { get; set; }
+
+ + + + + +

Property Value

+
+
IMachiningMotionResolution
+
+
+ + + + + + + + + + +

+ MachiningResolution + +

+ +

Gets or sets the machining resolution in millimeters. +For legacy compatable.

+
+
+ +
+ 
[JsAce]
+[Obsolete]
+public double MachiningResolution { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ MachiningResolution_mm + +

+ +

Gets or sets the machining resolution in millimeters.

+
+
+ +
+ 
[JsAce]
+public double MachiningResolution_mm { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ MachiningSession + +

+ +
+
+ +
+ 
public MachiningSession MachiningSession { get; }
+
+ + + + + +

Property Value

+
+
MachiningSession
+
+
+ + + + + + + + + + +

+ MapTask + +

+ +

Task tracking the status of mapping operations.

+
+
+ +
+ 
public Task MapTask { get; set; }
+
+ + + + + +

Property Value

+
+
Task
+
+
+ + + + + + + + + + +

+ MillingForceCycleDivisionNum + +

+ +

Gets or sets the number of divisions per cycle for milling force calculation. +This property should be set before milling force evaluation if TrainMillingPara(SampleFlag, string, double) is intended to be used.

+
+
+ +
+ 
[JsAce]
+public static int MillingForceCycleDivisionNum { get; set; }
+
+ + + + + +

Property Value

+
+
int
+
+
+ + + + + + + + + + +

+ NcOptOption + +

+ +
+
+ +
+ 
[JsAce]
+public NcOptOption NcOptOption { get; set; }
+
+ + + + + +

Property Value

+
+
NcOptOption
+
+
+ + + + + + + + + + +

+ OptEnableDepthCompensation + +

+ +

Enables or disables depth compensation during optimization.

+
+
+ +
+ 
[JsAce]
+public bool OptEnableDepthCompensation { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ OptEnableFeedrate + +

+ +

Gets or sets whether to enable feed rate optimization in NC optimization.

+
+
+ +
+ 
[JsAce]
+public bool OptEnableFeedrate { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ OptEnableForwardCompensation + +

+ +

Enables or disables forward compensation during optimization.

+
+
+ +
+ 
[JsAce]
+public bool OptEnableForwardCompensation { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ OptEnableInterpolation + +

+ +

Enables or disables reinterpolation for optimization.

+
+
+ +
+ 
[JsAce]
+public bool OptEnableInterpolation { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ OptEnableSideCompensation + +

+ +

Enables or disables side compensation during optimization.

+
+
+ +
+ 
[JsAce]
+public bool OptEnableSideCompensation { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ OptExtendedPostDistance_mm + +

+ +

Gets or sets the extended post-distance in millimeters for NC optimization. +This is the distance after the current segment that will be considered for optimization.

+
+
+ +
+ 
[JsAce]
+public double OptExtendedPostDistance_mm { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptExtendedPreDistance_mm + +

+ +

Gets or sets the extended pre-distance in millimeters for NC optimization. +This is the distance before the current segment that will be considered for optimization.

+
+
+ +
+ 
[JsAce]
+public double OptExtendedPreDistance_mm { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptMaxAcceleration_mmds2 + +

+ +

Maximum acceleration in mm/s² during optimization. Only takes effect on reinterpolated section.

+
+
+ +
+ 
[JsAce(DocContentHtml = "Only take effect on reinterpolated section.")]
+public double OptMaxAcceleration_mmds2 { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptMaxFeedrate_mmdmin + +

+ +

Maximum feed rate in mm/min for cutting movements during optimization.

+
+
+ +
+ 
[JsAce]
+public double OptMaxFeedrate_mmdmin { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptMaxJerk_mmds3 + +

+ +

Maximum jerk in mm/s³ during optimization. Only takes effect on reinterpolated section.

+
+
+ +
+ 
[JsAce(DocContentHtml = "Only take effect on reinterpolated section.")]
+public double OptMaxJerk_mmds3 { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptMinFeedrate_mmdmin + +

+ +

Minimum feed rate in mm/min for cutting movements during optimization.

+
+
+ +
+ 
[JsAce]
+public double OptMinFeedrate_mmdmin { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptPreferedForce_N + +

+ +

Preferred force in N for optimization.

+
+
+ +
+ 
[JsAce]
+public double OptPreferedForce_N { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptRapidFeed_mmdmin + +

+ +

Rapid feed rate in mm/min for non-cutting movements during optimization.

+
+
+ +
+ 
[JsAce]
+public double OptRapidFeed_mmdmin { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptSpindlePowerSafetyFactor + +

+ +

Safety factor for spindle power during optimization.

+
+
+ +
+ 
[JsAce]
+public double OptSpindlePowerSafetyFactor { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ OptSpindleTorqueSafetyFactor + +

+ +

Safety factor for spindle torque during optimization.

+
+
+ +
+ 
[JsAce]
+public double OptSpindleTorqueSafetyFactor { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ ParaTemplateDimension + +

+ +
+
+ +
+ 
[JsAce]
+public int ParaTemplateDimension { get; set; }
+
+ + + + + +

Property Value

+
+
int
+
+
+ + + + + + + + + + +

+ ScriptOptions + +

+ +

ScriptOptions.

+
+
+ +
+ 
public ScriptOptions ScriptOptions { get; set; }
+
+ + + + + +

Property Value

+
+
ScriptOptions
+
+
+ + + + + + + + + + +

+ StepCount + +

+ +

Gets the total number of milling steps.

+
+
+ +
+ 
[JsAce]
+public int StepCount { get; }
+
+ + + + + +

Property Value

+
+
int
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ AddTimeDataByFile(string, string, double, double) + +

+ +

Adds time-based data from a file to the time mapping dictionary with specified time bounds in seconds.

+
+
+ +
+ 
[JsAce("AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)")]
+[NonAction]
+public bool AddTimeDataByFile(string key, string relFile, double beginTime, double endTime)
+
+ +

Parameters

+
+
key string
+

Key to identify the data

+
+
relFile string
+

Relative path to the data file

+
+
beginTime double
+

Beginning time in seconds

+
+
endTime double
+

Ending time in seconds

+
+
+ +

Returns

+
+
bool
+

True if the data was successfully added, false otherwise

+
+
+ + + + + + + + + + + + + +

+ AddTimeDataByFile(string, string, string, string) + +

+ +

Adds time-based data from a file to the time mapping dictionary with specified time bounds.

+
+
+ +
+ 
[JsAce("AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)")]
+[HttpPost]
+public bool AddTimeDataByFile(string key, string relFile, string beginTimeText, string endTimeText)
+
+ +

Parameters

+
+
key string
+

Key to identify the data

+
+
relFile string
+

Relative path to the data file

+
+
beginTimeText string
+

Beginning time as text (seconds or TimeSpan format)

+
+
endTimeText string
+

Ending time as text (seconds or TimeSpan format)

+
+
+ +

Returns

+
+
bool
+

True if the data was successfully added, false otherwise

+
+
+ + + + + + + + + + + + + +

+ AppendMessagesToFile(string, params string[]) + +

+ +

Appends messages to a file, optionally filtered by tags.

+
+
+ +
+ 
[JsAce("AppendMessagesToFile(\"dstRelFile\",flags)")]
+[HttpPost]
+public void AppendMessagesToFile(string dstRelFile, params string[] flags)
+
+ +

Parameters

+
+
dstRelFile string
+

Destination relative file path

+
+
flags string[]
+

Optional flags to filter messages by tags

+
+
+ + + + + + + + + + + + + + +

+ BeginPreserve() + +

+ +

Begin Preserve section in optimzation process.

+
+
+ +
+ 
[JsAce("BeginPreserve()")]
+[HttpPost]
+public void BeginPreserve()
+
+ + + + + + + + + + + + + + + +

+ BeginSelection(string, AnchorMode, IStepShift) + +

+ +

Begin mark on current line. +milling step() has not triggered yet.

+
+
+ +
+ 
[NonAction]
+public void BeginSelection(string key, AnchorMode anchorMode = AnchorMode.LineBegin, IStepShift shift = null)
+
+ +

Parameters

+
+
key string
+

Identifier key for the selection

+
+
anchorMode AnchorMode
+

Mode for anchoring the beginning of selection

+
+
shift IStepShift
+

Step shift to apply

+
+
+ + + + + + + + + + + + + + +

+ BeginSession() + +

+ +
+
+ +
+ 
[HttpPost]
+public void BeginSession()
+
+ + + + + + + + + + + + + + + +

+ ClearTimeMappingData() + +

+ +

Clears all time mapping data.

+
+
+ +
+ 
[JsAce]
+[HttpPost]
+public void ClearTimeMappingData()
+
+ + + + + + + + + + + + + + + +

+ Diff(double) + +

+ +

Performs a difference analysis on the workpiece geometry to detect variations.

+
+
+ +
+ 
[JsAce("Diff($1detectionRadius_mm)")]
+[HttpPost]
+public void Diff(double detectionRadius_mm)
+
+ +

Parameters

+
+
detectionRadius_mm double
+

Radius for detecting differences

+
+
+ + + + + + + + + + + + + + +

+ EndPreserve() + +

+ +

End Preserve section in optimzation process.

+
+
+ +
+ 
[JsAce("EndPreserve()")]
+[HttpPost]
+public void EndPreserve()
+
+ + + + + + + + + + + + + + + +

+ EndSelection(string, AnchorMode, IStepShift) + +

+ +

End mark on current line for selection.

+
+
+ +
+ 
[NonAction]
+public void EndSelection(string key, AnchorMode anchorMode = AnchorMode.LineEnd, IStepShift shift = null)
+
+ +

Parameters

+
+
key string
+

Identifier key for the selection

+
+
anchorMode AnchorMode
+

Mode for anchoring the end of selection

+
+
shift IStepShift
+

Step shift to apply

+
+
+ + + + + + + + + + + + + + +

+ EndSession() + +

+ +
+
+ +
+ 
[HttpPost]
+public void EndSession()
+
+ + + + + + + + + + + + + + + +

+ ErrorMessage(string) + +

+ +

Displays an error message in the message host.

+
+
+ +
+ 
[JsAce("ErrorMessage($1message)")]
+[HttpPost]
+public void ErrorMessage(string message)
+
+ +

Parameters

+
+
message string
+

The error message to display

+
+
+ + + + + + + + + + + + + + +

+ FixedPace(double, double) + +

+ +

Creates a fixed machining motion resolution with specified parameters.

+
+
+ +
+ 
[JsAce("FixedPace($1linearResolution_mm, $2rotaryResolution_deg)")]
+[NonAction]
+public FixedMachiningMotionResolution FixedPace(double linearResolution_mm, double rotaryResolution_deg)
+
+ +

Parameters

+
+
linearResolution_mm double
+

Linear resolution in millimeters

+
+
rotaryResolution_deg double
+

Rotary resolution in degrees

+
+
+ +

Returns

+
+
FixedMachiningMotionResolution
+

A new fixed machining motion resolution instance

+
+
+ + + + + + + + + + + + + +

+ GetMillingStep(int) + +

+ +

Retrieves a milling step at the specified index.

+
+
+ +
+ 
[JsAce(Snippet = "GetMillingStep($1\"stepIndex\")")]
+[NonAction]
+public MachiningStep GetMillingStep(int stepIndex)
+
+ +

Parameters

+
+
stepIndex int
+

Index of the milling step to retrieve

+
+
+ +

Returns

+
+
MachiningStep
+

The milling step at the specified index

+
+
+ + + + + + + + + + + + + +

+ GetStickMachiningToolObservationHeight_mm(int) + +

+ +

Gets the observation height in millimeters for the specified stick machining tool.

+
+
+ +
+ 
[JsAce("GetStickMachiningToolObservationHeight_mm($1toolId)")]
+public double GetStickMachiningToolObservationHeight_mm(int toolId)
+
+ +

Parameters

+
+
toolId int
+

The ID of the tool

+
+
+ +

Returns

+
+
double
+

The observation height in millimeters

+
+
+ + + + + + + + + + + + + +

+ GetUniformContourTrayShiftAngle_deg(int) + +

+ +

Gets the shift angle in degrees for the uniform contour tray of the specified tool.

+
+
+ +
+ 
[JsAce("GetUniformContourTrayShiftAngle_deg($1toolId)")]
+[HttpGet]
+public double GetUniformContourTrayShiftAngle_deg(int toolId)
+
+ +

Parameters

+
+
toolId int
+

The ID of the tool

+
+
+ +

Returns

+
+
double
+

The shift angle in degrees

+
+
+ + + + + + + + + + + + + +

+ LineSelection(string, AnchorMode, IStepShift, AnchorMode, IStepShift) + +

+ +

Create a line selection from begin to end mark.

+
+
+ +
+ 
[NonAction]
+public void LineSelection(string key, AnchorMode beginAnchorMode = AnchorMode.LineBegin, IStepShift beginShift = null, AnchorMode endAnchorMode = AnchorMode.LineEnd, IStepShift endShift = null)
+
+ +

Parameters

+
+
key string
+

Identifier key for the selection

+
+
beginAnchorMode AnchorMode
+

Mode for anchoring the beginning of selection

+
+
beginShift IStepShift
+

Step shift to apply at beginning

+
+
endAnchorMode AnchorMode
+

Mode for anchoring the end of selection

+
+
endShift IStepShift
+

Step shift to apply at end

+
+
+ + + + + + + + + + + + + + +

+ Map(string, FileTimeSection, CycleSamplingMode?) + +

+ +

Maps selection data to time section.

+
+
+ +
+ 
[HttpPost]
+public Task Map(string key, FileTimeSection fileTimeSection = null, StepTimeShotUtil.CycleSamplingMode? cycleSamplingMode = CycleSamplingMode.SpindleCycle)
+
+ +

Parameters

+
+
key string
+

Identifier key for the selection

+
+
fileTimeSection FileTimeSection
+

File time section, or null to use the one associated with the key

+
+
cycleSamplingMode StepTimeShotUtil.CycleSamplingMode?
+

Cycle sampling mode

+
+
+ +

Returns

+
+
Task
+

Task representing the asynchronous mapping operation

+
+
+ + + + + + + + + + + + + +

+ Message(string) + +

+ +

Displays a message in the message host.

+
+
+ +
+ 
[JsAce("Message($1message)")]
+[HttpPost]
+public void Message(string message)
+
+ +

Parameters

+
+
message string
+

The message to display

+
+
+ + + + + + + + + + + + + + +

+ OptimizeToFiles(string) + +

+ +

Optimizes NC files and saves results using the specified file template.

+
+
+ +
+ 
[JsAce(Snippet = "OptimizeToFiles(\"Output/Opt-[NcName]\")", DocContentHtml = "Optimize To Files by substitude template keywoard \"[NcName]\"")]
+[HttpPost]
+public void OptimizeToFiles(string relFileTemplate = "Output/Opt-[NcName]")
+
+ +

Parameters

+
+
relFileTemplate string
+

Template for output file path, can include [NcName] placeholder

+
+
+ + + + + + + + + + + + + + +

+ Pace() + +

+ +

Controls the pace of machining operations during execution.

+
+
+ +
+ 
[JsAce("Pace();")]
+[HttpPost]
+public void Pace()
+
+ + + + + + + + + + + + + + + +

+ Pause() + +

+ +

Pause Player

+
+
+ +
+ 
[JsAce(DocContentHtml = "Pause Player")]
+public void Pause()
+
+ + + + + + + + + + + + + + + +

+ PlayAct(IAct, ISourceCommand, CancellationToken?) + +

+ +
+
+ +
+ 
[JsAce]
+[NonAction]
+public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null)
+
+ +

Parameters

+
+
act IAct
+
+
sourceCommand ISourceCommand
+
+
cancellationToken CancellationToken?
+
+
+ + + + + + + + + + + + + + +

+ PlayClTeleport(double, double, double, double, double, double) + +

+ +
+
+ +
+ 
[JsAce]
+[HttpPost]
+public void PlayClTeleport(double x, double y, double z, double i, double j, double k)
+
+ +

Parameters

+
+
x double
+
+
y double
+
+
z double
+
+
i double
+
+
j double
+
+
k double
+
+
+ + + + + + + + + + + + + + +

+ PlayNc(string, string) + +

+ +

Plays NC code directly from a string, executing each action and pacing between them.

+
+
+ +
+ 
[JsAce(Snippet = "PlayNc($1\"ncCommand\",$2\"\"(Direct Command)\"\");", DocContentHtml = "Play NC. second parameter is the file name alternative shows in the log.")]
+[HttpPost]
+public void PlayNc(string ncText, string fileNameAlternative = "--")
+
+ +

Parameters

+
+
ncText string
+

NC code as a string

+
+
fileNameAlternative string
+

Alternative name to display in logs

+
+
+ + + + + + + + + + + + + + +

+ PlayNcFile(string) + +

+ +

Plays an NC file with the specified relative path.

+
+
+ +
+ 
[JsAce("PlayNcFile($1\"ncFile\");")]
+[HttpPost]
+public void PlayNcFile(string relNcFilePath)
+
+ +

Parameters

+
+
relNcFilePath string
+

Relative path to the NC file

+
+
+ + + + + + + + + + + + + + +

+ PlayToolingTeleport(int) + +

+ +
+
+ +
+ 
[JsAce]
+[HttpPost]
+public void PlayToolingTeleport(int toolId)
+
+ +

Parameters

+
+
toolId int
+
+
+ + + + + + + + + + + + + + +

+ Preserve() + +

+ +

Preserve one line NC code in optimzation process.

+
+
+ +
+ 
[JsAce("Preserve()")]
+[HttpPost]
+public void Preserve()
+
+ + + + + + + + + + + + + + + +

+ ProgressMessage(string) + +

+ +

Displays a progress message in the message host.

+
+
+ +
+ 
[JsAce("ProgressMessage($1message)")]
+[HttpPost]
+public void ProgressMessage(string message)
+
+ +

Parameters

+
+
message string
+

The progress message to display

+
+
+ + + + + + + + + + + + + + +

+ ReTrainMillingPara(SampleFlag, string, double) + +

+ +

Re-trains milling parameters using the specified sample flag.

+
+
+ +
+ 
[JsAce("ReTrainMillingPara(Fx|Fy|Fz, $1dstFile)")]
+[HttpPost]
+public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2)
+
+ +

Parameters

+
+
sampleFlag SampleFlag
+

Sample flag indicating which components to train

+
+
dstRelFile string
+

Destination relative file path

+
+
outlierRatio double
+

Outlier ratio for data filtering

+
+
+ + + + + + + + + + + + + + +

+ ReadCsvByTimeInterpolation(string) + +

+ +

Reads a CSV file and performs time-based interpolation to map data to milling steps.

+
+
+ +
+ 
[JsAce(Snippet = "ReadCsvByTimeInterpolation($1\"csvFile\")")]
+public void ReadCsvByTimeInterpolation(string csvFile)
+
+ +

Parameters

+
+
csvFile string
+

Path to the CSV file relative to the base directory

+
+
+ + + + + + + + + + + + + + +

+ ReadRuntimeGeom(string) + +

+ +

Reads runtime geometry from a file.

+
+
+ +
+ 
[JsAce("ReadRuntimeGeom($1\"srcFile\")")]
+[HttpPost]
+public void ReadRuntimeGeom(string relFile)
+
+ +

Parameters

+
+
relFile string
+

Relative path to the input file

+
+
+ + + + + + + + + + + + + + +

+ RegisterStepVariable(string, string, string, string, Func<MachiningStep, object>) + +

+ +

Registers a step variable for tracking during execution.

+
+
+ +
+ 
[JsAce(Snippet = "RegisterStepVariable(\"$1key\",\"$2name\",\"$3unit\",\"$4formatString\",\"$5variableFunc\")", DocContentHtml = "<p>Register Step Variable.</p> <p>\"unit\" is nullable</p> <p>\"formatString\" is nullable</p>")]
+[NonAction]
+public void RegisterStepVariable(string key, string name, string unit, string formatString, Func<MachiningStep, object> variableFunc = null)
+
+ +

Parameters

+
+
key string
+

Unique key to identify the variable

+
+
name string
+

Human-readable name of the variable

+
+
unit string
+

Physical unit of the variable (can be null)

+
+
formatString string
+

Format string for displaying the variable (can be null)

+
+
variableFunc Func<MachiningStep, object>
+

Function to compute the variable value from a milling step (can be null)

+
+
+ + + + + + + + + + + + + + +

+ RemoveFlyPiece() + +

+ +

Removes any disconnected or “flying” pieces from the workpiece geometry.

+
+
+ +
+ 
[JsAce]
+[HttpPost]
+public void RemoveFlyPiece()
+
+ + + + + + + + + + + + + + + +

+ Reset() + +

+ +

Reset Player

+
+
+ +
+ 
[JsAce(DocContentHtml = "Reset Player")]
+public void Reset()
+
+ + + + + + + + + + + + + + + +

+ ResetRuntime() + +

+ +

Clears internal buffers.

+
+
+ +
+ 
[JsAce]
+[HttpPost]
+public void ResetRuntime()
+
+ + + + + + + + + + + + + + + +

+ RunNc(string, string) + +

+ +

Runs NC code directly from a string.

+
+
+ +
+ 
[JsAce(Snippet = "RunNc($1\"ncCommand\",$2\"\"(Direct Command)\"\");", DocContentHtml = "Run NC. second parameter is the file name alternative shows in the log.")]
+[NonAction]
+public IEnumerable<Action> RunNc(string ncText, string fileNameAlternative = "--")
+
+ +

Parameters

+
+
ncText string
+

NC code as a string

+
+
fileNameAlternative string
+

Alternative name to display in logs

+
+
+ +

Returns

+
+
IEnumerable<Action>
+

Enumerable sequence of actions to be executed

+
+
+ + + + + + + + + + + + + +

+ RunNcFile(string) + +

+ +

Runs an NC file with the specified relative path.

+
+
+ +
+ 
[JsAce("RunNcFile($1\"ncFile\");")]
+[NonAction]
+public IEnumerable<Action> RunNcFile(string relNcFilePath)
+
+ +

Parameters

+
+
relNcFilePath string
+

Relative path to the NC file

+
+
+ +

Returns

+
+
IEnumerable<Action>
+

Enumerable sequence of actions to be executed

+
+
+ + + + + + + + + + + + + +

+ SetNcResolutionFeedPerCycle() + +

+ +

Sets NC resolution to feed per cycle mode.

+
+
+ +
+ 
[HttpPost]
+public void SetNcResolutionFeedPerCycle()
+
+ + + + + + + + + + + + + + + +

+ SetNcResolutionFeedPerTooth() + +

+ +

Sets NC resolution to feed per tooth mode.

+
+
+ +
+ 
[HttpPost]
+public void SetNcResolutionFeedPerTooth()
+
+ + + + + + + + + + + + + + + +

+ SetNcResolutionFixed(double, double) + +

+ +

Sets NC resolution to fixed mode with specified resolution values.

+
+
+ +
+ 
[HttpPost]
+public void SetNcResolutionFixed(double linearResolution_mm, double rotaryResolution_deg)
+
+ +

Parameters

+
+
linearResolution_mm double
+

Linear resolution in millimeters.

+
+
rotaryResolution_deg double
+

Rotary resolution in degrees.

+
+
+ + + + + + + + + + + + + + +

+ SetStickMachiningToolObservationHeight_mm(int, double) + +

+ +

Sets the observation height in millimeters for the specified stick machining tool.

+
+
+ +
+ 
[JsAce("SetStickMachiningToolObservationHeight_mm($1toolId,$2height_mm)")]
+public void SetStickMachiningToolObservationHeight_mm(int toolId, double height)
+
+ +

Parameters

+
+
toolId int
+

The ID of the tool

+
+
height double
+

The observation height in millimeters to set

+
+
+ + + + + + + + + + + + + + +

+ SetUniformContourTrayShiftAngle_deg(int, double) + +

+ +

Sets the shift angle in degrees for the uniform contour tray of the specified tool.

+
+
+ +
+ 
[JsAce("SetUniformContourTrayShiftAngle_deg($1toolId,$2angle_deg)")]
+[HttpPost]
+public void SetUniformContourTrayShiftAngle_deg(int toolId, double angle_deg)
+
+ +

Parameters

+
+
toolId int
+

The ID of the tool

+
+
angle_deg double
+

The shift angle in degrees to set

+
+
+ + + + + + + + + + + + + + +

+ ShiftDistance_mm(double) + +

+ +

Creates a distance shift object representing the specified distance in millimeters.

+
+
+ +
+ 
[NonAction]
+public DistanceShift ShiftDistance_mm(double distanceShift_mm)
+
+ +

Parameters

+
+
distanceShift_mm double
+

Distance shift in millimeters

+
+
+ +

Returns

+
+
DistanceShift
+

Distance shift object

+
+
+ + + + + + + + + + + + + +

+ ShiftTime_s(double) + +

+ +

Creates a time shift object representing the specified time in seconds.

+
+
+ +
+ 
[NonAction]
+public TimeShift ShiftTime_s(double seconds)
+
+ +

Parameters

+
+
seconds double
+

Time in seconds

+
+
+ +

Returns

+
+
TimeShift
+

Time shift object

+
+
+ + + + + + + + + + + + + +

+ TrainMillingPara(SampleFlag, string, double) + +

+ +

Trains milling parameters using the specified sample flag.

+
+
+ +
+ 
[JsAce("TrainMillingPara(Fx|Fy|Fz, $1dstFile)")]
+[HttpPost]
+public void TrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2)
+
+ +

Parameters

+
+
sampleFlag SampleFlag
+

Sample flag indicating which components to train

+
+
dstRelFile string
+

Destination relative file path

+
+
outlierRatio double
+

Outlier ratio for data filtering

+
+
+ + + + + + + + + + + + + + +

+ WarningMessage(string) + +

+ +

Displays a warning message in the message host.

+
+
+ +
+ 
[JsAce("WarningMessage($1message)")]
+[HttpPost]
+public void WarningMessage(string message)
+
+ +

Parameters

+
+
message string
+

The warning message to display

+
+
+ + + + + + + + + + + + + + +

+ WriteRuntimeGeom(string) + +

+ +

Writes the current runtime geometry to a file.

+
+
+ +
+ 
[JsAce("WriteRuntimeGeom($1\"dstFile\")")]
+[HttpPost]
+public void WriteRuntimeGeom(string relFile)
+
+ +

Parameters

+
+
relFile string
+

Relative path to the output file

+
+
+ + + + + + + + + + + + + + +

+ WriteRuntimeGeomToStl(string, double) + +

+ +

Writes the current runtime geometry to an STL file.

+
+
+ +
+ 
[JsAce("WriteRuntimeGeomToStl($1\"dstFile\",$2resolution_mm)")]
+[HttpPost]
+public void WriteRuntimeGeomToStl(string relFile, double resolution_mm = 0)
+
+ +

Parameters

+
+
relFile string
+

Relative path to the output STL file

+
+
resolution_mm double
+

Resolution in millimeters (0 for default)

+
+
+ + + + + + + + + + + + + + +

+ WriteShotFiles(double, string) + +

+ +

Writes time-series data to shot files with the specified resolution period (alternative parameter order).

+
+
+ +
+ 
public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate)
+
+ +

Parameters

+
+
resolutionPeroid_ms double
+

Resolution period in milliseconds

+
+
relFileTemplate string
+

Template for output file path, can include [NcName] placeholder

+
+
+ + + + + + + + + + + + + + +

+ WriteShotFiles(string, double) + +

+ +

Writes time-series data to shot files with the specified resolution period.

+
+
+ +
+ 
[JsAce(Snippet = "WriteShotFiles(\"Output/[NcName].shot.csv\",resolutionPeroid_ms)", DocContentHtml = "Write time series data by resolutionPeroid_ms")]
+[HttpPost]
+public void WriteShotFiles(string relFileTemplate = "Output/[NcName].shot.csv", double resolutionPeroid_ms = 1)
+
+ +

Parameters

+
+
relFileTemplate string
+

Template for output file path, can include [NcName] placeholder

+
+
resolutionPeroid_ms double
+

Resolution period in milliseconds

+
+
+ + + + + + + + + + + + + + +

+ WriteStepFiles(string) + +

+ +

Writes step-series data to files with the specified file template.

+
+
+ +
+ 
[JsAce(Snippet = "WriteStepFiles(\"Output/[NcName].step.csv\")", DocContentHtml = "Write step series data.")]
+[HttpPost]
+public void WriteStepFiles(string relFileTemplate = "Output/[NcName].step.csv")
+
+ +

Parameters

+
+
relFileTemplate string
+

Template for output file path, can include [NcName] placeholder

+
+
+ + + + + + + + + + + + +

Events +

+ + + +

+ MachiningStepBuilt + +

+ +

Gets or sets the action to configure steps during execution.

+
+
+ +
+ 
[JsAce(Snippet = "MachiningStepBuilt+=($1preStep,$2curStep)=>{$3Command};", DocContentHtml = "Runtime Step Configuration action. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.")]
+public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt
+
+ + + + + + +

Event Type

+
+
MachiningActRunner.MachiningStepBuiltDelegate
+
+
+ + + + + + + + +

+ MachiningStepSelected + +

+ +

Event that is triggered when a milling step is selected.

+
+
+ +
+ 
[JsAce(Snippet = "MachiningStepSelected+=($1millingStep)=>{$2Command};")]
+public event Action<MachiningStep> MachiningStepSelected
+
+ + + + + + +

Event Type

+
+
Action<MachiningStep>
+
+
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningMessage.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessage.html similarity index 59% rename from App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningMessage.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessage.html index fa7912fc..0cb58368 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.MachiningMessage.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessage.html @@ -2,9 +2,9 @@ - Class MachiningMessage | HiAPI-C# 2025 + Class SessionMessage | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@
-
+
-

-Class MachiningMessage +

+Class SessionMessage

@@ -103,7 +103,7 @@ such as source commands, machining steps, exceptions, and tagged messages.

- 
public class MachiningMessage
+ 
public class SessionMessage
@@ -113,7 +113,7 @@ such as source commands, machining steps, exceptions, and tagged messages.

Inheritance
-
MachiningMessage
+
SessionMessage
@@ -176,19 +176,19 @@ such as source commands, machining steps, exceptions, and tagged messages.

- + -

- MachiningMessage(int, object) +

+ SessionMessage(int, object)

-

Initializes a new instance of the MachiningMessage class.

+

Initializes a new instance of the SessionMessage class.

- 
public MachiningMessage(int index, object src)
+ 
public SessionMessage(int index, object src)

Parameters

@@ -216,15 +216,15 @@ such as source commands, machining steps, exceptions, and tagged messages.

- + -

+

ClStripPos

Gets or sets the cutter location strip position. -gets null if the Data is not ClStripPos.

+gets null if the Data is not ClStripPos.

@@ -249,9 +249,9 @@ gets null if the + -

+

Data

@@ -281,15 +281,48 @@ gets null if the + -

+

+ DirectInstantSourceCommand + +

+ +

Gets or sets the direct source command from the data. +gets null if the Data is not ISourceCommand.

+
+
+ +
+ 
public ISourceCommand DirectInstantSourceCommand { get; set; }
+
+ + + + + +

Property Value

+
+
ISourceCommand
+
+
+ + + + + + + + + + +

Exception

Gets or sets the exception. -gets null if the Data is not Exception.

+gets null if the Data is not Exception.

@@ -314,9 +347,9 @@ gets null if the + -

+

Index

@@ -327,7 +360,8 @@ The UI name is 'Serial.'.

- 
public int Index { get; set; }
+ 
[Present("Message Index", "M.I.", PhysicsUnit.None, "G")]
+public int Index { get; set; }
@@ -347,16 +381,16 @@ The UI name is 'Serial.'.

- + -

+

InstantSourceCommand

Gets the source command, either directly or from the associated milling step. -gets null if both Hi.MachiningProcs.MachiningMessage.DirectInstantSourceCommand and the SourceCommand -from ClStripPos's State are null.

+gets null if both DirectInstantSourceCommand and the SourceCommand +from ClStripPos's State are null.

@@ -370,7 +404,7 @@ from Property Value
-
ISourceCommand
+
ISourceCommand
@@ -381,15 +415,15 @@ from + -

+

MachiningStep

Gets the milling step from the cutter location strip position. -gets null if ClStripPos is null or its State is not a MachiningStep.

+gets null if ClStripPos is null or its State is not a MachiningStep.

@@ -403,7 +437,7 @@ gets null if Property Value
-
MachiningStep
+
MachiningStep
@@ -414,21 +448,22 @@ gets null if + -

+

Message

Gets the message text from either the multi-tag message or exception. -gets null if both MultiTagMessage and Exception are null, -or if MultiTagMessage.Message is null.

+gets null if both MultiTagMessage and Exception are null, +or if MultiTagMessage.Message is null.

- 
public string Message { get; }
+ 
[Present("Message", "Msg", PhysicsUnit.None, "G")]
+public string Message { get; }
@@ -448,21 +483,22 @@ or if + -

+

MessageOrNcText

Gets the message text or NC code text. -gets null if all sources (InstantSourceCommand, MultiTagMessage, -Exception, and Data) are null or cannot provide text.

+gets null if all sources (InstantSourceCommand, MultiTagMessage, +Exception, and Data) are null or cannot provide text.

- 
public string MessageOrNcText { get; }
+ 
[Present("Message/NC", "Msg/NC", PhysicsUnit.None, "G")]
+public string MessageOrNcText { get; }
@@ -482,9 +518,9 @@ gets null if all sources ( + -

+

MessageRoleText

@@ -494,7 +530,8 @@ gets null if all sources (
- 
public string MessageRoleText { get; }
+ 
[Present("Role", "Role", PhysicsUnit.None, "G")]
+public string MessageRoleText { get; }
@@ -514,15 +551,15 @@ gets null if all sources ( + -

+

MultiTagMessage

Gets or sets the multi-tag message. -gets null if the Data is not MultiTagMessage.

+gets null if the Data is not MultiTagMessage.

@@ -547,13 +584,49 @@ gets null if the + +

+ Tags + +

+ +

Gets the tags associated with the message.

+
+
+ +
+ 
public HashSet<string> Tags { get; }
+
+ + + + + +

Property Value

+
+
HashSet<string>
+
+
+ + + + +

Remarks

+

Different from MultiTagMessage.Tags, +the Tags here includes the infomation of the Data.

+
+ + + +

Methods

- + -

+

ToString()

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.FilterFlag.html similarity index 81% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.FilterFlag.html index b1f1cf93..3c5f80ce 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.FilterFlag.html @@ -2,11 +2,11 @@ - Enum StickMachiningTool.CutterAlignmentMode | HiAPI-C# 2025 + Enum SessionMessageHost.FilterFlag | HiAPI-C# 2025 - + + - @@ -84,26 +84,26 @@
-
+
-

-Enum StickMachiningTool.CutterAlignmentMode +

+Enum SessionMessageHost.FilterFlag

-
Namespace
Hi.MillingMech.MillingTools
+
Namespace
Hi.MachiningProcs
Assembly
HiMech.dll
-

Defines the modes for aligning the cutter.

-
+
- 
public enum StickMachiningTool.CutterAlignmentMode
+ 
[Flags]
+public enum SessionMessageHost.FilterFlag
@@ -145,14 +145,18 @@ Enum StickMachiningTool.CutterAlignmentMode

Fields

-
ExposedCutterHeight = 0
+
Error = 8
-

Align based on exposed cutter height.

-
-
PreservedDistanceBetweenFluteAndSpindleNose = 1
+
+
NC = 2
-

Align based on preserved distance between flute and spindle nose.

-
+
+
Progress = 4
+ +
+
Step = 1
+ +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.html index 085ad9e8..0437fe15 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.html @@ -102,7 +102,7 @@ Class SessionMessageHost
- 
public class SessionMessageHost : IMessageHost
+ 
public class SessionMessageHost : IMessageKit
@@ -119,7 +119,7 @@ Class SessionMessageHost
Implements
- +
@@ -184,38 +184,6 @@ Class SessionMessageHost - - -

- IsStableIndexAlwaysAtEnd - -

- -

Gets or sets whether the stable index should always be at the end of the collection.

-
-
- -
- 
public bool IsStableIndexAlwaysAtEnd { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - -

@@ -229,7 +197,7 @@ The getter is for readonly. Do not edit the collection directly.

- 
public SynList<MachiningMessage> MessageCollection { get; }
+ 
public SynList<SessionMessage> MessageCollection { get; }
@@ -238,7 +206,7 @@ The getter is for readonly. Do not edit the collection directly.

Property Value

-
SynList<MachiningMessage>
+
SynList<SessionMessage>
@@ -352,33 +320,32 @@ The term stable means it is thread safe to access range from 0 to StableIndex(ex - + -

- GenAlwaysStableTorch(bool) +

+ GetFliteredList(FilterFlag, string)

-

Generates a new SessionMessageHost.AlwaysStableTorch instance.

-
+
- 
public SessionMessageHost.AlwaysStableTorch GenAlwaysStableTorch(bool isStableIndexAlwaysAtEnd)
+ 
public List<SessionMessage> GetFliteredList(SessionMessageHost.FilterFlag flags, string filterText)

Parameters

-
isStableIndexAlwaysAtEnd bool
-

Whether the index should always be stable.

-
+
flags SessionMessageHost.FilterFlag
+
+
filterText string
+

Returns

-
SessionMessageHost.AlwaysStableTorch
-

A new SessionMessageHost.AlwaysStableTorch instance.

-
+
List<SessionMessage>
+
@@ -393,8 +360,8 @@ The term stable means it is thread safe to access range from 0 to StableIndex(ex -

- GetSourceCommand(MachiningMessage) +

+ GetSourceCommand(SessionMessage)

@@ -403,19 +370,19 @@ The term stable means it is thread safe to access range from 0 to StableIndex(ex
- 
public ISourceCommand GetSourceCommand(MachiningMessage machiningMessage)
+ 
public ISourceCommand GetSourceCommand(SessionMessage machiningMessage)

Parameters

-
machiningMessage MachiningMessage
+
machiningMessage SessionMessage

The machining message to find the source command for.

Returns

-
ISourceCommand
+
ISourceCommand

The source command that generated the message, or null if not found.

@@ -430,66 +397,6 @@ The term stable means it is thread safe to access range from 0 to StableIndex(ex - - -

- PopAlwaysStable() - -

- -

Pops the previous stable index state.

-
-
- -
- 
public void PopAlwaysStable()
-
- - - - - - - - - - - - - - - -

- PushAlwaysStable(bool) - -

- -

Pushes the current stable index state and sets a new state.

-
-
- -
- 
public void PushAlwaysStable(bool isStableIndexAlwaysAtEnd)
-
- -

Parameters

-
-
isStableIndexAlwaysAtEnd bool
-

The new stable index state.

-
-
- - - - - - - - - - - -

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessagePack.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessagePack.html index d64537ac..a787af7a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessagePack.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessagePack.html @@ -174,6 +174,46 @@ Class SessionMessagePack +

Constructors +

+ + + + +

+ SessionMessagePack(SessionMessageHost, SessionMessage) + +

+ +

Initializes a new instance of the SessionMessagePack class.

+
+
+ +
+ 
public SessionMessagePack(SessionMessageHost host, SessionMessage msg)
+
+ +

Parameters

+
+
host SessionMessageHost
+

The session message host.

+
+
msg SessionMessage
+

The machining message.

+
+
+ + + + + + + + + + + +

Properties

@@ -242,38 +282,6 @@ Class SessionMessagePack - - -

- MachiningMessage - -

- -

Gets the machining message contained in this pack.

-
-
- -
- 
public MachiningMessage MachiningMessage { get; }
-
- - - - - -

Property Value

-
-
MachiningMessage
-
-
- - - - - - - -

@@ -306,6 +314,38 @@ Class SessionMessagePack + + +

+ SessionMessage + +

+ +

Gets the machining message contained in this pack.

+
+
+ +
+ 
public SessionMessage SessionMessage { get; }
+
+ + + + + +

Property Value

+
+
SessionMessage
+
+
+ + + + + + + +

@@ -327,7 +367,7 @@ Class SessionMessagePack

Property Value

-
ISourceCommand
+
ISourceCommand
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SetupController.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SetupController.html new file mode 100644 index 00000000..1a5b995f --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SetupController.html @@ -0,0 +1,921 @@ + + + + + Class SetupController | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class SetupController +

+ +
+
Namespace
Hi.MachiningProcs
+
Assembly
HiNc.dll
+
+ +
+
+ +
+ 
[ApiController]
+[Route("api/[controller]/[action]")]
+public class SetupController : ControllerBase
+
+ + + + +
+
Inheritance
+
+ + +
SetupController
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ SetupController(IPathedMachiningProjectHost) + +

+ +
+
+ +
+ 
public SetupController(IPathedMachiningProjectHost pathedMachiningProjectHost)
+
+ +

Parameters

+
+
pathedMachiningProjectHost IPathedMachiningProjectHost
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ InitResolution_mm + +

+ +

InitResolution_mm.

+
+
+ +
+ 
public double InitResolution_mm { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ ApplyClMillingDevice() + +

+ +
+
+ +
+ 
[HttpPost]
+public void ApplyClMillingDevice()
+
+ + + + + + + + + + + + + + + +

+ LoadFixture(string) + +

+ +
+
+ +
+ 
[HttpPost]
+public void LoadFixture(string fixtureXmlFilePath)
+
+ +

Parameters

+
+
fixtureXmlFilePath string
+
+
+ + + + + + + + + + + + + + +

+ LoadProject(string) + +

+ +
+
+ +
+ 
[HttpPost]
+public void LoadProject(string filePath)
+
+ +

Parameters

+
+
filePath string
+
+
+ + + + + + + + + + + + + + +

+ SaveProject() + +

+ +
+
+ +
+ 
[HttpPost]
+public void SaveProject()
+
+ + + + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ShellApi.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ShellApi.html deleted file mode 100644 index 74c541cd..00000000 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.ShellApi.html +++ /dev/null @@ -1,3201 +0,0 @@ - - - - - Class ShellApi | HiAPI-C# 2025 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
-
-
-
-
Table of Contents
- -
-
- -
-
-
- -
-
- - - -
- -
- - - -

-Class ShellApi -

- -
-
Namespace
Hi.MachiningProcs
-
Assembly
HiNc.dll
-
- -

Provides a C# scripting API for controlling and manipulating the milling course. -Allows for runtime control of milling operations, geometry manipulation, and data analysis.

-
-
- -
- 
public class ShellApi : ICsScriptApi
-
- - - - -
-
Inheritance
-
- -
ShellApi
-
-
- -
-
Implements
-
- -
-
- - -
-
Inherited Members
-
- - - - - - - -
- -
-
Extension Methods
-
- - - - - - - -
- - - - - -

Constructors -

- - - - -

- ShellApi(MachiningProject) - -

- -

Initializes a new instance of the ShellApi class.

-
-
- -
- 
public ShellApi(MachiningProject machiningProject)
-
- -

Parameters

-
-
machiningProject MachiningProject
-

The milling course this API will interact with

-
-
- - - - - - - - - - - - -

Properties -

- - - - -

- DiffVisualRadius_mm - -

- -

Gets or sets the visual radius in millimeters for difference visualization. -Controls the radius used for highlighting differences between workpiece states.

-
-
- -
- 
[JsAce]
-public double DiffVisualRadius_mm { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- DispCacheMb - -

- -

Gets or sets the display cache size in megabytes.

-
-
- -
- 
public long DispCacheMb { get; set; }
-
- - - - - -

Property Value

-
-
long
-
-
- - - - - - - - - - -

- DispCache_Mb - -

- -

Gets or sets the display cache size in megabytes.

-
-
- -
- 
[JsAce]
-public long DispCache_Mb { get; set; }
-
- - - - - -

Property Value

-
-
long
-
-
- - - - - - - - - - -

- EnableAutoMapOnSelectionEnd - -

- -

Gets or sets whether to automatically map selections when they end.

-
-
- -
- 
[JsAce]
-public bool EnableAutoMapOnSelectionEnd { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- EnableCollisionDetection - -

- -

Gets or sets whether collision detection is enabled.

-
-
- -
- 
[JsAce(DocContentHtml = "Enable Collision Detection.")]
-public bool EnableCollisionDetection { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- EnableMillingForceEvaluation - -

- -

Gets or sets whether milling force evaluation is enabled.

-
-
- -
- 
[JsAce(DocContentHtml = "Enable Milling Force Evaluation.")]
-public bool EnableMillingForceEvaluation { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- EnablePauseOnCollision - -

- -

Gets or sets whether to pause execution when a collision is detected. -This property only has an effect if collision detection is enabled.

-
-
- -
- 
[JsAce(DocContentHtml = "Enable Pause On Collision. This property works only if Collision Detection is enabled.")]
-public bool EnablePauseOnCollision { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- EnableWearEffect - -

- -

Gets or sets whether tool wear effects are enabled in simulation.

-
-
- -
- 
[JsAce]
-public bool EnableWearEffect { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- FeedPerCycle - -

- -

Gets a new feed per cycle machining motion resolution instance.

-
-
- -
- 
[JsAce]
-public FeedPerCycleMachiningMotionResolution FeedPerCycle { get; }
-
- - - - - -

Property Value

-
-
FeedPerCycleMachiningMotionResolution
-
-
- - - - - - - - - - -

- FeedPerTooth - -

- -

Gets a new feed per tooth machining motion resolution instance.

-
-
- -
- 
[JsAce]
-public FeedPerToothMachiningMotionResolution FeedPerTooth { get; }
-
- - - - - -

Property Value

-
-
FeedPerToothMachiningMotionResolution
-
-
- - - - - - - - - - -

- Global - -

- -

Global variables.

-
-
- -
- 
[JsAce("Global[$1key]")]
-public Dictionary<object, object> Global { get; }
-
- - - - - -

Property Value

-
-
Dictionary<object, object>
-
-
- - - - - - - - - - -

- InitSpindleTemperature_C - -

- -

Gets or sets the initial spindle temperature in degrees Celsius.

-
-
- -
- 
[JsAce(DocContentHtml = "Spindle Temperature on initialization.")]
-public double InitSpindleTemperature_C { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- JsAceCompletionProfileJsonArray - -

- -

Internal used.

-
-
- -
- 
public static JsonArray JsAceCompletionProfileJsonArray { get; }
-
- - - - - -

Property Value

-
-
JsonArray
-
-
- - - - - - - - - - -

- MachiningMotionResolution - -

- -

Gets or sets the machining motion resolution.

-
-
- -
- 
[JsAce]
-public IMachiningMotionResolution MachiningMotionResolution { get; set; }
-
- - - - - -

Property Value

-
-
IMachiningMotionResolution
-
-
- - - - - - - - - - -

- MachiningResolution - -

- -

Gets or sets the machining resolution in millimeters. -For legacy compatable.

-
-
- -
- 
[JsAce]
-[Obsolete]
-public double MachiningResolution { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- MachiningResolution_mm - -

- -

Gets or sets the machining resolution in millimeters.

-
-
- -
- 
[JsAce]
-public double MachiningResolution_mm { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- MachiningSession - -

- -
-
- -
- 
public MachiningSession MachiningSession { get; }
-
- - - - - -

Property Value

-
-
MachiningSession
-
-
- - - - - - - - - - -

- MapTask - -

- -

Task tracking the status of mapping operations.

-
-
- -
- 
public Task MapTask { get; set; }
-
- - - - - -

Property Value

-
-
Task
-
-
- - - - - - - - - - -

- MillingForceCycleDivisionNum - -

- -

Gets or sets the number of divisions per cycle for milling force calculation. -This property should be set before milling force evaluation if TrainMillingPara(SampleFlag, string, double) is intended to be used.

-
-
- -
- 
[JsAce]
-public static int MillingForceCycleDivisionNum { get; set; }
-
- - - - - -

Property Value

-
-
int
-
-
- - - - - - - - - - -

- OptEnableDepthCompensation - -

- -

Enables or disables depth compensation during optimization.

-
-
- -
- 
[JsAce]
-public bool OptEnableDepthCompensation { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- OptEnableFeedrate - -

- -

Gets or sets whether to enable feed rate optimization in NC optimization.

-
-
- -
- 
[JsAce]
-public bool OptEnableFeedrate { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- OptEnableForwardCompensation - -

- -

Enables or disables forward compensation during optimization.

-
-
- -
- 
[JsAce]
-public bool OptEnableForwardCompensation { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- OptEnableInterpolation - -

- -

Enables or disables reinterpolation for optimization.

-
-
- -
- 
[JsAce]
-public bool OptEnableInterpolation { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- OptEnableSideCompensation - -

- -

Enables or disables side compensation during optimization.

-
-
- -
- 
[JsAce]
-public bool OptEnableSideCompensation { get; set; }
-
- - - - - -

Property Value

-
-
bool
-
-
- - - - - - - - - - -

- OptExtendedPostDistance_mm - -

- -

Gets or sets the extended post-distance in millimeters for NC optimization. -This is the distance after the current segment that will be considered for optimization.

-
-
- -
- 
[JsAce]
-public double OptExtendedPostDistance_mm { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptExtendedPreDistance_mm - -

- -

Gets or sets the extended pre-distance in millimeters for NC optimization. -This is the distance before the current segment that will be considered for optimization.

-
-
- -
- 
[JsAce]
-public double OptExtendedPreDistance_mm { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptMaxAcceleration_mmds2 - -

- -

Maximum acceleration in mm/s² during optimization. Only takes effect on reinterpolated section.

-
-
- -
- 
[JsAce(DocContentHtml = "Only take effect on reinterpolated section.")]
-public double OptMaxAcceleration_mmds2 { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptMaxFeedrate_mmdmin - -

- -

Maximum feed rate in mm/min for cutting movements during optimization.

-
-
- -
- 
[JsAce]
-public double OptMaxFeedrate_mmdmin { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptMaxJerk_mmds3 - -

- -

Maximum jerk in mm/s³ during optimization. Only takes effect on reinterpolated section.

-
-
- -
- 
[JsAce(DocContentHtml = "Only take effect on reinterpolated section.")]
-public double OptMaxJerk_mmds3 { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptMinFeedrate_mmdmin - -

- -

Minimum feed rate in mm/min for cutting movements during optimization.

-
-
- -
- 
[JsAce]
-public double OptMinFeedrate_mmdmin { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptPreferedForce_N - -

- -

Preferred force in N for optimization.

-
-
- -
- 
[JsAce]
-public double OptPreferedForce_N { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptRapidFeed_mmdmin - -

- -

Rapid feed rate in mm/min for non-cutting movements during optimization.

-
-
- -
- 
[JsAce]
-public double OptRapidFeed_mmdmin { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptSpindlePowerSafetyFactor - -

- -

Safety factor for spindle power during optimization.

-
-
- -
- 
[JsAce]
-public double OptSpindlePowerSafetyFactor { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- OptSpindleTorqueSafetyFactor - -

- -

Safety factor for spindle torque during optimization.

-
-
- -
- 
[JsAce]
-public double OptSpindleTorqueSafetyFactor { get; set; }
-
- - - - - -

Property Value

-
-
double
-
-
- - - - - - - - - - -

- ScriptOptions - -

- -

ScriptOptions.

-
-
- -
- 
public ScriptOptions ScriptOptions { get; set; }
-
- - - - - -

Property Value

-
-
ScriptOptions
-
-
- - - - - - - - - - -

- StepCount - -

- -

Gets the total number of milling steps.

-
-
- -
- 
[JsAce]
-public int StepCount { get; }
-
- - - - - -

Property Value

-
-
int
-
-
- - - - - - - - -

Methods -

- - - - -

- AddTimeDataByFile(string, string, double, double) - -

- -

Adds time-based data from a file to the time mapping dictionary with specified time bounds in seconds.

-
-
- -
- 
[JsAce("AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)")]
-public bool AddTimeDataByFile(string key, string relFile, double beginTime, double endTime)
-
- -

Parameters

-
-
key string
-

Key to identify the data

-
-
relFile string
-

Relative path to the data file

-
-
beginTime double
-

Beginning time in seconds

-
-
endTime double
-

Ending time in seconds

-
-
- -

Returns

-
-
bool
-

True if the data was successfully added, false otherwise

-
-
- - - - - - - - - - - - - -

- AddTimeDataByFile(string, string, string, string) - -

- -

Adds time-based data from a file to the time mapping dictionary with specified time bounds.

-
-
- -
- 
[JsAce("AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)")]
-public bool AddTimeDataByFile(string key, string relFile, string beginTimeText, string endTimeText)
-
- -

Parameters

-
-
key string
-

Key to identify the data

-
-
relFile string
-

Relative path to the data file

-
-
beginTimeText string
-

Beginning time as text (seconds or TimeSpan format)

-
-
endTimeText string
-

Ending time as text (seconds or TimeSpan format)

-
-
- -

Returns

-
-
bool
-

True if the data was successfully added, false otherwise

-
-
- - - - - - - - - - - - - -

- AppendMessagesToFile(string, params string[]) - -

- -

Appends messages to a file, optionally filtered by tags.

-
-
- -
- 
[JsAce("AppendMessagesToFile(\"dstRelFile\",flags)")]
-public void AppendMessagesToFile(string dstRelFile, params string[] flags)
-
- -

Parameters

-
-
dstRelFile string
-

Destination relative file path

-
-
flags string[]
-

Optional flags to filter messages by tags

-
-
- - - - - - - - - - - - - - -

- BeginPreserve() - -

- -

Begin Preserve section in optimzation process.

-
-
- -
- 
[JsAce("BeginPreserve()")]
-public void BeginPreserve()
-
- - - - - - - - - - - - - - - -

- BeginSelection(string, BoundAnchorMode, IStepShift) - -

- -

Begin mark on current line. -milling step() has not triggered yet.

-
-
- -
- 
public void BeginSelection(string key, BoundAnchorMode anchorMode = BoundAnchorMode.LineBegin, IStepShift shift = null)
-
- -

Parameters

-
-
key string
-

Identifier key for the selection

-
-
anchorMode BoundAnchorMode
-

Mode for anchoring the beginning of selection

-
-
shift IStepShift
-

Step shift to apply

-
-
- - - - - - - - - - - - - - -

- ClearTimeMappingData() - -

- -

Clears all time mapping data.

-
-
- -
- 
[JsAce]
-public void ClearTimeMappingData()
-
- - - - - - - - - - - - - - - -

- Diff(double) - -

- -

Performs a difference analysis on the workpiece geometry to detect variations.

-
-
- -
- 
[JsAce("Diff($1detectionRadius_mm)")]
-public void Diff(double detectionRadius_mm)
-
- -

Parameters

-
-
detectionRadius_mm double
-

Radius for detecting differences

-
-
- - - - - - - - - - - - - - -

- EndPreserve() - -

- -

End Preserve section in optimzation process.

-
-
- -
- 
[JsAce("EndPreserve()")]
-public void EndPreserve()
-
- - - - - - - - - - - - - - - -

- EndSelection(string, BoundAnchorMode, IStepShift) - -

- -

End mark on current line for selection.

-
-
- -
- 
public void EndSelection(string key, BoundAnchorMode anchorMode = BoundAnchorMode.LineEnd, IStepShift shift = null)
-
- -

Parameters

-
-
key string
-

Identifier key for the selection

-
-
anchorMode BoundAnchorMode
-

Mode for anchoring the end of selection

-
-
shift IStepShift
-

Step shift to apply

-
-
- - - - - - - - - - - - - - -

- ErrorMessage(string) - -

- -

Displays an error message in the message host.

-
-
- -
- 
[JsAce("ErrorMessage($1message)")]
-public void ErrorMessage(string message)
-
- -

Parameters

-
-
message string
-

The error message to display

-
-
- - - - - - - - - - - - - - -

- FixedPace(double, double) - -

- -

Creates a fixed machining motion resolution with specified parameters.

-
-
- -
- 
[JsAce("FixedPace($1linearResolution_mm, $2rotaryResolution_deg)")]
-public FixedMachiningMotionResolution FixedPace(double linearResolution_mm, double rotaryResolution_deg)
-
- -

Parameters

-
-
linearResolution_mm double
-

Linear resolution in millimeters

-
-
rotaryResolution_deg double
-

Rotary resolution in degrees

-
-
- -

Returns

-
-
FixedMachiningMotionResolution
-

A new fixed machining motion resolution instance

-
-
- - - - - - - - - - - - - -

- GetMillingStep(int) - -

- -

Retrieves a milling step at the specified index.

-
-
- -
- 
[JsAce(Snippet = "GetMillingStep($1\"stepIndex\")")]
-public MachiningStep GetMillingStep(int stepIndex)
-
- -

Parameters

-
-
stepIndex int
-

Index of the milling step to retrieve

-
-
- -

Returns

-
-
MachiningStep
-

The milling step at the specified index

-
-
- - - - - - - - - - - - - -

- GetStickMachiningToolObservationHeight_mm(int) - -

- -

Gets the observation height in millimeters for the specified stick machining tool.

-
-
- -
- 
[JsAce("GetStickMachiningToolObservationHeight_mm($1toolId)")]
-public double GetStickMachiningToolObservationHeight_mm(int toolId)
-
- -

Parameters

-
-
toolId int
-

The ID of the tool

-
-
- -

Returns

-
-
double
-

The observation height in millimeters

-
-
- - - - - - - - - - - - - -

- GetUniformContourTrayShiftAngle_deg(int) - -

- -

Gets the shift angle in degrees for the uniform contour tray of the specified tool.

-
-
- -
- 
[JsAce("GetUniformContourTrayShiftAngle_deg($1toolId)")]
-public double GetUniformContourTrayShiftAngle_deg(int toolId)
-
- -

Parameters

-
-
toolId int
-

The ID of the tool

-
-
- -

Returns

-
-
double
-

The shift angle in degrees

-
-
- - - - - - - - - - - - - -

- LineSelection(string, BoundAnchorMode, IStepShift, BoundAnchorMode, IStepShift) - -

- -

Create a line selection from begin to end mark.

-
-
- -
- 
public void LineSelection(string key, BoundAnchorMode beginAnchorMode = BoundAnchorMode.LineBegin, IStepShift beginShift = null, BoundAnchorMode endAnchorMode = BoundAnchorMode.LineEnd, IStepShift endShift = null)
-
- -

Parameters

-
-
key string
-

Identifier key for the selection

-
-
beginAnchorMode BoundAnchorMode
-

Mode for anchoring the beginning of selection

-
-
beginShift IStepShift
-

Step shift to apply at beginning

-
-
endAnchorMode BoundAnchorMode
-

Mode for anchoring the end of selection

-
-
endShift IStepShift
-

Step shift to apply at end

-
-
- - - - - - - - - - - - - - -

- Map(string, FileTimeSection, CycleSamplingMode?) - -

- -

Maps selection data to time section.

-
-
- -
- 
public Task Map(string key, FileTimeSection fileTimeSection = null, StepTimeShotUtil.CycleSamplingMode? cycleSamplingMode = CycleSamplingMode.SpindleCycle)
-
- -

Parameters

-
-
key string
-

Identifier key for the selection

-
-
fileTimeSection FileTimeSection
-

File time section, or null to use the one associated with the key

-
-
cycleSamplingMode StepTimeShotUtil.CycleSamplingMode?
-

Cycle sampling mode

-
-
- -

Returns

-
-
Task
-

Task representing the asynchronous mapping operation

-
-
- - - - - - - - - - - - - -

- Message(string) - -

- -

Displays a message in the message host.

-
-
- -
- 
[JsAce("Message($1message)")]
-public void Message(string message)
-
- -

Parameters

-
-
message string
-

The message to display

-
-
- - - - - - - - - - - - - - -

- OptimizeToFiles(string) - -

- -

Optimizes NC files and saves results using the specified file template.

-
-
- -
- 
[JsAce(Snippet = "OptimizeToFiles(\"Output/Opt-[NcName]\")", DocContentHtml = "Optimize To Files by substitude template keywoard \"[NcName]\"")]
-public void OptimizeToFiles(string relFileTemplate = "Output/Opt-[NcName]")
-
- -

Parameters

-
-
relFileTemplate string
-

Template for output file path, can include [NcName] placeholder

-
-
- - - - - - - - - - - - - - -

- Pace() - -

- -

Controls the pace of machining operations during execution.

-
-
- -
- 
[JsAce("Pace();")]
-public void Pace()
-
- - - - - - - - - - - - - - - -

- Pause() - -

- -

Pause Player

-
-
- -
- 
[JsAce(DocContentHtml = "Pause Player")]
-public void Pause()
-
- - - - - - - - - - - - - - - -

- PlayNc(string, string) - -

- -

Plays NC code directly from a string, executing each action and pacing between them.

-
-
- -
- 
[JsAce(Snippet = "PlayNc($1\"ncCommand\",$2\"\"(Direct Command)\"\");", DocContentHtml = "Play NC. second parameter is the file name alternative shows in the log.")]
-public void PlayNc(string ncText, string fileNameAlternative = "--")
-
- -

Parameters

-
-
ncText string
-

NC code as a string

-
-
fileNameAlternative string
-

Alternative name to display in logs

-
-
- - - - - - - - - - - - - - -

- PlayNcFile(string) - -

- -

Plays an NC file with the specified relative path.

-
-
- -
- 
[JsAce("PlayNcFile($1\"ncFile\");")]
-public void PlayNcFile(string relNcFilePath)
-
- -

Parameters

-
-
relNcFilePath string
-

Relative path to the NC file

-
-
- - - - - - - - - - - - - - -

- Preserve() - -

- -

Preserve one line NC code in optimzation process.

-
-
- -
- 
[JsAce("Preserve()")]
-public void Preserve()
-
- - - - - - - - - - - - - - - -

- ProgressMessage(string) - -

- -

Displays a progress message in the message host.

-
-
- -
- 
[JsAce("ProgressMessage($1message)")]
-public void ProgressMessage(string message)
-
- -

Parameters

-
-
message string
-

The progress message to display

-
-
- - - - - - - - - - - - - - -

- ReTrainMillingPara(SampleFlag, string, double) - -

- -

Re-trains milling parameters using the specified sample flag.

-
-
- -
- 
[JsAce("ReTrainMillingPara(Fx|Fy|Fz, $1dstFile)")]
-public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2)
-
- -

Parameters

-
-
sampleFlag SampleFlag
-

Sample flag indicating which components to train

-
-
dstRelFile string
-

Destination relative file path

-
-
outlierRatio double
-

Outlier ratio for data filtering

-
-
- - - - - - - - - - - - - - -

- ReadCsvByTimeInterpolation(string) - -

- -

Reads a CSV file and performs time-based interpolation to map data to milling steps.

-
-
- -
- 
[JsAce(Snippet = "ReadCsvByTimeInterpolation($1\"csvFile\")")]
-public void ReadCsvByTimeInterpolation(string csvFile)
-
- -

Parameters

-
-
csvFile string
-

Path to the CSV file relative to the base directory

-
-
- - - - - - - - - - - - - - -

- ReadRuntimeGeom(string) - -

- -

Reads runtime geometry from a file.

-
-
- -
- 
[JsAce("ReadRuntimeGeom($1\"srcFile\")")]
-public void ReadRuntimeGeom(string relFile)
-
- -

Parameters

-
-
relFile string
-

Relative path to the input file

-
-
- - - - - - - - - - - - - - -

- RegisterStepVariable(string, string, string, string, Func<MachiningStep, object>) - -

- -

Registers a step variable for tracking during execution.

-
-
- -
- 
[JsAce(Snippet = "RegisterStepVariable(\"$1key\",\"$2name\",\"$3unit\",\"$4formatString\",\"$5variableFunc\")", DocContentHtml = "<p>Register Step Variable.</p> <p>\"unit\" is nullable</p> <p>\"formatString\" is nullable</p>")]
-public void RegisterStepVariable(string key, string name, string unit, string formatString, Func<MachiningStep, object> variableFunc = null)
-
- -

Parameters

-
-
key string
-

Unique key to identify the variable

-
-
name string
-

Human-readable name of the variable

-
-
unit string
-

Physical unit of the variable (can be null)

-
-
formatString string
-

Format string for displaying the variable (can be null)

-
-
variableFunc Func<MachiningStep, object>
-

Function to compute the variable value from a milling step (can be null)

-
-
- - - - - - - - - - - - - - -

- RemoveFlyPiece() - -

- -

Removes any disconnected or “flying” pieces from the workpiece geometry.

-
-
- -
- 
[JsAce]
-public void RemoveFlyPiece()
-
- - - - - - - - - - - - - - - -

- Reset() - -

- -

Reset Player

-
-
- -
- 
[JsAce(DocContentHtml = "Reset Player")]
-public void Reset()
-
- - - - - - - - - - - - - - - -

- ResetRuntime() - -

- -

Clears internal buffers.

-
-
- -
- 
[JsAce]
-public void ResetRuntime()
-
- - - - - - - - - - - - - - - -

- RunNc(string, string) - -

- -

Runs NC code directly from a string.

-
-
- -
- 
[JsAce(Snippet = "RunNc($1\"ncCommand\",$2\"\"(Direct Command)\"\");", DocContentHtml = "Run NC. second parameter is the file name alternative shows in the log.")]
-public IEnumerable<Action> RunNc(string ncText, string fileNameAlternative = "--")
-
- -

Parameters

-
-
ncText string
-

NC code as a string

-
-
fileNameAlternative string
-

Alternative name to display in logs

-
-
- -

Returns

-
-
IEnumerable<Action>
-

Enumerable sequence of actions to be executed

-
-
- - - - - - - - - - - - - -

- RunNcFile(string) - -

- -

Runs an NC file with the specified relative path.

-
-
- -
- 
[JsAce("RunNcFile($1\"ncFile\");")]
-public IEnumerable<Action> RunNcFile(string relNcFilePath)
-
- -

Parameters

-
-
relNcFilePath string
-

Relative path to the NC file

-
-
- -

Returns

-
-
IEnumerable<Action>
-

Enumerable sequence of actions to be executed

-
-
- - - - - - - - - - - - - -

- SetNcResolutionFeedPerCycle() - -

- -

Sets NC resolution to feed per cycle mode.

-
-
- -
- 
public void SetNcResolutionFeedPerCycle()
-
- - - - - - - - - - - - - - - -

- SetNcResolutionFeedPerTooth() - -

- -

Sets NC resolution to feed per tooth mode.

-
-
- -
- 
public void SetNcResolutionFeedPerTooth()
-
- - - - - - - - - - - - - - - -

- SetNcResolutionFixed(double, double) - -

- -

Sets NC resolution to fixed mode with specified resolution values.

-
-
- -
- 
public void SetNcResolutionFixed(double linearResolution_mm, double rotaryResolution_deg)
-
- -

Parameters

-
-
linearResolution_mm double
-

Linear resolution in millimeters.

-
-
rotaryResolution_deg double
-

Rotary resolution in degrees.

-
-
- - - - - - - - - - - - - - -

- SetStickMachiningToolObservationHeight_mm(int, double) - -

- -

Sets the observation height in millimeters for the specified stick machining tool.

-
-
- -
- 
[JsAce("SetStickMachiningToolObservationHeight_mm($1toolId,$2height_mm)")]
-public void SetStickMachiningToolObservationHeight_mm(int toolId, double height)
-
- -

Parameters

-
-
toolId int
-

The ID of the tool

-
-
height double
-

The observation height in millimeters to set

-
-
- - - - - - - - - - - - - - -

- SetUniformContourTrayShiftAngle_deg(int, double) - -

- -

Sets the shift angle in degrees for the uniform contour tray of the specified tool.

-
-
- -
- 
[JsAce("SetUniformContourTrayShiftAngle_deg($1toolId,$2angle_deg)")]
-public void SetUniformContourTrayShiftAngle_deg(int toolId, double angle_deg)
-
- -

Parameters

-
-
toolId int
-

The ID of the tool

-
-
angle_deg double
-

The shift angle in degrees to set

-
-
- - - - - - - - - - - - - - -

- ShiftDistance_mm(double) - -

- -

Creates a distance shift object representing the specified distance in millimeters.

-
-
- -
- 
public DistanceShift ShiftDistance_mm(double distanceShift_mm)
-
- -

Parameters

-
-
distanceShift_mm double
-

Distance shift in millimeters

-
-
- -

Returns

-
-
DistanceShift
-

Distance shift object

-
-
- - - - - - - - - - - - - -

- ShiftTime_s(double) - -

- -

Creates a time shift object representing the specified time in seconds.

-
-
- -
- 
public TimeShift ShiftTime_s(double seconds)
-
- -

Parameters

-
-
seconds double
-

Time in seconds

-
-
- -

Returns

-
-
TimeShift
-

Time shift object

-
-
- - - - - - - - - - - - - -

- TrainMillingPara(SampleFlag, string, double) - -

- -

Trains milling parameters using the specified sample flag.

-
-
- -
- 
[JsAce("TrainMillingPara(Fx|Fy|Fz, $1dstFile)")]
-public void TrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2)
-
- -

Parameters

-
-
sampleFlag SampleFlag
-

Sample flag indicating which components to train

-
-
dstRelFile string
-

Destination relative file path

-
-
outlierRatio double
-

Outlier ratio for data filtering

-
-
- - - - - - - - - - - - - - -

- WarningMessage(string) - -

- -

Displays a warning message in the message host.

-
-
- -
- 
[JsAce("WarningMessage($1message)")]
-public void WarningMessage(string message)
-
- -

Parameters

-
-
message string
-

The warning message to display

-
-
- - - - - - - - - - - - - - -

- WriteRuntimeGeom(string) - -

- -

Writes the current runtime geometry to a file.

-
-
- -
- 
[JsAce("WriteRuntimeGeom($1\"dstFile\")")]
-public void WriteRuntimeGeom(string relFile)
-
- -

Parameters

-
-
relFile string
-

Relative path to the output file

-
-
- - - - - - - - - - - - - - -

- WriteRuntimeGeomToStl(string, double) - -

- -

Writes the current runtime geometry to an STL file.

-
-
- -
- 
[JsAce("WriteRuntimeGeomToStl($1\"dstFile\",$2resolution_mm)")]
-public void WriteRuntimeGeomToStl(string relFile, double resolution_mm = 0)
-
- -

Parameters

-
-
relFile string
-

Relative path to the output STL file

-
-
resolution_mm double
-

Resolution in millimeters (0 for default)

-
-
- - - - - - - - - - - - - - -

- WriteShotFiles(double, string) - -

- -

Writes time-series data to shot files with the specified resolution period (alternative parameter order).

-
-
- -
- 
public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate)
-
- -

Parameters

-
-
resolutionPeroid_ms double
-

Resolution period in milliseconds

-
-
relFileTemplate string
-

Template for output file path, can include [NcName] placeholder

-
-
- - - - - - - - - - - - - - -

- WriteShotFiles(string, double) - -

- -

Writes time-series data to shot files with the specified resolution period.

-
-
- -
- 
[JsAce(Snippet = "WriteShotFiles(\"Output/[NcName].shot.csv\",resolutionPeroid_ms)", DocContentHtml = "Write time series data by resolutionPeroid_ms")]
-public void WriteShotFiles(string relFileTemplate = "Output/[NcName].shot.csv", double resolutionPeroid_ms = 1)
-
- -

Parameters

-
-
relFileTemplate string
-

Template for output file path, can include [NcName] placeholder

-
-
resolutionPeroid_ms double
-

Resolution period in milliseconds

-
-
- - - - - - - - - - - - - - -

- WriteStepFiles(string) - -

- -

Writes step-series data to files with the specified file template.

-
-
- -
- 
[JsAce(Snippet = "WriteStepFiles(\"Output/[NcName].step.csv\")", DocContentHtml = "Write step series data.")]
-public void WriteStepFiles(string relFileTemplate = "Output/[NcName].step.csv")
-
- -

Parameters

-
-
relFileTemplate string
-

Template for output file path, can include [NcName] placeholder

-
-
- - - - - - - - - - - - -

Events -

- - - -

- MachiningStepBuilt - -

- -

Gets or sets the action to configure steps during execution.

-
-
- -
- 
[JsAce(Snippet = "MachiningStepBuilt+=($1preStep,$2curStep)=>{$3Command};", DocContentHtml = "Runtime Step Configuration action. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.")]
-public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt
-
- - - - - - -

Event Type

-
-
MachiningActRunner.MachiningStepBuiltDelegate
-
-
- - - - - - - - -

- MillingStepSelected - -

- -

Event that is triggered when a milling step is selected.

-
-
- -
- 
[JsAce(Snippet = "MillingStepSelected+=($1millingStep)=>{$2Command};")]
-public event Action<MachiningStep> MillingStepSelected
-
- - - - - - -

Event Type

-
-
Action<MachiningStep>
-
-
- - - - - - - - -
- -
-
- - -
- -
- -
-
- -
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.html index cc7bd98b..243ca10d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.html @@ -102,12 +102,6 @@ Classes
MachiningActRunner

Represents a runner for machining actions that manages milling steps, tool paths, and collision detection.

-
-
-
-
MachiningMessage
-

Represents a message in the machining process that can contain various types of data -such as source commands, machining steps, exceptions, and tagged messages.

@@ -155,13 +149,20 @@ Provides settings for physics simulation, evaluation, and temperature control.
-
SessionMessageHost
-

Represents a host for managing milling messages with thread-safe operations and stable index tracking.

+
RuntimeController
+

Provides a C# scripting API for controlling and manipulating the milling course. +Allows for runtime control of milling operations, geometry manipulation, and data analysis.

-
SessionMessageHost.AlwaysStableTorch
-

A disposable class that manages the stable index state.

+
SessionMessage
+

Represents a message in the machining process that can contain various types of data +such as source commands, machining steps, exceptions, and tagged messages.

+
+
+
+
SessionMessageHost
+

Represents a host for managing milling messages with thread-safe operations and stable index tracking.

@@ -170,10 +171,23 @@ Provides settings for physics simulation, evaluation, and temperature control.
-
ShellApi
-

Provides a C# scripting API for controlling and manipulating the milling course. -Allows for runtime control of milling operations, geometry manipulation, and data analysis.

-
+
SetupController
+
+
+

+Interfaces +

+
+
IMachiningProjectGetter
+
+
+
+
IMachiningProjectHost
+
+
+
+
IPathedMachiningProjectHost
+

Enums @@ -183,6 +197,10 @@ Enums

Flags that control which elements are rendered in the visualization.

+
+
SessionMessageHost.FilterFlag
+
+

Delegates

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.IGetSourceCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.IGetSourceCommand.html similarity index 91% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.IGetSourceCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.IGetSourceCommand.html index 7bc6aee4..00932f28 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.IGetSourceCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.IGetSourceCommand.html @@ -84,16 +84,16 @@
-
+
-

+

Interface IGetSourceCommand

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -146,9 +146,9 @@ Interface IGetSourceCommand - + -

+

GetSourceCommand()

@@ -164,7 +164,7 @@ Interface IGetSourceCommand

Returns

-
ISourceCommand
+
ISourceCommand

The source command object.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.IMachiningStepHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.IMachiningStepHost.html similarity index 85% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.IMachiningStepHost.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.IMachiningStepHost.html index 6509cfe6..f381c47b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.IMachiningStepHost.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.IMachiningStepHost.html @@ -84,16 +84,16 @@
-
+
-

+

Interface IMachiningStepHost

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -153,9 +153,9 @@ Interface IMachiningStepHost - + -

+

DictionaryColorGuide

@@ -185,9 +185,9 @@ Interface IMachiningStepHost - + -

+

MachiningEquipment

@@ -217,9 +217,9 @@ Interface IMachiningStepHost - + -

+

MachiningToolHouse

@@ -249,9 +249,9 @@ Interface IMachiningStepHost - + -

+

MillingStepLuggageReader

@@ -281,9 +281,9 @@ Interface IMachiningStepHost - + -

+

TimeMapping

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.ISourceCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.ISourceCommand.html similarity index 91% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.ISourceCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.ISourceCommand.html index 279dee0b..f72c1cc5 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.ISourceCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.ISourceCommand.html @@ -84,16 +84,16 @@ -
+
-

+

Interface ISourceCommand

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -133,7 +133,7 @@ Interface ISourceCommand IGetFileLineIndex.GetFileLineIndex() @@ -171,9 +171,9 @@ Interface ISourceCommand - + -

+

FlagsText

@@ -183,7 +183,8 @@ Interface ISourceCommand
- 
string FlagsText { get; }
+ 
[Present("NC Flag", "NC Flag", PhysicsUnit.None, "G")]
+string FlagsText { get; }
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MachineMotionStep.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachineMotionStep.html similarity index 71% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MachineMotionStep.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachineMotionStep.html index 10f9b5bf..fbd07a9e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MachineMotionStep.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachineMotionStep.html @@ -84,16 +84,16 @@ -
+
-

+

Class MachineMotionStep

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -183,14 +183,14 @@ Note that the spindle information is only for milling behavior.

- + -

+

MachineMotionStep(MachineMotionStep)

-

Initializes a new instance of the MachineMotionStep class by copying from another instance.

+

Initializes a new instance of the MachineMotionStep class by copying from another instance.

@@ -200,7 +200,7 @@ Note that the spindle information is only for milling behavior.

Parameters

-
src MachineMotionStep
+
src MachineMotionStep

The source machining step to copy from.

@@ -216,14 +216,14 @@ Note that the spindle information is only for milling behavior.

- + -

+

MachineMotionStep(TimeSpan, TimeSpan, double, double[], double, double, SpindleDirection, int, Mat4d, Mat4d, SeqPair<Mat4d>)

-

Initializes a new instance of the MachineMotionStep class with specified parameters.

+

Initializes a new instance of the MachineMotionStep class with specified parameters.

@@ -283,9 +283,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

AccumulatedTime

@@ -315,9 +315,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

BeginSpindleAngle_deg

@@ -347,9 +347,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

BeginSpindleAngle_rad

@@ -379,9 +379,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CdnTransformProgramToToolRunning

@@ -411,9 +411,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CdnTransformProgramToWorkpieceGeom

@@ -443,9 +443,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CdnTransformToolRunningToProgram

@@ -475,9 +475,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CdnTransformToolRunningToWorkpieceGeom

@@ -507,9 +507,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CdnTransformWorkpieceGeomToProgram

@@ -539,9 +539,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CdnTransformWorkpieceGeomToToolRunning

@@ -571,9 +571,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CyclePeriod

@@ -603,9 +603,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

CyclePeriod_s

@@ -635,9 +635,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

EndSpindleAngle_deg

@@ -667,9 +667,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

EndSpindleAngle_rad

@@ -699,9 +699,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

FeedPerCycle_mm

@@ -731,9 +731,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

Feedrate_mmds

@@ -763,9 +763,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GeomCl

@@ -795,9 +795,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

McValues

@@ -827,9 +827,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

MoveOnProgramCoordinate_mm

@@ -859,9 +859,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

MoveOnWorkpieceGeomCoordinate_mm

@@ -891,9 +891,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

MovingDirectionOnWorkpieceGeomCoordinate

@@ -923,9 +923,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

MovingLength_mm

@@ -955,9 +955,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

PassedSpindleAngle_deg

@@ -987,9 +987,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

PassedSpindleAngle_rad

@@ -1019,9 +1019,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

ProgramCl

@@ -1051,9 +1051,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

ProgramToWorkpieceGeomMat4d

@@ -1083,9 +1083,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

SeqOnToolRunningCoordinate

@@ -1115,9 +1115,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

SeqOnWorkpieceGeomCoordinate

@@ -1147,9 +1147,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

SpindleDirection

@@ -1179,9 +1179,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

SpindleSpeed_cycleds

@@ -1211,9 +1211,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

SpindleSpeed_radds

@@ -1243,9 +1243,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

SpindleSpeed_rpm

@@ -1275,9 +1275,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

StepBeginTime

@@ -1307,9 +1307,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

StepDuration

@@ -1339,9 +1339,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

ToolId

@@ -1371,9 +1371,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

WorkpieceGeomToProgramMat4d

@@ -1407,9 +1407,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetFeedPerTooth_mm(IMachiningTool)

@@ -1446,9 +1446,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetFeedrate_mmds()

@@ -1479,9 +1479,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetMachiningTool(MachiningToolHouse)

@@ -1518,9 +1518,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetProgramSideCuspHeight_mm(IMachiningTool)

@@ -1557,9 +1557,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetSideCuspList_mm(IMachiningTool)

@@ -1596,9 +1596,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetSideCuspPhaseInterval_rad(IMachiningTool)

@@ -1635,9 +1635,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetSpindleDirection()

@@ -1668,9 +1668,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetSpindleSpeed_radds()

@@ -1701,9 +1701,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetToothArcDuration_s(IMachiningTool)

@@ -1740,9 +1740,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

GetToothSeqOnToolRunningCoordinate(IMachiningTool)

@@ -1779,9 +1779,9 @@ Note that the spindle information is only for milling behavior.

- + -

+

ToString()

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MachiningStep.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachiningStep.html similarity index 72% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MachiningStep.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachiningStep.html index 6111b543..ef7c9e32 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MachiningStep.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachiningStep.html @@ -84,16 +84,16 @@
-
+
-

+

Class MachiningStep

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -118,7 +118,7 @@ Class MachiningStep
Implements
- + @@ -196,9 +196,9 @@ Class MachiningStep - + -

+

MachiningStep(IMachiningStepHost, int, ISourceCommand, MachineMotionStep, MillingPhysicsStep)

@@ -213,16 +213,16 @@ Class MachiningStep

Parameters

-
host IMachiningStepHost
+
host IMachiningStepHost

The host of the milling step.

stepIndex int

The index of the step.

-
sourceCommand ISourceCommand
+
sourceCommand ISourceCommand

The source command.

-
machiningStep MachineMotionStep
+
machiningStep MachineMotionStep

The machining step.

millingPhysicsStep MillingPhysicsStep
@@ -245,9 +245,9 @@ Class MachiningStep - + -

+

AccumulatedCraterWear_um

@@ -279,9 +279,9 @@ public double AccumulatedCraterWear_um { get; } - + -

+

AccumulatedFlankWearDepth_um

@@ -313,9 +313,9 @@ public double AccumulatedFlankWearDepth_um { get; } - + -

+

AccumulatedFlankWearWidth_um

@@ -347,9 +347,9 @@ public double AccumulatedFlankWearWidth_um { get; } - + -

+

AccumulatedSpindleEnergyConsumption_kWh

@@ -381,9 +381,9 @@ public double AccumulatedSpindleEnergyConsumption_kWh { get; } - + -

+

AccumulatedTime

@@ -393,7 +393,7 @@ public double AccumulatedSpindleEnergyConsumption_kWh { get; }
- 
[Present("Accumulated Time", null, PhysicsUnit.None, "G")]
+    
[Present("Time", null, PhysicsUnit.None, "G")]
 [JsAce(ClassExt = "MachiningStep")]
 public TimeSpan AccumulatedTime { get; }
@@ -415,9 +415,9 @@ public TimeSpan AccumulatedTime { get; } - + -

+

AvgAbsMomentAboutSensorVec3d_Nm

@@ -449,9 +449,9 @@ public Vec3d AvgAbsMomentAboutSensorVec3d_Nm { get; } - + -

+

AvgAbsMomentXAboutSensorOnSpindleRotationCoordinate_Nm

@@ -483,9 +483,9 @@ public double? AvgAbsMomentXAboutSensorOnSpindleRotationCoordinate_Nm { get; } + -

+

AvgAbsMomentXAboutToolTipOnSpindleRotationCoordinate_Nm

@@ -517,9 +517,9 @@ public double AvgAbsMomentXAboutToolTipOnSpindleRotationCoordinate_Nm { get; } + -

+

AvgAbsTorqueByMapping_Nm

@@ -551,9 +551,9 @@ public double? AvgAbsTorqueByMapping_Nm { get; } - + -

+

AvgAbsTorqueErrorRatioWithMapping

@@ -585,9 +585,9 @@ public double? AvgAbsTorqueErrorRatioWithMapping { get; } - + -

+

AvgAbsTorqueSignedErrorRelationWithMapping

@@ -619,9 +619,9 @@ public double? AvgAbsTorqueSignedErrorRelationWithMapping { get; } - + -

+

AvgAbsTorque_Nm

@@ -653,9 +653,9 @@ public double? AvgAbsTorque_Nm { get; } - + -

+

AvgForceToToolOnToolRunningCoordinate_N

@@ -687,9 +687,9 @@ public Vec3d AvgForceToToolOnToolRunningCoordinate_N { get; } - + -

+

AvgForceXToToolOnToolRunningCoordinate_N

@@ -720,9 +720,9 @@ public double? AvgForceXToToolOnToolRunningCoordinate_N { get; } - + -

+

AvgForceYToToolOnToolRunningCoordinate_N

@@ -753,9 +753,9 @@ public double? AvgForceYToToolOnToolRunningCoordinate_N { get; } - + -

+

AvgForceZToToolOnToolRunningCoordinate_N

@@ -786,9 +786,9 @@ public double? AvgForceZToToolOnToolRunningCoordinate_N { get; } - + -

+

AvgMomentAboutSensor_Nm

@@ -820,9 +820,9 @@ public double? AvgMomentAboutSensor_Nm { get; } - + -

+

AvgMomentAboutToolTipOnProgramCoordinate_Nm

@@ -854,9 +854,9 @@ public Vec3d AvgMomentAboutToolTipOnProgramCoordinate_Nm { get; } - + -

+

AvgMomentAboutToolTipOnToolRunningCoordinate_Nm

@@ -888,9 +888,9 @@ public Vec3d AvgMomentAboutToolTipOnToolRunningCoordinate_Nm { get; } + -

+

AvgMomentAboutToolTip_Nm

@@ -922,9 +922,9 @@ public double? AvgMomentAboutToolTip_Nm { get; } - + -

+

AvgMomentXyAboutObservationPoint_Nm

@@ -956,9 +956,9 @@ public double? AvgMomentXyAboutObservationPoint_Nm { get; } - + -

+

AvgMomentXyByMapping_Nm

@@ -990,9 +990,9 @@ public double? AvgMomentXyByMapping_Nm { get; } - + -

+

AvgMomentXyErrorRatioWithMapping

@@ -1025,9 +1025,9 @@ public double? AvgMomentXyErrorRatioWithMapping { get; } - + -

+

AvgMomentXySignedErrorRelationWithMapping

@@ -1059,9 +1059,9 @@ public double? AvgMomentXySignedErrorRelationWithMapping { get; } - + -

+

BeginSpindleAngle_deg

@@ -1093,9 +1093,9 @@ public double BeginSpindleAngle_deg { get; } - + -

+

ChipMass_g

@@ -1126,9 +1126,9 @@ public double? ChipMass_g { get; } - + -

+

ChipMass_mg

@@ -1160,9 +1160,9 @@ public double? ChipMass_mg { get; } - + -

+

ChipTemperature_C

@@ -1194,9 +1194,9 @@ public double? ChipTemperature_C { get; } - + -

+

ChipThickness_mm

@@ -1228,9 +1228,9 @@ public double? ChipThickness_mm { get; } - + -

+

ChipThickness_um

@@ -1260,9 +1260,9 @@ public double? ChipThickness_mm { get; } - + -

+

ChipVolume_mm3

@@ -1294,9 +1294,9 @@ public double? ChipVolume_mm3 { get; } - + -

+

Cl

@@ -1327,9 +1327,9 @@ public DVec3d Cl { get; } - + -

+

CutterBodyTemperature_C

@@ -1361,9 +1361,9 @@ public double? CutterBodyTemperature_C { get; } - + -

+

CutterDermisTemperature_C

@@ -1395,9 +1395,9 @@ public double? CutterDermisTemperature_C { get; } - + -

+

CuttingDepth_mm

@@ -1429,9 +1429,9 @@ public double CuttingDepth_mm { get; } - + -

+

CuttingSpeed_mmds

@@ -1463,9 +1463,9 @@ public double? CuttingSpeed_mmds { get; } - + -

+

CuttingWidth_mm

@@ -1497,9 +1497,9 @@ public double CuttingWidth_mm { get; } - + -

+

DeltaTipDeflectionOnToolRunningCoordinate_um

@@ -1531,9 +1531,9 @@ public Vec3d DeltaTipDeflectionOnToolRunningCoordinate_um { get; } - + -

+

FeedPerCycle_mm

@@ -1565,9 +1565,9 @@ public double FeedPerCycle_mm { get; } - + -

+

FeedPerTooth_mm

@@ -1599,9 +1599,9 @@ public double FeedPerTooth_mm { get; } - + -

+

Feedrate_mmdmin

@@ -1634,9 +1634,9 @@ public double Feedrate_mmdmin { get; } - + -

+

FileNo

@@ -1668,9 +1668,9 @@ public int? FileNo { get; } - + -

+

FilePath

@@ -1702,9 +1702,9 @@ public string FilePath { get; } - + -

+

FlagsText

@@ -1736,9 +1736,9 @@ public string FlagsText { get; } - + -

+

FlexDictionary

@@ -1768,9 +1768,9 @@ public string FlagsText { get; } - + -

+

FrictionPower_W

@@ -1802,9 +1802,9 @@ public double? FrictionPower_W { get; } - + -

+

Host

@@ -1823,7 +1823,7 @@ public double? FrictionPower_W { get; }

Property Value

-
IMachiningStepHost
+
IMachiningStepHost
@@ -1834,9 +1834,9 @@ public double? FrictionPower_W { get; } - + -

+

InfInsistentSpindlePowerRatio

@@ -1868,9 +1868,9 @@ public double? InfInsistentSpindlePowerRatio { get; } - + -

+

InfInsistentSpindleTorqueRatio

@@ -1902,9 +1902,9 @@ public double? InfInsistentSpindleTorqueRatio { get; } - + -

+

InstantCraterWear_um

@@ -1936,9 +1936,9 @@ public double? InstantCraterWear_um { get; } - + -

+

IsTouched

@@ -1970,9 +1970,9 @@ public bool IsTouched { get; } - + -

+

this[string]

@@ -2009,9 +2009,9 @@ public bool IsTouched { get; } - + -

+

LineNo

@@ -2043,9 +2043,9 @@ public int? LineNo { get; } - + -

+

LineText

@@ -2077,9 +2077,9 @@ public string LineText { get; } - + -

+

MachineMotionStep

@@ -2098,7 +2098,7 @@ public string LineText { get; }

Property Value

-
MachineMotionStep
+
MachineMotionStep
@@ -2109,9 +2109,9 @@ public string LineText { get; } - + -

+

MachiningTool

@@ -2141,9 +2141,9 @@ public string LineText { get; } - + -

+

MaxAbsForce_N

@@ -2175,9 +2175,9 @@ public double? MaxAbsForce_N { get; } - + -

+

MaxBottomEdgeDeflectionOnToolRunningCoordinate_mm

@@ -2208,9 +2208,9 @@ public Vec3d MaxBottomEdgeDeflectionOnToolRunningCoordinate_mm { get; } + -

+

MaxForceOnToolRunningCoordinate_N

@@ -2240,9 +2240,9 @@ public Vec3d MaxBottomEdgeDeflectionOnToolRunningCoordinate_mm { get; } + -

+

MaxMomentAboutSensor_Nm

@@ -2274,9 +2274,9 @@ public double MaxMomentAboutSensor_Nm { get; } - + -

+

MaxMomentAboutToolTip_Nm

@@ -2308,9 +2308,9 @@ public double MaxMomentAboutToolTip_Nm { get; } - + -

+

MaxSpindlePowerRatio

@@ -2342,9 +2342,9 @@ public double? MaxSpindlePowerRatio { get; } - + -

+

MaxSpindleTorqueRatio

@@ -2376,9 +2376,9 @@ public double? MaxSpindleTorqueRatio { get; } - + -

+

MaxTipDeflectionOnToolRunningCoordinate_mm

@@ -2409,9 +2409,9 @@ public Vec3d MaxTipDeflectionOnToolRunningCoordinate_mm { get; } - + -

+

MaxTipDeflectionOnToolRunningCoordinate_um

@@ -2443,9 +2443,9 @@ public Vec3d MaxTipDeflectionOnToolRunningCoordinate_um { get; } - + -

+

MillingPhysicsStep

@@ -2475,9 +2475,9 @@ public Vec3d MaxTipDeflectionOnToolRunningCoordinate_um { get; } - + -

+

MillingStepLuggage

@@ -2507,9 +2507,9 @@ public Vec3d MaxTipDeflectionOnToolRunningCoordinate_um { get; } - + -

+

MoveOnProgramCoordinate

@@ -2541,9 +2541,9 @@ public Vec3d MoveOnProgramCoordinate { get; } - + -

+

MovingLength_mm

@@ -2575,9 +2575,9 @@ public double MovingLength_mm { get; } - + -

+

Mrr_mm3ds

@@ -2609,9 +2609,9 @@ public double Mrr_mm3ds { get; } - + -

+

ProgramSideCusp_um

@@ -2645,9 +2645,9 @@ public double ProgramSideCusp_um { get; } - + -

+

ReCutDepth_um

@@ -2679,9 +2679,9 @@ public double ReCutDepth_um { get; } - + -

+

SideCuspList_um

@@ -2712,9 +2712,9 @@ public List<double> SideCuspList_um { get; } - + -

+

SourceCommand

@@ -2733,7 +2733,7 @@ public List<double> SideCuspList_um { get; }

Property Value

-
ISourceCommand
+
ISourceCommand
@@ -2744,9 +2744,9 @@ public List<double> SideCuspList_um { get; } - + -

+

SpindleCyclePeriod_s

@@ -2778,9 +2778,9 @@ public double SpindleCyclePeriod_s { get; } - + -

+

SpindleInputPower_W

@@ -2813,9 +2813,9 @@ public double SpindleInputPower_W { get; } - + -

+

SpindleOutputPower_W

@@ -2848,9 +2848,9 @@ public double SpindleOutputPower_W { get; } - + -

+

SpindleSpeed_rpm

@@ -2883,9 +2883,9 @@ public double SpindleSpeed_rpm { get; } - + -

+

SpindleTemperature_C

@@ -2917,9 +2917,9 @@ public double? SpindleTemperature_C { get; } - + -

+

SpindleWorkingTemperatureRatio

@@ -2951,9 +2951,9 @@ public double? SpindleWorkingTemperatureRatio { get; } - + -

+

StepDuration

@@ -2985,9 +2985,9 @@ public TimeSpan StepDuration { get; } - + -

+

StepIndex

@@ -2999,6 +2999,7 @@ public TimeSpan StepDuration { get; } 
[Key]
 [DatabaseGenerated(DatabaseGeneratedOption.None)]
+[Present("Step Index", "S.I.", PhysicsUnit.None, "G")]
 public int StepIndex { get; }
@@ -3019,9 +3020,9 @@ public int StepIndex { get; } - + -

+

ThermalStress_MPa

@@ -3053,9 +3054,9 @@ public double? ThermalStress_MPa { get; } - + -

+

ThermalYieldRatio

@@ -3087,9 +3088,9 @@ public double? ThermalYieldRatio { get; } - + -

+

TipDeflectionsOnToolRunningCoordinate_um

@@ -3120,9 +3121,9 @@ public List<Vec3d> TipDeflectionsOnToolRunningCoordinate_um { get; } + -

+

ToolId

@@ -3154,9 +3155,9 @@ public int ToolId { get; } - + -

+

ToothArcDuration_s

@@ -3188,9 +3189,9 @@ public double ToothArcDuration_s { get; } - + -

+

ToothSeqOnToolRunningCoordinate

@@ -3220,9 +3221,9 @@ public double ToothArcDuration_s { get; } - + -

+

WorkpieceDermisTemperature_C

@@ -3254,9 +3255,9 @@ public double? WorkpieceDermisTemperature_C { get; } - + -

+

WorkpiecePlasticDepth_um

@@ -3288,9 +3289,9 @@ public double WorkpiecePlasticDepth_um { get; } - + -

+

YieldingStressRatio

@@ -3326,9 +3327,9 @@ public double? YieldingStressRatio { get; } - + -

+

GetCutterDermisAvgTemperature_C(double)

@@ -3366,9 +3367,9 @@ public double GetCutterDermisAvgTemperature_C(double depth_mm) - + -

+

GetCutterDermisTemperature_C(double)

@@ -3406,9 +3407,9 @@ public double GetCutterDermisTemperature_C(double depth_mm) - + -

+

GetFeedrate_mmds()

@@ -3439,9 +3440,9 @@ public double GetCutterDermisTemperature_C(double depth_mm) - + -

+

GetKeyToQuantityNativeDictionary(IMachiningChain)

@@ -3451,7 +3452,7 @@ public double GetCutterDermisTemperature_C(double depth_mm)
- 
public static ConcurrentDictionary<string, StepPropertyAccess> GetKeyToQuantityNativeDictionary(IMachiningChain machiningChain)
+ 
public static ConcurrentDictionary<string, PropertyAccess<MachiningStep>> GetKeyToQuantityNativeDictionary(IMachiningChain machiningChain)

Parameters

@@ -3462,7 +3463,7 @@ public double GetCutterDermisTemperature_C(double depth_mm)

Returns

-
ConcurrentDictionary<string, StepPropertyAccess>
+
ConcurrentDictionary<string, PropertyAccess<MachiningStep>>
@@ -3476,9 +3477,9 @@ public double GetCutterDermisTemperature_C(double depth_mm) - + -

+

GetMcValue(IMachiningChain, string)

@@ -3518,9 +3519,9 @@ public double GetCutterDermisTemperature_C(double depth_mm) - + -

+

GetMcValue(int)

@@ -3558,9 +3559,9 @@ public double? GetMcValue(int index) - + -

+

GetRgbWithPriority(out Vec3d, out double)

@@ -3594,9 +3595,9 @@ public double? GetMcValue(int index) - + -

+

GetSourceCommand()

@@ -3612,7 +3613,7 @@ public double? GetMcValue(int index)

Returns

-
ISourceCommand
+
ISourceCommand

The source command object.

@@ -3627,9 +3628,9 @@ public double? GetMcValue(int index) - + -

+

GetSpindleDirection()

@@ -3659,9 +3660,9 @@ public double? GetMcValue(int index) - + -

+

GetSpindleSpeed_radds()

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MillingStepUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachiningStepUtil.html similarity index 84% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MillingStepUtil.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachiningStepUtil.html index ff2b751d..09e11da9 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.MillingStepUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.MachiningStepUtil.html @@ -2,9 +2,9 @@ - Class MillingStepUtil | HiAPI-C# 2025 + Class MachiningStepUtil | HiAPI-C# 2025 - + @@ -84,16 +84,16 @@
-
+
-

-Class MillingStepUtil +

+Class MachiningStepUtil

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -102,7 +102,7 @@ Class MillingStepUtil
- 
public static class MillingStepUtil
+ 
public static class MachiningStepUtil
@@ -112,7 +112,7 @@ Class MillingStepUtil
Inheritance
-
MillingStepUtil
+
MachiningStepUtil
@@ -153,10 +153,10 @@ Class MillingStepUtil - + -

- MillingStepDbName +

+ MachiningStepDbName

@@ -165,7 +165,7 @@ Class MillingStepUtil
- 
public static string MillingStepDbName { get; }
+ 
public static string MachiningStepDbName { get; }
@@ -185,9 +185,9 @@ Class MillingStepUtil - + -

+

MillingStepLuggageCollectionName

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PresentAccess.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PresentAccess.html new file mode 100644 index 00000000..fbbdb07c --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PresentAccess.html @@ -0,0 +1,303 @@ + + + + + Class PresentAccess | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class PresentAccess +

+ +
+
Namespace
Hi.MachiningSteps
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public class PresentAccess
+
+ + + + +
+
Inheritance
+
+ +
PresentAccess
+
+
+ + + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ PresentAccess(PresentAttribute, Func<object, object>) + +

+ +
+
+ +
+ 
public PresentAccess(PresentAttribute present, Func<object, object> getFunc)
+
+ +

Parameters

+
+
present PresentAttribute
+
+
getFunc Func<object, object>
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ GetValueFunc + +

+ +
+
+ +
+ 
public Func<object, object> GetValueFunc { get; set; }
+
+ + + + + +

Property Value

+
+
Func<object, object>
+
+
+ + + + + + + + + + +

+ Present + +

+ +
+
+ +
+ 
public PresentAttribute Present { get; set; }
+
+ + + + + +

Property Value

+
+
PresentAttribute
+
+
+ + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.PresentAttribute.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PresentAttribute.html similarity index 86% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.PresentAttribute.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PresentAttribute.html index c5a7255d..fefb6f8a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.PresentAttribute.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PresentAttribute.html @@ -84,16 +84,16 @@ -
+
-

+

Class PresentAttribute

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -284,14 +284,14 @@ Class PresentAttribute - + -

+

PresentAttribute()

-

Initializes a new instance of the PresentAttribute class.

+

Initializes a new instance of the PresentAttribute class.

@@ -311,14 +311,14 @@ Class PresentAttribute - + -

+

PresentAttribute(PresentAttribute)

-

Initializes a new instance of the PresentAttribute class by copying from another instance.

+

Initializes a new instance of the PresentAttribute class by copying from another instance.

@@ -328,7 +328,7 @@ Class PresentAttribute

Parameters

-
src PresentAttribute
+
src PresentAttribute

The source attribute to copy from.

@@ -344,14 +344,14 @@ Class PresentAttribute - + -

+

PresentAttribute(string, string, PhysicsUnit, string)

-

Initializes a new instance of the PresentAttribute class with specified parameters.

+

Initializes a new instance of the PresentAttribute class with specified parameters.

@@ -390,9 +390,9 @@ Class PresentAttribute - + -

+

DataFormatString

@@ -422,9 +422,9 @@ Class PresentAttribute - + -

+

Name

@@ -454,9 +454,9 @@ Class PresentAttribute - + -

+

ShortName

@@ -486,9 +486,9 @@ Class PresentAttribute - + -

+

TailUnitString

@@ -518,9 +518,9 @@ Class PresentAttribute - + -

+

Unit

@@ -554,9 +554,9 @@ Class PresentAttribute - + -

+

GetPresentName(StringLocalizer)

@@ -593,9 +593,9 @@ Class PresentAttribute - + -

+

GetPresentName(IStringLocalizer)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.StepPropertyAccess.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PropertyAccess-1.html similarity index 69% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.StepPropertyAccess.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PropertyAccess-1.html index b90c52ad..11ea0a0e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.StepPropertyAccess.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.PropertyAccess-1.html @@ -2,9 +2,9 @@ - Class StepPropertyAccess | HiAPI-C# 2025 + Class PropertyAccess<TData> | HiAPI-C# 2025 - + @@ -84,16 +84,16 @@
-
+
-

-Class StepPropertyAccess +

+Class PropertyAccess<TData>

-
Namespace
Hi.MillingSteps
+
Namespace
Hi.MachiningSteps
Assembly
HiMech.dll
@@ -102,17 +102,22 @@ Class StepPropertyAccess
- 
public class StepPropertyAccess
+ 
public class PropertyAccess<TData> where TData : class
+

Type Parameters

+
+
TData
+
+
Inheritance
-
StepPropertyAccess
+
PropertyAccess<TData>
@@ -178,27 +183,27 @@ Class StepPropertyAccess - + -

- StepPropertyAccess(PresentAttribute, Func<MachiningStep, double?>) +

+ PropertyAccess(PresentAttribute, Func<TData, double?>)

-

Initializes a new instance of the StepPropertyAccess class for numeric properties.

+

Initializes a new instance for numeric properties.

- 
public StepPropertyAccess(PresentAttribute presentAttribute, Func<MachiningStep, double?> getQuantityFunc)
+ 
public PropertyAccess(PresentAttribute presentAttribute, Func<TData, double?> getQuantityFunc)

Parameters

-
presentAttribute PresentAttribute
+
presentAttribute PresentAttribute

The presentation attribute for the property.

-
getQuantityFunc Func<MachiningStep, double?>
+
getQuantityFunc Func<TData, double?>

The function to retrieve the numeric value.

@@ -214,27 +219,27 @@ Class StepPropertyAccess - + -

- StepPropertyAccess(PresentAttribute, Func<MachiningStep, object>) +

+ PropertyAccess(PresentAttribute, Func<TData, object>)

-

Initializes a new instance of the StepPropertyAccess class for non-numeric properties.

+

Initializes a new instance for non-numeric properties.

- 
public StepPropertyAccess(PresentAttribute presentAttribute, Func<MachiningStep, object> getNonQuantityFunc)
+ 
public PropertyAccess(PresentAttribute presentAttribute, Func<TData, object> getNonQuantityFunc)

Parameters

-
presentAttribute PresentAttribute
+
presentAttribute PresentAttribute

The presentation attribute for the property.

-
getNonQuantityFunc Func<MachiningStep, object>
+
getNonQuantityFunc Func<TData, object>

The function to retrieve the non-numeric value.

@@ -254,9 +259,9 @@ Class StepPropertyAccess - + -

+

GetNonQuantityFunc

@@ -266,7 +271,7 @@ Class StepPropertyAccess
- 
public Func<MachiningStep, object> GetNonQuantityFunc { get; set; }
+ 
public Func<TData, object> GetNonQuantityFunc { get; set; }
@@ -275,7 +280,7 @@ Class StepPropertyAccess

Property Value

-
Func<MachiningStep, object>
+
Func<TData, object>
@@ -286,9 +291,9 @@ Class StepPropertyAccess - + -

+

GetQuantityFunc

@@ -298,7 +303,7 @@ Class StepPropertyAccess
- 
public Func<MachiningStep, double?> GetQuantityFunc { get; set; }
+ 
public Func<TData, double?> GetQuantityFunc { get; set; }
@@ -307,7 +312,7 @@ Class StepPropertyAccess

Property Value

-
Func<MachiningStep, double?>
+
Func<TData, double?>
@@ -318,9 +323,9 @@ Class StepPropertyAccess - + -

+

PresentAttribute

@@ -339,7 +344,7 @@ Class StepPropertyAccess

Property Value

-
PresentAttribute
+
PresentAttribute
@@ -354,10 +359,10 @@ Class StepPropertyAccess - + -

- GetValue(MachiningStep) +

+ GetValue(TData)

@@ -366,12 +371,12 @@ Class StepPropertyAccess
- 
public object GetValue(MachiningStep step)
+ 
public object GetValue(TData step)

Parameters

-
step MachiningStep
+
step TData

The milling step to get the property value from.

@@ -393,48 +398,9 @@ Class StepPropertyAccess - + -

- GetValueText(MachiningStep) - -

- -

Gets the formatted text representation of the property value for the specified milling step.

-
-
- -
- 
public string GetValueText(MachiningStep step)
-
- -

Parameters

-
-
step MachiningStep
-

The milling step to get the property value from.

-
-
- -

Returns

-
-
string
-

The formatted text representation of the property value.

-
-
- - - - - - - - - - - - - -

+

GetValueText(object)

@@ -471,6 +437,45 @@ Class StepPropertyAccess + + +

+ GetValueText(TData) + +

+ +

Gets the formatted text representation of the property value for the specified milling step.

+
+
+ +
+ 
public string GetValueText(TData step)
+
+ +

Parameters

+
+
step TData
+

The milling step to get the property value from.

+
+
+ +

Returns

+
+
string
+

The formatted text representation of the property value.

+
+
+ + + + + + + + + + +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.html b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.html new file mode 100644 index 00000000..5f8b2ab9 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MachiningSteps.html @@ -0,0 +1,169 @@ + + + + + Namespace Hi.MachiningSteps | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ +

Namespace Hi.MachiningSteps

+
+
+
+ +

+Classes +

+
+
MachineMotionStep
+

MachiningStep has spindle information. +Note that the spindle information is only for milling behavior.

+
+
+
+
MachiningStep
+
+
+
+
MachiningStepUtil
+

Utility class for milling step related constants and helper methods.

+
+
+
+
PresentAccess
+
+
+
+
PresentAttribute
+

Attribute for presenting property information with localization support.

+
+
+
+
PropertyAccess<TData>
+

Provides access to properties of a milling step with presentation information.

+
+
+

+Interfaces +

+
+
IGetSourceCommand
+

Defines an interface for retrieving source command information.

+
+
+
+
IMachiningStepHost
+

Represents a host interface for milling steps that provides access to milling equipment and related resources.

+
+
+
+
ISourceCommand
+

Represents a source command interface that provides access to file line information and command flags.

+
+
+ + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.CsvNcStep.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.CsvNcStep.html index 8b393300..63f93b4a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.CsvNcStep.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.CsvNcStep.html @@ -494,8 +494,8 @@ Class CsvNcStep -

- BuildByFile(ClStrip, string, string, IMessageHost, StepInterpoationMode) +

+ BuildByFile(ClStrip, string, string, IMessageKit, StepInterpoationMode)

@@ -504,7 +504,7 @@ Class CsvNcStep
- 
public static void BuildByFile(ClStrip clStrip, string baseDirectory, string relPath, IMessageHost messageHost, CsvNcStep.StepInterpoationMode stepInterpoationMode)
+ 
public static void BuildByFile(ClStrip clStrip, string baseDirectory, string relPath, IMessageKit messageHost, CsvNcStep.StepInterpoationMode stepInterpoationMode)

Parameters

@@ -518,7 +518,7 @@ Class CsvNcStep
relPath string

The relative path to the CSV file.

-
messageHost IMessageHost
+
messageHost IMessageKit

The message host for logging.

stepInterpoationMode CsvNcStep.StepInterpoationMode
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.TimeMapping.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.TimeMapping.html index 363e6a93..bf967ee8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.TimeMapping.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mapping.TimeMapping.html @@ -782,26 +782,30 @@ Any exceptions during file reading are captured and can be inspected through the -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML representation of the time mapping data.

+

Creates an XML representation of the time mapping data. +relFile is not used in current implementation.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string
-

The base directory for creating relative file paths.

+

The base directory for resolving relative paths

relFile string
-

The relative file path (not used in current implementation).

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -818,7 +822,7 @@ Any exceptions during file reading are captured and can be inspected through the -

Remarks

+

Remarks

The XML structure includes:

  • A root TimeMapping element
    • diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mappings.FileTimeSection.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mappings.FileTimeSection.html index 9ae95feb..fbadd477 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mappings.FileTimeSection.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mappings.FileTimeSection.html @@ -151,10 +151,10 @@ Class FileTimeSection
    Extension Methods
    XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) @@ -623,8 +623,8 @@ Class FileTimeSection -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -634,7 +634,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -644,6 +644,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -660,6 +663,11 @@ This method may also generate additional resources such as related files.

    +

    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.Mech.GeneralMechanism.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.GeneralMechanism.html index 845ff458..82f0fbfe 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.GeneralMechanism.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.GeneralMechanism.html @@ -102,7 +102,7 @@ Class GeneralMechanism
    - 
    public class GeneralMechanism : IMakeXmlSource, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetAnchorToSolidDictionary
    + 
    public class GeneralMechanism : IMakeXmlSource, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IGetAnchorToSolidDictionary, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d
    @@ -120,15 +120,15 @@ Class GeneralMechanism
    Implements
    - + - - - - - + + + + +
    @@ -163,10 +163,7 @@ Class GeneralMechanism
    Extension Methods
    -
    DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -177,6 +174,18 @@ Class GeneralMechanism + + + + @@ -468,6 +477,39 @@ This function is usually used to compute the bounding box of elements.

    + + +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + +

    @@ -567,43 +609,10 @@ This function is usually used to compute the bounding box of elements.

    - - -

    - GetRootAnchor() - -

    - -

    Get root anchor.

    -
    -
    - -
    - 
    public Anchor GetRootAnchor()
    -
    - - -

    Returns

    -
    -
    Anchor
    -

    root anchor.

    -
    -
    - - - - - - - - - - - -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -613,7 +622,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -623,6 +632,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -639,6 +651,11 @@ This method may also generate additional resources such as related files.

    +

    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.Mech.IMachiningChain.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.IMachiningChain.html index 3f28ab29..cac0dacf 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.IMachiningChain.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.IMachiningChain.html @@ -102,7 +102,7 @@ Interface IMachiningChain
    - 
    public interface IMachiningChain : IGetAsmb, IGetTopoIndex, IGetRootAnchor
    + 
    public interface IMachiningChain : IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary
    @@ -118,7 +118,13 @@ Interface IMachiningChain IGetAsmb.GetAsmb()
+ + @@ -137,6 +143,12 @@ Interface IMachiningChain + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.IMachiningChainSource.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.IMachiningChainSource.html index 288db617..5d4f43e9 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.IMachiningChainSource.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.IMachiningChainSource.html @@ -115,7 +115,7 @@ Interface IMachiningChainSource
Inherited Members
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Anchor.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Anchor.html index 13912970..19ece9cc 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Anchor.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Anchor.html @@ -102,7 +102,7 @@ Class Anchor
- 
public class Anchor : IGetAnchor, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d
+ 
public class Anchor : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d
@@ -119,10 +119,9 @@ Class Anchor
Implements
+ - -
@@ -155,6 +154,9 @@ Class Anchor
Extension Methods
+ @@ -593,7 +595,7 @@ This function is usually used to compute the bounding box of elements.

-

Get key anchor.

+

Get key anchor. (i.e. root anchor)

@@ -830,39 +832,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchorFuncSource.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchorFuncSource.html index 5960db75..592fa24a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchorFuncSource.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchorFuncSource.html @@ -298,7 +298,7 @@ Class AnchorFuncSource

-

Get key anchor.

+

Get key anchor. (i.e. root anchor)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredBoxable.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredBoxable.html index c86a654a..f95fdf82 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredBoxable.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredBoxable.html @@ -102,7 +102,7 @@ Class AnchoredBoxable
- 
public class AnchoredBoxable : IGetRootAnchor, IExpandToBox3d
+ 
public class AnchoredBoxable : IGetAnchor, IGetTopoIndex, IExpandToBox3d
@@ -119,7 +119,8 @@ Class AnchoredBoxable
Implements
- + +
@@ -163,6 +164,12 @@ Class AnchoredBoxable + + @@ -214,8 +221,8 @@ Class AnchoredBoxable -

- AnchoredBoxable(IGetRootAnchor, IExpandToBox3d) +

+ AnchoredBoxable(IGetAnchor, IExpandToBox3d)

@@ -224,12 +231,12 @@ Class AnchoredBoxable
- 
public AnchoredBoxable(IGetRootAnchor anchor, IExpandToBox3d boxable)
+ 
public AnchoredBoxable(IGetAnchor anchor, IExpandToBox3d boxable)

Parameters

-
anchor IGetRootAnchor
+
anchor IGetAnchor

The object that provides the root anchor.

boxable IExpandToBox3d
@@ -354,26 +361,26 @@ This function is usually used to compute the bounding box of elements.

- + -

- GetRootAnchor() +

+ GetAnchor()

-

Get root anchor.

+

Get key anchor. (i.e. root anchor)

- 
public Anchor GetRootAnchor()
+ 
public Anchor GetAnchor()

Returns

Anchor
-

root anchor.

+

key anchor

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredDisplayee.html index eba13c73..d7dc0bd1 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AnchoredDisplayee.html @@ -102,7 +102,7 @@ Class AnchoredDisplayee
- 
public class AnchoredDisplayee : IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d
+ 
public class AnchoredDisplayee : IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex
@@ -120,9 +120,10 @@ Class AnchoredDisplayee
Implements
- + +
@@ -156,6 +157,9 @@ Class AnchoredDisplayee
Extension Methods
+ @@ -165,6 +169,12 @@ Class AnchoredDisplayee + + @@ -395,7 +405,8 @@ Class AnchoredDisplayee -
+

Get key anchor. (i.e. root anchor)

+
@@ -406,39 +417,7 @@ Class AnchoredDisplayee

Returns

Anchor
-
-
- - - - - - - - - - - - - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

+

key anchor

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Asmb.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Asmb.html index fa09b207..21d58067 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Asmb.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.Asmb.html @@ -589,8 +589,8 @@ the members will be generated; otherwise, the existed members are applied.

-

- Display(Bind, Anchor, params IGetRootAnchor[]) +

+ Display(Bind, Anchor, params IGetAnchor[])

@@ -601,7 +601,7 @@ If the element of displayees is not
- 
public void Display(Bind bind, Anchor root, params IGetRootAnchor[] displayees)
+ 
public void Display(Bind bind, Anchor root, params IGetAnchor[] displayees)

Parameters

@@ -612,7 +612,7 @@ If the element of displayees is not Anchor

fixed anchor

-
displayees IGetRootAnchor[]
+
displayees IGetAnchor[]

element to be rendered

@@ -630,8 +630,8 @@ If the element of displayees is not -

- Display(Bind, Dictionary<Anchor, Mat4d>, params IGetRootAnchor[]) +

+ Display(Bind, Dictionary<Anchor, Mat4d>, params IGetAnchor[])

@@ -641,7 +641,7 @@ If displayees is null, do nothing.

- 
public static void Display(Bind bind, Dictionary<Anchor, Mat4d> map, params IGetRootAnchor[] displayees)
+ 
public static void Display(Bind bind, Dictionary<Anchor, Mat4d> map, params IGetAnchor[] displayees)

Parameters

@@ -652,7 +652,7 @@ If displayees is null, do nothing.

map Dictionary<Anchor, Mat4d>

anchor to transformation map

-
displayees IGetRootAnchor[]
+
displayees IGetAnchor[]

displayees

@@ -728,8 +728,8 @@ If displayees is null, do nothing.

-

- ExpandToBox3d(Box3d, Anchor, params IGetRootAnchor[]) +

+ ExpandToBox3d(Box3d, Anchor, params IGetAnchor[])

@@ -738,7 +738,7 @@ If displayees is null, do nothing.

- 
public void ExpandToBox3d(Box3d dst, Anchor root, params IGetRootAnchor[] displayees)
+ 
public void ExpandToBox3d(Box3d dst, Anchor root, params IGetAnchor[] displayees)

Parameters

@@ -749,7 +749,7 @@ If displayees is null, do nothing.

root Anchor

The root anchor for the calculation.

-
displayees IGetRootAnchor[]
+
displayees IGetAnchor[]

The displayable objects to include in the calculation.

@@ -962,8 +962,8 @@ If displayees is null, do nothing.

-

- GetBox3d(Anchor, params IGetRootAnchor[]) +

+ GetBox3d(Anchor, params IGetAnchor[])

@@ -972,7 +972,7 @@ If displayees is null, do nothing.

- 
public Box3d GetBox3d(Anchor root, params IGetRootAnchor[] displayees)
+ 
public Box3d GetBox3d(Anchor root, params IGetAnchor[] displayees)

Parameters

@@ -980,7 +980,7 @@ If displayees is null, do nothing.

root Anchor

The root anchor for the calculation.

-
displayees IGetRootAnchor[]
+
displayees IGetAnchor[]

The displayable objects to include in the calculation.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AsmbDraw.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AsmbDraw.html index 6b387de2..965e925f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AsmbDraw.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.AsmbDraw.html @@ -155,6 +155,9 @@ in form of Coordinate
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicFreeform.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicFreeform.html index b425448c..64bcc4a0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicFreeform.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicFreeform.html @@ -429,8 +429,8 @@ Class DynamicFreeform -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -440,7 +440,7 @@ This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -450,6 +450,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -466,6 +469,11 @@ This method may also generate additional resources such as related files.

+

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.Mech.Topo.DynamicRotation.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicRotation.html index 29c5348d..1bfa6b60 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicRotation.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicRotation.html @@ -628,8 +628,8 @@ Class DynamicRotation -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -639,7 +639,7 @@ This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -649,6 +649,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -665,6 +668,11 @@ This method may also generate additional resources such as related files.

+

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.Mech.Topo.DynamicTranslation.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicTranslation.html index aa1257a0..9ca11032 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicTranslation.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.DynamicTranslation.html @@ -561,8 +561,8 @@ Class DynamicTranslation -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -572,7 +572,7 @@ This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -582,6 +582,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -598,6 +601,11 @@ This method may also generate additional resources such as related files.

+

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.Mech.Topo.GeneralTransform.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.GeneralTransform.html index 981e28e0..f05bf630 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.GeneralTransform.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.GeneralTransform.html @@ -589,8 +589,8 @@ Class GeneralTransform -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -600,7 +600,7 @@ This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -610,6 +610,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -626,6 +629,11 @@ This method may also generate additional resources such as related files.

+

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.Mech.Topo.IAnchoredDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IAnchoredDisplayee.html index 54ac7dae..0d78f431 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IAnchoredDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IAnchoredDisplayee.html @@ -102,7 +102,7 @@ Interface IAnchoredDisplayee
- 
public interface IAnchoredDisplayee : IGetRootAnchor, IDisplayee, IExpandToBox3d
+ 
public interface IAnchoredDisplayee : IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d
@@ -115,7 +115,7 @@ Interface IAnchoredDisplayee
Inherited Members
IDisplayee.Display(Bind) @@ -128,6 +128,9 @@ Interface IAnchoredDisplayee
Extension Methods
+ @@ -137,6 +140,12 @@ Interface IAnchoredDisplayee + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicRegular.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicRegular.html index 9c8550f2..c01145fe 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicRegular.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicRegular.html @@ -124,7 +124,7 @@ Interface IDynamicRegular ITransformer.Clone()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicTransformer.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicTransformer.html index de9d53b1..52bc66f7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicTransformer.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IDynamicTransformer.html @@ -124,7 +124,7 @@ Interface IDynamicTransformer ITransformer.Clone()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetAnchor.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetAnchor.html index 40c6f6cf..7b256c89 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetAnchor.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetAnchor.html @@ -159,7 +159,7 @@ Interface IGetAnchor -

Get key anchor.

+

Get key anchor. (i.e. root anchor)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IStaticTransformer.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IStaticTransformer.html index eed60a0a..f792d57a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IStaticTransformer.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IStaticTransformer.html @@ -124,7 +124,7 @@ Interface IStaticTransformer ITransformer.Clone()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.ITopoDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITopo.html similarity index 81% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.ITopoDisplayee.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITopo.html index 464d0c08..c3d5e927 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.ITopoDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITopo.html @@ -2,9 +2,9 @@ - Interface ITopoDisplayee | HiAPI-C# 2025 + Interface ITopo | HiAPI-C# 2025 - + @@ -84,16 +84,16 @@
-
+
-

-Interface ITopoDisplayee +

+Interface ITopo

-
Namespace
Hi.Disp
+
Namespace
Hi.Mech.Topo
Assembly
HiMech.dll
@@ -102,7 +102,7 @@ Interface ITopoDisplayee
- 
public interface ITopoDisplayee : IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList
+ 
public interface ITopo : IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList
@@ -118,13 +118,7 @@ Interface ITopoDisplayee IGetAsmb.GetAsmb()
- -
ColorUtil.GetGloomyColor(object, double, double) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.ISolidMachiningChain.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITopoDisplayee.html similarity index 71% rename from App/wwwroot/HiAPI-docsite/api/Hi.NcMech.ISolidMachiningChain.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITopoDisplayee.html index 7ceb9191..72d97dfb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.ISolidMachiningChain.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITopoDisplayee.html @@ -2,11 +2,11 @@ - Interface ISolidMachiningChain | HiAPI-C# 2025 + Interface ITopoDisplayee | HiAPI-C# 2025 - + + - @@ -84,26 +84,24 @@
-
+
-

-Interface ISolidMachiningChain +

+Interface ITopoDisplayee

-
Namespace
Hi.NcMech
+
Namespace
Hi.Mech.Topo
Assembly
HiMech.dll
-

Interface for a machining chain that provides access to solid geometry. -Extends IMachiningChain with solid geometry capabilities.

-
+
- 
public interface ISolidMachiningChain : IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary
+ 
public interface ITopoDisplayee : ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d
@@ -115,32 +113,20 @@ Extends IMachiningChain
Inherited Members
- - - -
@@ -148,7 +134,19 @@ Extends IMachiningChain
Extension Methods
+ + + +
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITransformer.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITransformer.html index 4995beb7..302e6475 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITransformer.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.ITransformer.html @@ -115,7 +115,7 @@ Interface ITransformer
Inherited Members
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.NoTransform.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.NoTransform.html index aab005d8..aae6cae5 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.NoTransform.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.NoTransform.html @@ -421,8 +421,8 @@ Class NoTransform -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -432,7 +432,7 @@ This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -442,6 +442,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -458,6 +461,11 @@ This method may also generate additional resources such as related files.

+

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.Mech.Topo.StackTransformer.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StackTransformer.html index 98253fa1..20bccf70 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StackTransformer.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StackTransformer.html @@ -585,33 +585,37 @@ If forward mats is ABCD, then the inv-mats: DinvCinvBinv -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML representation of this transformer stack.

+

Creates an XML representation of the object. +This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string
-

The base directory for resolving relative paths.

+

The base directory for resolving relative paths

relFile string
-

The relative file path for XML serialization.

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element containing the transformer stack configuration.

+

An XML element representing the object's state

@@ -621,6 +625,11 @@ If forward mats is ABCD, then the inv-mats: DinvCinvBinvRemarks +

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.Mech.Topo.StaticFreeform.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticFreeform.html index 8aaef38e..da193d74 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticFreeform.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticFreeform.html @@ -490,8 +490,8 @@ Class StaticFreeform -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -501,7 +501,7 @@ This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -511,6 +511,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -527,6 +530,11 @@ This method may also generate additional resources such as related files.

+

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.Mech.Topo.StaticRotation.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticRotation.html index 8482776d..9834844d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticRotation.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticRotation.html @@ -621,33 +621,37 @@ Class StaticRotation -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML element representing this rotation.

+

Creates an XML representation of the object. +This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string
-

The base directory for relative paths.

+

The base directory for resolving relative paths

relFile string
-

The relative file path.

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element containing the rotation data.

+

An XML element representing the object's state

@@ -657,6 +661,11 @@ Class StaticRotation +

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.Mech.Topo.StaticTranslation.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticTranslation.html index 18e98272..1ff2f05c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticTranslation.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.StaticTranslation.html @@ -522,8 +522,8 @@ Class StaticTranslation -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -533,7 +533,7 @@ This method may also generate additional resources such as related files.

- 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -543,6 +543,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -559,6 +562,11 @@ This method may also generate additional resources such as related files.

+

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.Disp.TopoDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.TopoDisplayee.html similarity index 77% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.TopoDisplayee.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.TopoDisplayee.html index 0d9ace54..fdd910b6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.TopoDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.TopoDisplayee.html @@ -84,16 +84,16 @@
-
+
-

+

Class TopoDisplayee

-
Namespace
Hi.Disp
+
Namespace
Hi.Mech.Topo
Assembly
HiMech.dll
@@ -102,7 +102,7 @@ Class TopoDisplayee
- 
public class TopoDisplayee : ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList
+ 
public class TopoDisplayee : ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList
@@ -119,13 +119,10 @@ Class TopoDisplayee
Implements
- + + - - - -
@@ -161,10 +158,16 @@ Class TopoDisplayee
Extension Methods
+ +
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -197,14 +200,14 @@ Class TopoDisplayee - + -

+

TopoDisplayee(Anchor, Asmb, params IAnchoredDisplayee[])

-

Initializes a new instance of the TopoDisplayee class with the specified root anchor, assembly, and displayees.

+

Initializes a new instance of the TopoDisplayee class with the specified root anchor, assembly, and displayees.

@@ -240,9 +243,9 @@ Class TopoDisplayee - + -

+

AnchoredDisplayeeList

@@ -272,9 +275,9 @@ Class TopoDisplayee - + -

+

Asmb

@@ -304,9 +307,9 @@ Class TopoDisplayee - + -

+

RootAnchor

@@ -340,15 +343,14 @@ Class TopoDisplayee - + -

+

Display(Bind)

-

Display function called in DispEngine rendering loop.

-
+
@@ -358,8 +360,7 @@ Class TopoDisplayee

Parameters

bind Bind
-

Bind with DispEngine. See Bind.

-
+
@@ -373,16 +374,14 @@ Class TopoDisplayee - + -

+

ExpandToBox3d(Box3d)

-

Expands the destination box. -This function is usually used to compute the bounding box of elements.

-
+
@@ -392,8 +391,7 @@ This function is usually used to compute the bounding box of elements.

Parameters

dst Box3d
-

Destination box

-
+
@@ -407,9 +405,42 @@ This function is usually used to compute the bounding box of elements.

- + -

+

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + + + + +

GetAnchoredDisplayeeList()

@@ -440,9 +471,9 @@ This function is usually used to compute the bounding box of elements.

- + -

+

GetAsmb()

@@ -473,39 +504,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.TopoDisplayeeUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.TopoDisplayeeUtil.html similarity index 86% rename from App/wwwroot/HiAPI-docsite/api/Hi.Disp.TopoDisplayeeUtil.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.TopoDisplayeeUtil.html index 58b4bb10..0f52e45e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Disp.TopoDisplayeeUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.TopoDisplayeeUtil.html @@ -84,16 +84,16 @@
-
+
-

+

Class TopoDisplayeeUtil

-
Namespace
Hi.Disp
+
Namespace
Hi.Mech.Topo
Assembly
HiMech.dll
@@ -153,10 +153,10 @@ Class TopoDisplayeeUtil - + -

- Display(ITopoDisplayee, Bind) +

+ Display(ITopo, Bind)

@@ -165,12 +165,12 @@ Class TopoDisplayeeUtil
- 
public static void Display(this ITopoDisplayee src, Bind bind)
+ 
public static void Display(this ITopo src, Bind bind)

Parameters

-
src ITopoDisplayee
+
src ITopo

The topological displayee to display.

bind Bind
@@ -189,10 +189,10 @@ Class TopoDisplayeeUtil - + -

- ExpandToBox3d(ITopoDisplayee, Box3d) +

+ ExpandToBox3d(ITopo, Box3d)

@@ -201,12 +201,12 @@ Class TopoDisplayeeUtil
- 
public static void ExpandToBox3d(this ITopoDisplayee src, Box3d dst)
+ 
public static void ExpandToBox3d(this ITopo src, Box3d dst)

Parameters

-
src ITopoDisplayee
+
src ITopo

The topological displayee whose geometry should be included.

dst Box3d
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.html b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.html index 86d65b93..9b21f841 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.html @@ -183,6 +183,16 @@ in form of Coordinate
StaticTranslation

Static Translate.

+
+
+
+
TopoDisplayee
+

Implements a displayable topological element that manages a collection of anchored displayees within an assembly.

+
+
+
+
TopoDisplayeeUtil
+

Provides utility methods for displaying and manipulating topological displayees.

@@ -231,11 +241,6 @@ Interfaces
IGetAsmb

Interface of Getting a key Asmb.

-
-
-
-
IGetBuckleAnchorList
-

Interface of GetBuckleAnchorList().

@@ -246,11 +251,6 @@ Interfaces
IGetInverseTransformer

Interface for objects that can provide their inverse transformer.

-
-
-
-
IGetRootAnchor
-

Interface of GetRootAnchor().

@@ -263,6 +263,15 @@ Interfaces

Static Transformer

+
+
ITopo
+

Defines an interface for displaying topological elements that combines assembly, anchoring, and display capabilities.

+
+
+
+
ITopoDisplayee
+
+
ITransformer

Interface of single transform matrix manipulation.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.AptDerivative.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.AptDerivative.html index f60ea990..bcaf8dd4 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.AptDerivative.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.AptDerivative.html @@ -102,7 +102,7 @@ Class AptDerivative
- 
public class AptDerivative : IExpandToBox3d, IGetZrContour
+ 
public class AptDerivative : IExpandToBox3d, IGetZrContour, IGenStl
@@ -121,6 +121,7 @@ Class AptDerivative
+
@@ -318,6 +319,37 @@ Class AptDerivative + + +

+ DefaultPolarResolution2d + +

+ +
+
+ +
+ 
public static IPolarResolution2d DefaultPolarResolution2d { get; set; }
+
+ + + + + +

Property Value

+
+
IPolarResolution2d
+
+
+ + + + + + + +

@@ -614,33 +646,29 @@ This function is usually used to compute the bounding box of elements.

-

- GenStl(int, int) +

+ GenStl(IPolarResolution2d)

-

Generate shank stl.

+

Generate a new Stl.

- 
public Stl GenStl(int latitudeNum = 8, int longitudeNum = 24)
+ 
public Stl GenStl(IPolarResolution2d resolution)

Parameters

-
latitudeNum int
-

latitude number

-
-
longitudeNum int
-

longitude number

-
+
resolution IPolarResolution2d
+

Returns

Stl
-

shank stl

+

newly created Stl

@@ -695,45 +723,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetPairZrList(int) - -

- -

Gets a list of Z-R pairs that define the tool profile.

-
-
- -
- 
public List<PairZr> GetPairZrList(int latitudeNum = 8)
-
- -

Parameters

-
-
latitudeNum int
-

The number of latitude divisions for the profile.

-
-
- -

Returns

-
-
List<PairZr>
-

A list of Z-R coordinate pairs defining the tool profile.

-
-
- - - - - - - - - - -

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BallApt.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BallApt.html index 991af37b..337e514d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BallApt.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BallApt.html @@ -102,7 +102,7 @@ Class BallApt
- 
public class BallApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate
+ 
public class BallApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IToXElement
@@ -127,6 +127,7 @@ Class BallApt +

@@ -387,33 +388,6 @@ Class BallApt - - -

- ClearCache() - -

- -

Clears the internal cache.

-
-
- -
- 
public void ClearCache()
-
- - - - - - - - - - - - -

@@ -522,8 +496,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -533,7 +507,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -543,6 +517,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -559,6 +536,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BullNoseApt.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BullNoseApt.html index b5970f46..506f9c72 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BullNoseApt.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.BullNoseApt.html @@ -102,7 +102,7 @@ Class BullNoseApt
- 
public class BullNoseApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc
+ 
public class BullNoseApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc, IToXElement
@@ -128,6 +128,7 @@ Class BullNoseApt +
@@ -420,33 +421,6 @@ Class BullNoseApt - - -

- ClearCache() - -

- -

Clears the internal cache.

-
-
- -
- 
public void ClearCache()
-
- - - - - - - - - - - - -

@@ -555,8 +529,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -566,7 +540,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -576,6 +550,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -592,6 +569,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ColumnApt.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ColumnApt.html index fc985ea7..ed6df74a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ColumnApt.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ColumnApt.html @@ -104,7 +104,7 @@ However, the nose radius is generally smaller than the
- 
public class ColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc
+ 
public class ColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc, IToXElement
@@ -130,6 +130,7 @@ However, the nose radius is generally smaller than the IMakeXmlSource + @@ -422,33 +423,6 @@ However, the nose radius is generally smaller than the - -

- ClearCache() - -

- -

Clears the internal cache.

-
-
- -
- 
public void ClearCache()
-
- - - - - - - - - - - - -

@@ -557,8 +531,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -568,7 +542,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -578,6 +552,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -594,6 +571,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ConeApt.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ConeApt.html index bdef7ad0..310a2d42 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ConeApt.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ConeApt.html @@ -102,7 +102,7 @@ Class ConeApt
- 
public class ConeApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptAlpha
+ 
public class ConeApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptAlpha, IToXElement
@@ -128,6 +128,7 @@ Class ConeApt + @@ -452,33 +453,6 @@ Class ConeApt - - -

- ClearCache() - -

- -

Clears the internal cache.

-
-
- -
- 
public void ClearCache()
-
- - - - - - - - - - - - -

@@ -587,8 +561,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -598,7 +572,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -608,6 +582,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -624,6 +601,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ExactColumnApt.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ExactColumnApt.html index 05f4cc3a..dd8a3398 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ExactColumnApt.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.ExactColumnApt.html @@ -102,7 +102,7 @@ Class ExactColumnApt
- 
public class ExactColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate
+ 
public class ExactColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IToXElement
@@ -127,6 +127,7 @@ Class ExactColumnApt + @@ -387,33 +388,6 @@ Class ExactColumnApt - - -

- ClearCache() - -

- -

Clears the internal cache.

-
-
- -
- 
public void ClearCache()
-
- - - - - - - - - - - - -

@@ -522,8 +496,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -533,7 +507,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -543,6 +517,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -559,6 +536,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.GeneralApt.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.GeneralApt.html index 694a9197..dafd849b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.GeneralApt.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.GeneralApt.html @@ -102,7 +102,7 @@ Class GeneralApt
- 
public class GeneralApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IEquatable<GeneralApt>, IAptRc, IAptRr, IAptRz, IAptAlpha, IAptBeta, IGetZrContour
+ 
public class GeneralApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IEquatable<GeneralApt>, IAptRc, IAptRr, IAptRz, IAptAlpha, IAptBeta, IGetZrContour, IToXElement, IGenStl, IClearCache
@@ -134,6 +134,9 @@ Class GeneralApt + + + @@ -909,33 +912,29 @@ This function is usually used to compute the bounding box of elements.

-

- GenStl(int, int) +

+ GenStl(IPolarResolution2d)

-

Generate shank stl.

+

Generate a new Stl.

- 
public Stl GenStl(int latitudeNum = 8, int longtitudeNum = 24)
+ 
public Stl GenStl(IPolarResolution2d polarResolution)

Parameters

-
latitudeNum int
-

latitude number

-
-
longtitudeNum int
-

longtitude number

-
+
polarResolution IPolarResolution2d
+

Returns

Stl
-

shank stl

+

newly created Stl

@@ -1057,8 +1056,8 @@ The Z values should generally be ordered from smallest to largest.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1068,7 +1067,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1078,6 +1077,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1094,6 +1096,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -1131,6 +1138,39 @@ This method may also generate additional resources such as related files.

+ + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + + + + +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.IAptBased.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.IAptBased.html index 28285d89..278e1173 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.IAptBased.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.IAptBased.html @@ -124,7 +124,7 @@ Interface IAptBased IExpandToBox3d.ExpandToBox3d(Box3d)
IDuplicate.Duplicate(params object[]) @@ -229,37 +229,6 @@ Interface IAptBased -

Methods -

- - - - -

- ClearCache() - -

- -

Clears the internal cache.

-
-
- -
- 
void ClearCache()
-
- - - - - - - - - - - - -
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.TaperApt.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.TaperApt.html index 8862c0da..b3365afa 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.TaperApt.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Apts.TaperApt.html @@ -102,7 +102,7 @@ Class TaperApt
- 
public class TaperApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRz, IAptAlpha, IAptBeta
+ 
public class TaperApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRz, IAptAlpha, IAptBeta, IToXElement
@@ -130,6 +130,7 @@ Class TaperApt + @@ -555,33 +556,6 @@ The unit is radian.

- - -

- ClearCache() - -

- -

Clears the internal cache.

-
-
- -
- 
public void ClearCache()
-
- - - - - - - - - - - - -

@@ -690,8 +664,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -701,7 +675,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -711,6 +685,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -727,6 +704,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.AptProfile.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.AptProfile.html index 18edfbd5..4d265a24 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.AptProfile.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.AptProfile.html @@ -6,7 +6,7 @@ - + @@ -98,13 +98,12 @@ Class AptProfile

Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. -This profile uses APT definitions to describe the cutter geometry. -Internal Use Only

+This profile uses APT definitions to describe the cutter geometry.

- 
public class AptProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IGetSelectionName, IGetInitStickConvex, IVolumeRemover, IDisposable, IUpdateByContent, IClearCache
+ 
public class AptProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IGetSelectionName, IGetInitStickConvex, IVolumeRemover, IDisposable, IUpdateByContent, IClearCache, IPolarResolution2dSourceProperty
@@ -124,8 +123,9 @@ Internal Use Only

- + + @@ -133,6 +133,7 @@ Internal Use Only

+ @@ -205,8 +206,8 @@ Internal Use Only

-

- AptProfile(MillingCutter) +

+ AptProfile()

@@ -215,15 +216,9 @@ Internal Use Only

- 
public AptProfile(MillingCutter host)
+ 
public AptProfile()
-

Parameters

-
-
host MillingCutter
-

The milling cutter that hosts this profile.

-
-
@@ -238,8 +233,8 @@ Internal Use Only

-

- AptProfile(MillingCutter, IAptBased) +

+ AptProfile(IAptBased)

@@ -248,14 +243,11 @@ Internal Use Only

- 
public AptProfile(MillingCutter host, IAptBased apt)
+ 
public AptProfile(IAptBased apt)

Parameters

-
host MillingCutter
-

The milling cutter that hosts this profile.

-
apt IAptBased

The APT-based object.

@@ -274,8 +266,8 @@ Internal Use Only

-

- AptProfile(XElement, string, MillingCutter) +

+ AptProfile(XElement, string)

@@ -284,7 +276,7 @@ Internal Use Only

- 
public AptProfile(XElement src, string baseDirectory, MillingCutter host)
+ 
public AptProfile(XElement src, string baseDirectory)

Parameters

@@ -294,9 +286,6 @@ Internal Use Only

baseDirectory string

The base directory for resolving relative paths.

-
-
host MillingCutter
-

The milling cutter that hosts this profile.

@@ -322,8 +311,7 @@ Internal Use Only

-

Gets the abstract note from the APT definition. -Internal Use Only

+

Gets the abstract note from the APT definition.

@@ -355,8 +343,7 @@ Internal Use Only

-

Gets or sets the APT-based definition for the profile. -Internal Use Only

+

Gets or sets the APT-based definition for the profile.

@@ -381,20 +368,19 @@ Internal Use Only

- + -

- Host +

+ DefaultAngleResolution_rad

-

Gets or sets the associated milling cutter. -Internal Use Only

+

Gets or sets the default angle resolution in radians.

- 
public MillingCutter Host { get; set; }
+ 
public static double DefaultAngleResolution_rad { get; set; }
@@ -403,7 +389,70 @@ Internal Use Only

Property Value

-
MillingCutter
+
double
+
+
+ + + + + + + + + + +

+ DefaultLinearResolution_mm + +

+ +

Gets or sets the default linear resolution in millimeters.

+
+
+ +
+ 
public static double DefaultLinearResolution_mm { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ PolarResolution2dSource + +

+ +
+
+ +
+ 
public Func<IPolarResolution2d> PolarResolution2dSource { get; set; }
+
+ + + + + +

Property Value

+
+
Func<IPolarResolution2d>
@@ -457,8 +506,7 @@ Internal Use Only

-

Clears all cached data. -Internal Use Only

+

Clears all cached data.

@@ -485,8 +533,7 @@ Internal Use Only

-

Disposes of all resources. -Internal Use Only

+

Disposes of all resources.

@@ -513,8 +560,7 @@ Internal Use Only

-

Disposes of unmanaged resources. -Internal Use Only

+

Disposes of unmanaged resources.

@@ -579,6 +625,44 @@ Internal Use Only

+ + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
public Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + +

@@ -586,8 +670,7 @@ Internal Use Only

-

Gets the initial stick convex representation of the profile. -Internal Use Only

+

Gets the initial stick convex representation of the profile.

@@ -620,8 +703,7 @@ Internal Use Only

-

Gets the display name for selection. -Internal Use Only

+

Gets the display name for selection.

@@ -654,8 +736,7 @@ Internal Use Only

-

Gets the STL mesh representation of the profile. -Internal Use Only

+

Gets the STL mesh representation of the profile.

@@ -688,8 +769,7 @@ Internal Use Only

-

Gets the ZR contour list for the profile. -Internal Use Only

+

Gets the ZR contour list for the profile.

@@ -717,8 +797,8 @@ Internal Use Only

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -728,7 +808,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -738,6 +818,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -754,6 +837,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -765,8 +853,7 @@ This method may also generate additional resources such as related files.

-

Updates the profile based on content changes. -Internal Use Only

+

Updates the profile based on content changes.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.ConstRatioProfile.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.ConstRatioProfile.html index ad339616..b5e68a48 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.ConstRatioProfile.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.ConstRatioProfile.html @@ -6,7 +6,7 @@ - + @@ -98,13 +98,12 @@ Class ConstRatioProfile

Represents a constant ratio profile for a milling cutter. -This profile maintains a constant ratio between inner and outer radii. -Internal Use Only

+This profile maintains a constant ratio between inner and outer radii.

- 
public class ConstRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache
+ 
public class ConstRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGetStl, IDuplicate, IClearCache, IGenStl, IZrListSourceProperty
@@ -124,10 +123,12 @@ Internal Use Only

- + + + @@ -200,26 +201,19 @@ Internal Use Only

-

- ConstRatioProfile(MillingCutter) +

+ ConstRatioProfile()

-

Initializes a new instance of the ConstRatioProfile class. -Internal Use Only

+

Initializes a new instance of the ConstRatioProfile class.

- 
public ConstRatioProfile(MillingCutter millingCutter)
+ 
public ConstRatioProfile()
-

Parameters

-
-
millingCutter MillingCutter
-

The associated milling cutter

-
-
@@ -234,25 +228,21 @@ Internal Use Only

-

- ConstRatioProfile(MillingCutter, double) +

+ ConstRatioProfile(double)

-

Initializes a new instance of the ConstRatioProfile class with a specified radius ratio. -Internal Use Only

+

Initializes a new instance of the ConstRatioProfile class with a specified radius ratio.

- 
public ConstRatioProfile(MillingCutter millingCutter, double innerRadiusRatio)
+ 
public ConstRatioProfile(double innerRadiusRatio)

Parameters

-
millingCutter MillingCutter
-

The associated milling cutter

-
innerRadiusRatio double

The ratio between inner and outer radii

@@ -271,8 +261,8 @@ Internal Use Only

-

- ConstRatioProfile(XElement, string, MillingCutter) +

+ ConstRatioProfile(XElement, string)

@@ -281,7 +271,7 @@ Internal Use Only

- 
public ConstRatioProfile(XElement element, string baseDirectory, MillingCutter host)
+ 
public ConstRatioProfile(XElement element, string baseDirectory)

Parameters

@@ -291,9 +281,6 @@ Internal Use Only

baseDirectory string

The base directory for resolving relative paths.

-
-
host MillingCutter
-

The host milling cutter.

@@ -319,8 +306,7 @@ Internal Use Only

-

Gets the abstract note describing the profile. -Internal Use Only

+

Gets the abstract note describing the profile.

@@ -345,39 +331,6 @@ Internal Use Only

- - -

- MillingCutter - -

- -

Gets or sets the associated milling cutter. -Internal Use Only

-
-
- -
- 
public MillingCutter MillingCutter { get; set; }
-
- - - - - -

Property Value

-
-
MillingCutter
-
-
- - - - - - - -

@@ -385,8 +338,7 @@ Internal Use Only

-

Gets or sets the ratio between inner and outer radii. -Internal Use Only

+

Gets or sets the ratio between inner and outer radii.

@@ -443,6 +395,39 @@ Internal Use Only

+ + +

+ ZrListSource + +

+ +

Get base geometry source. +Runtime property.

+
+
+ +
+ 
public Func<IGetZrList> ZrListSource { get; set; }
+
+ + + + + +

Property Value

+
+
Func<IGetZrList>
+
+
+ + + + + + + +

Methods

@@ -513,6 +498,44 @@ Internal Use Only

+ + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
public Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + +

@@ -581,8 +604,8 @@ Internal Use Only

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -592,7 +615,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -602,6 +625,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -618,6 +644,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.Cutters.CustomSpinningProfile.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.CustomSpinningProfile.html index c17fc909..47d28707 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.CustomSpinningProfile.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.CustomSpinningProfile.html @@ -6,7 +6,7 @@ - + @@ -98,13 +98,12 @@ Class CustomSpinningProfile

Represents a custom spinning profile for a milling cutter. -This profile allows for custom geometry to be used as the cutter profile. -Internal Use Only

+This profile allows for custom geometry to be used as the cutter profile.

- 
public class CustomSpinningProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache
+ 
public class CustomSpinningProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache, IPolarResolution2dSourceProperty
@@ -124,10 +123,12 @@ Internal Use Only

- + + + @@ -200,8 +201,8 @@ Internal Use Only

-

- CustomSpinningProfile(MillingCutter) +

+ CustomSpinningProfile(IGetStl)

@@ -210,12 +211,12 @@ Internal Use Only

- 
public CustomSpinningProfile(MillingCutter host)
+ 
public CustomSpinningProfile(IGetStl geom)

Parameters

-
host MillingCutter
+
geom IGetStl
@@ -232,8 +233,8 @@ Internal Use Only

-

- CustomSpinningProfile(XElement, string, MillingCutter, params object[]) +

+ CustomSpinningProfile(XElement, string, params object[])

@@ -242,7 +243,7 @@ Internal Use Only

- 
public CustomSpinningProfile(XElement element, string baseDirectory, MillingCutter host, params object[] res)
+ 
public CustomSpinningProfile(XElement element, string baseDirectory, params object[] res)

Parameters

@@ -252,9 +253,6 @@ Internal Use Only

baseDirectory string

The base directory for resolving relative paths.

-
-
host MillingCutter
-

The host milling cutter.

res object[]

Additional resolution parameters.

@@ -283,8 +281,7 @@ Internal Use Only

-

Gets the abstract note describing the profile. -Internal Use Only

+

Gets the abstract note describing the profile.

@@ -316,8 +313,7 @@ Internal Use Only

-

Gets or sets the geometry that defines the profile. -Internal Use Only

+

Gets or sets the geometry that defines the profile.

@@ -342,20 +338,18 @@ Internal Use Only

- + -

- Host +

+ PolarResolution2dSource

-

Gets or sets the associated milling cutter. -Internal Use Only

-
+
- 
public MillingCutter Host { get; set; }
+ 
public Func<IPolarResolution2d> PolarResolution2dSource { get; set; }
@@ -364,7 +358,7 @@ Internal Use Only

Property Value

-
MillingCutter
+
Func<IPolarResolution2d>
@@ -418,8 +412,7 @@ Internal Use Only

-

Clears any cached data. -Internal Use Only

+

Clears any cached data.

@@ -478,6 +471,44 @@ Internal Use Only

+ + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
public Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + +

@@ -485,8 +516,7 @@ Internal Use Only

-

Gets the STL mesh representation of the profile. -Internal Use Only

+

Gets the STL mesh representation of the profile.

@@ -520,8 +550,7 @@ Internal Use Only

Gets the ZR contour list for the profile. -This method attempts to get the ZR list from various geometry types. -Internal Use Only

+This method attempts to get the ZR list from various geometry types.

@@ -549,8 +578,8 @@ Internal Use Only

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -560,7 +589,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -570,6 +599,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -586,6 +618,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.Cutters.FluteContourDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.FluteContourDisplayee.html index 8ebbef8f..278a5c0c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.FluteContourDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.FluteContourDisplayee.html @@ -158,6 +158,9 @@ Internal Use Only

Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.FluteDependentRatioProfile.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.FluteDependentRatioProfile.html index 4cf43f3d..d3d84e9a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.FluteDependentRatioProfile.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.FluteDependentRatioProfile.html @@ -6,7 +6,7 @@ - + @@ -98,13 +98,12 @@ Class FluteDependentRatioProfile

Represents a flute number dependent ratio profile for a milling cutter. -This profile determines the ratio between inner and outer radii based on the number of flutes. -Internal Use Only

+This profile determines the ratio between inner and outer radii based on the number of flutes.

- 
public class FluteDependentRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache
+ 
public class FluteDependentRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache, IFluteNumSourceProperty, IZrListSourceProperty
@@ -124,10 +123,13 @@ Internal Use Only

- + + + + @@ -200,26 +202,19 @@ Internal Use Only

-

- FluteDependentRatioProfile(MillingCutter) +

+ FluteDependentRatioProfile()

-

Initializes a new instance of the FluteDependentRatioProfile class. -Internal Use Only

+

Initializes a new instance.

- 
public FluteDependentRatioProfile(MillingCutter millingCutter)
+ 
public FluteDependentRatioProfile()
-

Parameters

-
-
millingCutter MillingCutter
-

The associated milling cutter

-
-
@@ -234,8 +229,8 @@ Internal Use Only

-

- FluteDependentRatioProfile(XElement, string, MillingCutter) +

+ FluteDependentRatioProfile(XElement, string)

@@ -244,7 +239,7 @@ Internal Use Only

- 
public FluteDependentRatioProfile(XElement element, string baseDirectory, MillingCutter host)
+ 
public FluteDependentRatioProfile(XElement element, string baseDirectory)

Parameters

@@ -254,9 +249,6 @@ Internal Use Only

baseDirectory string

The base directory for resolving relative paths.

-
-
host MillingCutter
-

The host milling cutter.

@@ -282,8 +274,7 @@ Internal Use Only

-

Gets the abstract note describing the profile. -Internal Use Only

+

Gets the abstract note describing the profile.

@@ -308,20 +299,18 @@ Internal Use Only

- + -

- MillingCutter +

+ FluteNumSource

-

Gets or sets the associated milling cutter. -Internal Use Only

-
+
- 
public MillingCutter MillingCutter { get; set; }
+ 
public Func<int> FluteNumSource { get; set; }
@@ -330,7 +319,7 @@ Internal Use Only

Property Value

-
MillingCutter
+
Func<int>
@@ -348,8 +337,7 @@ Internal Use Only

-

Gets the radius ratio based on the current number of flutes. -Internal Use Only

+

Gets the radius ratio based on the current number of flutes.

@@ -406,6 +394,39 @@ Internal Use Only

+ + +

+ ZrListSource + +

+ +

Get base geometry source. +Runtime property.

+
+
+ +
+ 
public Func<IGetZrList> ZrListSource { get; set; }
+
+ + + + + +

Property Value

+
+
Func<IGetZrList>
+
+
+ + + + + + + +

Methods

@@ -476,6 +497,44 @@ Internal Use Only

+ + +

+ GenStl(IPolarResolution2d) + +

+ +

Generate a new Stl.

+
+
+ +
+ 
public Stl GenStl(IPolarResolution2d resolution)
+
+ +

Parameters

+
+
resolution IPolarResolution2d
+
+
+ +

Returns

+
+
Stl
+

newly created Stl

+
+
+ + + + + + + + + + +

@@ -544,8 +603,8 @@ Internal Use Only

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -555,7 +614,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -565,6 +624,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -581,6 +643,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.Cutters.IShaperProfile.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.IShaperProfile.html index 39496f76..e9227a8c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.IShaperProfile.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.IShaperProfile.html @@ -6,7 +6,7 @@ - + @@ -97,14 +97,12 @@ Interface IShaperProfile
Assembly
HiMech.dll
-

Interface defining the shape profile of a cutter flute. -The cutter flute must also inherit IGetInitStickConvex or IGetSweptable. -Internal Use Only

+

Interface defining the shape profile of a cutter flute.

- 
public interface IShaperProfile : IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache
+ 
public interface IShaperProfile : IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache
@@ -117,16 +115,19 @@ Internal Use Only

Inherited Members
+
IDuplicate.Duplicate(params object[]) @@ -170,17 +171,6 @@ Internal Use Only

-

Remarks

-

This interface combines multiple capabilities:

- -
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutter.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutter.html index 244cd643..8f38edc7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutter.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutter.html @@ -102,7 +102,7 @@ Class MillingCutter
- 
public class MillingCutter : ICutter, IGetSweptable, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IDisposable, IGetFluteHeight, IUpdateByContent, IClearCache, IGetThermalLayerList, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IDuplicate, IGetInitStickConvex, IVolumeRemover, ILinearAndRoundStlResolutionHost, IGetZrList
+ 
public class MillingCutter : ICutter, IGetSweptable, IAnchoredDisplayee, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IDisposable, INameNote, IGetFluteHeight, IDisplayee, IExpandToBox3d, IUpdateByContent, IClearCache, IGetThermalLayerList, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IDuplicate, IGetInitStickConvex, IVolumeRemover, IPolarResolution2d, IGetZrList
@@ -121,6 +121,7 @@ Class MillingCutter
+ @@ -128,22 +129,22 @@ Class MillingCutter + + + - + + - - - - - +
@@ -179,14 +180,23 @@ Class MillingCutter
Extension Methods
- + + + + @@ -405,7 +415,8 @@ Call

Gets or sets the list of coating thermal layers.

+

Gets or sets the list of coating thermal layers. +The sequence starts from surface, i.e. from outer to inner.

@@ -629,7 +640,7 @@ Call

Has to be simultanous with ExposedCutterHeight_mm.

+

Has to be simultanous with ExposedCutterHeight_mm.

@@ -1110,6 +1121,70 @@ Call + +

+ Name + +

+ +

Name.

+
+
+ +
+ 
public string Name { get; set; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + + + +

+ Note + +

+ +

Note.

+
+
+ +
+ 
public string Note { get; set; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + +

@@ -1215,6 +1290,7 @@ Call

Gets or sets the cutter shank mass in grams. If IntegralMode is SolidEnd, the mass is the full cutter mass. +If IntegralMode is InsertEnd, the mass is the shank mass. since the flute mass is assumed small and dynamic depends on the CWE (Cutter-Workpiece-Engagement).

@@ -1405,20 +1481,20 @@ However, there is no exception mechanism.

- + -

- StlLongitudeNum +

+ StrutTopoBrick

-

Stl Longitude Num. -Dependent property form LinearResolution_mm and AngleResolution_rad.

+

uncutable part of cutter. +the part triggers collision to workpiece if overlapped.

- 
public int StlLongitudeNum { get; }
+ 
public ITopoBrick StrutTopoBrick { get; }
@@ -1427,7 +1503,7 @@ Dependent property form Property Value
-
int
+
ITopoBrick
@@ -1534,20 +1610,18 @@ Dependent property form + -

- UpperBeamTopoBrick +

+ UpperBeamPolarResolution2dSource

-

uncutable part of cutter. -the part triggers collision to workpiece if overlapped.

-
+
- 
public ITopoBrick UpperBeamTopoBrick { get; }
+ 
public Func<PolarResolution2d> UpperBeamPolarResolution2dSource { get; set; }
@@ -1556,7 +1630,7 @@ the part triggers collision to workpiece if overlapped.

Property Value

-
ITopoBrick
+
Func<PolarResolution2d>
@@ -1821,6 +1895,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -2166,7 +2273,8 @@ The volume is count from

Gets the minimum uncut chip thickness in millimeters for the specified cutting parameters.

+

Gets the minimum uncut chip thickness in millimeters for the specified cutting parameters. +The value is dependent on HoneRadius_um.

@@ -2270,39 +2378,6 @@ The volume is count from - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

@@ -2509,8 +2584,8 @@ The volume is count from -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -2520,7 +2595,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -2530,6 +2605,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -2546,6 +2624,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html new file mode 100644 index 00000000..44d5a914 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html @@ -0,0 +1,180 @@ + + + + + Enum MillingCutterEditorDisplayee.ShapeModeEnum | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + + +

+Enum MillingCutterEditorDisplayee.ShapeModeEnum +

+ +
+
Namespace
Hi.Milling.Cutters
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public enum MillingCutterEditorDisplayee.ShapeModeEnum
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + + +
+ +

Fields +

+
+
DetailPhysicsShape = 1
+ +
+
SolidBoundingShape = 0
+ +
+
+ + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html index ef55b2b8..3caf50cf 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html @@ -104,7 +104,7 @@ Internal Use Only

- 
public class MillingCutterEditorDisplayee : IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IClearCache, IDisposable
+ 
public class MillingCutterEditorDisplayee : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IClearCache, IDisposable
@@ -122,7 +122,8 @@ Internal Use Only

Implements
- + + @@ -160,6 +161,15 @@ Internal Use Only

Extension Methods
+ + + @@ -198,8 +208,7 @@ Internal Use Only

-

Initializes a new instance of the MillingCutterEditorDisplayee class. -Internal Use Only

+

Initializes a new instance of the MillingCutterEditorDisplayee class.

@@ -226,8 +235,7 @@ Internal Use Only

-

Initializes a new instance of the MillingCutterEditorDisplayee class with a milling cutter host. -Internal Use Only

+

Initializes a new instance of the MillingCutterEditorDisplayee class with a milling cutter host.

@@ -257,20 +265,19 @@ Internal Use Only

- + -

- MillingCutterHost +

+ MillingCutterSourceFunc

-

Gets or sets the function that provides the milling cutter instance. -Internal Use Only

+

Gets or sets the function that provides the milling cutter instance.

- 
public Func<MillingCutter> MillingCutterHost { get; set; }
+ 
public Func<MillingCutter> MillingCutterSourceFunc { get; set; }
@@ -290,6 +297,37 @@ Internal Use Only

+ + +

+ ShapeMode + +

+ +
+
+ +
+ 
public MillingCutterEditorDisplayee.ShapeModeEnum ShapeMode { get; set; }
+
+ + + + + +

Property Value

+
+
MillingCutterEditorDisplayee.ShapeModeEnum
+
+
+ + + + + + + +

Methods

@@ -301,8 +339,7 @@ Internal Use Only

-

Clears all cached display data. -Internal Use Only

+

Clears all cached display data.

@@ -329,8 +366,7 @@ Internal Use Only

-

Displays the milling cutter visualization. -Internal Use Only

+

Displays the milling cutter visualization.

@@ -363,8 +399,7 @@ Internal Use Only

-

Disposes of all resources. -Internal Use Only

+

Disposes of all resources.

@@ -391,8 +426,7 @@ Internal Use Only

-

Disposes of unmanaged resources. -Internal Use Only

+

Disposes of unmanaged resources.

@@ -425,8 +459,7 @@ Internal Use Only

-

Expands the bounding box to include the cutter geometry. -Internal Use Only

+

Expands the bounding box to include the cutter geometry.

@@ -452,20 +485,19 @@ Internal Use Only

- + -

- GetRootAnchor() +

+ GetAnchor()

-

Gets the root anchor point of the cutter. -Internal Use Only

+

Gets the root anchor point of the cutter.

- 
public Anchor GetRootAnchor()
+ 
public Anchor GetAnchor()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.html index b24975a5..fcd4a69d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.Cutters.html @@ -97,22 +97,19 @@ Classes
AptProfile

Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. -This profile uses APT definitions to describe the cutter geometry. -Internal Use Only

+This profile uses APT definitions to describe the cutter geometry.

ConstRatioProfile

Represents a constant ratio profile for a milling cutter. -This profile maintains a constant ratio between inner and outer radii. -Internal Use Only

+This profile maintains a constant ratio between inner and outer radii.

CustomSpinningProfile

Represents a custom spinning profile for a milling cutter. -This profile allows for custom geometry to be used as the cutter profile. -Internal Use Only

+This profile allows for custom geometry to be used as the cutter profile.

@@ -130,8 +127,7 @@ Internal Use Only

FluteDependentRatioProfile

Represents a flute number dependent ratio profile for a milling cutter. -This profile determines the ratio between inner and outer radii based on the number of flutes. -Internal Use Only

+This profile determines the ratio between inner and outer radii based on the number of flutes.

@@ -151,9 +147,7 @@ Interfaces
IShaperProfile
-

Interface defining the shape profile of a cutter flute. -The cutter flute must also inherit IGetInitStickConvex or IGetSweptable. -Internal Use Only

+

Interface defining the shape profile of a cutter flute.

@@ -169,6 +163,10 @@ Enums

Defines the mass assignment mode for the cutter.

+
+
MillingCutterEditorDisplayee.ShapeModeEnum
+
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ConstHelixSideContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ConstHelixSideContour.html index e6e9a489..d3b0ff83 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ConstHelixSideContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ConstHelixSideContour.html @@ -854,8 +854,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -865,7 +865,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -875,6 +875,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -891,6 +894,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.FluteContours.FluteContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FluteContour.html index 1b8cb9cb..4a7d619f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FluteContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FluteContour.html @@ -687,17 +687,18 @@ This is the side profile after applying the shift angle transformation.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML element representing this flute contour

+

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)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -706,14 +707,17 @@ This is the side profile after applying the shift angle transformation.

The base directory for resolving relative paths

relFile string
-

The relative file path

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element containing the flute contour data

+

An XML element representing the object's state

@@ -723,6 +727,11 @@ This is the side profile after applying the shift angle transformation.

+

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.Milling.FluteContours.FreeContourTray.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FreeContourTray.html index 0081609a..822fcc57 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FreeContourTray.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FreeContourTray.html @@ -102,7 +102,7 @@ Class FreeContourTray
- 
public class FreeContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache
+ 
public class FreeContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache, IGetFluteNum
@@ -124,6 +124,7 @@ Class FreeContourTray + @@ -498,10 +499,42 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetFluteNum() + +

+ +

Gets the number of flutes in the contour tray.

+
+
+ +
+ 
public int GetFluteNum()
+
+ + +

Returns

+
+
int
+
+
+ + + + + + + + + + + -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -511,7 +544,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -521,6 +554,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -537,6 +573,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.FluteContours.FreeformSideContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FreeformSideContour.html index 48784b2a..2b2ad067 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FreeformSideContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.FreeformSideContour.html @@ -615,17 +615,18 @@ geometric and angular properties

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML element representing this freeform side contour

+

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)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -634,14 +635,17 @@ geometric and angular properties

The base directory for resolving relative paths

relFile string
-

The relative file path

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element containing the contour data

+

An XML element representing the object's state

@@ -651,6 +655,11 @@ geometric and angular properties

+

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.Milling.FluteContours.IBottomContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IBottomContour.html index 38afacb9..6e33cad0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IBottomContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IBottomContour.html @@ -102,7 +102,7 @@ Interface IBottomContour
- 
public interface IBottomContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d
+ 
public interface IBottomContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d, IClearCache
@@ -124,11 +124,14 @@ Interface IBottomContour IWorkingContour.Duplicate(IGetZrList)
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IContourTray.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IContourTray.html index a2818893..81b22a90 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IContourTray.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IContourTray.html @@ -102,7 +102,7 @@ Interface IContourTray
- 
public interface IContourTray : IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache
+ 
public interface IContourTray : IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache, IGetFluteNum
@@ -115,7 +115,7 @@ Interface IContourTray
Inherited Members
@@ -234,39 +237,6 @@ Interface IContourTray - - -

- GetFluteNum() - -

- -

Gets the number of flutes in this contour tray.

-
-
- -
- 
int GetFluteNum()
-
- - -

Returns

-
-
int
-

The number of flute contours.

-
-
- - - - - - - - - - -
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetBuckleAnchorList.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IFluteNumSourceProperty.html similarity index 80% rename from App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetBuckleAnchorList.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IFluteNumSourceProperty.html index 16322261..3d13674e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetBuckleAnchorList.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IFluteNumSourceProperty.html @@ -2,11 +2,11 @@ - Interface IGetBuckleAnchorList | HiAPI-C# 2025 + Interface IFluteNumSourceProperty | HiAPI-C# 2025 - + - + @@ -84,25 +84,25 @@ -
+
-

-Interface IGetBuckleAnchorList +

+Interface IFluteNumSourceProperty

-
Namespace
Hi.Mech.Topo
+
Namespace
Hi.Milling.FluteContours
Assembly
HiMech.dll
-

Interface of GetBuckleAnchorList().

+

Interface that requiring a FluteNumSource property.

- 
public interface IGetBuckleAnchorList
+ 
public interface IFluteNumSourceProperty
@@ -142,31 +142,32 @@ Interface IGetBuckleAnchorList -

Methods +

Properties

- + -

- GetBuckleAnchorList() +

+ FluteNumSource

-

Get buckle anchors.

-
+
- 
List<Anchor> GetBuckleAnchorList()
+ 
Func<int> FluteNumSource { get; set; }
-

Returns

+ + + +

Property Value

-
List<Anchor>
-

buckle anchors

-
+
Func<int>
+
@@ -177,9 +178,6 @@ Interface IGetBuckleAnchorList - - -
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetRootAnchor.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IGetFluteNum.html similarity index 83% rename from App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetRootAnchor.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IGetFluteNum.html index bb9709eb..63ead086 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Mech.Topo.IGetRootAnchor.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IGetFluteNum.html @@ -2,11 +2,11 @@ - Interface IGetRootAnchor | HiAPI-C# 2025 + Interface IGetFluteNum | HiAPI-C# 2025 - + + - @@ -84,25 +84,24 @@
-
+
-

-Interface IGetRootAnchor +

+Interface IGetFluteNum

-
Namespace
Hi.Mech.Topo
+
Namespace
Hi.Milling.FluteContours
Assembly
HiMech.dll
-

Interface of GetRootAnchor().

-
+
- 
public interface IGetRootAnchor
+ 
public interface IGetFluteNum
@@ -146,27 +145,26 @@ Interface IGetRootAnchor - + -

- GetRootAnchor() +

+ GetFluteNum()

-

Get root anchor.

+

Gets the number of flutes in the contour tray.

- 
Anchor GetRootAnchor()
+ 
int GetFluteNum()

Returns

-
Anchor
-

root anchor.

-
+
int
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ISideContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ISideContour.html index 1fe79da5..291af78c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ISideContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ISideContour.html @@ -102,7 +102,7 @@ Interface ISideContour
- 
public interface ISideContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d
+ 
public interface ISideContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d, IClearCache
@@ -124,11 +124,14 @@ Interface ISideContour IWorkingContour.Duplicate(IGetZrList)
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IWorkingContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IWorkingContour.html index 31877857..11c0487e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IWorkingContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.IWorkingContour.html @@ -103,7 +103,7 @@ This interface is implemented by both side contours (
- 
public interface IWorkingContour : IMakeXmlSource, IExpandToBox3d
+ 
public interface IWorkingContour : IMakeXmlSource, IExpandToBox3d, IClearCache
@@ -116,11 +116,14 @@ This interface is implemented by both side contours (IMakeXmlSource.MakeXmlSource(string, string) + IMakeXmlSource.MakeXmlSource(string, string, bool) +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ShiftedWorkingContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ShiftedWorkingContour.html index 55e32789..f1acbd04 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ShiftedWorkingContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.ShiftedWorkingContour.html @@ -103,7 +103,7 @@ This class wraps another working contour and applies an angular transformation t
- 
public class ShiftedWorkingContour : IWorkingContour, IExpandToBox3d, IMakeXmlSource, IEquatable<ShiftedWorkingContour>
+ 
public class ShiftedWorkingContour : IWorkingContour, IExpandToBox3d, IClearCache, IMakeXmlSource, IEquatable<ShiftedWorkingContour>
@@ -122,6 +122,7 @@ This class wraps another working contour and applies an angular transformation t
+
@@ -452,6 +453,33 @@ This class wraps another working contour and applies an angular transformation t + + +

+ ClearCache() + +

+ +

Clears any cached data held by the implementing object.

+
+
+ +
+ 
public void ClearCache()
+
+ + + + + + + + + + + + +

@@ -670,17 +698,18 @@ This class wraps another working contour and applies an angular transformation t -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML element representing this shifted working contour

+

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)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -689,14 +718,17 @@ This class wraps another working contour and applies an angular transformation t

The base directory for resolving relative paths

relFile string
-

The relative file path

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element containing the shifted working contour data

+

An XML element representing the object's state

@@ -706,6 +738,11 @@ This class wraps another working contour and applies an angular transformation t +

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.Milling.FluteContours.SideContourDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.SideContourDisplayee.html index ed2d0385..a514bb31 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.SideContourDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.SideContourDisplayee.html @@ -155,6 +155,9 @@ Class SideContourDisplayee
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.SlideBottomContour.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.SlideBottomContour.html index ee95f539..05da056e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.SlideBottomContour.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.SlideBottomContour.html @@ -102,7 +102,7 @@ Class SlideBottomContour
- 
public class SlideBottomContour : IBottomContour, IWorkingContour, IMakeXmlSource, IExpandToBox3d
+ 
public class SlideBottomContour : IBottomContour, IWorkingContour, IMakeXmlSource, IExpandToBox3d, IClearCache
@@ -123,6 +123,7 @@ Class SlideBottomContour +
@@ -622,6 +623,33 @@ in radian.

+ + +

+ ClearCache() + +

+ +

Clears any cached data held by the implementing object.

+
+
+ +
+ 
public void ClearCache()
+
+ + + + + + + + + + + + +

@@ -775,8 +803,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -786,7 +814,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -796,6 +824,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -812,6 +843,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.FluteContours.UniformContourTray.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.UniformContourTray.html index 0097b8ca..306951b3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.UniformContourTray.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.UniformContourTray.html @@ -102,7 +102,7 @@ Class UniformContourTray
- 
public class UniformContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache
+ 
public class UniformContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IGetFluteNum, IUpdateByContent, IClearCache
@@ -122,6 +122,7 @@ Class UniformContourTray + @@ -535,7 +536,7 @@ This function is usually used to compute the bounding box of elements.

- 
public virtual int GetFluteNum()
+ 
public int GetFluteNum()
@@ -558,8 +559,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -569,7 +570,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -579,6 +580,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -595,6 +599,11 @@ This method may also generate additional resources such as related files.

+

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.Milling.FluteContours.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.html index 1ab8877d..35cd7ad0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.FluteContours.html @@ -158,6 +158,15 @@ Interfaces

Interface for a container that holds multiple flute contours.

+
+
IFluteNumSourceProperty
+

Interface that requiring a FluteNumSource property.

+
+
+
+
IGetFluteNum
+
+
ISideContour

Represents a side flute contour for milling tools.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingRemovalUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingRemovalUtil.html index 28bb60b4..40e765e1 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingRemovalUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingRemovalUtil.html @@ -155,7 +155,7 @@ Class MillingRemovalUtil -

+

GetContoursOnToolRunningCoordinate(Substraction, MachineMotionStep)

@@ -173,7 +173,7 @@ Class MillingRemovalUtil
substraction Substraction

The subtraction containing contact contours.

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step with coordinate transformation.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.StickMachiningTool.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingTool.html similarity index 65% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.StickMachiningTool.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingTool.html index 8b22d8ed..0a148de7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.StickMachiningTool.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingTool.html @@ -2,9 +2,9 @@ - Class StickMachiningTool | HiAPI-C# 2025 + Class MillingTool | HiAPI-C# 2025 - + @@ -84,16 +84,16 @@ -
+
-

-Class StickMachiningTool +

+Class MillingTool

-
Namespace
Hi.MillingMech.MillingTools
+
Namespace
Hi.Milling.MillingTools
Assembly
HiMech.dll
@@ -102,7 +102,7 @@ Class StickMachiningTool
- 
public class StickMachiningTool : IMachiningTool, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache
+ 
public class MillingTool : IMachiningTool, IDisplayee, IExpandToBox3d, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache, IGetFluteNum
@@ -112,7 +112,7 @@ Class StickMachiningTool
Inheritance
-
StickMachiningTool
+
MillingTool
@@ -120,19 +120,19 @@ Class StickMachiningTool
Implements
- - - - - + + + + +
@@ -167,16 +167,22 @@ Class StickMachiningTool
Extension Methods
+ +
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -209,10 +215,10 @@ Class StickMachiningTool - + -

- StickMachiningTool() +

+ MillingTool()

@@ -221,7 +227,7 @@ Class StickMachiningTool
- 
public StickMachiningTool()
+ 
public MillingTool()
@@ -236,19 +242,19 @@ Class StickMachiningTool - + -

- StickMachiningTool(XElement, string, string) +

+ MillingTool(XElement, string, string)

-

Initializes a new instance of the StickMachiningTool class.

+

Initializes a new instance of the MillingTool class.

- 
public StickMachiningTool(XElement src, string baseDirectory, string relFile)
+ 
public MillingTool(XElement src, string baseDirectory, string relFile)

Parameters

@@ -279,9 +285,9 @@ Class StickMachiningTool - + -

+

AbstractNote

@@ -311,9 +317,9 @@ Class StickMachiningTool - + -

+

Asmb

@@ -343,9 +349,9 @@ Class StickMachiningTool - + -

+

Cutter

@@ -375,9 +381,9 @@ Class StickMachiningTool - + -

+

CutterFile

@@ -407,9 +413,9 @@ Class StickMachiningTool - + -

+

ExposedCutterBendingPara_umdN

@@ -439,9 +445,9 @@ Class StickMachiningTool - + -

+

ExposedCutterHeight_mm

@@ -471,9 +477,9 @@ Class StickMachiningTool - + -

+

ExposedCutterZDeflectionPara_umdN

@@ -503,9 +509,9 @@ Class StickMachiningTool - + -

+

Holder

@@ -535,9 +541,9 @@ Class StickMachiningTool - + -

+

HolderFile

@@ -567,41 +573,9 @@ Class StickMachiningTool - + -

- KeyCutterAlignmentMode - -

- -

Gets or sets the key cutter alignment mode.

-
-
- -
- 
public StickMachiningTool.CutterAlignmentMode KeyCutterAlignmentMode { get; set; }
-
- - - - - -

Property Value

-
-
StickMachiningTool.CutterAlignmentMode
-
-
- - - - - - - - - - -

+

Note

@@ -631,9 +605,9 @@ Class StickMachiningTool - + -

+

ObservationAnchor

@@ -663,9 +637,9 @@ Class StickMachiningTool - + -

+

ObservationAnchorReference

@@ -684,7 +658,7 @@ Class StickMachiningTool

Property Value

-
MillingToolAnchorReference
+
MillingToolAnchorReference
@@ -695,9 +669,9 @@ Class StickMachiningTool - + -

+

ObservationHeightFromToolTip

@@ -727,14 +701,15 @@ Class StickMachiningTool - + -

+

ObservationRingRadius_mm

-

Gets the tool observation reference point.

+

Obsoleted. +Gets the tool observation reference point.

@@ -759,9 +734,9 @@ Class StickMachiningTool - + -

+

PreservedDistanceBetweenFluteAndSpindleNose_mm

@@ -791,9 +766,9 @@ Class StickMachiningTool - + -

+

RelativeHeightFromObservationAnchor_mm

@@ -823,9 +798,9 @@ Class StickMachiningTool - + -

+

SpindleBuckle

@@ -855,9 +830,9 @@ Class StickMachiningTool - + -

+

SpindleBuckleToToolTipLength

@@ -887,9 +862,9 @@ Class StickMachiningTool - + -

+

ToolTip

@@ -919,9 +894,9 @@ Class StickMachiningTool - + -

+

XName

@@ -955,9 +930,9 @@ Class StickMachiningTool - + -

+

AlignAnchorByExposedCutterHeight()

@@ -982,9 +957,9 @@ Class StickMachiningTool - + -

+

ClearCache()

@@ -1009,9 +984,9 @@ Class StickMachiningTool - + -

+

Display(Bind)

@@ -1042,9 +1017,9 @@ Class StickMachiningTool - + -

+

Duplicate(params object[])

@@ -1081,9 +1056,9 @@ Class StickMachiningTool - + -

+

ExpandToBox3d(Box3d)

@@ -1111,16 +1086,49 @@ This function is usually used to compute the bounding box of elements.

-

Remarks

+

Remarks

For display

- + -

+

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + + + + +

GetAnchoredDisplayeeList()

@@ -1151,9 +1159,9 @@ This function is usually used to compute the bounding box of elements.

- + -

+

GetAsmb()

@@ -1184,9 +1192,9 @@ This function is usually used to compute the bounding box of elements.

- + -

+

GetFletchBuckle()

@@ -1218,27 +1226,26 @@ the anchor that generally connect to fixed part such as ground and triggering(mo - + -

- GetRootAnchor() +

+ GetFluteNum()

-

Get root anchor.

+

Gets the number of flutes in the contour tray.

- 
public Anchor GetRootAnchor()
+ 
public int GetFluteNum()

Returns

-
Anchor
-

root anchor.

-
+
int
+
@@ -1251,10 +1258,10 @@ the anchor that generally connect to fixed part such as ground and triggering(mo - + -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1264,7 +1271,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1274,6 +1281,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1290,6 +1300,11 @@ This method may also generate additional resources such as related files.

+

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.MillingMech.MillingTools.MillingToolAnchorReference.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolAnchorReference.html similarity index 89% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.MillingToolAnchorReference.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolAnchorReference.html index b18a3ba7..866851ac 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.MillingToolAnchorReference.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolAnchorReference.html @@ -84,17 +84,17 @@ -
+
-

+

Enum MillingToolAnchorReference

-
Namespace
Hi.MillingMech.MillingTools
+
Namespace
Hi.Milling.MillingTools
Assembly
HiMech.dll
@@ -145,19 +145,19 @@ Enum MillingToolAnchorReference

Fields

-
HolderAnc = 2
+
HolderAnc = 2

The holder anchor as the reference point.

-
None = 0
+
None = 0

No specific anchor reference point.

-
SpindleBuckleAnc = 4
+
SpindleBuckleAnc = 4

The spindle buckle anchor as the reference point.

-
ToolTip = 1
+
ToolTip = 1

The tool tip as the anchor reference point.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html new file mode 100644 index 00000000..ba830dab --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html @@ -0,0 +1,617 @@ + + + + + Class MillingToolEditorDisplayee | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class MillingToolEditorDisplayee +

+ +
+
Namespace
Hi.Milling.MillingTools
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public class MillingToolEditorDisplayee : ITopoDisplayee, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IClearCache
+
+ + + + +
+
Inheritance
+
+ +
MillingToolEditorDisplayee
+
+
+ +
+
Implements
+
+ + + + + + + + + + +
+
+ + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ HolderEditorDisplayee + +

+ +
+
+ +
+ 
public HolderEditorDisplayee HolderEditorDisplayee { get; }
+
+ + + + + +

Property Value

+
+
HolderEditorDisplayee
+
+
+ + + + + + + + + + +

+ MillingCutterEditorDisplayee + +

+ +
+
+ +
+ 
public MillingCutterEditorDisplayee MillingCutterEditorDisplayee { get; }
+
+ + + + + +

Property Value

+
+
MillingCutterEditorDisplayee
+
+
+ + + + + + + + + + +

+ MillingTool + +

+ +
+
+ +
+ 
public MillingTool MillingTool { get; }
+
+ + + + + +

Property Value

+
+
MillingTool
+
+
+ + + + + + + + + + +

+ MillingToolGetter + +

+ +
+
+ +
+ 
public Func<MillingTool> MillingToolGetter { get; set; }
+
+ + + + + +

Property Value

+
+
Func<MillingTool>
+
+
+ + + + + + + + + + +

+ ShowCutter + +

+ +
+
+ +
+ 
public bool ShowCutter { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowHolder + +

+ +
+
+ +
+ 
public bool ShowHolder { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ ClearCache() + +

+ +

Clears any cached data held by the implementing object.

+
+
+ +
+ 
public void ClearCache()
+
+ + + + + + + + + + + + + + + +

+ Display(Bind) + +

+ +

Display function called in DispEngine rendering loop.

+
+
+ +
+ 
public void Display(Bind bind)
+
+ +

Parameters

+
+
bind Bind
+

Bind with DispEngine. See Bind.

+
+
+ + + + + + + + + + + + + + +

+ ExpandToBox3d(Box3d) + +

+ +

Expands the destination box. +This function is usually used to compute the bounding box of elements.

+
+
+ +
+ 
public void ExpandToBox3d(Box3d dst)
+
+ +

Parameters

+
+
dst Box3d
+

Destination box

+
+
+ + + + + + + + + + + + + + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + + + + +

+ GetAnchoredDisplayeeList() + +

+ +

Gets a list of anchored displayable objects.

+
+
+ +
+ 
public List<IAnchoredDisplayee> GetAnchoredDisplayeeList()
+
+ + +

Returns

+
+
List<IAnchoredDisplayee>
+

A list of IAnchoredDisplayee objects

+
+
+ + + + + + + + + + + + + +

+ GetAsmb() + +

+ +

Gets the key asmb.

+
+
+ +
+ 
public Asmb GetAsmb()
+
+ + +

Returns

+
+
Asmb
+

The key asmb.

+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.MillingToolUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolUtil.html similarity index 79% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.MillingToolUtil.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolUtil.html index c67c3808..e637f68d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.MillingToolUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.MillingToolUtil.html @@ -84,16 +84,16 @@ -
+
-

+

Class MillingToolUtil

-
Namespace
Hi.MillingMech.MillingTools
+
Namespace
Hi.Milling.MillingTools
Assembly
HiMech.dll
@@ -153,48 +153,9 @@ Class MillingToolUtil - + -

- GetFluteNum(IMachiningTool) - -

- -

Gets the number of flutes if the tool is equipped with a MillingCutter.

-
-
- -
- 
public static int? GetFluteNum(this IMachiningTool millingTool)
-
- -

Parameters

-
-
millingTool IMachiningTool
-

The milling tool to check.

-
-
- -

Returns

-
-
int?
-

The number of flutes if available; otherwise, null.

-
-
- - - - - - - - - - - - - -

+

GetFullH(IMachiningTool)

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.html similarity index 84% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.html index d88445ec..76b99e7e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingMech.MillingTools.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.MillingTools.html @@ -2,9 +2,9 @@ - Namespace Hi.MillingMech.MillingTools | HiAPI-C# 2025 + Namespace Hi.Milling.MillingTools | HiAPI-C# 2025 - + @@ -84,9 +84,9 @@ -
+
-

Namespace Hi.MillingMech.MillingTools

+

Namespace Hi.Milling.MillingTools

@@ -95,28 +95,27 @@ Classes
-
MillingToolUtil
-

Provides utility methods for working with milling tools.

+
MillingTool
+

Represents a central stick milling tool that combines a holder and a cutter.

-
StickMachiningTool
-

Represents a central stick milling tool that combines a holder and a cutter.

+
MillingToolEditorDisplayee
+
+
+
+
MillingToolUtil
+

Provides utility methods for working with milling tools.

Enums

-
MillingToolAnchorReference
+
MillingToolAnchorReference

Defines reference points for anchoring milling tools.

-
-
StickMachiningTool.CutterAlignmentMode
-

Defines the modes for aligning the cutter.

-
-
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.SpindleCapability.html b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.SpindleCapability.html index 59b50475..e7b54f77 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Milling.SpindleCapability.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Milling.SpindleCapability.html @@ -121,7 +121,7 @@ Internal Use Only

Implements
- +
@@ -769,8 +769,8 @@ Internal Use Only

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -780,7 +780,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -790,6 +790,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -806,6 +809,11 @@ This method may also generate additional resources such as related files.

+

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.MillingForces.Fittings.CuttingParaUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.CuttingParaUtil.html index c12dc061..308593b8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.CuttingParaUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.CuttingParaUtil.html @@ -166,7 +166,7 @@ This function is for adjusting obsoleted design as some milling parameter format
- 
public static RakeFaceCuttingPara ToRakeFaceCuttingPara(this ICuttingPara millingPara)
+ 
public static RakeFaceCuttingPara3d ToRakeFaceCuttingPara(this ICuttingPara millingPara)

Parameters

@@ -178,7 +178,7 @@ This function is for adjusting obsoleted design as some milling parameter format

Returns

-
RakeFaceCuttingPara
+
RakeFaceCuttingPara3d

A RakeFaceCuttingPara instance, or null if conversion is not possible.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.ICuttingPara.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.ICuttingPara.html index b4eaf898..887ae8eb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.ICuttingPara.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.ICuttingPara.html @@ -119,13 +119,13 @@ The milling parameter is trainable.

IGetCuttingPara.GetCuttingPara() diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.IGetCuttingPara.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.IGetCuttingPara.html index b0afc1db..9b8d9fe2 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.IGetCuttingPara.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Fittings.IGetCuttingPara.html @@ -115,7 +115,7 @@ Interface IGetCuttingPara
Inherited Members
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceLuggage.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceLuggage.html index 20c35089..b90224d6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceLuggage.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceLuggage.html @@ -532,7 +532,7 @@ The forced item is workpiece.

-

+

GetCuttingForcesToWorkpieceOnProgramCoordinate_N(MachineMotionStep)

@@ -547,7 +547,7 @@ The forced item is workpiece.

Parameters

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step to get forces for

@@ -571,7 +571,7 @@ The forced item is workpiece.

-

+

GetForceToToolOnToolRunningCoordinateCsvString(MachineMotionStep)

@@ -586,7 +586,7 @@ The forced item is workpiece.

Parameters

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step to get forces for.

@@ -610,7 +610,7 @@ The forced item is workpiece.

-

+

GetForceToWorkpieceOnProgramCoordinateCsvString(MachineMotionStep)

@@ -625,7 +625,7 @@ The forced item is workpiece.

Parameters

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step to get forces for.

@@ -688,7 +688,7 @@ The forced item is workpiece.

-

+

GetMomentsAboutAnchorOnToolRunningCoordinate_Nm(MachiningToolHouse, MachineMotionStep)

@@ -706,7 +706,7 @@ The forced item is workpiece.

toolHouse MachiningToolHouse

The tool house containing the machining tool.

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step to calculate moments for.

@@ -730,7 +730,7 @@ The forced item is workpiece.

-

+

GetMomentsAboutObservationPointOnSpindleRotationCoordinate_Nm(MachiningToolHouse, MachineMotionStep)

@@ -748,7 +748,7 @@ The forced item is workpiece.

toolHouse MachiningToolHouse

The tool house containing the machining tool

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step to get moments for

@@ -918,7 +918,7 @@ The forced item is workpiece.

-

+

GetMomentsToToolOnSpindleRotationZeroCsvString(MachiningToolHouse, MachineMotionStep, RakeFacePhysicsBrief)

@@ -936,7 +936,7 @@ The forced item is workpiece.

toolHouse MachiningToolHouse

The tool house containing the machining tool.

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step to get moments for.

brief RakeFacePhysicsBrief
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceUtil.html index 2b563eb0..4d6c0dc3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.MillingForceUtil.html @@ -223,7 +223,7 @@ Class MillingForceUtil -

+

GetMillingFoce(SeqPair<Mat4d>, double, IContourTray, ICuttingPara, double, double, double, MachineMotionStep, LayerMillingEngagement, out RakeFacePhysicsBrief, out MillingForceLuggage, double, double)

@@ -259,7 +259,7 @@ Class MillingForceUtil
aptRz double

The APT RZ value in millimeters

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step information

engagement LayerMillingEngagement
@@ -370,7 +370,7 @@ Class MillingForceUtil -

+

GetMillingFoce(ICuttingPara, IMachiningTool, MachineMotionStep, LayerMillingEngagement, out RakeFacePhysicsBrief, out MillingForceLuggage, double)

@@ -391,7 +391,7 @@ Class MillingForceUtil
millingTool IMachiningTool

The machining tool used for the operation

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step information

engagement LayerMillingEngagement
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html index 8afba41a..de45b118 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html @@ -1388,8 +1388,8 @@ Firat Eren, University of New Hampshire, Durham.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1399,7 +1399,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1409,6 +1409,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1425,6 +1428,11 @@ This method may also generate additional resources such as related files.

+

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.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html index 9190a4a9..4b33302e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html @@ -123,7 +123,7 @@ This class manages cutting parameters for both side and bottom milling operation - + @@ -991,33 +991,37 @@ Each element contains cutting coefficients (Ksr, Kst, Ksa) for the corresponding -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

-

Creates an XML element representing the current parameter map.

+

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)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string
-

The base directory for resolving relative paths.

+

The base directory for resolving relative paths

relFile string
-

The relative file path.

+

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

Returns

XElement
-

An XML element containing the parameter data.

+

An XML element representing the object's state

@@ -1027,6 +1031,11 @@ Each element contains cutting coefficients (Ksr, Kst, Ksa) for the corresponding +

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.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html new file mode 100644 index 00000000..125939a9 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html @@ -0,0 +1,413 @@ + + + + + Interface IRakeFaceCuttingPara | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Interface IRakeFaceCuttingPara +

+ +
+
Namespace
Hi.MillingForces.RakeFaceCuttingParas
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public interface IRakeFaceCuttingPara : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, IDuplicate
+
+ + + + + + + +
+
Inherited Members
+
+ + + + + + + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ AnchorRakeAngle_deg + +

+ +

Gets or sets the anchor rake angle in degrees.

+
+
+ +
+ 
double AnchorRakeAngle_deg { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ AnchorRakeAngle_rad + +

+ +

Gets or sets the anchor rake angle in radians. +Different rake angles may have different ploughing parameters but share the same shearing parameters.

+
+
+ +
+ 
double AnchorRakeAngle_rad { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Kpc + +

+ +

Gets or sets the ploughing coefficient along the rake face cross line (c). +Unit: N/mm.

+
+
+ +
+ 
double Kpc { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Kpn + +

+ +

Gets or sets the ploughing coefficient along the rake face normal direction (n). +Unit: N/mm.

+
+
+ +
+ 
double Kpn { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Ksc + +

+ +

Gets or sets the shear coefficient along the rake face cross line (c). +Direction is from outer to center on side cutting. +Unit: N/mm².

+
+
+ +
+ 
double Ksc { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Ksn + +

+ +

Gets or sets the shear coefficient along the rake face normal direction (n). +Unit: N/mm².

+
+
+ +
+ 
double Ksn { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html index f5abdeb4..7af0ec53 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html @@ -123,7 +123,7 @@ Internal Use Only.

- + @@ -337,7 +337,7 @@ Internal Use Only.

- 
public RakeFaceCuttingPara[] LocalRakeFaceCuttingParas { get; set; }
+ 
public RakeFaceCuttingPara3d[] LocalRakeFaceCuttingParas { get; set; }
@@ -346,7 +346,7 @@ Internal Use Only.

Property Value

-
RakeFaceCuttingPara[]
+
RakeFaceCuttingPara3d[]
@@ -639,7 +639,7 @@ Internal Use Only.

- 
public RakeFaceCuttingPara GetLocalRakeFaceCuttingPara(int fluteIndex)
+ 
public RakeFaceCuttingPara3d GetLocalRakeFaceCuttingPara(int fluteIndex)

Parameters

@@ -651,7 +651,7 @@ Internal Use Only.

Returns

-
RakeFaceCuttingPara
+
RakeFaceCuttingPara3d

The rake face cutting parameters for the specified flute.

@@ -668,8 +668,8 @@ Internal Use Only.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -679,7 +679,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -689,6 +689,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -705,6 +708,11 @@ This method may also generate additional resources such as related files.

+

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.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d.html similarity index 53% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d.html index 78e7bc07..f84d438e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d.html @@ -2,9 +2,9 @@ - Class RakeFace2DCuttingPara | HiAPI-C# 2025 + Class RakeFaceCuttingPara2d | HiAPI-C# 2025 - + @@ -84,16 +84,16 @@
-
+
-

-Class RakeFace2DCuttingPara +

+Class RakeFaceCuttingPara2d

-
Namespace
Hi.MillingForces.ProjectedRakeFaceCuttingParas
+
Namespace
Hi.MillingForces.RakeFaceCuttingParas
Assembly
HiMech.dll
@@ -102,7 +102,7 @@ Class RakeFace2DCuttingPara
- 
public class RakeFace2DCuttingPara : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote
+ 
public class RakeFaceCuttingPara2d : IRakeFaceCuttingPara, ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, IDuplicate
@@ -112,17 +112,19 @@ Class RakeFace2DCuttingPara
Inheritance
-
RakeFace2DCuttingPara
+
RakeFaceCuttingPara2d
Implements
+ - + +
@@ -190,19 +192,19 @@ Class RakeFace2DCuttingPara - + -

- RakeFace2DCuttingPara() +

+ RakeFaceCuttingPara2d()

-

Initializes a new instance of the RakeFace2DCuttingPara class.

+

Initializes a new instance of the RakeFaceCuttingPara2d class.

- 
public RakeFace2DCuttingPara()
+ 
public RakeFaceCuttingPara2d()
@@ -217,24 +219,24 @@ Class RakeFace2DCuttingPara - + -

- RakeFace2DCuttingPara(RakeFace2DCuttingPara) +

+ RakeFaceCuttingPara2d(RakeFaceCuttingPara2d)

-

Initializes a new instance of the RakeFace2DCuttingPara class by copying from another instance.

+

Initializes a new instance of the RakeFaceCuttingPara2d class by copying from another instance.

- 
public RakeFace2DCuttingPara(RakeFace2DCuttingPara src)
+ 
public RakeFaceCuttingPara2d(RakeFaceCuttingPara2d src)

Parameters

-
src RakeFace2DCuttingPara
+
src RakeFaceCuttingPara2d

The source instance to copy from.

@@ -250,19 +252,19 @@ Class RakeFace2DCuttingPara - + -

- RakeFace2DCuttingPara(XElement, string) +

+ RakeFaceCuttingPara2d(XElement, string)

-

Initializes a new instance of the RakeFace2DCuttingPara class from XML.

+

Initializes a new instance of the RakeFaceCuttingPara2d class from XML.

- 
public RakeFace2DCuttingPara(XElement src, string baseDirectory)
+ 
public RakeFaceCuttingPara2d(XElement src, string baseDirectory)

Parameters

@@ -291,7 +293,7 @@ Class RakeFace2DCuttingPara -

+

element_num

@@ -325,9 +327,74 @@ Class RakeFace2DCuttingPara - + -

+

+ AnchorRakeAngle_deg + +

+ +

Gets or sets the anchor rake angle in degrees.

+
+
+ +
+ 
public double AnchorRakeAngle_deg { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ AnchorRakeAngle_rad + +

+ +

Gets or sets the anchor rake angle in radians. +Different rake angles may have different ploughing parameters but share the same shearing parameters.

+
+
+ +
+ 
public double AnchorRakeAngle_rad { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

ElementNum

@@ -357,9 +424,9 @@ Class RakeFace2DCuttingPara - + -

+

FluteFormNum

@@ -389,9 +456,206 @@ Class RakeFace2DCuttingPara - + -

+

+ Kp + +

+ +

Gets the ploughing coefficient vector in ECN coordinates.

+
+
+ +
+ 
public Vec2d Kp { get; set; }
+
+ + + + + +

Property Value

+
+
Vec2d
+
+
+ + + + + + + + + + +

+ Kpc + +

+ +

Gets or sets the ploughing coefficient along the rake face cross line (c). +Unit: N/mm.

+
+
+ +
+ 
public double Kpc { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Kpn + +

+ +

Gets or sets the ploughing coefficient along the rake face normal direction (n). +Unit: N/mm.

+
+
+ +
+ 
public double Kpn { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Ks + +

+ +

Gets the shear coefficient vector in ECN coordinates.

+
+
+ +
+ 
public Vec2d Ks { get; set; }
+
+ + + + + +

Property Value

+
+
Vec2d
+
+
+ + + + + + + + + + +

+ Ksc + +

+ +

Gets or sets the shear coefficient along the rake face cross line (c). +Direction is from outer to center on side cutting. +Unit: N/mm².

+
+
+ +
+ 
public double Ksc { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

+ Ksn + +

+ +

Gets or sets the shear coefficient along the rake face normal direction (n). +Unit: N/mm².

+
+
+ +
+ 
public double Ksn { get; set; }
+
+ + + + + +

Property Value

+
+
double
+
+
+ + + + + + + + + + +

Name

@@ -421,9 +685,9 @@ Class RakeFace2DCuttingPara - + -

+

Note

@@ -453,73 +717,9 @@ Class RakeFace2DCuttingPara - + -

- PloughPara - -

- -

Gets or sets the plough parameter vector.

-
-
- -
- 
public Vec2d PloughPara { get; set; }
-
- - - - - -

Property Value

-
-
Vec2d
-
-
- - - - - - - - - - -

- ShearPara - -

- -

Gets or sets the shear parameter vector.

-
-
- -
- 
public Vec2d ShearPara { get; set; }
-
- - - - - -

Property Value

-
-
Vec2d
-
-
- - - - - - - - - - -

+

XName

@@ -549,9 +749,9 @@ Class RakeFace2DCuttingPara - + -

+

XmlSourceFile

@@ -584,9 +784,9 @@ Class RakeFace2DCuttingPara - + -

+

CloneTemplate()

@@ -617,9 +817,48 @@ Class RakeFace2DCuttingPara - + -

+

+ Duplicate(params object[]) + +

+ +

Creates a deep copy of the object, excluding any source file references.

+
+
+ +
+ 
public object Duplicate(params object[] res)
+
+ +

Parameters

+
+
res object[]
+

Optional parameters that may be needed during the duplication process

+
+
+ +

Returns

+
+
object
+

A new instance that is a deep copy of the original object

+
+
+ + + + + + + + + + + + + +

GenUnitParas()

@@ -652,9 +891,9 @@ For parameter training.

- + -

+

GetCuttingPara()

@@ -685,9 +924,9 @@ For parameter training.

- + -

+

GetElementByIndex(int)

@@ -724,10 +963,10 @@ For parameter training.

- + -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -737,7 +976,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -747,6 +986,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -763,19 +1005,23 @@ This method may also generate additional resources such as related files.

+

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.

+
- + -

+

SetElementByIndex(int, double)

-

Set element by index. -For parameter training.

+

Sets the value of an element at the specified index.

@@ -786,10 +1032,10 @@ For parameter training.

Parameters

elementIndex int
-

element index

+

The index of the element to set (0-5).

v double
-

value

+

The value to set.

@@ -800,13 +1046,22 @@ For parameter training.

+

Remarks

+

Index mapping: +0 - Kse (N/mm²) +1 - Ksc (N/mm²) +2 - Ksn (N/mm²) +3 - Kpe (N/mm) +4 - Kpc (N/mm) +5 - Kpn (N/mm)

+
- + -

+

ToTemplateXElement()

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d.html similarity index 77% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara.html rename to App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d.html index 78ff9086..2bc1db5d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d.html @@ -2,9 +2,9 @@ - Class RakeFaceCuttingPara | HiAPI-C# 2025 + Class RakeFaceCuttingPara3d | HiAPI-C# 2025 - + @@ -84,12 +84,12 @@
-
+
-

-Class RakeFaceCuttingPara +

+Class RakeFaceCuttingPara3d

@@ -106,7 +106,7 @@ Internal Use Only.

- 
public class RakeFaceCuttingPara : IDuplicate, ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote
+ 
public class RakeFaceCuttingPara3d : IRakeFaceCuttingPara, ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, IDuplicate
@@ -116,18 +116,19 @@ Internal Use Only.

Inheritance
-
RakeFaceCuttingPara
+
RakeFaceCuttingPara3d
Implements
- + - + +
@@ -189,7 +190,7 @@ Internal Use Only.

-

Remarks

+

Remarks

  • Velocity is measured relative to the cutter
  • Resulting force is applied to the cutter
    • @@ -201,10 +202,10 @@ Internal Use Only.

    - + -

    - RakeFaceCuttingPara() +

    + RakeFaceCuttingPara3d()

    @@ -213,7 +214,7 @@ Internal Use Only.

    - 
    public RakeFaceCuttingPara()
    + 
    public RakeFaceCuttingPara3d()
    @@ -228,10 +229,10 @@ Internal Use Only.

    - + -

    - RakeFaceCuttingPara(Vec3d, Vec3d, double) +

    + RakeFaceCuttingPara3d(Vec3d, Vec3d, double)

    @@ -240,7 +241,7 @@ Internal Use Only.

    - 
    public RakeFaceCuttingPara(Vec3d shearEcn, Vec3d ploughEcn, double anchorRakeAngle_rad = NaN)
    + 
    public RakeFaceCuttingPara3d(Vec3d shearEcn, Vec3d ploughEcn, double anchorRakeAngle_rad = NaN)

    Parameters

    @@ -267,10 +268,10 @@ Internal Use Only.

    - + -

    - RakeFaceCuttingPara(RakeFaceCuttingPara) +

    + RakeFaceCuttingPara3d(RakeFaceCuttingPara3d)

    @@ -279,12 +280,12 @@ Internal Use Only.

    - 
    public RakeFaceCuttingPara(RakeFaceCuttingPara src)
    + 
    public RakeFaceCuttingPara3d(RakeFaceCuttingPara3d src)

    Parameters

    -
    src RakeFaceCuttingPara
    +
    src RakeFaceCuttingPara3d

    The source instance to copy from.

    @@ -300,10 +301,10 @@ Internal Use Only.

    - + -

    - RakeFaceCuttingPara(double, double, double, double, double, double, double) +

    + RakeFaceCuttingPara3d(double, double, double, double, double, double, double)

    @@ -312,7 +313,7 @@ Internal Use Only.

    - 
    public RakeFaceCuttingPara(double kse, double ksc, double ksn, double kpe, double kpc, double kpn, double anchorRakeAngle_rad)
    + 
    public RakeFaceCuttingPara3d(double kse, double ksc, double ksn, double kpe, double kpc, double kpn, double anchorRakeAngle_rad)

    Parameters

    @@ -351,10 +352,10 @@ Internal Use Only.

    - + -

    - RakeFaceCuttingPara(XElement, string) +

    + RakeFaceCuttingPara3d(XElement, string)

    @@ -363,7 +364,7 @@ Internal Use Only.

    - 
    public RakeFaceCuttingPara(XElement src, string baseDirectory)
    + 
    public RakeFaceCuttingPara3d(XElement src, string baseDirectory)

    Parameters

    @@ -391,9 +392,9 @@ Internal Use Only.

    - + -

    +

    AnchorRakeAngle_deg

    @@ -423,9 +424,9 @@ Internal Use Only.

    - + -

    +

    AnchorRakeAngle_rad

    @@ -456,9 +457,9 @@ Different rake angles may have different ploughing parameters but share the same - + -

    +

    ChipFlowAngle_deg

    @@ -488,9 +489,9 @@ Different rake angles may have different ploughing parameters but share the same - + -

    +

    ChipFlowAngle_rad

    @@ -520,9 +521,9 @@ Different rake angles may have different ploughing parameters but share the same - + -

    +

    CsvText

    @@ -553,9 +554,9 @@ Format: Kse,Ksc,Ksn,Kpe,Kpc,Kpn,AnchorRakeAngle_deg

    - + -

    +

    ElementNum

    @@ -585,9 +586,9 @@ Format: Kse,Ksc,Ksn,Kpe,Kpc,Kpn,AnchorRakeAngle_deg

    - + -

    +

    FluteFormNum

    @@ -618,9 +619,9 @@ Always returns 1 as this class represents a single form.

    - + -

    +

    FrictionAngle_deg

    @@ -650,9 +651,9 @@ Always returns 1 as this class represents a single form.

    - + -

    +

    FrictionAngle_rad

    @@ -682,9 +683,9 @@ Always returns 1 as this class represents a single form.

    - + -

    +

    Kp

    @@ -714,9 +715,9 @@ Always returns 1 as this class represents a single form.

    - + -

    +

    KpOnZeroRakeAngleCoordinate

    @@ -747,9 +748,9 @@ The vector changed by the view of coordinate transformation.

    - + -

    +

    Kpc

    @@ -780,9 +781,9 @@ Unit: N/mm.

    - + -

    +

    Kpe

    @@ -813,9 +814,9 @@ Unit: N/mm.

    - + -

    +

    Kpn

    @@ -846,9 +847,9 @@ Unit: N/mm.

    - + -

    +

    Ks

    @@ -878,9 +879,9 @@ Unit: N/mm.

    - + -

    +

    Ksc

    @@ -912,9 +913,9 @@ Unit: N/mm².

    - + -

    +

    Kse

    @@ -946,9 +947,9 @@ Unit: N/mm².

    - + -

    +

    Ksn

    @@ -979,9 +980,9 @@ Unit: N/mm².

    - + -

    +

    Name

    @@ -1011,9 +1012,9 @@ Unit: N/mm².

    - + -

    +

    Note

    @@ -1043,9 +1044,9 @@ Unit: N/mm².

    - + -

    +

    XName

    @@ -1079,9 +1080,9 @@ Unit: N/mm².

    - + -

    +

    CloneTemplate()

    @@ -1112,9 +1113,9 @@ Unit: N/mm².

    - + -

    +

    Duplicate(params object[])

    @@ -1151,9 +1152,9 @@ Unit: N/mm².

    - + -

    +

    GenUnitParas()

    @@ -1186,9 +1187,9 @@ For parameter training.

    - + -

    +

    GetCuttingPara()

    @@ -1219,9 +1220,9 @@ For parameter training.

    - + -

    +

    GetElementByIndex(int)

    @@ -1254,7 +1255,7 @@ For parameter training.

    -

    Remarks

    +

    Remarks

    Index mapping: 0 - Kse (N/mm²) 1 - Ksc (N/mm²) @@ -1267,10 +1268,10 @@ For parameter training.

    - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -1280,7 +1281,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -1290,6 +1291,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -1306,13 +1310,18 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    +

    SetElementByIndex(int, double)

    @@ -1342,7 +1351,7 @@ This method may also generate additional resources such as related files.

    -

    Remarks

    +

    Remarks

    Index mapping: 0 - Kse (N/mm²) 1 - Ksc (N/mm²) @@ -1355,9 +1364,9 @@ This method may also generate additional resources such as related files.

    - + -

    +

    ToTemplateXElement()

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html index b2e1189c..112964e9 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html @@ -122,7 +122,7 @@ Class RakeFaceCuttingParaMap - + @@ -972,7 +972,7 @@ For parameter training.

    - 
    public RakeFaceCuttingPara GetLocalRakeFaceCuttingPara(int fluteIndex, double nAngle_rad, double ecAngle_rad)
    + 
    public RakeFaceCuttingPara3d GetLocalRakeFaceCuttingPara(int fluteIndex, double nAngle_rad, double ecAngle_rad)

    Parameters

    @@ -990,7 +990,7 @@ For parameter training.

    Returns

    -
    RakeFaceCuttingPara
    +
    RakeFaceCuttingPara3d

    A rake face cutting parameter object.

    @@ -1007,8 +1007,8 @@ For parameter training.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -1018,7 +1018,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -1028,6 +1028,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -1044,6 +1047,11 @@ This method may also generate additional resources such as related files.

    +

    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.MillingForces.RakeFaceCuttingParas.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.html index af14a2ba..fb203744 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFaceCuttingParas.html @@ -106,7 +106,12 @@ Internal Use Only.

    -
    RakeFaceCuttingPara
    +
    RakeFaceCuttingPara2d
    +

    Represents a 2D cutting parameter for rake face cutting operations.

    +
    +
    +
    +
    RakeFaceCuttingPara3d

    Represents local ECN (Edge-Cross-Normal) cutting parameters for rake face cutting. E: cutting edge direction C: Cross vector, along the rake face cross line, perpendicular to cutting edge @@ -119,6 +124,13 @@ Internal Use Only.

    Represents a map of rake face cutting parameters.

    +

    +Interfaces +

    +
    +
    IRakeFaceCuttingPara
    +
    +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFacePhysicsBrief.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFacePhysicsBrief.html index 361bacf0..c772c78f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFacePhysicsBrief.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.RakeFacePhysicsBrief.html @@ -1280,7 +1280,7 @@ a small arbitrary gap is set to avoid the singular behavior.

-

+

GetAvgForceToWorkpieceOnProgramCoordinate(MachineMotionStep)

@@ -1295,7 +1295,7 @@ a small arbitrary gap is set to avoid the singular behavior.

Parameters

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep
@@ -1350,7 +1350,7 @@ a small arbitrary gap is set to avoid the singular behavior.

-

+

GetDeflectionTransformOnWorkpieceGeomCoordinate(IMachiningTool, WorkpieceMaterial, MachineMotionStep, Func<MillingForceLuggage>)

@@ -1371,7 +1371,7 @@ a small arbitrary gap is set to avoid the singular behavior.

workpieceMaterial WorkpieceMaterial

The workpiece material.

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step.

luggageFunc Func<MillingForceLuggage>
@@ -1470,7 +1470,7 @@ a small arbitrary gap is set to avoid the singular behavior.

-

+

GetMaxAbsForceSlope_NdDeg(MachiningToolHouse, WorkpieceMaterial, MachineMotionStep, Func<MillingForceLuggage>)

@@ -1489,7 +1489,7 @@ a small arbitrary gap is set to avoid the singular behavior.

workpieceMaterial WorkpieceMaterial
-
machineStep MachineMotionStep
+
machineStep MachineMotionStep
luggageFunc Func<MillingForceLuggage>
@@ -1513,7 +1513,7 @@ a small arbitrary gap is set to avoid the singular behavior.

-

+

GetMaxBottomEdgeDeflectionOnToolRunningCoordinate_mm(IMachiningTool, WorkpieceMaterial, MachineMotionStep, Func<MillingForceLuggage>)

@@ -1534,7 +1534,7 @@ a small arbitrary gap is set to avoid the singular behavior.

workpieceMaterial WorkpieceMaterial

The workpiece material.

-
machineStep MachineMotionStep
+
machineStep MachineMotionStep

The machining step.

luggageFunc Func<MillingForceLuggage>
@@ -1561,7 +1561,7 @@ a small arbitrary gap is set to avoid the singular behavior.

-

+

GetMaxDeflectionTransformOnToolRunningCoordinate(IMachiningTool, WorkpieceMaterial, MachineMotionStep, Func<MillingForceLuggage>)

@@ -1580,7 +1580,7 @@ a small arbitrary gap is set to avoid the singular behavior.

workpieceMaterial WorkpieceMaterial
-
machineStep MachineMotionStep
+
machineStep MachineMotionStep
luggageFunc Func<MillingForceLuggage>
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Training.MillingTraining.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Training.MillingTraining.html index 21840dc8..0221c048 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Training.MillingTraining.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.Training.MillingTraining.html @@ -185,6 +185,37 @@ Class MillingTraining + + +

+ ParaTemplate + +

+ +
+
+ +
+ 
public static ICuttingPara ParaTemplate { get; set; }
+
+ + + + + +

Property Value

+
+
ICuttingPara
+
+
+ + + + + + + +

@@ -287,8 +318,8 @@ Class MillingTraining -

- Convert(ICuttingPara, ICuttingPara, GeneralApt, double, double, IMessageHost, CancellationToken) +

+ Convert(ICuttingPara, ICuttingPara, GeneralApt, double, double, IMessageKit, CancellationToken)

@@ -297,7 +328,7 @@ Class MillingTraining
- 
public static ICuttingPara Convert(ICuttingPara src, ICuttingPara dstTemplate, GeneralApt apt, double helixAngle_rad, double radialRakeAngle_rad, IMessageHost messageHost, CancellationToken cancellationToken)
+ 
public static ICuttingPara Convert(ICuttingPara src, ICuttingPara dstTemplate, GeneralApt apt, double helixAngle_rad, double radialRakeAngle_rad, IMessageKit messageHost, CancellationToken cancellationToken)

Parameters

@@ -317,7 +348,7 @@ Class MillingTraining
radialRakeAngle_rad double

Radial rake angle in radians

-
messageHost IMessageHost
+
messageHost IMessageKit

Message host for logging

cancellationToken CancellationToken
@@ -344,8 +375,8 @@ Class MillingTraining -

- Convert(LocalProfileMillingPara, double, double, IMessageHost, CancellationToken) +

+ Convert(LocalProfileMillingPara, double, double, IMessageKit, CancellationToken)

@@ -354,7 +385,7 @@ Class MillingTraining
- 
public static RakeFaceCuttingPara Convert(LocalProfileMillingPara src, double helixAngle_rad, double radialRakeAngle_rad, IMessageHost messageHost, CancellationToken cancellationToken)
+ 
public static RakeFaceCuttingPara2d Convert(LocalProfileMillingPara src, double helixAngle_rad, double radialRakeAngle_rad, IMessageKit messageHost, CancellationToken cancellationToken)

Parameters

@@ -368,7 +399,7 @@ Class MillingTraining
radialRakeAngle_rad double

Radial rake angle in radians

-
messageHost IMessageHost
+
messageHost IMessageKit

Message host for logging

cancellationToken CancellationToken
@@ -378,7 +409,7 @@ Class MillingTraining

Returns

-
RakeFaceCuttingPara
+
RakeFaceCuttingPara2d

The converted RakeFaceCuttingPara

@@ -395,8 +426,8 @@ Class MillingTraining -

- GatherAndBuild(ConcurrentDictionary<int, List<ITimeShot>>, ClStrip, SampleFlag, bool, double, IMessageHost, CancellationToken) +

+ GatherAndBuild(ConcurrentDictionary<int, List<ITimeShot>>, ClStrip, SampleFlag, bool, double, IMessageKit, CancellationToken)

@@ -405,7 +436,7 @@ Class MillingTraining
- 
public static ICuttingPara GatherAndBuild(ConcurrentDictionary<int, List<ITimeShot>> stepToTimeShotListDictionary, ClStrip clStrip, SampleFlag sampleFlags, bool enableFzOnlyDuringDrilling, double outlierRatio, IMessageHost messageHost, CancellationToken cancellationToken)
+ 
public static ICuttingPara GatherAndBuild(ConcurrentDictionary<int, List<ITimeShot>> stepToTimeShotListDictionary, ClStrip clStrip, SampleFlag sampleFlags, bool enableFzOnlyDuringDrilling, double outlierRatio, IMessageKit messageHost, CancellationToken cancellationToken)

Parameters

@@ -425,7 +456,7 @@ Class MillingTraining
outlierRatio double

Ratio of outliers to exclude

-
messageHost IMessageHost
+
messageHost IMessageKit

Message host for logging

cancellationToken CancellationToken
@@ -452,8 +483,8 @@ Class MillingTraining -

- GatherAndGetUpdate(ConcurrentDictionary<int, List<ITimeShot>>, ClStrip, ICuttingPara, SampleFlag, double, IMessageHost, CancellationToken) +

+ GatherAndGetUpdate(ConcurrentDictionary<int, List<ITimeShot>>, ClStrip, ICuttingPara, SampleFlag, double, IMessageKit, CancellationToken)

@@ -462,7 +493,7 @@ Class MillingTraining
- 
public static ICuttingPara GatherAndGetUpdate(ConcurrentDictionary<int, List<ITimeShot>> stepToTimeShotListDictionary, ClStrip clStrip, ICuttingPara anchorPara, SampleFlag sampleFlags, double outlierRatio, IMessageHost messageHost, CancellationToken cancellationToken)
+ 
public static ICuttingPara GatherAndGetUpdate(ConcurrentDictionary<int, List<ITimeShot>> stepToTimeShotListDictionary, ClStrip clStrip, ICuttingPara anchorPara, SampleFlag sampleFlags, double outlierRatio, IMessageKit messageHost, CancellationToken cancellationToken)

Parameters

@@ -482,7 +513,7 @@ Class MillingTraining
outlierRatio double

Ratio of outliers to exclude

-
messageHost IMessageHost
+
messageHost IMessageKit

Message host for logging

cancellationToken CancellationToken
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingProcs.MillingGuide.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingProcs.MillingGuide.html index 730b00c3..ccd04280 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingProcs.MillingGuide.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingProcs.MillingGuide.html @@ -449,8 +449,8 @@ Class MillingGuide -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -460,7 +460,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -470,6 +470,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -486,6 +489,11 @@ This method may also generate additional resources such as related files.

+

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.MillingStepUtils.ClStripChartConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ClStripChartConfig.html index bd750ea2..b6627753 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ClStripChartConfig.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ClStripChartConfig.html @@ -318,8 +318,8 @@ Class ClStripChartConfig -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -329,7 +329,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -339,6 +339,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -355,6 +358,11 @@ This method may also generate additional resources such as related files.

+

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.MillingStepUtils.ClStripChartItemConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ClStripChartItemConfig.html index ab5b11cb..a438d3f4 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ClStripChartItemConfig.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ClStripChartItemConfig.html @@ -315,8 +315,8 @@ Class ClStripChartItemConfig -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -326,7 +326,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -336,6 +336,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -352,6 +355,11 @@ This method may also generate additional resources such as related files.

+

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.MillingStepUtils.ForceCycleLineDivConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ForceCycleLineDivConfig.html index 70d30123..c2060e16 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ForceCycleLineDivConfig.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.ForceCycleLineDivConfig.html @@ -325,8 +325,8 @@ Class ForceCycleLineDivConfig -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -334,7 +334,7 @@ Class ForceCycleLineDivConfig
- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -343,6 +343,8 @@ Class ForceCycleLineDivConfig
relFile string
+
exhibitionOnly bool
+

Returns

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html index 1d95f529..214baa26 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html @@ -318,8 +318,8 @@ Class SpindleMomentCycleLineDivConfig -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -329,7 +329,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -339,6 +339,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -355,6 +358,11 @@ This method may also generate additional resources such as related files.

+

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.MillingStepUtils.TimeChartYConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.TimeChartYConfig.html index 4c89b6fd..aad5b5d9 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.TimeChartYConfig.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingStepUtils.TimeChartYConfig.html @@ -353,8 +353,8 @@ Class TimeChartYConfig -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -364,7 +364,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -374,6 +374,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -390,6 +393,11 @@ This method may also generate additional resources such as related files.

+

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.MillingSteps.html b/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.html index 06a729bc..ef57d54a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.MillingSteps.html @@ -94,16 +94,6 @@

Classes

-
-
MachineMotionStep
-

MachiningStep has spindle information. -Note that the spindle information is only for milling behavior.

-
-
-
-
MachiningStep
-
-
MillingPhysicsStep

Represents the physics step of a milling operation, containing physical properties and calculations.

@@ -114,44 +104,6 @@ Note that the spindle information is only for milling behavior.

Represents additional data associated with a milling step.

-
-
MillingStepUtil
-

Utility class for milling step related constants and helper methods.

-
-
-
-
PresentAttribute
-

Attribute for presenting property information with localization support.

-
-
-
-
StepPropertyAccess
-

Provides access to properties of a milling step with presentation information.

-
-
-
-
StringValueAttribute
-

Attribute for associating a string value with an enum value or other element.

-
-
-

-Interfaces -

-
-
IGetSourceCommand
-

Defines an interface for retrieving source command information.

-
-
-
-
IMachiningStepHost
-

Represents a host interface for milling steps that provides access to milling equipment and related resources.

-
-
-
-
ISourceCommand
-

Represents a source command interface that provides access to file line information and command flags.

-
-
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Native.box3d.html b/App/wwwroot/HiAPI-docsite/api/Hi.Native.box3d.html index be176572..074d2a70 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Native.box3d.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Native.box3d.html @@ -140,6 +140,9 @@ Struct box3d
Extension Methods
+ diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.Fixture.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.Fixture.html index 358ebbd8..85fbcc01 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.Fixture.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.Fixture.html @@ -102,7 +102,7 @@ Class Fixture
- 
public class Fixture : IGetSolid, IMakeXmlSource, IDisplayee, IExpandToBox3d, IGetRootAnchor, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable
+ 
public class Fixture : IGetSolid, IMakeXmlSource, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetAsmb, IGetAnchor, IGetTopoIndex, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable
@@ -123,7 +123,10 @@ Class Fixture - + + + + @@ -165,6 +168,15 @@ Class Fixture + + + @@ -430,6 +442,163 @@ Delegate by + +

+ GeomAnchor + +

+ +
+
+ +
+ 
public Anchor GeomAnchor { get; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + + + + +

+ GeomToTableBranch + +

+ +
+
+ +
+ 
public Branch GeomToTableBranch { get; }
+
+ + + + + +

Property Value

+
+
Branch
+
+
+ + + + + + + + + + +

+ GeomToTableTransformer + +

+ +

Transformer from Geometry origin to table (machine tool side) origin.

+
+
+ +
+ 
public ITransformer GeomToTableTransformer { get; set; }
+
+ + + + + +

Property Value

+
+
ITransformer
+
+
+ + + + + + + + + + +

+ GeomToWorkpieceBranch + +

+ +
+
+ +
+ 
public Branch GeomToWorkpieceBranch { get; }
+
+ + + + + +

Property Value

+
+
Branch
+
+
+ + + + + + + + + + +

+ GeomToWorkpieceTransformer + +

+ +

Transformer from Geometry origin to workpiece origin.

+
+
+ +
+ 
public ITransformer GeomToWorkpieceTransformer { get; set; }
+
+ + + + + +

Property Value

+
+
ITransformer
+
+
+ + + + + + + +

@@ -496,19 +665,18 @@ Solid anchor.

- + -

- TableToWorkpieceBranch +

+ ThemeColor

-

Gets the branch connecting the table to the workpiece.

-
+
- 
public Branch TableToWorkpieceBranch { get; }
+ 
public static Vec3d ThemeColor { get; }
@@ -517,39 +685,7 @@ Solid anchor.

Property Value

-
Branch
-
-
- - - - - - - - - - -

- TableToWorkpieceTransformer - -

- -

Transformer from fixture origin to workpiece origin.

-
-
- -
- 
public ITransformer TableToWorkpieceTransformer { get; set; }
-
- - - - - -

Property Value

-
-
ITransformer
+
Vec3d
@@ -749,6 +885,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -782,6 +951,72 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchoredDisplayeeList() + +

+ +

Gets a list of anchored displayable objects.

+
+
+ +
+ 
public List<IAnchoredDisplayee> GetAnchoredDisplayeeList()
+
+ + +

Returns

+
+
List<IAnchoredDisplayee>
+

A list of IAnchoredDisplayee objects

+
+
+ + + + + + + + + + + + + +

+ GetAsmb() + +

+ +

Gets the key asmb.

+
+
+ +
+ 
public Asmb GetAsmb()
+
+ + +

Returns

+
+
Asmb
+

The key asmb.

+
+
+ + + + + + + + + + +

@@ -848,39 +1083,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

@@ -916,8 +1118,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -927,7 +1129,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -937,6 +1139,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -953,14 +1158,19 @@ This method may also generate additional resources such as related files.

+

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.

+
- + -

- SetWorkpieceTransformationToTopCenter() +

+ SetWorkpieceTransformationToGeomTopCenter()

@@ -969,7 +1179,7 @@ This method may also generate additional resources such as related files.

- 
public void SetWorkpieceTransformationToTopCenter()
+ 
public void SetWorkpieceTransformationToGeomTopCenter()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.LoggingMessageQueue.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html similarity index 52% rename from App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.LoggingMessageQueue.html rename to App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html index 7c3c3cd7..90d18927 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.Messages.LoggingMessageQueue.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html @@ -2,11 +2,11 @@ - Class LoggingMessageQueue | HiAPI-C# 2025 + Class FixtureEditorDisplayee | HiAPI-C# 2025 - + + - @@ -84,25 +84,24 @@
-
+
-

-Class LoggingMessageQueue +

+Class FixtureEditorDisplayee

-
Namespace
Hi.Common.Messages
-
Assembly
HiGeom.dll
+
Namespace
Hi.NcMech.Fixtures
+
Assembly
HiMech.dll
-

A queue for logging messages with multi-tag support and file output capabilities.

-
+
- 
public class LoggingMessageQueue : IMultiTagMessageQueue, IDisposable
+ 
public class FixtureEditorDisplayee : IDisplayee, IExpandToBox3d, IGetAsmb, IGetAnchor, IGetTopoIndex
@@ -112,15 +111,18 @@ Class LoggingMessageQueue
Inheritance
-
LoggingMessageQueue
+
FixtureEditorDisplayee
Implements
- - + + + + +
@@ -155,22 +157,13 @@ Class LoggingMessageQueue
Extension Methods
- - -
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -203,19 +196,18 @@ Class LoggingMessageQueue - + -

- Capacity +

+ Config

-

Gets or sets the maximum number of messages to keep in the queue.

-
+
- 
public int Capacity { get; set; }
+ 
public FixtureEditorDisplayeeConfig Config { get; set; }
@@ -224,7 +216,7 @@ Class LoggingMessageQueue

Property Value

-
int
+
FixtureEditorDisplayeeConfig
@@ -235,19 +227,18 @@ Class LoggingMessageQueue - + -

- MessageFile +

+ Fixture

-

Gets the path to the log file where messages are being written.

-
+
- 
public string MessageFile { get; }
+ 
public Fixture Fixture { get; }
@@ -256,7 +247,162 @@ Class LoggingMessageQueue

Property Value

-
string
+
Fixture
+
+
+ + + + + + + + + + +

+ FixtureGetter + +

+ +
+
+ +
+ 
public Func<Fixture> FixtureGetter { get; set; }
+
+ + + + + +

Property Value

+
+
Func<Fixture>
+
+
+ + + + + + + + + + +

+ RenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum RenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ ShowGeomAnchor + +

+ +
+
+ +
+ 
public bool ShowGeomAnchor { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowTableBuckle + +

+ +
+
+ +
+ 
public bool ShowTableBuckle { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowWorkpieceBuckle + +

+ +
+
+ +
+ 
public bool ShowWorkpieceBuckle { get; set; }
+
+ + + + + +

Property Value

+
+
bool
@@ -271,117 +417,25 @@ Class LoggingMessageQueue - + -

- Clear() +

+ Display(Bind)

-

Clears the message queue and closes the log file.

+

Display function called in DispEngine rendering loop.

- 
public void Clear()
-
- - - - - - - - - - - - - - - -

- Dispose() - -

- -

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

-
-
- -
- 
public void Dispose()
-
- - - - - - - - - - - - - - - -

- Dispose(bool) - -

- -
-
- -
- 
protected virtual void Dispose(bool disposing)
+ 
public void Display(Bind bind)

Parameters

-
disposing bool
-
-
- - - - - - - - - - - - - - -

- Enqueue(MultiTagMessage) - -

- -

Adds a message to the queue and writes it to the log file.

-
-
- -
- 
public MultiTagMessage Enqueue(MultiTagMessage multiTagMessage)
-
- -

Parameters

-
-
multiTagMessage MultiTagMessage
-

The message to enqueue

-
-
- -

Returns

-
-
MultiTagMessage
-

The enqueued message

+
bind Bind
+

Bind with DispEngine. See Bind.

@@ -395,26 +449,61 @@ Class LoggingMessageQueue - -

- GetLastMessages() + + +

+ ExpandToBox3d(Box3d)

-

Gets all messages currently in the queue as a single string.

+

Expands the destination box. +This function is usually used to compute the bounding box of elements.

- 
public string GetLastMessages()
+ 
public void ExpandToBox3d(Box3d dst)
+
+ +

Parameters

+
+
dst Box3d
+

Destination box

+
+
+ + + + + + + + + + + + + + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()

Returns

-
string
-

A string containing all messages in the queue, separated by newlines

+
Anchor
+

key anchor

@@ -428,33 +517,27 @@ Class LoggingMessageQueue -

Events -

+ - - -

- ClearEvent +

+ GetAsmb()

-

Event triggered when the queue is cleared.

+

Gets the key asmb.

- 
public event Action ClearEvent
+ 
public Asmb GetAsmb()
- - - - -

Event Type

+

Returns

-
Action
-
+
Asmb
+

The key asmb.

+
@@ -464,33 +547,6 @@ Class LoggingMessageQueue -

- MessageEvent - -

- -

Event triggered when a new message is added to the queue.

-
-
- -
- 
public event Action<string> MessageEvent
-
- - - - - - -

Event Type

-
-
Action<string>
-
-
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html new file mode 100644 index 00000000..9c60b28e --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html @@ -0,0 +1,484 @@ + + + + + Class FixtureEditorDisplayeeConfig | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class FixtureEditorDisplayeeConfig +

+ +
+
Namespace
Hi.NcMech.Fixtures
+
Assembly
HiMech.dll
+
+ +

Configuration settings for FixtureSetupDisplayee

+
+
+ +
+ 
public class FixtureEditorDisplayeeConfig : IMakeXmlSource
+
+ + + + +
+
Inheritance
+
+ +
FixtureEditorDisplayeeConfig
+
+
+ +
+
Implements
+
+ +
+
+ + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ FixtureEditorDisplayeeConfig() + +

+ +
+
+ +
+ 
public FixtureEditorDisplayeeConfig()
+
+ + + + + + + + + + + + + + + +

+ FixtureEditorDisplayeeConfig(XElement) + +

+ +

Constructor for XML deserialization

+
+
+ +
+ 
public FixtureEditorDisplayeeConfig(XElement element)
+
+ +

Parameters

+
+
element XElement
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ RenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum RenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ ShowGeomAnchor + +

+ +
+
+ +
+ 
public bool ShowGeomAnchor { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowTableBuckle + +

+ +
+
+ +
+ 
public bool ShowTableBuckle { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowWorkpieceBuckle + +

+ +
+
+ +
+ 
public bool ShowWorkpieceBuckle { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ XName + +

+ +

Name for XML IO.

+
+
+ +
+ 
public static string XName { get; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ 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.

+
+ + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.html index 9a722643..9fa944f4 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Fixtures.html @@ -99,6 +99,15 @@ Classes

Represents a fixture used to hold workpieces during machining operations.

+
+
FixtureEditorDisplayee
+
+
+
+
FixtureEditorDisplayeeConfig
+

Configuration settings for FixtureSetupDisplayee

+
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.CylindroidHolder.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.CylindroidHolder.html index 06e6e0f9..53519086 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.CylindroidHolder.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.CylindroidHolder.html @@ -102,7 +102,7 @@ Class CylindroidHolder
- 
public class CylindroidHolder : IHolder, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetBuckleAnchorList, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable
+ 
public class CylindroidHolder : IHolder, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IClearCache
@@ -120,26 +120,28 @@ Class CylindroidHolder
Implements
- + - + - - - - + + + + + +
@@ -177,10 +179,19 @@ Class CylindroidHolder CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int)
+ + +
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -479,6 +490,37 @@ Class CylindroidHolder + + +

+ CutterBuckle + +

+ +
+
+ +
+ 
public Anchor CutterBuckle { get; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + +

@@ -518,7 +560,7 @@ Class CylindroidHolder

-

Equivalent of GetTailBuckle().

+

Equivalent of CutterBuckle.

@@ -607,10 +649,99 @@ Class CylindroidHolder + + +

+ PolarResolution2d + +

+ +
+
+ +
+ 
public PolarResolution2d PolarResolution2d { get; set; }
+
+ + + + + +

Property Value

+
+
PolarResolution2d
+
+
+ + + + + + + + + + +

+ SpindleBuckle + +

+ +
+
+ +
+ 
public Anchor SpindleBuckle { get; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + +

Methods

+ + +

+ ClearCache() + +

+ +

Clears any cached data held by the implementing object.

+
+
+ +
+ 
public void ClearCache()
+
+ + + + + + + + + + + + +

@@ -775,6 +906,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -874,26 +1038,26 @@ This function is usually used to compute the bounding box of elements.

- + -

- GetBuckleAnchorList() +

+ GetCollidable()

-

Get buckle anchors.

+

Get ICollidable.

- 
public List<Anchor> GetBuckleAnchorList()
+ 
public ICollidable GetCollidable()

Returns

-
List<Anchor>
-

buckle anchors

+
ICollidable
+

The collidable object.

@@ -914,8 +1078,7 @@ This function is usually used to compute the bounding box of elements.

-

Gets the anchor associated with this collidable leaf.

-
+
@@ -926,8 +1089,7 @@ This function is usually used to compute the bounding box of elements.

Returns

Anchor
-

The anchor for this collidable leaf.

-
+
@@ -1007,39 +1169,6 @@ the anchor that generally connect to fixed part such as ground and triggering(mo - - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

@@ -1080,7 +1209,7 @@ the anchor that generally connect to fixed part such as ground and triggering(mo

-

Tool Buckle. Generally locate on free-end-side.

+

Cutter Buckle. Generally locate on free-end-side.

@@ -1107,8 +1236,8 @@ the anchor that generally connect to fixed part such as ground and triggering(mo -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1118,7 +1247,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1128,6 +1257,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1144,6 +1276,11 @@ This method may also generate additional resources such as related files.

+

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.NcMech.Holders.FreeformHolder.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.FreeformHolder.html index f86c7149..ad0e45b4 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.FreeformHolder.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.FreeformHolder.html @@ -102,7 +102,7 @@ Class FreeformHolder
- 
public class FreeformHolder : IHolder, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetBuckleAnchorList, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable
+ 
public class FreeformHolder : IHolder, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IClearCache
@@ -120,26 +120,28 @@ Class FreeformHolder
Implements
- + - + - - - - + + + + + +
@@ -177,10 +179,19 @@ Class FreeformHolder CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int)
+ + +
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -242,8 +253,8 @@ Class FreeformHolder -

- FreeformHolder(IGetStl) +

+ FreeformHolder(IStlSource)

@@ -252,12 +263,12 @@ Class FreeformHolder
- 
public FreeformHolder(IGetStl rawGeom)
+ 
public FreeformHolder(IStlSource geom)

Parameters

-
rawGeom IGetStl
+
geom IStlSource

The STL geometry provider.

@@ -273,42 +284,6 @@ Class FreeformHolder - - -

- FreeformHolder(IGetStl, ITransformer) - -

- -

Initializes a new instance of the FreeformHolder class from STL geometry with a transformer.

-
-
- -
- 
public FreeformHolder(IGetStl rawGeom, ITransformer transformer)
-
- -

Parameters

-
-
rawGeom IGetStl
-

The STL geometry provider.

-
-
transformer ITransformer
-

The geometry transformer.

-
-
- - - - - - - - - - - -

@@ -483,6 +458,73 @@ Class FreeformHolder + + +

+ CutterBuckle + +

+ +

Gets the tail buckle (tool buckle) anchor point

+
+
+ +
+ 
public Anchor CutterBuckle { get; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + + + + +

+ Geom + +

+ +

Gets the transformation geometry. Internal Use Only.

+
+
+ +
+ 
public IStlSource Geom { get; set; }
+
+ + + + + +

Property Value

+
+
IStlSource
+
+
+ + + + +

Remarks

+

Call UpdateByGeom() to keep state of Hi.NcMech.Holders.FreeformHolder.Solid if content modified.

+
+ + + +

@@ -515,19 +557,19 @@ Class FreeformHolder - + -

- GeomToBaseBranch +

+ GeomAnchorToSpindleBuckleBranch

-

Gets the branch from geometry to base

+

Gets the branch from GeomAnchor to SpindleBuckle.

- 
public Branch GeomToBaseBranch { get; }
+ 
public Branch GeomAnchorToSpindleBuckleBranch { get; }
@@ -547,51 +589,19 @@ Class FreeformHolder - + -

- GeomToBaseTransformer +

+ GeomToCutterBranch

-

Gets or sets the transformer from geometry to base

+

Gets the branch from GeomAnchor to CutterBuckle.

- 
public ITransformer GeomToBaseTransformer { get; set; }
-
- - - - - -

Property Value

-
-
ITransformer
-
-
- - - - - - - - - - -

- GeomToTailBranch - -

- -

Gets the branch from geometry to tail

-
-
- -
- 
public Branch GeomToTailBranch { get; }
+ 
public Branch GeomToCutterBranch { get; }
@@ -611,19 +621,19 @@ Class FreeformHolder - + -

- GeomToTailTransformer +

+ GeomToCutterTransformer

-

Gets or sets the transformer from geometry to tail

+

Gets or sets the transformer from geometry to tail (Cutter).

- 
public ITransformer GeomToTailTransformer { get; set; }
+ 
public ITransformer GeomToCutterTransformer { get; set; }
@@ -643,19 +653,19 @@ Class FreeformHolder - + -

- GeomTransformer +

+ GeomToSpindleTransformer

-

Gets or sets the geometry transformer.

+

Gets or sets the transformer from geometry to base (Spindle)

- 
public ITransformer GeomTransformer { get; set; }
+ 
public ITransformer GeomToSpindleTransformer { get; set; }
@@ -739,19 +749,19 @@ Class FreeformHolder - + -

- RawGeom +

+ PolarResolution2d

-

Gets or sets the raw geometry

+

Gets or sets the polar resolution 2D settings.

- 
public IGetStl RawGeom { get; set; }
+ 
public PolarResolution2d PolarResolution2d { get; set; }
@@ -760,7 +770,7 @@ Class FreeformHolder

Property Value

-
IGetStl
+
PolarResolution2d
@@ -771,19 +781,19 @@ Class FreeformHolder - + -

- TransformationGeom +

+ SpindleBuckle

-

Gets the transformation geometry. Internal Use Only.

+

Gets the base buckle (spindle buckle) anchor point

- 
public TransformationGeom TransformationGeom { get; }
+ 
public Anchor SpindleBuckle { get; }
@@ -792,16 +802,13 @@ Class FreeformHolder

Property Value

-
TransformationGeom
+
Anchor
-

Remarks

-

Call UpdateByRawGeomOrTransformer() to keep state of Hi.NcMech.Holders.FreeformHolder.Solid if content modified.

-
@@ -810,6 +817,33 @@ Class FreeformHolder + + +

+ ClearCache() + +

+ +

Clears any cached data held by the implementing object.

+
+
+ +
+ 
public void ClearCache()
+
+ + + + + + + + + + + + +

@@ -974,6 +1008,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -1073,26 +1140,26 @@ This function is usually used to compute the bounding box of elements.

- + -

- GetBuckleAnchorList() +

+ GetCollidable()

-

Get buckle anchors.

+

Get ICollidable.

- 
public List<Anchor> GetBuckleAnchorList()
+ 
public ICollidable GetCollidable()

Returns

-
List<Anchor>
-

buckle anchors

+
ICollidable
+

The collidable object.

@@ -1113,8 +1180,7 @@ This function is usually used to compute the bounding box of elements.

-

Gets the anchor associated with this collidable leaf.

-
+
@@ -1125,8 +1191,7 @@ This function is usually used to compute the bounding box of elements.

Returns

Anchor
-

The anchor for this collidable leaf.

-
+
@@ -1206,39 +1271,6 @@ the anchor that generally connect to fixed part such as ground and triggering(mo - - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

@@ -1279,7 +1311,7 @@ the anchor that generally connect to fixed part such as ground and triggering(mo

-

Tool Buckle. Generally locate on free-end-side.

+

Cutter Buckle. Generally locate on free-end-side.

@@ -1306,8 +1338,8 @@ the anchor that generally connect to fixed part such as ground and triggering(mo -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1317,7 +1349,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1327,6 +1359,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1343,24 +1378,28 @@ This method may also generate additional resources such as related files.

+

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.

+
- + -

- UpdateByRawGeomOrTransformer() +

+ UpdateByGeom()

-

Update Branch By RawGeom. -Call the function if the RawGeom content changed.

+

Call the function if the Geom content changed.

- 
public void UpdateByRawGeomOrTransformer()
+ 
public void UpdateByGeom()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.HolderEditorDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.HolderEditorDisplayee.html index 7acd58ab..2aa71a8f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.HolderEditorDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.HolderEditorDisplayee.html @@ -102,7 +102,7 @@ Class HolderEditorDisplayee
- 
public class HolderEditorDisplayee : IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d
+ 
public class HolderEditorDisplayee : IAnchoredDisplayee, IGetAnchor, IDisplayee, IExpandToBox3d, IGetAsmb, IGetTopoIndex
@@ -120,9 +120,11 @@ Class HolderEditorDisplayee
Implements
- + + +
@@ -156,6 +158,15 @@ Class HolderEditorDisplayee
Extension Methods
+ + + @@ -283,6 +294,130 @@ Class HolderEditorDisplayee + + +

+ RenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum RenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ ShowCutterBuckle + +

+ +
+
+ +
+ 
public bool ShowCutterBuckle { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowGeomAnchor + +

+ +
+
+ +
+ 
public bool ShowGeomAnchor { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowSpindleBuckle + +

+ +
+
+ +
+ 
public bool ShowSpindleBuckle { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + +

Methods

@@ -354,26 +489,59 @@ This function is usually used to compute the bounding box of elements.

- + -

- GetRootAnchor() +

+ GetAnchor()

-

Get root anchor.

+

Get key anchor. (i.e. root anchor)

- 
public Anchor GetRootAnchor()
+ 
public Anchor GetAnchor()

Returns

Anchor
-

root anchor.

+

key anchor

+
+
+ + + + + + + + + + + + + +

+ GetAsmb() + +

+ +

Gets the key asmb.

+
+
+ +
+ 
public Asmb GetAsmb()
+
+ + +

Returns

+
+
Asmb
+

The key asmb.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.IHolder.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.IHolder.html index a26afbb0..6874b1c6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.IHolder.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Holders.IHolder.html @@ -102,7 +102,7 @@ Interface IHolder
- 
public interface IHolder : ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetBuckleAnchorList, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IAnchoredCollidableBased, IDuplicate, INameNote
+ 
public interface IHolder : ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IAnchoredCollidableBased, IDuplicate, INameNote, IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex, IGetSolid
@@ -118,7 +118,7 @@ Interface IHolder IGetAsmb.GetAsmb()
IDisplayee.Display(Bind) @@ -127,13 +127,7 @@ Interface IHolder IExpandToBox3d.ExpandToBox3d(Box3d)
- -
IAbstractNote.AbstractNote @@ -151,10 +145,22 @@ Interface IHolder IDuplicate.Duplicate(params object[])
+ + + +
@@ -162,10 +168,19 @@ Interface IHolder
Extension Methods
+ + +
DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[]) @@ -194,6 +209,134 @@ Interface IHolder +

Properties +

+ + + + +

+ CutterBuckle + +

+ +
+
+ +
+ 
Anchor CutterBuckle { get; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + + + + +

+ GeomAnchor + +

+ +
+
+ +
+ 
Anchor GeomAnchor { get; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + + + + +

+ SpindleBuckle + +

+ +
+
+ +
+ 
Anchor SpindleBuckle { get; }
+
+ + + + + +

Property Value

+
+
Anchor
+
+
+ + + + + + + + + + +

+ ThemeColor + +

+ +
+
+ +
+ 
public static Vec3d ThemeColor { get; }
+
+ + + + + +

Property Value

+
+
Vec3d
+
+
+ + + + + + + +

Methods

@@ -205,7 +348,7 @@ Interface IHolder -

Tool Buckle. Generally locate on free-end-side.

+

Cutter Buckle. Generally locate on free-end-side.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.ICollisionIndexPairsSource.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.ICollisionIndexPairsSource.html index 4460f550..b124e3c0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.ICollisionIndexPairsSource.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.ICollisionIndexPairsSource.html @@ -119,7 +119,7 @@ Extends IGetCol IGetCollisionIndexPairs.GetCollisionIndexPairs()
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.IGetSolidMachiningChain.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.IGetSolidMachiningChain.html deleted file mode 100644 index c7687538..00000000 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.IGetSolidMachiningChain.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - Interface IGetSolidMachiningChain | HiAPI-C# 2025 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
-
-
-
-
Table of Contents
- -
-
- -
-
-
- -
-
- - - -
- -
- - - -

-Interface IGetSolidMachiningChain -

- -
-
Namespace
Hi.NcMech
-
Assembly
HiMech.dll
-
- -

Interface of get ISolidMachiningChain.

-
-
- -
- 
public interface IGetSolidMachiningChain
-
- - - - - - - - -
-
Extension Methods
-
- - - - - - - -
- - - - - -

Methods -

- - - - -

- GetSolidMachiningChain() - -

- -

Get ISolidMachiningChain.

-
-
- -
- 
ISolidMachiningChain GetSolidMachiningChain()
-
- - -

Returns

-
-
ISolidMachiningChain
-

ISolidMachiningChain

-
-
- - - - - - - - - - - - -
- -
-
- - -
- -
- -
-
- -
- - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.Solid.RenderingModeEnum.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.Solid.RenderingModeEnum.html new file mode 100644 index 00000000..4e509e24 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.Solid.RenderingModeEnum.html @@ -0,0 +1,183 @@ + + + + + Enum Solid.RenderingModeEnum | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + + +

+Enum Solid.RenderingModeEnum +

+ +
+
Namespace
Hi.NcMech.Solids
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public enum Solid.RenderingModeEnum
+
+ + + + + + + + +
+
Extension Methods
+
+ + + + + + + + +
+ +

Fields +

+
+
Edge = 1
+ +
+
Hide = 2
+ +
+
Solid = 0
+ +
+
+ + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.Solid.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.Solid.html index 13d1d98d..ae6143b2 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.Solid.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.Solid.html @@ -103,7 +103,7 @@ Provides thread-safe access to geometry data and caching mechanisms.

- 
public class Solid : IGetTriTree, ICollidable, IGetCollidable, IDisplayee, IExpandToBox3d, IDisposable, IGetSolid, IUpdateByContent, IClearCache, IStlSource, IGetStl, IMakeXmlSource
+ 
public class Solid : IGetTriTree, ICollidable, IGetCollidable, IDisplayee, IExpandToBox3d, IStlSource, IGetStl, IPolarResolution2dSourceProperty, IDisposable, IMakeXmlSource, IGetSolid, IUpdateByContent, IClearCache
@@ -125,13 +125,14 @@ Provides thread-safe access to geometry data and caching mechanisms.

+ + + + - - - @@ -165,6 +166,9 @@ Provides thread-safe access to geometry data and caching mechanisms.

+ @@ -468,6 +472,37 @@ The data is created from the STL representation when first accessed.

+ + +

+ PolarResolution2dSource + +

+ +
+
+ +
+ 
public Func<IPolarResolution2d> PolarResolution2dSource { get; set; }
+
+ + + + + +

Property Value

+
+
Func<IPolarResolution2d>
+
+
+ + + + + + + +

@@ -633,6 +668,70 @@ The cache determines the behavior of the + +

+ Display(Bind, RenderingModeEnum) + +

+ +
+
+ +
+ 
public void Display(Bind bind, Solid.RenderingModeEnum renderingMode)
+
+ +

Parameters

+
+
bind Bind
+
+
renderingMode Solid.RenderingModeEnum
+
+
+ + + + + + + + + + + + + + +

+ DisplayFeatureEdges(Bind) + +

+ +
+
+ +
+ 
public void DisplayFeatureEdges(Bind bind)
+
+ +

Parameters

+
+
bind Bind
+
+
+ + + + + + + + + + + +

@@ -927,8 +1026,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -938,7 +1037,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -948,6 +1047,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -964,6 +1066,11 @@ This method may also generate additional resources such as related files.

+

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.NcMech.Solids.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.html index b85b7ccf..9a51043b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Solids.html @@ -115,6 +115,13 @@ Interfaces Provides a standardized way to access solid models.

+

+Enums +

+
+
Solid.RenderingModeEnum
+
+
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.INcTransformer.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.INcTransformer.html index 4fa1a8fb..e400e3c8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.INcTransformer.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.INcTransformer.html @@ -127,7 +127,7 @@ Interface INcTransformer ITransformer.Clone()
INcStroke.GetKeyCode() diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.ITopoBrick.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.ITopoBrick.html index 7873d340..c703a60d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.ITopoBrick.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.ITopoBrick.html @@ -103,7 +103,7 @@ Combines solid geometry, display capabilities, and collision detection functiona
- 
public interface ITopoBrick : IGetSolid, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable
+ 
public interface ITopoBrick : IGetSolid, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable
@@ -119,7 +119,7 @@ Combines solid geometry, display capabilities, and collision detection functiona IGetSolid.GetSolid()
IDisplayee.Display(Bind) @@ -150,6 +150,15 @@ Combines solid geometry, display capabilities, and collision detection functiona + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcRotation.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcRotation.html index 03a530a9..f4b4f507 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcRotation.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcRotation.html @@ -790,8 +790,8 @@ Provides functionality for rotational motion with stroke and speed limits.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -801,7 +801,7 @@ This method may also generate additional resources such as related files.

- 
public override XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public override XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -811,6 +811,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -827,6 +830,11 @@ This method may also generate additional resources such as related files.

+

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.NcMech.Topo.NcTranslation.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcTranslation.html index af9b336c..b4504ef1 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcTranslation.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.NcTranslation.html @@ -681,8 +681,8 @@ Provides functionality for linear motion with stroke and speed limits.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -692,7 +692,7 @@ This method may also generate additional resources such as related files.

- 
public override XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public override XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -702,6 +702,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -718,6 +721,11 @@ This method may also generate additional resources such as related files.

+

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.NcMech.Topo.SolidSourceTopoBrick.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.SolidSourceTopoBrick.html index 5e714f7c..0670872e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.SolidSourceTopoBrick.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.SolidSourceTopoBrick.html @@ -103,7 +103,7 @@ Implements display, collision detection, and content update capabilities.

- 
public class SolidSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IUpdateByContent, IClearCache
+ 
public class SolidSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IUpdateByContent, IClearCache
@@ -123,7 +123,8 @@ Implements display, collision detection, and content update capabilities.

- + + @@ -168,6 +169,15 @@ Implements display, collision detection, and content update capabilities.

+ + + @@ -525,6 +535,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -624,39 +667,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.StlSourceTopoBrick.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.StlSourceTopoBrick.html index 7ac7b3f4..c9c6342f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.StlSourceTopoBrick.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Topo.StlSourceTopoBrick.html @@ -103,7 +103,7 @@ Implements display, collision detection, and content update capabilities.

- 
public class StlSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IDisposable, IUpdateByContent, IClearCache
+ 
public class StlSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IDisposable, IUpdateByContent, IClearCache
@@ -123,7 +123,8 @@ Implements display, collision detection, and content update capabilities.

- + + @@ -169,6 +170,15 @@ Implements display, collision detection, and content update capabilities.

+ + + @@ -618,6 +628,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -717,39 +760,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.Workpiece.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.Workpiece.html index 7a1de040..d3436756 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.Workpiece.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.Workpiece.html @@ -102,7 +102,7 @@ Class Workpiece
- 
public class Workpiece : IDisplayee, IExpandToBox3d, IDisposable, IGetRootAnchor, IGetAnchoredDisplayeeList, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IGetCuttingPara, IMakeXmlSource
+ 
public class Workpiece : IDisplayee, IExpandToBox3d, IDisposable, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IGetCuttingPara, IMakeXmlSource
@@ -122,7 +122,8 @@ Class Workpiece - + + @@ -166,6 +167,15 @@ Class Workpiece + + + @@ -395,6 +405,103 @@ Class Workpiece + + +

+ CuttingPara + +

+ +

Milling parameters.

+
+
+ +
+ 
public ICuttingPara CuttingPara { get; set; }
+
+ + + + + +

Property Value

+
+
ICuttingPara
+
+
+ + + + + + + + + + +

+ CuttingParaFile + +

+ +

File path for milling parameters.

+
+
+ +
+ 
public string CuttingParaFile { get; set; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + + + +

+ DiffAttachmentBag + +

+ +

transient object. +For Internal Use.

+
+
+ +
+ 
public ConcurrentBag<DiffAttachment> DiffAttachmentBag { get; set; }
+
+ + + + + +

Property Value

+
+
ConcurrentBag<DiffAttachment>
+
+
+ + + + + + + +

@@ -619,19 +726,20 @@ Class Workpiece - + -

- IdealGeomFaceDrawing +

+ IdealSolid

-

Gets the drawing representing the ideal geometry faces of the workpiece.

+

Gets the drawing representing the ideal geometry faces of the workpiece. +The derived solid from IdealGeom.

- 
public Drawing IdealGeomFaceDrawing { get; }
+ 
public Solid IdealSolid { get; }
@@ -640,7 +748,7 @@ Class Workpiece

Property Value

-
Drawing
+
Solid
@@ -715,6 +823,38 @@ Class Workpiece + + +

+ InitSolid + +

+ +

The derived solid from InitGeom.

+
+
+ +
+ 
public Solid InitSolid { get; }
+
+ + + + + +

Property Value

+
+
Solid
+
+
+ + + + + + + +

@@ -747,70 +887,6 @@ Class Workpiece - - -

- MillingPara - -

- -

Milling parameters.

-
-
- -
- 
public ICuttingPara MillingPara { get; set; }
-
- - - - - -

Property Value

-
-
ICuttingPara
-
-
- - - - - - - - - - -

- MillingParaFile - -

- -

File path for milling parameters.

-
-
- -
- 
public string MillingParaFile { get; set; }
-
- - - - - -

Property Value

-
-
string
-
-
- - - - - - - -

@@ -843,38 +919,6 @@ Class Workpiece - - -

- RawGeomDrawing - -

- -

Gets the drawing representing the raw geometry of the workpiece.

-
-
- -
- 
public Drawing RawGeomDrawing { get; }
-
- - - - - -

Property Value

-
-
Drawing
-
-
- - - - - - - -

@@ -1321,6 +1365,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -1486,39 +1563,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - -

@@ -1563,8 +1607,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1574,7 +1618,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1584,6 +1628,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1600,6 +1647,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -1670,6 +1722,37 @@ This method may also generate additional resources such as related files.

+ + +

+ SetRuntimeGeom(CubeTree) + +

+ +
+
+ +
+ 
public void SetRuntimeGeom(CubeTree runtimeGeom_)
+
+ +

Parameters

+
+
runtimeGeom_ CubeTree
+
+
+ + + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html new file mode 100644 index 00000000..c4670385 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html @@ -0,0 +1,523 @@ + + + + + Class WorkpieceEditorDisplayee | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class WorkpieceEditorDisplayee +

+ +
+
Namespace
Hi.NcMech.Workpieces
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public class WorkpieceEditorDisplayee : IDisplayee, IExpandToBox3d
+
+ + + + +
+
Inheritance
+
+ +
WorkpieceEditorDisplayee
+
+
+ +
+
Implements
+
+ + +
+
+ + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + + +
+ + + + + +

Properties +

+ + + + +

+ Config + +

+ +
+
+ +
+ 
public WorkpieceEditorDisplayeeConfig Config { get; set; }
+
+ + + + + +

Property Value

+
+
WorkpieceEditorDisplayeeConfig
+
+
+ + + + + + + + + + +

+ FixtureRenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum FixtureRenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ IdealGeomRenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum IdealGeomRenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ MachiningEquipmentGetter + +

+ +
+
+ +
+ 
public Func<MachiningEquipment> MachiningEquipmentGetter { get; set; }
+
+ + + + + +

Property Value

+
+
Func<MachiningEquipment>
+
+
+ + + + + + + + + + +

+ RawGeomRenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum RawGeomRenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ ShowRuntimeGeom + +

+ +
+
+ +
+ 
public bool ShowRuntimeGeom { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ ClearIdealGeomCache() + +

+ +
+
+ +
+ 
public void ClearIdealGeomCache()
+
+ + + + + + + + + + + + + + + +

+ ClearRawGeomCache() + +

+ +
+
+ +
+ 
public void ClearRawGeomCache()
+
+ + + + + + + + + + + + + + + +

+ Display(Bind) + +

+ +

Display function called in DispEngine rendering loop.

+
+
+ +
+ 
public void Display(Bind bind)
+
+ +

Parameters

+
+
bind Bind
+

Bind with DispEngine. See Bind.

+
+
+ + + + + + + + + + + + + + +

+ ExpandToBox3d(Box3d) + +

+ +

Expands the destination box. +This function is usually used to compute the bounding box of elements.

+
+
+ +
+ 
public void ExpandToBox3d(Box3d dst)
+
+ +

Parameters

+
+
dst Box3d
+

Destination box

+
+
+ + + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html new file mode 100644 index 00000000..39d96743 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html @@ -0,0 +1,577 @@ + + + + + Class WorkpieceEditorDisplayeeConfig | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class WorkpieceEditorDisplayeeConfig +

+ +
+
Namespace
Hi.NcMech.Workpieces
+
Assembly
HiMech.dll
+
+ +

Configuration settings for EquipmentWorkpieceSetupDispalyee

+
+
+ +
+ 
public class WorkpieceEditorDisplayeeConfig : IMakeXmlSource
+
+ + + + +
+
Inheritance
+
+ +
WorkpieceEditorDisplayeeConfig
+
+
+ +
+
Implements
+
+ +
+
+ + +
+
Inherited Members
+
+ + + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ WorkpieceEditorDisplayeeConfig() + +

+ +
+
+ +
+ 
public WorkpieceEditorDisplayeeConfig()
+
+ + + + + + + + + + + + + + + +

+ WorkpieceEditorDisplayeeConfig(XElement) + +

+ +

Constructor for XML deserialization

+
+
+ +
+ 
public WorkpieceEditorDisplayeeConfig(XElement element)
+
+ +

Parameters

+
+
element XElement
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ FixtureRenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum FixtureRenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ IdealGeomRenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum IdealGeomRenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ RawGeomRenderingMode + +

+ +
+
+ +
+ 
public Solid.RenderingModeEnum RawGeomRenderingMode { get; set; }
+
+ + + + + +

Property Value

+
+
Solid.RenderingModeEnum
+
+
+ + + + + + + + + + +

+ ShowFixtureBuckle + +

+ +
+
+ +
+ 
public bool ShowFixtureBuckle { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowGeomAnchor + +

+ +
+
+ +
+ 
public bool ShowGeomAnchor { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowProgramZeroAnchor + +

+ +
+
+ +
+ 
public bool ShowProgramZeroAnchor { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ ShowRuntimeGeom + +

+ +
+
+ +
+ 
public bool ShowRuntimeGeom { get; set; }
+
+ + + + + +

Property Value

+
+
bool
+
+
+ + + + + + + + + + +

+ XName + +

+ +

Name for XML IO.

+
+
+ +
+ 
public static string XName { get; }
+
+ + + + + +

Property Value

+
+
string
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ 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.

+
+ + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.html index 97f4f969..cd91314c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Workpieces.html @@ -99,6 +99,15 @@ Classes

Workpiece.

+
+
WorkpieceEditorDisplayee
+
+
+
+
WorkpieceEditorDisplayeeConfig
+

Configuration settings for EquipmentWorkpieceSetupDispalyee

+
+

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html index f6cc1ad6..2b28e40f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html @@ -102,7 +102,7 @@ Class CodeXyzabcMachineTool
- 
public class CodeXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote
+ 
public class CodeXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote
@@ -124,17 +124,15 @@ Class CodeXyzabcMachineTool - + - - - + @@ -168,9 +166,18 @@ Class CodeXyzabcMachineTool
Extension Methods
+ + + @@ -278,7 +285,7 @@ Class CodeXyzabcMachineTool -

Initializes a new instance of the CodeXyzabcMachineTool class from XML.

+

Initializes a new instance from XML.

@@ -731,6 +738,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -925,72 +965,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - - - - -

- GetSolidMachiningChain() - -

- -

Get ISolidMachiningChain.

-
-
- -
- 
public ISolidMachiningChain GetSolidMachiningChain()
-
- - -

Returns

-
-
ISolidMachiningChain
-

ISolidMachiningChain

-
-
- - - - - - - - - - -

@@ -1321,8 +1295,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1332,7 +1306,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1342,6 +1316,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1358,6 +1335,11 @@ This method may also generate additional resources such as related files.

+

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.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html index a1f3ea39..30dea6a6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html @@ -428,37 +428,6 @@ Class CodeXyzabcMachineToolUri - - -

- GetSolidMachiningChain() - -

- -
-
- -
- 
public ISolidMachiningChain GetSolidMachiningChain()
-
- - -

Returns

-
-
ISolidMachiningChain
-
-
- - - - - - - - - - -

@@ -530,8 +499,8 @@ Class CodeXyzabcMachineToolUri -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -541,7 +510,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -551,6 +520,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -567,6 +539,11 @@ This method may also generate additional resources such as related files.

+

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.NcMech.Xyzabc.GeneralXyzabcMachineTool.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html index 4ec7acd6..007bef73 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html @@ -102,7 +102,7 @@ Class GeneralXyzabcMachineTool
- 
public class GeneralXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote
+ 
public class GeneralXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote
@@ -124,17 +124,15 @@ Class GeneralXyzabcMachineTool - + - - - + @@ -168,9 +166,18 @@ Class GeneralXyzabcMachineTool
Extension Methods
+ + + @@ -739,6 +746,39 @@ This function is usually used to compute the bounding box of elements.

+ + +

+ GetAnchor() + +

+ +

Get key anchor. (i.e. root anchor)

+
+
+ +
+ 
public Anchor GetAnchor()
+
+ + +

Returns

+
+
Anchor
+

key anchor

+
+
+ + + + + + + + + + +

@@ -933,72 +973,6 @@ This function is usually used to compute the bounding box of elements.

- - -

- GetRootAnchor() - -

- -

Get root anchor.

-
-
- -
- 
public Anchor GetRootAnchor()
-
- - -

Returns

-
-
Anchor
-

root anchor.

-
-
- - - - - - - - - - - - - -

- GetSolidMachiningChain() - -

- -

Get ISolidMachiningChain.

-
-
- -
- 
public ISolidMachiningChain GetSolidMachiningChain()
-
- - -

Returns

-
-
ISolidMachiningChain
-

ISolidMachiningChain

-
-
- - - - - - - - - - -

@@ -1329,8 +1303,8 @@ This function is usually used to compute the bounding box of elements.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1340,7 +1314,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1350,6 +1324,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1366,6 +1343,11 @@ This method may also generate additional resources such as related files.

+

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.NcMech.Xyzabc.IXyzabcMachineTool.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.IXyzabcMachineTool.html index 6373748c..642631b1 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.IXyzabcMachineTool.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.Xyzabc.IXyzabcMachineTool.html @@ -102,7 +102,7 @@ Interface IXyzabcMachineTool
- 
public interface IXyzabcMachineTool : IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote
+ 
public interface IXyzabcMachineTool : IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote
@@ -157,13 +157,10 @@ Interface IXyzabcMachineTool IGetAsmb.GetAsmb() -
Extension Methods
+ + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.html index 3bf8648b..c5b68ea2 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcMech.html @@ -98,17 +98,6 @@ Interfaces
ICollisionIndexPairsSource

Interface that provides access to collision index pairs and XML serialization capabilities. Extends IGetCollisionIndexPairs with XML serialization support.

-
-
-
-
IGetSolidMachiningChain
-

Interface of get ISolidMachiningChain.

-
-
-
-
ISolidMachiningChain
-

Interface for a machining chain that provides access to solid geometry. -Extends IMachiningChain with solid geometry capabilities.

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.CuttingVelocityOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.CuttingVelocityOptLimit.html index 24f76fcd..7ecef657 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.CuttingVelocityOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.CuttingVelocityOptLimit.html @@ -102,7 +102,7 @@ Class CuttingVelocityOptLimit
- 
public class CuttingVelocityOptLimit : ICuttingVelocityOptLimit, IMakeXmlSource, IDuplicate
+ 
public class CuttingVelocityOptLimit : ICuttingVelocityOptLimit, IMakeXmlSource, IDuplicate, IToXElement
@@ -122,6 +122,7 @@ Class CuttingVelocityOptLimit + @@ -524,8 +525,8 @@ Class CuttingVelocityOptLimit -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -535,7 +536,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -545,6 +546,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -561,6 +565,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerCycleOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerCycleOptLimit.html index f1cf834f..5e0e0baa 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerCycleOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerCycleOptLimit.html @@ -103,7 +103,7 @@ Provides implementation for feed-per-cycle optimization with fixed minimum and m
- 
public class FixedFeedPerCycleOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache
+ 
public class FixedFeedPerCycleOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache, IToXElement
@@ -124,6 +124,7 @@ Provides implementation for feed-per-cycle optimization with fixed minimum and m + @@ -533,8 +534,8 @@ Provides implementation for feed-per-cycle optimization with fixed minimum and m -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -544,7 +545,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -554,6 +555,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -570,6 +574,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerToothOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerToothOptLimit.html index 5f50cff8..c4f08ff7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerToothOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.FixedFeedPerToothOptLimit.html @@ -103,7 +103,7 @@ Provides implementation for feed-per-tooth optimization with fixed minimum and m
- 
public class FixedFeedPerToothOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate
+ 
public class FixedFeedPerToothOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IToXElement
@@ -123,6 +123,7 @@ Provides implementation for feed-per-tooth optimization with fixed minimum and m + @@ -458,8 +459,8 @@ Provides implementation for feed-per-tooth optimization with fixed minimum and m -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -469,7 +470,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -479,6 +480,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -495,6 +499,11 @@ This method may also generate additional resources such as related files.

+

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.

+
@@ -532,6 +541,39 @@ This method may also generate additional resources such as related files.

+ + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + + + + +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICutterOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICutterOptLimit.html index 6e11c38d..695d220c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICutterOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICutterOptLimit.html @@ -123,7 +123,7 @@ Inherits from IMak IFeedPerToothOptLimit.GetMaxFeedPerTooth_mm()
IDuplicate.Duplicate(params object[]) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICuttingVelocityOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICuttingVelocityOptLimit.html index 7be14713..3ae90bcd 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICuttingVelocityOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ICuttingVelocityOptLimit.html @@ -117,7 +117,7 @@ Implements IMakeXm
Inherited Members
IDuplicate.Duplicate(params object[]) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.IFeedPerToothOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.IFeedPerToothOptLimit.html index 7d8bcc90..5127cb86 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.IFeedPerToothOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.IFeedPerToothOptLimit.html @@ -117,7 +117,7 @@ Implements IMakeXm
Inherited Members
IDuplicate.Duplicate(params object[]) diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.MillingCutterOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.MillingCutterOptLimit.html index 993ba3ea..b3e0796a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.MillingCutterOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.MillingCutterOptLimit.html @@ -102,7 +102,7 @@ Class MillingCutterOptLimit
- 
public class MillingCutterOptLimit : ICutterOptLimit, IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache
+ 
public class MillingCutterOptLimit : ICutterOptLimit, IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache, IToXElement
@@ -124,6 +124,7 @@ Class MillingCutterOptLimit +
@@ -519,6 +520,9 @@ Class MillingCutterOptLimit +

Remarks

+

res[0] has to be ICutter.

+
@@ -591,8 +595,8 @@ Class MillingCutterOptLimit -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -602,7 +606,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -612,6 +616,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -628,6 +635,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptOption.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptOption.html index 88ca4581..ee9f1d39 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptOption.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptOption.html @@ -102,7 +102,7 @@ Class NcOptOption
- 
public class NcOptOption : IMakeXmlSource, IEquatable<NcOptOption>
+ 
public class NcOptOption : IMakeXmlSource, IEquatable<NcOptOption>, IToXElement
@@ -121,6 +121,7 @@ Class NcOptOption
+
@@ -1135,8 +1136,8 @@ Note: 600mm/min=10mm/s.

-

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -1146,7 +1147,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -1156,6 +1157,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -1172,6 +1176,44 @@ This method may also generate additional resources such as related files.

+

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.

+
+ + + + + + +

+ ToXElement() + +

+ +

Get the XElement to represent the object.

+
+
+ +
+ 
public XElement ToXElement()
+
+ + +

Returns

+
+
XElement
+

XElement to represent the object.

+
+
+ + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html index 1c89c140..28c00eef 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.NcOptProc.html @@ -362,8 +362,8 @@ Class NcOptProc -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -373,7 +373,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -383,6 +383,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -399,14 +402,19 @@ This method may also generate additional resources such as related files.

+

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.

+
-

- Optimize(ICuttingPara, MachiningSession, LinkedList<NcLine>, NcEnv, List<MachiningStep>, MachiningToolHouse, IMessageHost, CancellationToken, string) +

+ Optimize(ICuttingPara, MachiningSession, LinkedList<NcLine>, NcEnv, List<MachiningStep>, MachiningToolHouse, IMessageKit, CancellationToken, string)

@@ -415,7 +423,7 @@ This method may also generate additional resources such as related files.

- 
public IEnumerable<(NcLine SrcNcLine, NcLine OptNcLine)> Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<NcLine> srcNcLines, NcEnv ncEnv, List<MachiningStep> millingSteps, MachiningToolHouse millingToolHouse, IMessageHost messageHost, CancellationToken cancellationToken, string relFileTemplate)
+ 
public IEnumerable<(NcLine SrcNcLine, NcLine OptNcLine)> Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<NcLine> srcNcLines, NcEnv ncEnv, List<MachiningStep> millingSteps, MachiningToolHouse millingToolHouse, IMessageKit messageHost, CancellationToken cancellationToken, string relFileTemplate)

Parameters

@@ -432,13 +440,13 @@ This method may also generate additional resources such as related files.

ncEnv NcEnv

The NC environment settings

-
millingSteps List<MachiningStep>
+
millingSteps List<MachiningStep>

The list of milling steps

millingToolHouse MachiningToolHouse

The machining tool house

-
messageHost IMessageHost
+
messageHost IMessageKit

The message host for logging

cancellationToken CancellationToken
@@ -468,8 +476,8 @@ This method may also generate additional resources such as related files.

-

- OptimizeToFiles(ICuttingPara, MachiningSession, LinkedList<NcLine>, NcEnv, MachiningToolHouse, ClStrip, string, IMessageHost, CancellationToken, string) +

+ OptimizeToFiles(ICuttingPara, MachiningSession, LinkedList<NcLine>, NcEnv, MachiningToolHouse, ClStrip, string, IMessageKit, CancellationToken, string)

@@ -478,7 +486,7 @@ This method may also generate additional resources such as related files.

- 
public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<NcLine> ncLines, NcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IMessageHost messageHost, CancellationToken cancellationToken, string relFileTemplate = "Output/Opt-[NcName]")
+ 
public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList<NcLine> ncLines, NcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IMessageKit messageHost, CancellationToken cancellationToken, string relFileTemplate = "Output/Opt-[NcName]")

Parameters

@@ -504,7 +512,7 @@ This method may also generate additional resources such as related files.

baseDirectory string

The base directory for output files

-
messageHost IMessageHost
+
messageHost IMessageKit

The message host for logging

cancellationToken CancellationToken
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ShapeBasedCutterOptLimit.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ShapeBasedCutterOptLimit.html index 186a5882..7bc14060 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ShapeBasedCutterOptLimit.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcOpt.ShapeBasedCutterOptLimit.html @@ -728,8 +728,8 @@ Class ShapeBasedCutterOptLimit -

- MakeXmlSource(string, string) +

+ MakeXmlSource(string, string, bool)

@@ -739,7 +739,7 @@ This method may also generate additional resources such as related files.

- 
public XElement MakeXmlSource(string baseDirectory, string relFile)
+ 
public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

@@ -749,6 +749,9 @@ This method may also generate additional resources such as related files.

relFile string

The relative file path for the XML source

+
+
exhibitionOnly bool
+

if true, the extended file creation is suppressed.

@@ -765,6 +768,11 @@ This method may also generate additional resources such as related files.

+

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.NcStepUtils.INcStepMonitee.html b/App/wwwroot/HiAPI-docsite/api/Hi.NcStepUtils.INcStepMonitee.html index e0607eee..cfa477a0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.NcStepUtils.INcStepMonitee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.NcStepUtils.INcStepMonitee.html @@ -117,7 +117,7 @@ Implements IMakeXm
Inherited Members
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClArc.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClArc.html index ac484388..8ce1c608 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClArc.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClArc.html @@ -102,7 +102,7 @@ Class ActClArc
- 
public class ActClArc : IActClMove, IAct
+ 
public class ActClArc : IActClMove, IActDuration, IAct
@@ -120,6 +120,7 @@ Class ActClArc
Implements
+
@@ -160,6 +161,9 @@ Class ActClArc + @@ -184,8 +188,8 @@ Class ActClArc -

- ActClArc(ClCircleArc) +

+ ActClArc(ClCircleArc, TimeSpan)

@@ -194,7 +198,7 @@ Class ActClArc
- 
public ActClArc(ClCircleArc path)
+ 
public ActClArc(ClCircleArc path, TimeSpan duration)

Parameters

@@ -202,6 +206,8 @@ Class ActClArc
path ClCircleArc

The circle arc path.

+
duration TimeSpan
+
@@ -219,6 +225,47 @@ Class ActClArc + + +

+ ActDuration + +

+ +

Gets or sets the duration of the action.

+
+
+ +
+ 
public TimeSpan ActDuration { get; set; }
+
+ + + + + +

Property Value

+
+
TimeSpan
+
+
+ + + + +

Remarks

+

The duration represents:

+
    +
  • The time required to complete the action
    • +
  • Should be positive and finite
    • +
  • Zero duration indicates an instantaneous action
    • +
  • Used for scheduling and timing calculations
    • +
+
+ + + +

@@ -288,6 +335,42 @@ Class ActClArc + + +

+ GetClSteps(IMachiningMotionResolution) + +

+ +
+
+ +
+ 
public IEnumerable<ActClStep> GetClSteps(IMachiningMotionResolution ncResolution)
+
+ +

Parameters

+
+
ncResolution IMachiningMotionResolution
+
+
+ +

Returns

+
+
IEnumerable<ActClStep>
+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClLinear.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClLinear.html index 7b323984..e86cc9a3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClLinear.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClLinear.html @@ -102,7 +102,7 @@ Class ActClLinear
- 
public class ActClLinear : IActClMove, IAct
+ 
public class ActClLinear : IActClMove, IActDuration, IAct
@@ -120,6 +120,7 @@ Class ActClLinear
Implements
+
@@ -160,6 +161,9 @@ Class ActClLinear + @@ -184,8 +188,8 @@ Class ActClLinear -

- ActClLinear(ClLinear) +

+ ActClLinear(ClLinear, TimeSpan?)

@@ -194,7 +198,7 @@ Class ActClLinear
- 
public ActClLinear(ClLinear path)
+ 
public ActClLinear(ClLinear path, TimeSpan? duration = null)

Parameters

@@ -202,6 +206,43 @@ Class ActClLinear
path ClLinear

The linear cutter location path.

+
duration TimeSpan?
+
+ + + + + + + + + + + + + + + +

+ ActClLinear(DVec3d, DVec3d, TimeSpan?) + +

+ +
+
+ +
+ 
public ActClLinear(DVec3d beginCl, DVec3d endCl, TimeSpan? duration = null)
+
+ +

Parameters

+
+
beginCl DVec3d
+
+
endCl DVec3d
+
+
duration TimeSpan?
+
@@ -219,6 +260,47 @@ Class ActClLinear + + +

+ ActDuration + +

+ +

Gets or sets the duration of the action.

+
+
+ +
+ 
public TimeSpan ActDuration { get; set; }
+
+ + + + + +

Property Value

+
+
TimeSpan
+
+
+ + + + +

Remarks

+

The duration represents:

+
    +
  • The time required to complete the action
    • +
  • Should be positive and finite
    • +
  • Zero duration indicates an instantaneous action
    • +
  • Used for scheduling and timing calculations
    • +
+
+ + + +

@@ -288,6 +370,42 @@ Class ActClLinear + + +

+ GetClSteps(IMachiningMotionResolution) + +

+ +
+
+ +
+ 
public IEnumerable<ActClStep> GetClSteps(IMachiningMotionResolution ncResolution)
+
+ +

Parameters

+
+
ncResolution IMachiningMotionResolution
+
+
+ +

Returns

+
+
IEnumerable<ActClStep>
+
+
+ + + + + + + + + + +

diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClStep.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClStep.html new file mode 100644 index 00000000..77170157 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClStep.html @@ -0,0 +1,358 @@ + + + + + Class ActClStep | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
Table of Contents
+ +
+
+ +
+
+
+ +
+
+ + + +
+ +
+ + + +

+Class ActClStep +

+ +
+
Namespace
Hi.Numerical.Acts
+
Assembly
HiMech.dll
+
+ +
+
+ +
+ 
public class ActClStep : IActMachineStep, IActDuration, IAct
+
+ + + + +
+
Inheritance
+
+ +
ActClStep
+
+
+ +
+
Implements
+
+ + + +
+
+ + +
+
Inherited Members
+
+ + + + + + +
+ +
+
Extension Methods
+
+ + + + + + + +
+ + + + + +

Constructors +

+ + + + +

+ ActClStep(DVec3d, TimeSpan?) + +

+ +

Initializes a new instance with the specified cutter location.

+
+
+ +
+ 
public ActClStep(DVec3d cl, TimeSpan? timeSpan = null)
+
+ +

Parameters

+
+
cl DVec3d
+

The cutter location vector.

+
+
timeSpan TimeSpan?
+
+
+ + + + + + + + + + + + +

Properties +

+ + + + +

+ ActDuration + +

+ +

Gets or sets the duration of the action.

+
+
+ +
+ 
public TimeSpan ActDuration { get; set; }
+
+ + + + + +

Property Value

+
+
TimeSpan
+
+
+ + + + +

Remarks

+

The duration represents:

+
    +
  • The time required to complete the action
    • +
  • Should be positive and finite
    • +
  • Zero duration indicates an instantaneous action
    • +
  • Used for scheduling and timing calculations
    • +
+
+ + + + + + +

+ Cl + +

+ +

Gets or sets the cutter location vector.

+
+
+ +
+ 
public DVec3d Cl { get; set; }
+
+ + + + + +

Property Value

+
+
DVec3d
+
+
+ + + + + + + + +

Methods +

+ + + + +

+ ToString() + +

+ +

Returns a string that represents the current object.

+
+
+ +
+ 
public override string ToString()
+
+ + +

Returns

+
+
string
+

A string that represents the current object.

+
+
+ + + + + + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ +
+ + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClTeleport.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClTeleport.html index 5c22b550..f0d043b6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClTeleport.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActClTeleport.html @@ -102,7 +102,7 @@ Class ActClTeleport
- 
public class ActClTeleport : IAct
+ 
public class ActClTeleport : IActDuration, IAct
@@ -119,6 +119,7 @@ Class ActClTeleport
Implements
+
@@ -145,9 +146,6 @@ Class ActClTeleport -
@@ -186,8 +184,8 @@ Class ActClTeleport -

- ActClTeleport(DVec3d) +

+ ActClTeleport(DVec3d, TimeSpan?)

@@ -196,7 +194,7 @@ Class ActClTeleport
- 
public ActClTeleport(DVec3d cl)
+ 
public ActClTeleport(DVec3d cl, TimeSpan? timeSpan = null)

Parameters

@@ -204,6 +202,8 @@ Class ActClTeleport
cl DVec3d

The cutter location vector.

+
timeSpan TimeSpan?
+
@@ -221,6 +221,47 @@ Class ActClTeleport

+ + +

+ ActDuration + +

+ +

Gets or sets the duration of the action.

+
+
+ +
+ 
public TimeSpan ActDuration { get; set; }
+
+ + + + + +

Property Value

+
+
TimeSpan
+
+
+ + + + +

Remarks

+

The duration represents:

+
    +
  • The time required to complete the action
    • +
  • Should be positive and finite
    • +
  • Zero duration indicates an instantaneous action
    • +
  • Used for scheduling and timing calculations
    • +
+
+ + + +

@@ -253,6 +294,43 @@ Class ActClTeleport +

Methods +

+ + + + +

+ ToString() + +

+ +

Returns a string that represents the current object.

+
+
+ +
+ 
public override string ToString()
+
+ + +

Returns

+
+
string
+

A string that represents the current object.

+
+
+ + + + + + + + + + +
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineBegin.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineBegin.html index 734e5c77..b0d77a35 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineBegin.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineBegin.html @@ -213,7 +213,7 @@ Class ActLineBegin -

+

ActLineBegin(ISourceCommand)

@@ -228,7 +228,7 @@ Class ActLineBegin

Parameters

-
sourceCommand ISourceCommand
+
sourceCommand ISourceCommand

The source command associated with this line beginning.

@@ -269,7 +269,7 @@ Class ActLineBegin

Property Value

-
ISourceCommand
+
ISourceCommand
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineEnd.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineEnd.html index b533b9e1..cb16ac3f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineEnd.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActLineEnd.html @@ -301,7 +301,7 @@ Class ActLineEnd

Property Value

-
ISourceCommand
+
ISourceCommand
diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActTooling.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActToolingStep.html similarity index 80% rename from App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActTooling.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActToolingStep.html index 49c32e39..9bf481c4 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActTooling.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActToolingStep.html @@ -2,11 +2,11 @@ - Class ActTooling | HiAPI-C# 2025 + Class ActToolingStep | HiAPI-C# 2025 - + - + @@ -84,12 +84,12 @@ -
+
-

-Class ActTooling +

+Class ActToolingStep

@@ -97,13 +97,12 @@ Class ActTooling
Assembly
HiMech.dll
-

Represents a tooling operation act in numerical control operations. -This class handles tool changes and related operations in the machining process.

+

Action of equiping the tool with machining step operation such as collision detection and volume removal.

- 
public class ActTooling : IActDuration, IActMachineStep, IAct
+ 
public class ActToolingStep : IActDuration, IActMachineStep, IActTooling, IAct
@@ -113,7 +112,7 @@ This class handles tool changes and related operations in the machining process.
Inheritance
-
ActTooling
+
ActToolingStep
@@ -122,6 +121,7 @@ This class handles tool changes and related operations in the machining process.
+
@@ -178,40 +178,25 @@ This class handles tool changes and related operations in the machining process. -

Remarks

-

This class is used for:

-
    -
  • Tool change operations
    • -
  • Tool selection and management
    • -
  • Tracking tool usage time
    • -
  • Managing tool-specific operations
    • -
-

The tooling operation includes:

-
    -
  • Tool identification
    • -
  • Change duration tracking
    • -
  • Operation validation
    • -
-

Constructors

- + -

- ActTooling(int, TimeSpan) +

+ ActToolingStep(int, TimeSpan?)

-

Initializes a new instance of the ActTooling class with the specified tool ID and duration.

+

Initializes a new instance of the ActToolingStep class with the specified tool ID and duration.

- 
public ActTooling(int toolId, TimeSpan actDuration)
+ 
public ActToolingStep(int toolId, TimeSpan? actDuration = null)

Parameters

@@ -224,7 +209,7 @@ This class handles tool changes and related operations in the machining process.
  • Is used for tool selection and validation
    • -
    actDuration TimeSpan
    +
    actDuration TimeSpan?

    The duration of the tooling operation. This represents:

    • Time needed for tool change
      • @@ -249,9 +234,9 @@ This class handles tool changes and related operations in the machining process. - + -

      +

      ActDuration

      @@ -277,7 +262,7 @@ This class handles tool changes and related operations in the machining process. -

      Remarks

      +

      Remarks

      The duration represents:

      • The time required to complete the action
        • @@ -290,9 +275,9 @@ This class handles tool changes and related operations in the machining process. - + -

        +

        ToolId

        @@ -318,7 +303,7 @@ This class handles tool changes and related operations in the machining process. -

        Remarks

        +

        Remarks

        The tool ID:

        • Uniquely identifies a specific tool
          • @@ -335,9 +320,9 @@ This class handles tool changes and related operations in the machining process. - + -

          +

          ToString()

          diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActToolingTeleport.html similarity index 68% rename from App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActToolingTeleport.html index 220955df..c0432a0c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActToolingTeleport.html @@ -2,11 +2,11 @@ - Class SessionMessageHost.AlwaysStableTorch | HiAPI-C# 2025 + Class ActToolingTeleport | HiAPI-C# 2025 - + - + @@ -84,25 +84,25 @@
        -
        +
        -

        -Class SessionMessageHost.AlwaysStableTorch +

        +Class ActToolingTeleport

        -
        Namespace
        Hi.MachiningProcs
        +
        Namespace
        Hi.Numerical.Acts
        Assembly
        HiMech.dll
        -

        A disposable class that manages the stable index state.

        +

        Action of Equiping the tool without machining step operation such as collision detection and volume removal.

        - 
        public class SessionMessageHost.AlwaysStableTorch : IDisposable
        + 
        public class ActToolingTeleport : IActTooling, IAct
        @@ -112,14 +112,15 @@ Class SessionMessageHost.AlwaysStableTorch
        Inheritance
        -
        SessionMessageHost.AlwaysStableTorch
        +
        ActToolingTeleport
        Implements
        - + +
        @@ -145,9 +146,6 @@ Class SessionMessageHost.AlwaysStableTorch -
    @@ -184,28 +182,30 @@ Class SessionMessageHost.AlwaysStableTorch - + -

    - AlwaysStableTorch(SessionMessageHost, bool) +

    + ActToolingTeleport(int)

    -

    Initializes a new instance of the SessionMessageHost.AlwaysStableTorch class.

    +

    Initializes a new instance of the ActToolingTeleport class with the specified tool ID and duration.

    - 
    public AlwaysStableTorch(SessionMessageHost host, bool isAlwaysStable)
    + 
    public ActToolingTeleport(int toolId)

    Parameters

    -
    host SessionMessageHost
    -

    The message host.

    -
    -
    isAlwaysStable bool
    -

    Whether the index should always be stable.

    +
    toolId int
    +

    The identifier of the tool to use. This value:

    +
      +
    • Must be a valid tool magazine position
      • +
    • Should correspond to an existing tool
      • +
    • Is used for tool selection and validation
      • +
    @@ -220,56 +220,75 @@ Class SessionMessageHost.AlwaysStableTorch +

    Properties +

    + + + + +

    + ToolId + +

    + +

    Gets or sets the tool identifier.

    +
    +
    + +
    + 
    public int ToolId { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    int
    +
    +
    + + + + +

    Remarks

    +

    The tool ID:

    +
      +
    • Uniquely identifies a specific tool
      • +
    • Used for tool selection and validation
      • +
    • Corresponds to the machine's tool magazine positions
      • +
    • Should be positive and valid for the machine configuration
      • +
    +
    + + + +

    Methods

    - + -

    - Dispose() +

    + ToString()

    -

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    +

    Returns a string that represents the current object.

    - 
    public void Dispose()
    + 
    public override string ToString()
    - - - - - - - - - - - - - -

    - Dispose(bool) - -

    - -

    Disposes of the resources used by the SessionMessageHost.AlwaysStableTorch.

    -
    -
    - -
    - 
    protected virtual void Dispose(bool disposing)
    -
    - -

    Parameters

    +

    Returns

    -
    disposing bool
    -

    True to release both managed and unmanaged resources; false to release only unmanaged resources.

    +
    string
    +

    A string that represents the current object.

    @@ -284,7 +303,6 @@ Class SessionMessageHost.AlwaysStableTorch -
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActUtil.html index d2b8ad03..55ac690a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.ActUtil.html @@ -153,6 +153,46 @@ Class ActUtil + + +

    + GetClSteps(IActClMove, int, IMachiningMotionResolution) + +

    + +
    +
    + +
    + 
    public static IEnumerable<ActClStep> GetClSteps(this IActClMove actClMove, int stepNum, IMachiningMotionResolution ncResolution)
    +
    + +

    Parameters

    +
    +
    actClMove IActClMove
    +
    +
    stepNum int
    +
    +
    ncResolution IMachiningMotionResolution
    +
    +
    + +

    Returns

    +
    +
    IEnumerable<ActClStep>
    +
    +
    + + + + + + + + + + +

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.IActClMove.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.IActClMove.html index 25d0d73c..92006433 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.IActClMove.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.IActClMove.html @@ -125,6 +125,9 @@ This interface defines the contract for tool path movements in machining operati + @@ -211,6 +214,42 @@ This interface defines the contract for tool path movements in machining operati + + +

    + GetClSteps(IMachiningMotionResolution) + +

    + +
    +
    + +
    + 
    IEnumerable<ActClStep> GetClSteps(IMachiningMotionResolution ncResolution)
    +
    + +

    Parameters

    +
    +
    ncResolution IMachiningMotionResolution
    +
    +
    + +

    Returns

    +
    +
    IEnumerable<ActClStep>
    +
    +
    + + + + + + + + + + +
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.IActTooling.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.IActTooling.html new file mode 100644 index 00000000..7d1c6a9c --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.IActTooling.html @@ -0,0 +1,203 @@ + + + + + Interface IActTooling | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Interface IActTooling +

    + +
    +
    Namespace
    Hi.Numerical.Acts
    +
    Assembly
    HiMech.dll
    +
    + +
    +
    + +
    + 
    public interface IActTooling : IAct
    +
    + + + + + + + + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Properties +

    + + + + +

    + ToolId + +

    + +
    +
    + +
    + 
    int ToolId { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    int
    +
    +
    + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.html index 033d9480..3e78b90d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Acts.html @@ -104,6 +104,10 @@ Classes

    Represents a linear cutter location movement action.

    +
    +
    ActClStep
    +
    +
    ActClTeleport

    Represents a teleport action for cutter location, allowing instant position change without movement.

    @@ -207,9 +211,13 @@ This class handles complex tool movements with both position and orientation con
    -
    ActTooling
    -

    Represents a tooling operation act in numerical control operations. -This class handles tool changes and related operations in the machining process.

    +
    ActToolingStep
    +

    Action of equiping the tool with machining step operation such as collision detection and volume removal.

    +
    +
    +
    +
    ActToolingTeleport
    +

    Action of Equiping the tool without machining step operation such as collision detection and volume removal.

    @@ -262,6 +270,10 @@ This interface is used to define actions that take a measurable amount of time t Acts as a marker interface to identify actions that should not be executed.

    +
    +
    IActTooling
    +
    +
    IWorkTimeAttrib

    Interface for objects that provide both read and write access to work time. diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.CoordinateEntryDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.CoordinateEntryDisplayee.html index 5d72f400..71fb8ae5 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.CoordinateEntryDisplayee.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.CoordinateEntryDisplayee.html @@ -154,6 +154,9 @@ Class CoordinateEntryDisplayee

    Extension Methods
    + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.FilePlayers.NcRunner.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.FilePlayers.NcRunner.html index ac499a43..3ceffd31 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.FilePlayers.NcRunner.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.FilePlayers.NcRunner.html @@ -262,7 +262,7 @@ Class NcRunner
    - 
    public NcEnv NcEnv { get; }
    + 
    public NcEnv NcEnv { get; set; }
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html new file mode 100644 index 00000000..e68779e1 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html @@ -0,0 +1,557 @@ + + + + + Class HeidenhainCoordinateEntryDisplayee | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class HeidenhainCoordinateEntryDisplayee +

    + +
    +
    Namespace
    Hi.Numerical
    +
    Assembly
    HiUniNc.dll
    +
    + +
    +
    + +
    + 
    public class HeidenhainCoordinateEntryDisplayee : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d
    +
    + + + + +
    +
    Inheritance
    +
    + +
    HeidenhainCoordinateEntryDisplayee
    +
    +
    + +
    +
    Implements
    +
    + + + + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + HeidenhainCoordinateEntryDisplayee(Func<NcEnv>, Func<IMachiningEquipment>) + +

    + +

    Initializes a new instance.

    +
    +
    + +
    + 
    public HeidenhainCoordinateEntryDisplayee(Func<NcEnv> ncEnvFunc, Func<IMachiningEquipment> millingEquipmentSource)
    +
    + +

    Parameters

    +
    +
    ncEnvFunc Func<NcEnv>
    +

    The function that provides the NcEnv instance.

    +
    +
    millingEquipmentSource Func<IMachiningEquipment>
    +

    The function that provides the machining equipment.

    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + HeidenhainCycleDef247Q339 + +

    + +

    Gets or sets the Heidenhain Cycle Def 247 Q339 value.

    +
    +
    + +
    + 
    public int HeidenhainCycleDef247Q339 { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    int
    +
    +
    + + + + + + + + + + +

    + HeidenhainCycleDef7Arg + +

    + +

    Gets or sets the Heidenhain Cycle Def 7 arguments.

    +
    +
    + +
    + 
    public HeidenhainCycleDef7Arg HeidenhainCycleDef7Arg { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    HeidenhainCycleDef7Arg
    +
    +
    + + + + + + + + + + +

    + MillingEquipmentFunc + +

    + +

    Gets or sets the function that provides the machining equipment.

    +
    +
    + +
    + 
    public Func<IMachiningEquipment> MillingEquipmentFunc { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Func<IMachiningEquipment>
    +
    +
    + + + + + + + + + + +

    + NcEnvFunc + +

    + +

    Gets or sets the function that provides the NcEnv instance.

    +
    +
    + +
    + 
    public Func<NcEnv> NcEnvFunc { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Func<NcEnv>
    +
    +
    + + + + + + + + + + +

    + ShowHeidenhainDatumPreset + +

    + +
    +
    + +
    + 
    public bool ShowHeidenhainDatumPreset { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + ShowHeidenhainDatumShift + +

    + +
    +
    + +
    + 
    public bool ShowHeidenhainDatumShift { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + Display(Bind) + +

    + +

    Display function called in DispEngine rendering loop.

    +
    +
    + +
    + 
    public void Display(Bind bind)
    +
    + +

    Parameters

    +
    +
    bind Bind
    +

    Bind with DispEngine. See Bind.

    +
    +
    + + + + + + + + + + + + + + +

    + ExpandToBox3d(Box3d) + +

    + +

    Expands the destination box. +This function is usually used to compute the bounding box of elements.

    +
    +
    + +
    + 
    public void ExpandToBox3d(Box3d dst)
    +
    + +

    Parameters

    +
    +
    dst Box3d
    +

    Destination box

    +
    +
    + + + + + + + + + + + + + + +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.IsoCoordinateEntryDisplayee.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.IsoCoordinateEntryDisplayee.html new file mode 100644 index 00000000..da8bfdcb --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.IsoCoordinateEntryDisplayee.html @@ -0,0 +1,460 @@ + + + + + Class IsoCoordinateEntryDisplayee | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class IsoCoordinateEntryDisplayee +

    + +
    +
    Namespace
    Hi.Numerical
    +
    Assembly
    HiUniNc.dll
    +
    + +
    +
    + +
    + 
    public class IsoCoordinateEntryDisplayee : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d
    +
    + + + + +
    +
    Inheritance
    +
    + +
    IsoCoordinateEntryDisplayee
    +
    +
    + +
    +
    Implements
    +
    + + + + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + IsoCoordinateEntryDisplayee(Func<NcEnv>, Func<IMachiningEquipment>) + +

    + +
    +
    + +
    + 
    public IsoCoordinateEntryDisplayee(Func<NcEnv> ncEnvFunc, Func<IMachiningEquipment> millingEquipmentSource)
    +
    + +

    Parameters

    +
    +
    ncEnvFunc Func<NcEnv>
    +
    +
    millingEquipmentSource Func<IMachiningEquipment>
    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + IsoCoordinateId + +

    + +

    Gets or sets the ISO coordinate ID.

    +
    +
    + +
    + 
    public int IsoCoordinateId { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    int
    +
    +
    + + + + + + + + + + +

    + MillingEquipmentFunc + +

    + +

    Gets or sets the function that provides the machining equipment.

    +
    +
    + +
    + 
    public Func<IMachiningEquipment> MillingEquipmentFunc { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Func<IMachiningEquipment>
    +
    +
    + + + + + + + + + + +

    + NcEnvFunc + +

    + +

    Gets or sets the function that provides the NcEnv instance.

    +
    +
    + +
    + 
    public Func<NcEnv> NcEnvFunc { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Func<NcEnv>
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + Display(Bind) + +

    + +

    Display function called in DispEngine rendering loop.

    +
    +
    + +
    + 
    public void Display(Bind bind)
    +
    + +

    Parameters

    +
    +
    bind Bind
    +

    Bind with DispEngine. See Bind.

    +
    +
    + + + + + + + + + + + + + + +

    + ExpandToBox3d(Box3d) + +

    + +

    Expands the destination box. +This function is usually used to compute the bounding box of elements.

    +
    +
    + +
    + 
    public void ExpandToBox3d(Box3d dst)
    +
    + +

    Parameters

    +
    +
    dst Box3d
    +

    Destination box

    +
    +
    + + + + + + + + + + + + + + +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.IsoCoordinateTable.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.IsoCoordinateTable.html index 8b1f046e..ab1b2134 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.IsoCoordinateTable.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.IsoCoordinateTable.html @@ -405,8 +405,8 @@ The dictionary key is 1000times coordinate index (ex. G54 is 54000); the diction -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -416,7 +416,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -426,6 +426,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -442,6 +445,11 @@ This method may also generate additional resources such as related files.

    +

    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.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html index dc84c84a..ac18a827 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html @@ -102,7 +102,7 @@ Class FeedPerCycleMachiningMotionResolution
    - 
    public class FeedPerCycleMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource
    + 
    public class FeedPerCycleMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource, IToXElement
    @@ -121,6 +121,7 @@ Class FeedPerCycleMachiningMotionResolution
    +
    @@ -428,8 +429,8 @@ Class FeedPerCycleMachiningMotionResolution -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -439,7 +440,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -449,6 +450,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -465,6 +469,44 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html index 04433434..9480a910 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html @@ -102,7 +102,7 @@ Class FeedPerToothMachiningMotionResolution
    - 
    public class FeedPerToothMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource
    + 
    public class FeedPerToothMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource, IToXElement
    @@ -121,6 +121,7 @@ Class FeedPerToothMachiningMotionResolution
    +
    @@ -431,8 +432,8 @@ This is a configuration option that affects the cutting behavior.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -442,7 +443,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -452,6 +453,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -468,6 +472,44 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html index bd9f35f6..23680fe6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html @@ -102,7 +102,7 @@ Class FeedPerToothNcResolution0
    - 
    public class FeedPerToothNcResolution0 : IMachiningMotionResolution, IMakeXmlSource
    + 
    public class FeedPerToothNcResolution0 : IMachiningMotionResolution, IMakeXmlSource, IToXElement
    @@ -121,6 +121,7 @@ Class FeedPerToothNcResolution0
    +
    @@ -465,8 +466,8 @@ Transient data.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -476,7 +477,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -486,6 +487,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -502,6 +506,44 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html index 352df64b..332edfe0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html @@ -102,7 +102,7 @@ Class FixedMachiningMotionResolution
    - 
    public class FixedMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource
    + 
    public class FixedMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource, IToXElement
    @@ -121,6 +121,7 @@ Class FixedMachiningMotionResolution
    +
    @@ -417,8 +418,8 @@ Class FixedMachiningMotionResolution -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -428,7 +429,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -438,6 +439,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -454,6 +458,44 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html index 152aabb0..0c186692 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html @@ -115,7 +115,7 @@ Interface IMachiningMotionResolution
    Inherited Members
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MillingToolOffsetTable.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MillingToolOffsetTable.html index 14a7bf85..373369d8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MillingToolOffsetTable.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.MillingToolOffsetTable.html @@ -6,7 +6,7 @@ - + @@ -98,7 +98,7 @@ Class MillingToolOffsetTable

    Offset table for milling tool. -The key is tool ID.

    +The key is Offset ID (H or D in NC code).

    @@ -399,8 +399,8 @@ The key is tool ID.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -409,7 +409,7 @@ The key is tool ID.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -420,6 +420,8 @@ The key is tool ID.

    relFile string

    The relative file path.

    +
    exhibitionOnly bool
    +

    Returns

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcEnv.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcEnv.html index 6bf4ea7b..c1eeb12d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcEnv.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcEnv.html @@ -1146,10 +1146,10 @@ Maximum rotary speed in degds.

    - + -

    - StrokeLimitABC_rad +

    + StrokeLimitAbc_rad

    @@ -1158,7 +1158,7 @@ Maximum rotary speed in degds.

    - 
    public Box3d StrokeLimitABC_rad { get; set; }
    + 
    public Box3d StrokeLimitAbc_rad { get; set; }
    @@ -1178,10 +1178,10 @@ Maximum rotary speed in degds.

    - + -

    - StrokeLimitXYZ_mm +

    + StrokeLimitXyz_mm

    @@ -1190,7 +1190,7 @@ Maximum rotary speed in degds.

    - 
    public Box3d StrokeLimitXYZ_mm { get; set; }
    + 
    public Box3d StrokeLimitXyz_mm { get; set; }
    @@ -1210,20 +1210,91 @@ Maximum rotary speed in degds.

    - + -

    - ToolingMc +

    + ToolingMcAbc_deg

    -

    Gets or sets the machine coordinate for tooling operations. -Defaults to HomeMc if not explicitly set.

    +

    Gets or sets the rotary machine coordinate for tooling operations. +Defaults to HomeMc if not explicitly set. +Set to NaN if tooling motion not apply the axis motion. +Unit is degree.

    - 
    public Vec3d ToolingMc { get; set; }
    + 
    public Vec3d ToolingMcAbc_deg { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Vec3d
    +
    +
    + + + + + + + + + + +

    + ToolingMcAbc_rad + +

    + +

    Gets or sets the rotary machine coordinate for tooling operations. +Defaults to HomeMc if not explicitly set. +Set to NaN if tooling motion not apply the axis motion. +Unit is radian.

    +
    +
    + +
    + 
    public Vec3d ToolingMcAbc_rad { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Vec3d
    +
    +
    + + + + + + + + + + +

    + ToolingMcXyz + +

    + +

    Gets or sets the translation machine coordinate for tooling operations. +Defaults to HomeMc if not explicitly set. +Set to NaN if tooling motion not apply the axis motion.

    +
    +
    + +
    + 
    public Vec3d ToolingMcXyz { get; set; }
    @@ -1311,6 +1382,46 @@ Defaults to HomeMc if not explicitly set.

    + + +

    + CheckStrokeLimit(DVec3d, IMessageKit) + +

    + +

    Check stroke limit.

    +
    +
    + +
    + 
    public bool CheckStrokeLimit(DVec3d mcXyzabc_mm_rad, IMessageKit messageKit)
    +
    + +

    Parameters

    +
    +
    mcXyzabc_mm_rad DVec3d
    +
    +
    messageKit IMessageKit
    +
    +
    + +

    Returns

    +
    +
    bool
    +

    Is under stroke limit.

    +
    +
    + + + + + + + + + + +

    @@ -1352,8 +1463,8 @@ Defaults to HomeMc if not explicitly set.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -1363,7 +1474,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -1373,6 +1484,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -1389,6 +1503,11 @@ This method may also generate additional resources such as related files.

    +

    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.NcFlagUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcFlagUtil.html index 1d2f6778..dc254a8e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcFlagUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcFlagUtil.html @@ -155,8 +155,8 @@ Class NcFlagUtil -

    - GetCompensationHeight(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageHost) +

    + GetCompensationHeight(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageKit)

    @@ -165,7 +165,7 @@ Class NcFlagUtil
    - 
    public static double GetCompensationHeight(this BitArray ncFlagBitArray, int H, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageHost messageHost)
    + 
    public static double GetCompensationHeight(this BitArray ncFlagBitArray, int H, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageKit messageHost)

    Parameters

    @@ -182,7 +182,7 @@ Class NcFlagUtil
    cncBrand CncBrand

    CNC brand

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    Message host for warnings

    @@ -206,8 +206,8 @@ Class NcFlagUtil -

    - GetCompensationRadius(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageHost) +

    + GetCompensationRadius(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageKit)

    @@ -216,7 +216,7 @@ Class NcFlagUtil
    - 
    public static double GetCompensationRadius(this BitArray ncFlagBitArray, int D, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageHost messageHost)
    + 
    public static double GetCompensationRadius(this BitArray ncFlagBitArray, int D, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageKit messageHost)

    Parameters

    @@ -233,7 +233,7 @@ Class NcFlagUtil
    cncBrand CncBrand

    The CNC controller brand.

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    The message host for reporting warnings or errors.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcLine.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcLine.html index 46cc123a..620d43a3 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcLine.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcLine.html @@ -119,12 +119,12 @@ Class NcLine
    Implements
    - + - +
    @@ -197,8 +197,8 @@ Class NcLine -

    - NcLine(NcEnv, IndexedFileLine, NcLine, out NcNoteCache, IMessageHost) +

    + NcLine(NcEnv, IndexedFileLine, NcLine, out NcNoteCache, IMessageKit)

    @@ -207,7 +207,7 @@ Class NcLine
    - 
    public NcLine(NcEnv ncEnv, IndexedFileLine fileLine, NcLine preNcLine, out NcNoteCache ncLineCache, IMessageHost messageHost)
    + 
    public NcLine(NcEnv ncEnv, IndexedFileLine fileLine, NcLine preNcLine, out NcNoteCache ncLineCache, IMessageKit messageHost)

    Parameters

    @@ -225,7 +225,7 @@ If previous NcLine is not nu
    ncLineCache NcNoteCache

    Output NC note cache

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    Message host for warnings

    @@ -243,8 +243,8 @@ If previous NcLine is not nu -

    - NcLine(NcEnv, IMessageHost) +

    + NcLine(NcEnv, IMessageKit)

    @@ -253,14 +253,14 @@ If previous NcLine is not nu
    - 
    public NcLine(NcEnv ncEnv, IMessageHost messageHost)
    + 
    public NcLine(NcEnv ncEnv, IMessageKit messageHost)

    Parameters

    ncEnv NcEnv
    -
    messageHost IMessageHost
    +
    messageHost IMessageKit
    @@ -479,6 +479,38 @@ Start on 0.

    + + +

    + FileNo + +

    + +
    +
    + +
    + 
    [Present("File Number", "FileNo", PhysicsUnit.None, "G")]
+public int FileNo { get; }
    +
    + + + + + +

    Property Value

    +
    +
    int
    +
    +
    + + + + + + + +

    @@ -491,7 +523,8 @@ Start on 0.

    - 
    public string FilePath { get; }
    + 
    [Present("File", "File", PhysicsUnit.None, "G")]
+public string FilePath { get; }
    @@ -1201,7 +1234,8 @@ One shot command.

    - 
    public string Line { get; }
    + 
    [Present("Line", "Line", PhysicsUnit.None, "G")]
+public string Line { get; }
    @@ -1254,6 +1288,69 @@ Start on 0.

    + + +

    + LineNo + +

    + +
    +
    + +
    + 
    [Present("Line Number", "LineNo", PhysicsUnit.None, "G")]
+public int LineNo { get; }
    +
    + + + + + +

    Property Value

    +
    +
    int
    +
    +
    + + + + + + + + + + +

    + McAbc_deg + +

    + +
    +
    + +
    + 
    public Vec3d McAbc_deg { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Vec3d
    +
    +
    + + + + + + + +

    @@ -1831,8 +1928,8 @@ So be care that do not change the NC XYZ if not needed.

    -

    - GetCompensationHeight(NcEnv, IMessageHost) +

    + GetCompensationHeight(NcEnv, IMessageKit)

    @@ -1841,7 +1938,7 @@ So be care that do not change the NC XYZ if not needed.

    - 
    public double GetCompensationHeight(NcEnv ncEnv, IMessageHost messageHost)
    + 
    public double GetCompensationHeight(NcEnv ncEnv, IMessageKit messageHost)

    Parameters

    @@ -1849,7 +1946,7 @@ So be care that do not change the NC XYZ if not needed.

    ncEnv NcEnv

    NC environment

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    Message host for warnings

    @@ -1873,8 +1970,8 @@ So be care that do not change the NC XYZ if not needed.

    -

    - GetCompensationRadius(CncBrand, MillingToolOffsetTable, IMessageHost) +

    + GetCompensationRadius(CncBrand, MillingToolOffsetTable, IMessageKit)

    @@ -1883,7 +1980,7 @@ So be care that do not change the NC XYZ if not needed.

    - 
    public double GetCompensationRadius(CncBrand cncBrand, MillingToolOffsetTable millingToolOffsetTable, IMessageHost messageHost)
    + 
    public double GetCompensationRadius(CncBrand cncBrand, MillingToolOffsetTable millingToolOffsetTable, IMessageKit messageHost)

    Parameters

    @@ -1894,7 +1991,7 @@ So be care that do not change the NC XYZ if not needed.

    millingToolOffsetTable MillingToolOffsetTable

    Milling tool offset table

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    Message host for warnings

    @@ -2023,8 +2120,8 @@ So be care that do not change the NC XYZ if not needed.

    -

    - GetMcByProgramPos(Vec3d, NcEnv, NcNoteCache, IMessageHost, out Vec3d) +

    + GetMcByProgramPos(Vec3d, NcEnv, NcNoteCache, IMessageKit, out Vec3d)

    @@ -2033,7 +2130,7 @@ So be care that do not change the NC XYZ if not needed.

    - 
    public DVec3d GetMcByProgramPos(Vec3d programPos, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageHost messageHost, out Vec3d programXyz)
    + 
    public DVec3d GetMcByProgramPos(Vec3d programPos, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageKit messageHost, out Vec3d programXyz)

    Parameters

    @@ -2044,7 +2141,7 @@ So be care that do not change the NC XYZ if not needed.

    ncLineCache NcNoteCache
    -
    messageHost IMessageHost
    +
    messageHost IMessageKit
    programXyz Vec3d
    @@ -2068,8 +2165,8 @@ So be care that do not change the NC XYZ if not needed.

    -

    - GetProgramXyzabc(NcEnv, DVec3d, out bool?, IMessageHost) +

    + GetProgramXyzabc(NcEnv, DVec3d, out bool?, IMessageKit)

    @@ -2078,7 +2175,7 @@ So be care that do not change the NC XYZ if not needed.

    - 
    public DVec3d GetProgramXyzabc(NcEnv ncEnv, DVec3d mcXyzabc, out bool? isG68p2Successed, IMessageHost messageHost)
    + 
    public DVec3d GetProgramXyzabc(NcEnv ncEnv, DVec3d mcXyzabc, out bool? isG68p2Successed, IMessageKit messageHost)

    Parameters

    @@ -2092,7 +2189,7 @@ So be care that do not change the NC XYZ if not needed.

    isG68p2Successed bool?

    Output parameter indicating whether G68.2 coordinate conversion was successful.

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    The message host for logging.

    @@ -2132,7 +2229,7 @@ So be care that do not change the NC XYZ if not needed.

    Returns

    -
    ISourceCommand
    +
    ISourceCommand

    The source command object.

    @@ -2230,8 +2327,8 @@ So be care that do not change the NC XYZ if not needed.

    -

    - RebuildByMc(NcEnv, DVec3d, NcNoteCache, IMessageHost) +

    + RebuildByMc(NcEnv, DVec3d, NcNoteCache, IMessageKit)

    @@ -2240,7 +2337,7 @@ So be care that do not change the NC XYZ if not needed.

    - 
    public void RebuildByMc(NcEnv ncEnv, DVec3d mc, NcNoteCache ncLineCache, IMessageHost messageHost)
    + 
    public void RebuildByMc(NcEnv ncEnv, DVec3d mc, NcNoteCache ncLineCache, IMessageKit messageHost)

    Parameters

    @@ -2254,7 +2351,7 @@ So be care that do not change the NC XYZ if not needed.

    ncLineCache NcNoteCache

    NC line cache.

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    Message host for logging and reporting.

    @@ -2272,8 +2369,8 @@ So be care that do not change the NC XYZ if not needed.

    -

    - RebuildByProgramXyz(NcEnv, Vec3d, NcNoteCache, IMessageHost) +

    + RebuildByProgramXyz(NcEnv, Vec3d, NcNoteCache, IMessageKit)

    @@ -2282,7 +2379,7 @@ So be care that do not change the NC XYZ if not needed.

    - 
    public void RebuildByProgramXyz(NcEnv ncEnv, Vec3d programXyz, NcNoteCache ncNoteCache, IMessageHost messageHost)
    + 
    public void RebuildByProgramXyz(NcEnv ncEnv, Vec3d programXyz, NcNoteCache ncNoteCache, IMessageKit messageHost)

    Parameters

    @@ -2296,7 +2393,7 @@ So be care that do not change the NC XYZ if not needed.

    ncNoteCache NcNoteCache

    NC note cache.

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    Message host for logging and reporting.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcProc.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcProc.html index 0b48caa7..d2464554 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcProc.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcProc.html @@ -155,8 +155,8 @@ Class NcProc -

    - GetActs(NcEnv, SeqPair<NcLine>, IMessageHost) +

    + GetActs(NcEnv, SeqPair<NcLine>, IMessageKit)

    @@ -165,7 +165,7 @@ Class NcProc
    - 
    public static IEnumerable<IAct> GetActs(NcEnv ncEnv, SeqPair<NcLine> ncLineSeq, IMessageHost messageHost)
    + 
    public static IEnumerable<IAct> GetActs(NcEnv ncEnv, SeqPair<NcLine> ncLineSeq, IMessageKit messageHost)

    Parameters

    @@ -176,7 +176,7 @@ Class NcProc
    ncLineSeq SeqPair<NcLine>

    The sequence pair of NcLines

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    The message host for logging

    @@ -200,8 +200,8 @@ Class NcProc -

    - GetActs(NcEnv, NcLine, NcLine, IMessageHost) +

    + GetActs(NcEnv, NcLine, NcLine, IMessageKit)

    @@ -210,7 +210,7 @@ Class NcProc
    - 
    public static IEnumerable<IAct> GetActs(NcEnv ncEnv, NcLine preNcLine, NcLine curNcLine, IMessageHost messageHost)
    + 
    public static IEnumerable<IAct> GetActs(NcEnv ncEnv, NcLine preNcLine, NcLine curNcLine, IMessageKit messageHost)

    Parameters

    @@ -224,7 +224,7 @@ Class NcProc
    curNcLine NcLine

    The current NcLine

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    The message host for logging

    @@ -248,8 +248,8 @@ Class NcProc -

    - GetActs(NcEnv, LinkedListNode<NcLine>, IMessageHost) +

    + GetActs(NcEnv, LinkedListNode<NcLine>, IMessageKit)

    @@ -258,7 +258,7 @@ Class NcProc
    - 
    public static IEnumerable<IAct> GetActs(NcEnv ncEnv, LinkedListNode<NcLine> ncLineNode, IMessageHost messageHost)
    + 
    public static IEnumerable<IAct> GetActs(NcEnv ncEnv, LinkedListNode<NcLine> ncLineNode, IMessageKit messageHost)

    Parameters

    @@ -269,7 +269,7 @@ Class NcProc
    ncLineNode LinkedListNode<NcLine>

    The linked list node containing the NcLine

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    The message host for logging

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcStepMonitor.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcStepMonitor.html index 733b0bdc..7cde89cc 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcStepMonitor.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.NcStepMonitor.html @@ -488,8 +488,8 @@ Otherwise, set -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -499,7 +499,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -509,6 +509,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -525,6 +528,11 @@ This method may also generate additional resources such as related files.

    +

    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.RadiusCompensationBuf.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.RadiusCompensationBuf.html index 90fe5b7e..70efa0ec 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.RadiusCompensationBuf.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.RadiusCompensationBuf.html @@ -405,8 +405,8 @@ Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1) -

    - ResolveRadiusCompensation(LinkedListNode<NcLine>, NcEnv, NcNoteCache, IMessageHost) +

    + ResolveRadiusCompensation(LinkedListNode<NcLine>, NcEnv, NcNoteCache, IMessageKit)

    @@ -415,7 +415,7 @@ Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1)
    - 
    public static bool ResolveRadiusCompensation(LinkedListNode<NcLine> srcNode, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageHost messageHost)
    + 
    public static bool ResolveRadiusCompensation(LinkedListNode<NcLine> srcNode, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageKit messageHost)

    Parameters

    @@ -429,7 +429,7 @@ Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1)
    ncLineCache NcNoteCache

    The NC line cache for storing messages.

    -
    messageHost IMessageHost
    +
    messageHost IMessageKit

    The message host for reporting issues.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.AnchorMode.html similarity index 87% rename from App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.AnchorMode.html index afa9356e..d94ebaf8 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.AnchorMode.html @@ -2,9 +2,9 @@ - Enum BoundAnchorMode | HiAPI-C# 2025 + Enum AnchorMode | HiAPI-C# 2025 - + @@ -84,13 +84,13 @@
    -
    +
    -

    -Enum BoundAnchorMode +

    +Enum AnchorMode

    @@ -103,7 +103,7 @@ Enum BoundAnchorMode
    - 
    public enum BoundAnchorMode
    + 
    public enum AnchorMode
    @@ -145,23 +145,23 @@ Enum BoundAnchorMode

    Fields

    -
    FirstTouch = 4
    +
    FirstTouch = 4

    Anchor at the first touch point.

    -
    LastTouch = 8
    +
    LastTouch = 8

    Anchor at the last touch point.

    -
    LineBegin = 1
    +
    LineBegin = 1

    Anchor at the beginning of a line.

    -
    LineEnd = 2
    +
    LineEnd = 2

    Anchor at the end of a line.

    -
    Undefined = 0
    +
    Undefined = 0

    Undefined anchor mode.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelector.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelector.html index 53f8b84a..09792d3d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelector.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelector.html @@ -188,8 +188,8 @@ Class BoundSelector -

    - BoundSelector(BoundAnchorMode, IStepShift, FileLineIndex, int) +

    + BoundSelector(AnchorMode, IStepShift, FileLineIndex, int)

    @@ -198,12 +198,12 @@ Class BoundSelector
    - 
    public BoundSelector(BoundAnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex)
    + 
    public BoundSelector(AnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex)

    Parameters

    -
    anchorMode BoundAnchorMode
    +
    anchorMode AnchorMode

    The anchor mode for the bound.

    shift IStepShift
    @@ -411,7 +411,7 @@ Start on 0.

    - 
    public BoundAnchorMode KeyAnchorMode { get; set; }
    + 
    public AnchorMode KeyAnchorMode { get; set; }
    @@ -420,7 +420,7 @@ Start on 0.

    Property Value

    -
    BoundAnchorMode
    +
    AnchorMode
    @@ -599,8 +599,8 @@ Start on 0.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -610,7 +610,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -620,6 +620,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -636,6 +639,11 @@ This method may also generate additional resources such as related files.

    +

    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.StepSelectionUtils.BoundSelectorHost.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html index 40186af6..08ce7194 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html @@ -289,8 +289,8 @@ Class BoundSelectorHost -

    - Begin(string, BoundAnchorMode, IStepShift, FileLineIndex, int) +

    + Begin(string, AnchorMode, IStepShift, FileLineIndex, int)

    @@ -299,7 +299,7 @@ Class BoundSelectorHost
    - 
    public void Begin(string key, BoundAnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex)
    + 
    public void Begin(string key, AnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex)

    Parameters

    @@ -307,7 +307,7 @@ Class BoundSelectorHost
    key string

    The key identifying the step section.

    -
    anchorMode BoundAnchorMode
    +
    anchorMode AnchorMode

    The anchor mode for the bound.

    shift IStepShift
    @@ -397,8 +397,8 @@ Class BoundSelectorHost -

    - End(string, BoundAnchorMode, IStepShift, FileLineIndex, int) +

    + End(string, AnchorMode, IStepShift, FileLineIndex, int)

    @@ -407,7 +407,7 @@ Class BoundSelectorHost
    - 
    public void End(string key, BoundAnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex)
    + 
    public void End(string key, AnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex)

    Parameters

    @@ -415,7 +415,7 @@ Class BoundSelectorHost
    key string

    The key identifying the step section.

    -
    anchorMode BoundAnchorMode
    +
    anchorMode AnchorMode

    The anchor mode for the bound.

    shift IStepShift
    @@ -559,8 +559,8 @@ Class BoundSelectorHost -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -570,7 +570,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -580,6 +580,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -596,6 +599,11 @@ This method may also generate additional resources such as related files.

    +

    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.StepSelectionUtils.BoundSelectorPair.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html index 5acb9481..1f234bf5 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html @@ -401,8 +401,8 @@ Class BoundSelectorPair -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -412,7 +412,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -422,6 +422,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -438,6 +441,11 @@ This method may also generate additional resources such as related files.

    +

    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.StepSelectionUtils.BoundSelectorStepSectionBundle.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html index 2e8349c8..8fe4f41c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html @@ -408,8 +408,8 @@ Class BoundSelectorStepSectionBundle -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -419,7 +419,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -429,6 +429,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -445,6 +448,11 @@ This method may also generate additional resources such as related files.

    +

    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.StepSelectionUtils.DistanceShift.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.DistanceShift.html index 2b6b6d12..76375182 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.DistanceShift.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.DistanceShift.html @@ -367,8 +367,8 @@ Class DistanceShift -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -378,7 +378,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -388,6 +388,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -404,6 +407,11 @@ This method may also generate additional resources such as related files.

    +

    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.StepSelectionUtils.IStepShift.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.IStepShift.html index 336bf4eb..6f8cdc46 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.IStepShift.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.IStepShift.html @@ -115,7 +115,7 @@ Interface IStepShift
    Inherited Members
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.TimeShift.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.TimeShift.html index 50930b2d..f09a9932 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.TimeShift.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.TimeShift.html @@ -408,33 +408,37 @@ The value is the unqualified name of the class (TimeShift).

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    -

    Creates an XML representation of this time shift configuration.

    +

    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)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    baseDirectory string
    -

    The base directory for resolving relative paths (not used).

    +

    The base directory for resolving relative paths

    relFile string
    -

    The relative file path (not used).

    +

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    Returns

    XElement
    -

    An XML element containing the time shift configuration.

    +

    An XML element representing the object's state

    @@ -444,6 +448,11 @@ The value is the unqualified name of the class (TimeShift).

    +

    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.StepSelectionUtils.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.html index 85b55922..c50c1fc7 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.StepSelectionUtils.html @@ -142,7 +142,7 @@ Interfaces Enums
    -
    BoundAnchorMode
    +
    AnchorMode

    Defines the mode for anchoring boundaries when selecting steps.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.CodeXyzabcChain.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.CodeXyzabcChain.html index 2ffd9da8..b5c50f95 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.CodeXyzabcChain.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.CodeXyzabcChain.html @@ -103,7 +103,7 @@ On purpose of easy XML hand management.

    - 
    public class CodeXyzabcChain : IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource
    + 
    public class CodeXyzabcChain : IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource
    @@ -122,12 +122,10 @@ On purpose of easy XML hand management.

    - + - - @@ -168,6 +166,12 @@ On purpose of easy XML hand management.

    + + @@ -1040,6 +1044,39 @@ This function is usually used to compute the bounding box of elements.

    + + +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + +

    @@ -1139,72 +1176,6 @@ This function is usually used to compute the bounding box of elements.

    - - -

    - GetRootAnchor() - -

    - -

    Get root anchor.

    -
    -
    - -
    - 
    public Anchor GetRootAnchor()
    -
    - - -

    Returns

    -
    -
    Anchor
    -

    root anchor.

    -
    -
    - - - - - - - - - - - - - -

    - GetSolidMachiningChain() - -

    - -

    Get ISolidMachiningChain.

    -
    -
    - -
    - 
    public ISolidMachiningChain GetSolidMachiningChain()
    -
    - - -

    Returns

    -
    -
    ISolidMachiningChain
    -

    ISolidMachiningChain

    -
    -
    - - - - - - - - - - -

    @@ -1504,8 +1475,8 @@ This function is usually used to compute the bounding box of elements.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -1515,7 +1486,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -1525,6 +1496,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -1541,6 +1515,11 @@ This method may also generate additional resources such as related files.

    +

    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.Xyzabc.GeneralXyzabcChain.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.GeneralXyzabcChain.html index 71052890..79ed58ab 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.GeneralXyzabcChain.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.GeneralXyzabcChain.html @@ -102,7 +102,7 @@ Class GeneralXyzabcChain
    - 
    public class GeneralXyzabcChain : IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource
    + 
    public class GeneralXyzabcChain : IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource
    @@ -121,12 +121,10 @@ Class GeneralXyzabcChain
    - + - - @@ -167,6 +165,12 @@ Class GeneralXyzabcChain + + @@ -761,6 +765,39 @@ This function is usually used to compute the bounding box of elements.

    + + +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + +

    @@ -860,72 +897,6 @@ This function is usually used to compute the bounding box of elements.

    - - -

    - GetRootAnchor() - -

    - -

    Get root anchor.

    -
    -
    - -
    - 
    public Anchor GetRootAnchor()
    -
    - - -

    Returns

    -
    -
    Anchor
    -

    root anchor.

    -
    -
    - - - - - - - - - - - - - -

    - GetSolidMachiningChain() - -

    - -

    Get ISolidMachiningChain.

    -
    -
    - -
    - 
    public ISolidMachiningChain GetSolidMachiningChain()
    -
    - - -

    Returns

    -
    -
    ISolidMachiningChain
    -

    ISolidMachiningChain

    -
    -
    - - - - - - - - - - -

    @@ -1225,8 +1196,8 @@ This function is usually used to compute the bounding box of elements.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -1236,7 +1207,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -1246,6 +1217,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -1262,6 +1236,11 @@ This method may also generate additional resources such as related files.

    +

    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.Xyzabc.IXyzabcChain.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.IXyzabcChain.html index 8198e9e1..08f13c2a 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.IXyzabcChain.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.IXyzabcChain.html @@ -102,7 +102,7 @@ Interface IXyzabcChain
    - 
    public interface IXyzabcChain : IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d
    + 
    public interface IXyzabcChain : IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d
    @@ -133,13 +133,10 @@ Interface IXyzabcChain IGetAsmb.GetAsmb()
    -
    IGetAnchorToSolidDictionary.GetAnchorToSolidDictionary() @@ -158,6 +155,12 @@ Interface IXyzabcChain + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html index 7b5dc46d..c061b80b 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html @@ -102,7 +102,7 @@ Class ReflectedXyzabcChain
    - 
    public class ReflectedXyzabcChain : IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d
    + 
    public class ReflectedXyzabcChain : IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d
    @@ -121,12 +121,10 @@ Class ReflectedXyzabcChain
    - + - - @@ -167,6 +165,12 @@ Class ReflectedXyzabcChain + + @@ -821,6 +825,39 @@ This function is usually used to compute the bounding box of elements.

    + + +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + +

    @@ -920,72 +957,6 @@ This function is usually used to compute the bounding box of elements.

    - - -

    - GetRootAnchor() - -

    - -

    Get root anchor.

    -
    -
    - -
    - 
    public Anchor GetRootAnchor()
    -
    - - -

    Returns

    -
    -
    Anchor
    -

    root anchor.

    -
    -
    - - - - - - - - - - - - - -

    - GetSolidMachiningChain() - -

    - -

    Get ISolidMachiningChain.

    -
    -
    - -
    - 
    public ISolidMachiningChain GetSolidMachiningChain()
    -
    - - -

    Returns

    -
    -
    ISolidMachiningChain
    -

    ISolidMachiningChain

    -
    -
    - - - - - - - - - - -

    @@ -1285,8 +1256,8 @@ This function is usually used to compute the bounding box of elements.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -1296,7 +1267,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -1306,6 +1277,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -1322,6 +1296,11 @@ This method may also generate additional resources such as related files.

    +

    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.Xyzabc.SimpleChainCoordinateConverter.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html index 60bac7b1..db925488 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html @@ -102,7 +102,7 @@ Class SimpleChainCoordinateConverter
    - 
    public class SimpleChainCoordinateConverter : ICoordinateConverter, IMakeXmlSource
    + 
    public class SimpleChainCoordinateConverter : ICoordinateConverter, IToXElement
    @@ -120,7 +120,7 @@ Class SimpleChainCoordinateConverter
    Implements
    - +
    @@ -507,9 +507,7 @@ The NP is from table buckle to tool attacher.

    -

    Creates an XML representation of the object. -This method may also generate additional resources such as related files.

    -
    +
    @@ -519,18 +517,15 @@ This method may also generate additional resources such as related files.

    Parameters

    baseDirectory string
    -

    The base directory for resolving relative paths

    -
    +
    relFile string
    -

    The relative file path for the XML source

    -
    +

    Returns

    XElement
    -

    An XML element representing the object's state

    -
    +
    @@ -701,6 +696,39 @@ The NP is from table buckle to tool attacher.

    + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + + + + +
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html index d83fe0df..8c549dac 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html @@ -442,8 +442,8 @@ The NP is from table buckle to tool attacher.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -453,7 +453,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -463,6 +463,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -479,6 +482,11 @@ This method may also generate additional resources such as related files.

    +

    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.Xyzabc.XyzabcUtil.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.XyzabcUtil.html index 381df917..bb748419 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.XyzabcUtil.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.Xyzabc.XyzabcUtil.html @@ -298,13 +298,13 @@ The output value set to NAN if the corresponding transformer does not exist.

    machine coordinate Z

    mcA double
    -

    machine coordinate A

    +

    machine coordinate A (rad)

    mcB double
    -

    machine coordinate B

    +

    machine coordinate B (rad)

    mcC double
    -

    machine coordinate C

    +

    machine coordinate C (rad)

    @@ -381,7 +381,7 @@ The output value set to NAN if the corresponding transformer does not exist.

    Returns

    DVec3d
    -

    Machine coordinate as DVec3d

    +

    Machine coordinate as DVec3d. ABC in rad.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.html b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.html index ee52533e..f172aa47 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Numerical.html @@ -104,6 +104,14 @@ Classes

    Utility for flexible dictionary operations.

    +
    +
    HeidenhainCoordinateEntryDisplayee
    +
    +
    +
    +
    IsoCoordinateEntryDisplayee
    +
    +
    IsoCoordinateTable

    Coordinate table for NC controller. @@ -118,7 +126,7 @@ The dictionary key is 1000times coordinate index (ex. G54 is 54000); the diction

    MillingToolOffsetTable

    Offset table for milling tool. -The key is tool ID.

    +The key is Offset ID (H or D in NC code).

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoatingMaterial.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoatingMaterial.html index 17e520ab..59267d53 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoatingMaterial.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoatingMaterial.html @@ -102,7 +102,7 @@ Class CoatingMaterial
    - 
    public class CoatingMaterial : CutterMaterial, ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote
    + 
    public class CoatingMaterial : CutterMaterial, ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote, IToXElement
    @@ -124,7 +124,8 @@ Class CoatingMaterial - + +
    @@ -513,8 +514,8 @@ Class CoatingMaterial -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -524,7 +525,7 @@ This method may also generate additional resources such as related files.

    - 
    public override XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public override XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -534,6 +535,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -550,6 +554,44 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public override XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoolantHeatCondition.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoolantHeatCondition.html index 5d573000..97036585 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoolantHeatCondition.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CoolantHeatCondition.html @@ -420,8 +420,8 @@ coolant: 1e3 (ref by “Modeling heat transfer in die milling”, 2014)< -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -431,7 +431,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -441,6 +441,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -457,6 +460,11 @@ This method may also generate additional resources such as related files.

    +

    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.Physics.CutterMaterial.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CutterMaterial.html index 01f96dc5..1a3b8568 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CutterMaterial.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.CutterMaterial.html @@ -102,7 +102,7 @@ Class CutterMaterial
    - 
    public class CutterMaterial : ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote
    + 
    public class CutterMaterial : ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote, IToXElement
    @@ -123,7 +123,8 @@ Class CutterMaterial - + + @@ -972,8 +973,8 @@ Class CutterMaterial -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -983,7 +984,7 @@ This method may also generate additional resources such as related files.

    - 
    public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -993,6 +994,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -1009,6 +1013,44 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public virtual XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.IStructureMaterial.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.IStructureMaterial.html index 1b6eeb99..c7e5fb1d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.IStructureMaterial.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.IStructureMaterial.html @@ -115,16 +115,16 @@ Interface IStructureMaterial
    Inherited Members
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ISurfaceMaterial.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ISurfaceMaterial.html index a39745fc..a8a65bb1 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ISurfaceMaterial.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ISurfaceMaterial.html @@ -136,16 +136,16 @@ Interface ISurfaceMaterial IStructureMaterial.ElasticModulus_GPa diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.StructureMaterial.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.StructureMaterial.html index 7904962c..71f217bb 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.StructureMaterial.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.StructureMaterial.html @@ -102,7 +102,7 @@ Class StructureMaterial
    - 
    public class StructureMaterial : IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote
    + 
    public class StructureMaterial : IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote, IToXElement
    @@ -122,7 +122,8 @@ Class StructureMaterial - + + @@ -774,8 +775,8 @@ Class StructureMaterial -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -785,7 +786,7 @@ This method may also generate additional resources such as related files.

    - 
    public virtual XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public virtual XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -795,6 +796,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -811,6 +815,44 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    + + + + + + +

    + ToXElement() + +

    + +

    Get the XElement to represent the object.

    +
    +
    + +
    + 
    public XElement ToXElement()
    +
    + + +

    Returns

    +
    +
    XElement
    +

    XElement to represent the object.

    +
    +
    + + + + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ThermalLayer1D.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ThermalLayer1D.html index 768465d2..7fff619f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ThermalLayer1D.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.ThermalLayer1D.html @@ -457,8 +457,8 @@ Class ThermalLayer1D -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -468,7 +468,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -478,6 +478,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -494,6 +497,11 @@ This method may also generate additional resources such as related files.

    +

    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.Physics.WorkpieceMaterial.html b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.WorkpieceMaterial.html index f74c35d7..b528701e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Physics.WorkpieceMaterial.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Physics.WorkpieceMaterial.html @@ -123,7 +123,7 @@ Class WorkpieceMaterial - + @@ -941,8 +941,8 @@ This is a conversion of HeatConductivity_WdmK with a factor of 1/1000.

    -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -952,7 +952,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -962,6 +962,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -978,6 +981,11 @@ This method may also generate additional resources such as related files.

    +

    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.ScriptApiUtils.ICsScriptApi.html b/App/wwwroot/HiAPI-docsite/api/Hi.ScriptApiUtils.ICsScriptApi.html index 976b8e79..19b2752f 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ScriptApiUtils.ICsScriptApi.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ScriptApiUtils.ICsScriptApi.html @@ -199,7 +199,7 @@ Interface ICsScriptApi

    Property Value

    -
    ScriptOptions
    +
    ScriptOptions
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RuntimeCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RuntimeCommand.html deleted file mode 100644 index bb018c37..00000000 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RuntimeCommand.html +++ /dev/null @@ -1,428 +0,0 @@ - - - - - Class RuntimeCommand | HiAPI-C# 2025 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -
    -
    -
    -
    -
    Table of Contents
    - -
    -
    - -
    -
    -
    - -
    -
    - - - -
    - -
    - - - -

    -Class RuntimeCommand -

    - -
    -
    Namespace
    Hi.ShellCommandUtils
    -
    Assembly
    HiNc.dll
    -
    - -

    Represents a shell command that can be executed at runtime.

    -
    -
    - -
    - 
    public class RuntimeCommand : IShellCommand, IMakeXmlSource
    -
    - - - - -
    -
    Inheritance
    -
    - -
    RuntimeCommand
    -
    -
    - -
    -
    Implements
    -
    - - -
    -
    - - -
    -
    Inherited Members
    -
    - - - - - - - -
    - -
    -
    Extension Methods
    -
    - - - - - - - -
    - - - - - -

    Constructors -

    - - - - -

    - RuntimeCommand() - -

    - -

    Initializes a new instance of the RuntimeCommand class.

    -
    -
    - -
    - 
    public RuntimeCommand()
    -
    - - - - - - - - - - - - - - - -

    - RuntimeCommand(Action<ShellApi>) - -

    - -

    Initializes a new instance of the RuntimeCommand class with the specified action.

    -
    -
    - -
    - 
    public RuntimeCommand(Action<ShellApi> action)
    -
    - -

    Parameters

    -
    -
    action Action<ShellApi>
    -

    The action to execute when this command is run.

    -
    -
    - - - - - - - - - - - - -

    Properties -

    - - - - -

    - Action - -

    - -

    Gets or sets the action to execute when this command is run.

    -
    -
    - -
    - 
    public Action<ShellApi> Action { get; set; }
    -
    - - - - - -

    Property Value

    -
    -
    Action<ShellApi>
    -
    -
    - - - - - - - - - - -

    - XName - -

    - -

    Name for XML IO.

    -
    -
    - -
    - 
    public static string XName { get; }
    -
    - - - - - -

    Property Value

    -
    -
    string
    -
    -
    - - - - - - - - -

    Methods -

    - - - - -

    - MakeXmlSource(string, string) - -

    - -

    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)
    -
    - -

    Parameters

    -
    -
    baseDirectory string
    -

    The base directory for resolving relative paths

    -
    -
    relFile string
    -

    The relative file path for the XML source

    -
    -
    - -

    Returns

    -
    -
    XElement
    -

    An XML element representing the object's state

    -
    -
    - - - - - - - -

    Remarks

    -

    The content of runtime command can not be saved.

    -
    - - - - - - -

    - Run(ShellApi) - -

    - -

    Runs the command using the provided script API.

    -
    -
    - -
    - 
    public IEnumerable<Action> Run(ShellApi shellApi)
    -
    - -

    Parameters

    -
    -
    shellApi ShellApi
    -
    -
    - -

    Returns

    -
    -
    IEnumerable<Action>
    -

    Sequence of actions to be executed.

    -
    -
    - - - - - - - - - - - - -
    - -
    -
    - - -
    - -
    - -
    -
    - -
    - - - - diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.EnablingWrapper.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.EnablingWrapper.html new file mode 100644 index 00000000..8c384775 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.EnablingWrapper.html @@ -0,0 +1,502 @@ + + + + + Class EnablingWrapper | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class EnablingWrapper +

    + +
    +
    Namespace
    Hi.ShellCommands
    +
    Assembly
    HiNc.dll
    +
    + +
    +
    + +
    + 
    public class EnablingWrapper : IShellCommand, IMakeXmlSource
    +
    + + + + +
    +
    Inheritance
    +
    + +
    EnablingWrapper
    +
    +
    + +
    +
    Implements
    +
    + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + EnablingWrapper() + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public EnablingWrapper()
    +
    + + + + + + + + + + + + + + + +

    + EnablingWrapper(IShellCommand) + +

    + +
    +
    + +
    + 
    public EnablingWrapper(IShellCommand command)
    +
    + +

    Parameters

    +
    +
    command IShellCommand
    +
    +
    + + + + + + + + + + + + + + +

    + EnablingWrapper(XElement, string, string, params object[]) + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public EnablingWrapper(XElement src, string baseDirectory, string relFile, params object[] res)
    +
    + +

    Parameters

    +
    +
    src XElement
    +

    XML

    +
    +
    baseDirectory string
    +

    Base directory for relative paths

    +
    +
    relFile string
    +

    Relative file path

    +
    +
    res object[]
    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + Command + +

    + +
    +
    + +
    + 
    public IShellCommand Command { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    IShellCommand
    +
    +
    + + + + + + + + + + +

    + IsEnabled + +

    + +
    +
    + +
    + 
    public bool IsEnabled { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + XName + +

    + +

    Name for XML IO.

    +
    +
    + +
    + 
    public static string XName { get; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + 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.

    +
    + + + + + + +

    + Run(RuntimeController) + +

    + +

    Runs the command using the provided script API.

    +
    +
    + +
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)
    +
    + +

    Parameters

    +
    +
    scriptApi RuntimeController
    +

    Script API for executing milling commands.

    +
    +
    + +

    Returns

    +
    +
    IEnumerable<Action>
    +

    Sequence of actions to be executed.

    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.GeomDiffCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.GeomDiffCommand.html similarity index 81% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.GeomDiffCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.GeomDiffCommand.html index 96e25471..57604c7e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.GeomDiffCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.GeomDiffCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class GeomDiffCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -119,7 +119,7 @@ Class GeomDiffCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class GeomDiffCommand - + -

    +

    GeomDiffCommand()

    @@ -212,9 +212,9 @@ Class GeomDiffCommand - + -

    +

    GeomDiffCommand(XElement, string)

    @@ -253,7 +253,7 @@ Class GeomDiffCommand -

    +

    ConstDisplayName

    @@ -287,9 +287,9 @@ Class GeomDiffCommand - + -

    +

    DetectRadius_mm

    @@ -319,9 +319,9 @@ Class GeomDiffCommand - + -

    +

    XName

    @@ -355,10 +355,10 @@ Class GeomDiffCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -368,7 +368,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -378,6 +378,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -394,14 +397,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -410,12 +418,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.IShellCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.IShellCommand.html similarity index 91% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.IShellCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.IShellCommand.html index 26245d6b..6708419c 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.IShellCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.IShellCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Interface IShellCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -115,7 +115,7 @@ Interface IShellCommand
    Inherited Members
    @@ -153,10 +153,10 @@ Interface IShellCommand - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -165,12 +165,12 @@ Interface IShellCommand
    - 
    IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ITitleCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ITitleCommand.html new file mode 100644 index 00000000..716a3f74 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ITitleCommand.html @@ -0,0 +1,214 @@ + + + + + Interface ITitleCommand | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Interface ITitleCommand +

    + +
    +
    Namespace
    Hi.ShellCommands
    +
    Assembly
    HiNc.dll
    +
    + +

    IShellCommand with title.

    +
    +
    + +
    + 
    public interface ITitleCommand : IShellCommand, IMakeXmlSource
    +
    + + + + + + + +
    +
    Inherited Members
    +
    + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Methods +

    + + + + +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.Lang.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.Lang.html similarity index 97% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.Lang.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.Lang.html index d55fdfc8..db0be2ba 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.Lang.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.Lang.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class Lang

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.ListCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ListCommand.html similarity index 74% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.ListCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ListCommand.html index c77c7b8f..cb75e5a6 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.ListCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ListCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class ListCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -102,7 +102,7 @@ Class ListCommand
    - 
    public class ListCommand : IShellCommand, IMakeXmlSource
    + 
    public class ListCommand : ITitleCommand, IShellCommand, IMakeXmlSource
    @@ -119,7 +119,8 @@ Class ListCommand
    Implements
    - + +
    @@ -185,9 +186,9 @@ Class ListCommand - + -

    +

    ListCommand()

    @@ -212,10 +213,10 @@ Class ListCommand - + -

    - ListCommand(XElement, string, string) +

    + ListCommand(XElement, string, string, params object[])

    @@ -224,7 +225,7 @@ Class ListCommand
    - 
    public ListCommand(XElement src, string baseDirectory, string relFile)
    + 
    public ListCommand(XElement src, string baseDirectory, string relFile, params object[] res)

    Parameters

    @@ -238,6 +239,8 @@ Class ListCommand
    relFile string

    Relative file path.

    +
    res object[]
    +
    @@ -255,9 +258,9 @@ Class ListCommand - + -

    +

    CommandEntryList

    @@ -268,7 +271,7 @@ The item in list is null capable.

    - 
    public List<CommandEntry> CommandEntryList { get; set; }
    + 
    public List<EnablingWrapper> CommandEntryList { get; set; }
    @@ -277,7 +280,7 @@ The item in list is null capable.

    Property Value

    -
    List<CommandEntry>
    +
    List<EnablingWrapper>
    @@ -288,9 +291,9 @@ The item in list is null capable.

    - + -

    +

    XName

    @@ -324,10 +327,41 @@ The item in list is null capable.

    - + -

    - MakeXmlSource(string, string) +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    public string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + + +

    + MakeXmlSource(string, string, bool)

    @@ -337,7 +371,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -347,6 +381,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -363,14 +400,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -379,12 +421,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.MachiningMotionResolutionCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.MachiningMotionResolutionCommand.html similarity index 78% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.MachiningMotionResolutionCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.MachiningMotionResolutionCommand.html index 3b046266..6fe68317 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.MachiningMotionResolutionCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.MachiningMotionResolutionCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class MachiningMotionResolutionCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -119,7 +119,7 @@ Class MachiningMotionResolutionCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class MachiningMotionResolutionCommand - + -

    +

    MachiningMotionResolutionCommand()

    @@ -212,9 +212,9 @@ Class MachiningMotionResolutionCommand - + -

    +

    MachiningMotionResolutionCommand(XElement, string, string)

    @@ -255,9 +255,9 @@ Class MachiningMotionResolutionCommand - + -

    +

    MachiningMotionResolution

    @@ -287,9 +287,9 @@ Class MachiningMotionResolutionCommand - + -

    +

    XName

    @@ -323,10 +323,10 @@ Class MachiningMotionResolutionCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -336,7 +336,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -346,6 +346,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -362,14 +365,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -378,12 +386,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcCodeCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcCodeCommand.html similarity index 70% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcCodeCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcCodeCommand.html index 8c98b8c8..09a3ca46 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcCodeCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcCodeCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class NcCodeCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -102,7 +102,7 @@ Class NcCodeCommand
    - 
    public class NcCodeCommand : IShellCommand, IMakeXmlSource
    + 
    public class NcCodeCommand : ITitleCommand, IShellCommand, IMakeXmlSource
    @@ -119,7 +119,8 @@ Class NcCodeCommand
    Implements
    - + +
    @@ -185,9 +186,67 @@ Class NcCodeCommand - + -

    +

    + NcCodeCommand() + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public NcCodeCommand()
    +
    + + + + + + + + + + + + + + + +

    + NcCodeCommand(string) + +

    + +
    +
    + +
    + 
    public NcCodeCommand(string nc)
    +
    + +

    Parameters

    +
    +
    nc string
    +
    +
    + + + + + + + + + + + + + + +

    NcCodeCommand(XElement, string)

    @@ -225,41 +284,9 @@ Class NcCodeCommand - + -

    - FileNameAlternative - -

    - -

    Alternative file name for the NC code file.

    -
    -
    - -
    - 
    public string FileNameAlternative { get; set; }
    -
    - - - - - -

    Property Value

    -
    -
    string
    -
    -
    - - - - - - - - - - -

    +

    NcText

    @@ -289,9 +316,42 @@ Class NcCodeCommand - + -

    +

    + Title + +

    + +

    Title. +Alternative file name for the NC code file.

    +
    +
    + +
    + 
    public string Title { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    XName

    @@ -325,10 +385,41 @@ Class NcCodeCommand - + -

    - MakeXmlSource(string, string) +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    public string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + + +

    + MakeXmlSource(string, string, bool)

    @@ -338,7 +429,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -348,6 +439,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -364,14 +458,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -380,12 +479,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcFileCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcFileCommand.html similarity index 73% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcFileCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcFileCommand.html index a850377f..d62e79f9 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcFileCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcFileCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class NcFileCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -102,7 +102,7 @@ Class NcFileCommand
    - 
    public class NcFileCommand : IShellCommand, IMakeXmlSource
    + 
    public class NcFileCommand : ITitleCommand, IShellCommand, IMakeXmlSource
    @@ -119,7 +119,8 @@ Class NcFileCommand
    Implements
    - + +
    @@ -185,9 +186,9 @@ Class NcFileCommand - + -

    +

    NcFileCommand()

    @@ -212,9 +213,40 @@ Class NcFileCommand - + -

    +

    + NcFileCommand(string) + +

    + +
    +
    + +
    + 
    public NcFileCommand(string ncFile)
    +
    + +

    Parameters

    +
    +
    ncFile string
    +
    +
    + + + + + + + + + + + + + + +

    NcFileCommand(XElement, string)

    @@ -252,9 +284,9 @@ Class NcFileCommand - + -

    +

    NcFile

    @@ -284,9 +316,9 @@ Class NcFileCommand - + -

    +

    XName

    @@ -320,10 +352,41 @@ Class NcFileCommand - + -

    - MakeXmlSource(string, string) +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    public string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + + +

    + MakeXmlSource(string, string, bool)

    @@ -333,7 +396,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -343,6 +406,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -359,14 +425,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -375,12 +446,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcFileListCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcFileListCommand.html similarity index 80% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcFileListCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcFileListCommand.html index 25349e43..1cd998df 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.NcFileListCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcFileListCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class NcFileListCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -119,7 +119,7 @@ Class NcFileListCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class NcFileListCommand - + -

    +

    NcFileListCommand()

    @@ -212,9 +212,9 @@ Class NcFileListCommand - + -

    +

    NcFileListCommand(XElement, string)

    @@ -252,9 +252,9 @@ Class NcFileListCommand - + -

    +

    NcFileList

    @@ -284,9 +284,9 @@ Class NcFileListCommand - + -

    +

    XName

    @@ -320,10 +320,10 @@ Class NcFileListCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -333,7 +333,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -343,6 +343,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -359,14 +362,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -375,12 +383,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcOptOptionCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcOptOptionCommand.html new file mode 100644 index 00000000..947154c1 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.NcOptOptionCommand.html @@ -0,0 +1,473 @@ + + + + + Class NcOptOptionCommand | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class NcOptOptionCommand +

    + +
    +
    Namespace
    Hi.ShellCommands
    +
    Assembly
    HiNc.dll
    +
    + +

    Command for NC optimization options.

    +
    +
    + +
    + 
    public class NcOptOptionCommand : ITitleCommand, IShellCommand, IMakeXmlSource
    +
    + + + + +
    +
    Inheritance
    +
    + +
    NcOptOptionCommand
    +
    +
    + +
    +
    Implements
    +
    + + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + NcOptOptionCommand() + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public NcOptOptionCommand()
    +
    + + + + + + + + + + + + + + + +

    + NcOptOptionCommand(XElement, string, string, params object[]) + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public NcOptOptionCommand(XElement src, string baseDirectory, string relFile, params object[] res)
    +
    + +

    Parameters

    +
    +
    src XElement
    +

    XML

    +
    +
    baseDirectory string
    +

    Base directory for relative paths

    +
    +
    relFile string
    +

    Relative file path

    +
    +
    res object[]
    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + NcOptOption + +

    + +
    +
    + +
    + 
    public NcOptOption NcOptOption { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    NcOptOption
    +
    +
    + + + + + + + + + + +

    + XName + +

    + +

    Name for XML IO.

    +
    +
    + +
    + 
    public static string XName { get; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    public string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + + +

    + 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.

    +
    + + + + + + +

    + Run(RuntimeController) + +

    + +

    Runs the command using the provided script API.

    +
    +
    + +
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)
    +
    + +

    Parameters

    +
    +
    scriptApi RuntimeController
    +

    Script API for executing milling commands.

    +
    +
    + +

    Returns

    +
    +
    IEnumerable<Action>
    +

    Sequence of actions to be executed.

    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.OptimizeToFilesCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.OptimizeToFilesCommand.html similarity index 79% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.OptimizeToFilesCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.OptimizeToFilesCommand.html index b62c63ab..7eb9df9d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.OptimizeToFilesCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.OptimizeToFilesCommand.html @@ -84,20 +84,20 @@ -
    +
    -

    +

    Class OptimizeToFilesCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    -

    Command to call OptimizeToFiles(string).

    +

    Command to call OptimizeToFiles(string).

    @@ -119,7 +119,7 @@ Class OptimizeToFilesCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class OptimizeToFilesCommand - + -

    +

    OptimizeToFilesCommand()

    @@ -212,9 +212,9 @@ Class OptimizeToFilesCommand - + -

    +

    OptimizeToFilesCommand(XElement, string)

    @@ -252,9 +252,9 @@ Class OptimizeToFilesCommand - + -

    +

    RelFileTemplate

    @@ -284,9 +284,9 @@ Class OptimizeToFilesCommand - + -

    +

    XName

    @@ -320,10 +320,10 @@ Class OptimizeToFilesCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -333,7 +333,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -343,6 +343,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -359,14 +362,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -375,12 +383,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.PostExecutionCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.PostExecutionCommand.html new file mode 100644 index 00000000..ef8d1024 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.PostExecutionCommand.html @@ -0,0 +1,783 @@ + + + + + Class PostExecutionCommand | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class PostExecutionCommand +

    + +
    +
    Namespace
    Hi.ShellCommands
    +
    Assembly
    HiNc.dll
    +
    + +

    Command for post-execution actions after NC command running.

    +
    +
    + +
    + 
    public class PostExecutionCommand : ITitleCommand, IShellCommand, IMakeXmlSource
    +
    + + + + +
    +
    Inheritance
    +
    + +
    PostExecutionCommand
    +
    +
    + +
    +
    Implements
    +
    + + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + PostExecutionCommand() + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public PostExecutionCommand()
    +
    + + + + + + + + + + + + + + + +

    + PostExecutionCommand(XElement, string, string, params object[]) + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public PostExecutionCommand(XElement src, string baseDirectory, string relFile, params object[] res)
    +
    + +

    Parameters

    +
    +
    src XElement
    +

    XML

    +
    +
    baseDirectory string
    +

    Base directory for relative paths

    +
    +
    relFile string
    +

    Relative file path

    +
    +
    res object[]
    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + EnableGeomDiff + +

    + +
    +
    + +
    + 
    public bool EnableGeomDiff { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableOptimizeToFiles + +

    + +
    +
    + +
    + 
    public bool EnableOptimizeToFiles { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableWriteRuntimeGeom + +

    + +
    +
    + +
    + 
    public bool EnableWriteRuntimeGeom { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableWriteShotFiles + +

    + +
    +
    + +
    + 
    public bool EnableWriteShotFiles { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableWriteStepFiles + +

    + +
    +
    + +
    + 
    public bool EnableWriteStepFiles { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + GeomDiffDetectRadius_mm + +

    + +
    +
    + +
    + 
    public double GeomDiffDetectRadius_mm { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    double
    +
    +
    + + + + + + + + + + +

    + OptimizationFileTemplate + +

    + +
    +
    + +
    + 
    public string OptimizationFileTemplate { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + RuntimeGeomFilePath + +

    + +
    +
    + +
    + 
    public string RuntimeGeomFilePath { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + ShotFileTemplate + +

    + +
    +
    + +
    + 
    public string ShotFileTemplate { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + ShotFileTimeResolution_ms + +

    + +
    +
    + +
    + 
    public double ShotFileTimeResolution_ms { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    double
    +
    +
    + + + + + + + + + + +

    + StepFileTemplate + +

    + +
    +
    + +
    + 
    public string StepFileTemplate { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + XName + +

    + +

    Name for XML IO.

    +
    +
    + +
    + 
    public static string XName { get; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    public string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + + +

    + 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.

    +
    + + + + + + +

    + Run(RuntimeController) + +

    + +

    Runs the command using the provided script API.

    +
    +
    + +
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)
    +
    + +

    Parameters

    +
    +
    scriptApi RuntimeController
    +

    Script API for executing milling commands.

    +
    +
    + +

    Returns

    +
    +
    IEnumerable<Action>
    +

    Sequence of actions to be executed.

    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.PreSettingCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.PreSettingCommand.html new file mode 100644 index 00000000..2caa34cd --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.PreSettingCommand.html @@ -0,0 +1,659 @@ + + + + + Class PreSettingCommand | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class PreSettingCommand +

    + +
    +
    Namespace
    Hi.ShellCommands
    +
    Assembly
    HiNc.dll
    +
    + +

    Command for pre-settings before NC command running.

    +
    +
    + +
    + 
    public class PreSettingCommand : ITitleCommand, IShellCommand, IMakeXmlSource
    +
    + + + + +
    +
    Inheritance
    +
    + +
    PreSettingCommand
    +
    +
    + +
    +
    Implements
    +
    + + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + PreSettingCommand() + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public PreSettingCommand()
    +
    + + + + + + + + + + + + + + + +

    + PreSettingCommand(XElement, string, string, params object[]) + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public PreSettingCommand(XElement src, string baseDirectory, string relFile, params object[] res)
    +
    + +

    Parameters

    +
    +
    src XElement
    +

    XML

    +
    +
    baseDirectory string
    +

    Base directory for relative paths

    +
    +
    relFile string
    +

    Relative file path

    +
    +
    res object[]
    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + EnableCollisionDetection + +

    + +
    +
    + +
    + 
    public bool EnableCollisionDetection { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnablePauseOnFailure + +

    + +
    +
    + +
    + 
    public bool EnablePauseOnFailure { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnablePhysics + +

    + +
    +
    + +
    + 
    public bool EnablePhysics { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableReadRuntimeGeom + +

    + +
    +
    + +
    + 
    public bool EnableReadRuntimeGeom { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + MachiningMotionResolution + +

    + +
    +
    + +
    + 
    public IMachiningMotionResolution MachiningMotionResolution { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    IMachiningMotionResolution
    +
    +
    + + + + + + + + + + +

    + MachiningResolution_mm + +

    + +
    +
    + +
    + 
    public double MachiningResolution_mm { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    double
    +
    +
    + + + + + + + + + + +

    + RuntimeGeomFile + +

    + +
    +
    + +
    + 
    public string RuntimeGeomFile { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + XName + +

    + +

    Name for XML IO.

    +
    +
    + +
    + 
    public static string XName { get; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    public string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + + +

    + 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.

    +
    + + + + + + +

    + Run(RuntimeController) + +

    + +

    Runs the command using the provided script API.

    +
    +
    + +
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)
    +
    + +

    Parameters

    +
    +
    scriptApi RuntimeController
    +

    Script API for executing milling commands.

    +
    +
    + +

    Returns

    +
    +
    IEnumerable<Action>
    +

    Sequence of actions to be executed.

    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.RecordRuntimeGeomActionEnum.html similarity index 89% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.RecordRuntimeGeomActionEnum.html index 82607826..65462055 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.RecordRuntimeGeomActionEnum.html @@ -84,21 +84,21 @@
    -
    +
    -

    +

    Enum RecordRuntimeGeomActionEnum

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    -

    Action of the RecordRuntimeGeomCommand.

    +

    Action of the RecordRuntimeGeomCommand.

    @@ -145,20 +145,20 @@ Enum RecordRuntimeGeomActionEnum

    Fields

    -
    NoAction = 0
    +
    NoAction = 0

    No action.

    -
    Read = 1
    +
    Read = 1

    Read runtime geometry from file.

    -
    ReadOnFirstOrWrite = 3
    +
    ReadOnFirstOrWrite = 3

    If file existed and no motion has ran before, read the runtime geometry; otherwise, write the current geometry into file.

    -
    Write = 2
    +
    Write = 2

    Write runtime geometry to file.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RecordRuntimeGeomCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.RecordRuntimeGeomCommand.html similarity index 78% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RecordRuntimeGeomCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.RecordRuntimeGeomCommand.html index 82054244..673546d0 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.RecordRuntimeGeomCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.RecordRuntimeGeomCommand.html @@ -84,16 +84,16 @@
    -
    +
    -

    +

    Class RecordRuntimeGeomCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -119,7 +119,7 @@ Class RecordRuntimeGeomCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class RecordRuntimeGeomCommand - + -

    +

    RecordRuntimeGeomCommand()

    @@ -212,9 +212,9 @@ Class RecordRuntimeGeomCommand - + -

    +

    RecordRuntimeGeomCommand(XElement, string)

    @@ -252,9 +252,9 @@ Class RecordRuntimeGeomCommand - + -

    +

    MainActionEnum

    @@ -273,7 +273,7 @@ Class RecordRuntimeGeomCommand

    Property Value

    -
    RecordRuntimeGeomActionEnum
    +
    RecordRuntimeGeomActionEnum
    @@ -284,9 +284,9 @@ Class RecordRuntimeGeomCommand - + -

    +

    RelFile

    @@ -316,9 +316,9 @@ Class RecordRuntimeGeomCommand - + -

    +

    XName

    @@ -352,10 +352,10 @@ Class RecordRuntimeGeomCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -365,7 +365,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -375,6 +375,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -391,14 +394,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -407,12 +415,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.ScriptCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ScriptCommand.html similarity index 67% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.ScriptCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ScriptCommand.html index 127e0769..f4fa8dbf 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.ScriptCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.ScriptCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class ScriptCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -102,7 +102,7 @@ Class ScriptCommand
    - 
    public class ScriptCommand : IShellCommand, IMakeXmlSource, IGetSelectionName
    + 
    public class ScriptCommand : ITitleCommand, IShellCommand, IMakeXmlSource, IGetSelectionName
    @@ -119,7 +119,8 @@ Class ScriptCommand
    Implements
    - + +
    @@ -186,9 +187,9 @@ Class ScriptCommand - + -

    +

    ScriptCommand()

    @@ -213,9 +214,9 @@ Class ScriptCommand - + -

    +

    ScriptCommand(XElement, string)

    @@ -253,9 +254,102 @@ Class ScriptCommand - + -

    +

    + ExecutionTemplate + +

    + +
    +
    + +
    + 
    public static ScriptCommand ExecutionTemplate { get; }
    +
    + + + + + +

    Property Value

    +
    +
    ScriptCommand
    +
    +
    + + + + + + + + + + +

    + OptimizationConfigurationTemplate + +

    + +
    +
    + +
    + 
    public static ScriptCommand OptimizationConfigurationTemplate { get; }
    +
    + + + + + +

    Property Value

    +
    +
    ScriptCommand
    +
    +
    + + + + + + + + + + +

    + PreSettingTemplate + +

    + +
    +
    + +
    + 
    public static ScriptCommand PreSettingTemplate { get; }
    +
    + + + + + +

    Property Value

    +
    +
    ScriptCommand
    +
    +
    + + + + + + + + + + +

    ScriptText

    @@ -285,9 +379,9 @@ Class ScriptCommand - + -

    +

    ScriptTitle

    @@ -317,9 +411,9 @@ Class ScriptCommand - + -

    +

    XName

    @@ -353,9 +447,9 @@ Class ScriptCommand - + -

    +

    GenTemplateCommand()

    @@ -371,7 +465,7 @@ Class ScriptCommand

    Returns

    -
    ScriptCommand
    +
    ScriptCommand

    A new ScriptCommand with template values

    @@ -386,9 +480,40 @@ Class ScriptCommand - + -

    +

    + GetCommandTitle() + +

    + +
    +
    + +
    + 
    public string GetCommandTitle()
    +
    + + +

    Returns

    +
    +
    string
    +
    +
    + + + + + + + + + + + + + +

    GetSelectionName()

    @@ -419,10 +544,10 @@ Class ScriptCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -432,7 +557,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -442,6 +567,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -458,14 +586,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -474,12 +607,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    @@ -501,10 +634,10 @@ This method may also generate additional resources such as related files.

    - + -

    - Run(ShellApi, string) +

    + Run(RuntimeController, string)

    @@ -513,12 +646,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi, string scriptText)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi, string scriptText)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    The milling course script API

    scriptText string
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.SimpleSessionCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.SimpleSessionCommand.html new file mode 100644 index 00000000..918f8ead --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.SimpleSessionCommand.html @@ -0,0 +1,1000 @@ + + + + + Class SimpleSessionCommand | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class SimpleSessionCommand +

    + +
    +
    Namespace
    Hi.ShellCommands
    +
    Assembly
    HiNc.dll
    +
    + +
    +
    + +
    + 
    public class SimpleSessionCommand : IShellCommand, IMakeXmlSource
    +
    + + + + +
    +
    Inheritance
    +
    + +
    SimpleSessionCommand
    +
    +
    + +
    +
    Implements
    +
    + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + SimpleSessionCommand() + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public SimpleSessionCommand()
    +
    + + + + + + + + + + + + + + + +

    + SimpleSessionCommand(XElement, string, string, params object[]) + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public SimpleSessionCommand(XElement src, string baseDirectory, string relFile, params object[] res)
    +
    + +

    Parameters

    +
    +
    src XElement
    +

    XML

    +
    +
    baseDirectory string
    +

    Base directory for relative paths

    +
    +
    relFile string
    +

    Relative file path

    +
    +
    res object[]
    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + EnableCollisionDetection + +

    + +
    +
    + +
    + 
    public bool EnableCollisionDetection { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableGeomDiff + +

    + +
    +
    + +
    + 
    public bool EnableGeomDiff { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableOptimizeToFiles + +

    + +
    +
    + +
    + 
    public bool EnableOptimizeToFiles { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnablePauseOnFailure + +

    + +
    +
    + +
    + 
    public bool EnablePauseOnFailure { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableReadRuntimeGeom + +

    + +
    +
    + +
    + 
    public bool EnableReadRuntimeGeom { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableWriteRuntimeGeom + +

    + +
    +
    + +
    + 
    public bool EnableWriteRuntimeGeom { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableWriteShotFiles + +

    + +
    +
    + +
    + 
    public bool EnableWriteShotFiles { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + EnableWriteStepFiles + +

    + +
    +
    + +
    + 
    public bool EnableWriteStepFiles { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    bool
    +
    +
    + + + + + + + + + + +

    + GeomDiffDetectRadius_mm + +

    + +
    +
    + +
    + 
    public double GeomDiffDetectRadius_mm { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    double
    +
    +
    + + + + + + + + + + +

    + MachiningMotionResolution + +

    + +
    +
    + +
    + 
    public IMachiningMotionResolution MachiningMotionResolution { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    IMachiningMotionResolution
    +
    +
    + + + + + + + + + + +

    + MachiningResolution_mm + +

    + +
    +
    + +
    + 
    public double MachiningResolution_mm { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    double
    +
    +
    + + + + + + + + + + +

    + NcCommandList + +

    + +

    Middle command list. Mainly for NC commands. +Because of the design idea is for simplicity, only expect the wrapper content to be NcFileCommand or NcCodeCommand or ScriptCommand.

    +
    +
    + +
    + 
    public List<EnablingWrapper> NcCommandList { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    List<EnablingWrapper>
    +
    +
    + + + + + + + + + + +

    + NcOptOption + +

    + +
    +
    + +
    + 
    public NcOptOption NcOptOption { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    NcOptOption
    +
    +
    + + + + + + + + + + +

    + OptimizationFileTemplate + +

    + +
    +
    + +
    + 
    public string OptimizationFileTemplate { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + RuntimeGeomFile + +

    + +
    +
    + +
    + 
    public string RuntimeGeomFile { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + RuntimeGeomFileTemplate + +

    + +
    +
    + +
    + 
    public string RuntimeGeomFileTemplate { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + ShotFileTemplate + +

    + +
    +
    + +
    + 
    public string ShotFileTemplate { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + ShotFileTimeResolution_ms + +

    + +
    +
    + +
    + 
    public double ShotFileTimeResolution_ms { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    double
    +
    +
    + + + + + + + + + + +

    + StepFileTemplate + +

    + +
    +
    + +
    + 
    public string StepFileTemplate { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + + + +

    + XName + +

    + +

    Name for XML IO.

    +
    +
    + +
    + 
    public static string XName { get; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + 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.

    +
    + + + + + + +

    + Run(RuntimeController) + +

    + +

    Runs the command using the provided script API.

    +
    +
    + +
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)
    +
    + +

    Parameters

    +
    +
    scriptApi RuntimeController
    +

    Script API for executing milling commands.

    +
    +
    + +

    Returns

    +
    +
    IEnumerable<Action>
    +

    Sequence of actions to be executed.

    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html similarity index 78% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html index d41b42f4..29f9392d 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html @@ -84,16 +84,16 @@ -
    +
    -

    +

    Class WriteRuntimeGeomToStlCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    @@ -119,7 +119,7 @@ Class WriteRuntimeGeomToStlCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class WriteRuntimeGeomToStlCommand - + -

    +

    WriteRuntimeGeomToStlCommand()

    @@ -212,9 +212,9 @@ Class WriteRuntimeGeomToStlCommand - + -

    +

    WriteRuntimeGeomToStlCommand(XElement, string)

    @@ -252,9 +252,9 @@ Class WriteRuntimeGeomToStlCommand - + -

    +

    RelFile

    @@ -284,9 +284,9 @@ Class WriteRuntimeGeomToStlCommand - + -

    +

    Resolution_mm

    @@ -316,9 +316,9 @@ Class WriteRuntimeGeomToStlCommand - + -

    +

    XName

    @@ -352,10 +352,10 @@ Class WriteRuntimeGeomToStlCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -365,7 +365,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -375,6 +375,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -391,14 +394,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -407,12 +415,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteShotFilesCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteShotFilesCommand.html similarity index 78% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteShotFilesCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteShotFilesCommand.html index a7bd05bc..f4962309 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteShotFilesCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteShotFilesCommand.html @@ -84,20 +84,20 @@ -
    +
    -

    +

    Class WriteShotFilesCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    -

    Command to call WriteShotFiles(string, double).

    +

    Command to call WriteShotFiles(string, double).

    @@ -119,7 +119,7 @@ Class WriteShotFilesCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class WriteShotFilesCommand - + -

    +

    WriteShotFilesCommand()

    @@ -212,9 +212,9 @@ Class WriteShotFilesCommand - + -

    +

    WriteShotFilesCommand(XElement, string)

    @@ -252,9 +252,9 @@ Class WriteShotFilesCommand - + -

    +

    RelFileTemplate

    @@ -284,9 +284,9 @@ Class WriteShotFilesCommand - + -

    +

    TimeResolution_ms

    @@ -316,9 +316,9 @@ Class WriteShotFilesCommand - + -

    +

    XName

    @@ -352,10 +352,10 @@ Class WriteShotFilesCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -365,7 +365,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -375,6 +375,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -391,14 +394,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -407,12 +415,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteStepFilesCommand.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteStepFilesCommand.html similarity index 79% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteStepFilesCommand.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteStepFilesCommand.html index 37e8e3a6..e8a6373e 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.WriteStepFilesCommand.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.WriteStepFilesCommand.html @@ -84,20 +84,20 @@
    -
    +
    -

    +

    Class WriteStepFilesCommand

    -
    Namespace
    Hi.ShellCommandUtils
    +
    Namespace
    Hi.ShellCommands
    Assembly
    HiNc.dll
    -

    Command to call WriteStepFiles(string).

    +

    Command to call WriteStepFiles(string).

    @@ -119,7 +119,7 @@ Class WriteStepFilesCommand
    Implements
    - +
    @@ -185,9 +185,9 @@ Class WriteStepFilesCommand - + -

    +

    WriteStepFilesCommand()

    @@ -212,9 +212,9 @@ Class WriteStepFilesCommand - + -

    +

    WriteStepFilesCommand(XElement, string)

    @@ -252,9 +252,9 @@ Class WriteStepFilesCommand - + -

    +

    RelFileTemplate

    @@ -284,9 +284,9 @@ Class WriteStepFilesCommand - + -

    +

    XName

    @@ -320,10 +320,10 @@ Class WriteStepFilesCommand - + -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -333,7 +333,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -343,6 +343,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -359,14 +362,19 @@ This method may also generate additional resources such as related files.

    +

    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.

    +
    - + -

    - Run(ShellApi) +

    + Run(RuntimeController)

    @@ -375,12 +383,12 @@ This method may also generate additional resources such as related files.

    - 
    public IEnumerable<Action> Run(ShellApi scriptApi)
    + 
    public IEnumerable<Action> Run(RuntimeController scriptApi)

    Parameters

    -
    scriptApi ShellApi
    +
    scriptApi RuntimeController

    Script API for executing milling commands.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.html b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.html similarity index 65% rename from App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.html rename to App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.html index 861a0be8..4e9fe154 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommandUtils.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.ShellCommands.html @@ -2,9 +2,9 @@ - Namespace Hi.ShellCommandUtils | HiAPI-C# 2025 + Namespace Hi.ShellCommands | HiAPI-C# 2025 - + @@ -84,9 +84,9 @@
    -
    +
    -

    Namespace Hi.ShellCommandUtils

    +

    Namespace Hi.ShellCommands

    @@ -95,94 +95,112 @@ Classes
    -
    CommandEntry
    -

    Represents a command entry with enabled state in a command list.

    -
    +
    EnablingWrapper
    +
    -
    GeomDiffCommand
    +
    GeomDiffCommand

    Command for calculating geometric differences between workpieces.

    -
    Lang
    +
    Lang

    Language package class for command flow.

    -
    ListCommand
    +
    ListCommand

    A command that contains and executes a list of other commands.

    -
    MachiningMotionResolutionCommand
    +
    MachiningMotionResolutionCommand

    Command for setting machining motion resolution for the milling process.

    -
    NcCodeCommand
    +
    NcCodeCommand

    Command for executing NC code directly.

    -
    NcFileCommand
    +
    NcFileCommand

    Command for executing NC code from a file.

    -
    NcFileListCommand
    +
    NcFileListCommand

    Command for executing multiple NC files sequentially.

    -
    OptimizeToFilesCommand
    -

    Command to call OptimizeToFiles(string).

    +
    NcOptOptionCommand
    +

    Command for NC optimization options.

    -
    RecordRuntimeGeomCommand
    +
    OptimizeToFilesCommand
    +

    Command to call OptimizeToFiles(string).

    +
    +
    +
    +
    PostExecutionCommand
    +

    Command for post-execution actions after NC command running.

    +
    +
    +
    +
    PreSettingCommand
    +

    Command for pre-settings before NC command running.

    +
    +
    +
    +
    RecordRuntimeGeomCommand

    Command for recording runtime geometry to/from file.

    -
    RuntimeCommand
    -

    Represents a shell command that can be executed at runtime.

    -
    -
    -
    -
    ScriptCommand
    +
    ScriptCommand

    Command for executing C# scripts in the milling process.

    -
    WriteRuntimeGeomToStlCommand
    +
    SimpleSessionCommand
    +
    +
    +
    +
    WriteRuntimeGeomToStlCommand

    Command to call Hi.MillingProcs.MachiningProjectCsScriptApi.WriteRuntimeGeomToStl.

    -
    WriteShotFilesCommand
    -

    Command to call WriteShotFiles(string, double).

    +
    WriteShotFilesCommand
    +

    Command to call WriteShotFiles(string, double).

    -
    WriteStepFilesCommand
    -

    Command to call WriteStepFiles(string).

    +
    WriteStepFilesCommand
    +

    Command to call WriteStepFiles(string).

    Interfaces

    -
    IShellCommand
    +
    IShellCommand

    Interface for commands that can be executed in a milling course.

    +
    +
    +
    +
    ITitleCommand
    +

    IShellCommand with title.

    Enums

    -
    RecordRuntimeGeomActionEnum
    -

    Action of the RecordRuntimeGeomCommand.

    +
    RecordRuntimeGeomActionEnum
    +

    Action of the RecordRuntimeGeomCommand.

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Hubs.RenderingHub.html b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Hubs.RenderingHub.html new file mode 100644 index 00000000..09527801 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Hubs.RenderingHub.html @@ -0,0 +1,833 @@ + + + + + Class RenderingHub | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class RenderingHub +

    + +
    +
    Namespace
    Hi.Webapi.Hubs
    +
    Assembly
    Hi.Webapi.dll
    +
    + +

    SignalR Hub 用於處理渲染畫布的實時通信

    +
    +
    + +
    + 
    public class RenderingHub : Hub, IDisposable
    +
    + + + + +
    +
    Inheritance
    +
    + + +
    RenderingHub
    +
    +
    + +
    +
    Implements
    +
    + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + RenderingHub(RenderingService, ILogger<RenderingHub>) + +

    + +
    +
    + +
    + 
    public RenderingHub(RenderingService renderingService, ILogger<RenderingHub> logger)
    +
    + +

    Parameters

    +
    +
    renderingService RenderingService
    +
    +
    logger ILogger<RenderingHub>
    +
    +
    + + + + + + + + + + + + +

    Methods +

    + + + + +

    + HandleKeyDown(string, string, bool, bool, bool) + +

    + +

    處理鍵盤按下事件

    +
    +
    + +
    + 
    public Task HandleKeyDown(string key, string code, bool ctrlKey, bool shiftKey, bool altKey)
    +
    + +

    Parameters

    +
    +
    key string
    +
    +
    code string
    +
    +
    ctrlKey bool
    +
    +
    shiftKey bool
    +
    +
    altKey bool
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleKeyUp(string, string, bool, bool, bool) + +

    + +

    處理鍵盤釋放事件

    +
    +
    + +
    + 
    public Task HandleKeyUp(string key, string code, bool ctrlKey, bool shiftKey, bool altKey)
    +
    + +

    Parameters

    +
    +
    key string
    +
    +
    code string
    +
    +
    ctrlKey bool
    +
    +
    shiftKey bool
    +
    +
    altKey bool
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleMouseDown(double, double, int) + +

    + +

    處理鼠標按下事件

    +
    +
    + +
    + 
    public Task HandleMouseDown(double x, double y, int button)
    +
    + +

    Parameters

    +
    +
    x double
    +
    +
    y double
    +
    +
    button int
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleMouseMove(double, double, int) + +

    + +

    處理鼠標移動事件

    +
    +
    + +
    + 
    public Task HandleMouseMove(double x, double y, int buttonMask)
    +
    + +

    Parameters

    +
    +
    x double
    +
    +
    y double
    +
    +
    buttonMask int
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleMouseUp(double, double, int) + +

    + +

    處理鼠標釋放事件

    +
    +
    + +
    + 
    public Task HandleMouseUp(double x, double y, int button)
    +
    + +

    Parameters

    +
    +
    x double
    +
    +
    y double
    +
    +
    button int
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleMouseWheel(double, double, double, double, string) + +

    + +

    處理鼠標滾輪事件

    +
    +
    + +
    + 
    public Task HandleMouseWheel(double x, double y, double deltaX, double deltaY, string browserBrand = "chrome")
    +
    + +

    Parameters

    +
    +
    x double
    +
    +
    y double
    +
    +
    deltaX double
    +
    +
    deltaY double
    +
    +
    browserBrand string
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleResize(int, int) + +

    + +

    處理窗口大小變化

    +
    +
    + +
    + 
    public Task HandleResize(int width, int height)
    +
    + +

    Parameters

    +
    +
    width int
    +
    +
    height int
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleTouchDown(int, double, double) + +

    + +

    處理觸摸按下事件

    +
    +
    + +
    + 
    public Task HandleTouchDown(int pointerId, double x, double y)
    +
    + +

    Parameters

    +
    +
    pointerId int
    +
    +
    x double
    +
    +
    y double
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleTouchMove(int, double, double) + +

    + +

    處理觸摸移動事件

    +
    +
    + +
    + 
    public Task HandleTouchMove(int pointerId, double x, double y)
    +
    + +

    Parameters

    +
    +
    pointerId int
    +
    +
    x double
    +
    +
    y double
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleTouchUp(int) + +

    + +

    處理觸摸釋放事件

    +
    +
    + +
    + 
    public Task HandleTouchUp(int pointerId)
    +
    + +

    Parameters

    +
    +
    pointerId int
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + HandleVisibilityChange(string) + +

    + +

    處理可見性變化

    +
    +
    + +
    + 
    public Task HandleVisibilityChange(string visibilityState)
    +
    + +

    Parameters

    +
    +
    visibilityState string
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + InitializeCanvas(int, int) + +

    + +

    客戶端連接時初始化渲染引擎

    +
    +
    + +
    + 
    public Task InitializeCanvas(int width, int height)
    +
    + +

    Parameters

    +
    +
    width int
    +
    +
    height int
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + OnDisconnectedAsync(Exception) + +

    + +

    客戶端斷開連接時清理資源

    +
    +
    + +
    + 
    public override Task OnDisconnectedAsync(Exception exception)
    +
    + +

    Parameters

    +
    +
    exception Exception
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + + +

    + SetView(string) + +

    + +

    設置視圖

    +
    +
    + +
    + 
    public Task SetView(string viewType)
    +
    + +

    Parameters

    +
    +
    viewType string
    +
    +
    + +

    Returns

    +
    +
    Task
    +
    +
    + + + + + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.html b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Hubs.html similarity index 86% rename from App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Hubs.html index af3ab67e..ff750916 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Hubs.html @@ -2,9 +2,9 @@ - Namespace Hi.MillingForces.ProjectedRakeFaceCuttingParas | HiAPI-C# 2025 + Namespace Hi.Webapi.Hubs | HiAPI-C# 2025 - + @@ -84,9 +84,9 @@ -
    +
    -

    Namespace Hi.MillingForces.ProjectedRakeFaceCuttingParas

    +

    Namespace Hi.Webapi.Hubs

    @@ -95,8 +95,8 @@ Classes
    -
    RakeFace2DCuttingPara
    -

    Represents a 2D cutting parameter for rake face cutting operations.

    +
    RenderingHub
    +

    SignalR Hub 用於處理渲染畫布的實時通信

    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Common.HiLog.html b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Services.RenderingService.html similarity index 62% rename from App/wwwroot/HiAPI-docsite/api/Hi.Common.HiLog.html rename to App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Services.RenderingService.html index bbc62b61..82cf3a21 100644 --- a/App/wwwroot/HiAPI-docsite/api/Hi.Common.HiLog.html +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Services.RenderingService.html @@ -2,11 +2,11 @@ - Class HiLog | HiAPI-C# 2025 + Class RenderingService | HiAPI-C# 2025 - + - + @@ -84,25 +84,25 @@ -
    +
    -

    -Class HiLog +

    +Class RenderingService

    -
    Namespace
    Hi.Common
    -
    Assembly
    HiGeom.dll
    +
    Namespace
    Hi.Webapi.Services
    +
    Assembly
    Hi.Webapi.dll
    -

    Logging utility class that provides logging functionality with timestamp.

    +

    管理 DispEngine 實例和渲染操作的服務

    - 
    public class HiLog
    + 
    public class RenderingService : IDisposable
    @@ -112,10 +112,16 @@ Class HiLog
    Inheritance
    -
    HiLog
    +
    RenderingService
    +
    +
    Implements
    +
    + +
    +
    @@ -172,102 +178,29 @@ Class HiLog -

    Remarks

    -

    Internal Use Only

    -

    Constructors

    - + -

    - HiLog() +

    + RenderingService(ILogger<RenderingService>)

    -

    Initializes a new instance of the HiLog class with no writer.

    -
    +
    - 
    public HiLog()
    -
    - - - - - - - - - - - - - - - -

    - HiLog(StreamWriter) - -

    - -

    Initializes a new instance of the HiLog class with the specified writer.

    -
    -
    - -
    - 
    public HiLog(StreamWriter writer)
    + 
    public RenderingService(ILogger<RenderingService> logger)

    Parameters

    -
    writer StreamWriter
    -

    The stream writer to use for logging

    -
    -
    - - - - - - - - - - - - -

    Properties -

    - - - - -

    - Default - -

    - -

    Gets or sets the default logger instance. -The default log file name is formatted as “logYYYYMM.txt” based on the current date.

    -
    -
    - -
    - 
    public static HiLog Default { get; set; }
    -
    - - - - - -

    Property Value

    -
    -
    HiLog
    +
    logger ILogger<RenderingService>
    @@ -278,66 +211,6 @@ The default log file name is formatted as “logYYYYMM.txt” based on t - - -

    - WriteToConsole - -

    - -

    Gets or sets a value indicating whether log messages should also be written to the console.

    -
    -
    - -
    - 
    public bool WriteToConsole { get; set; }
    -
    - - - - - -

    Property Value

    -
    -
    bool
    -
    -
    - - - - - - - - - - -

    - Writer - -

    - -

    Gets or sets the stream writer used for logging.

    -
    -
    - -
    - 
    public StreamWriter Writer { get; set; }
    -
    - - - - - -

    Property Value

    -
    -
    StreamWriter
    -
    -
    - - - - @@ -346,27 +219,53 @@ The default log file name is formatted as “logYYYYMM.txt” based on t - + -

    - Append(string) +

    + Dispose()

    -

    Synchronously appends the specified information to the log with a timestamp. -This is a blocking wrapper around AppendAsync(string).

    +

    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

    - 
    public void Append(string info)
    + 
    public void Dispose()
    -

    Parameters

    + + + + + + + + + + + + + + +

    + GetActiveEngineCount() + +

    + +

    獲取當前活動的引擎數量

    +
    +
    + +
    + 
    public int GetActiveEngineCount()
    +
    + + +

    Returns

    -
    info string
    -

    The information to log

    -
    +
    int
    +
    @@ -379,35 +278,68 @@ This is a blocking wrapper around - - -

    - AppendAsync(string) +

    + GetOrCreateEngine(string)

    -

    Asynchronously appends the specified information to the log with a timestamp. -If WriteToConsole is true, the information is also output to the console.

    +

    創建或獲取一個 DispEngine 實例

    - 
    public Task AppendAsync(string info)
    + 
    public DispEngine GetOrCreateEngine(string sessionId)

    Parameters

    -
    info string
    -

    The information to log

    -
    +
    sessionId string
    +

    Returns

    -
    Task
    -

    A task representing the asynchronous operation

    -
    +
    DispEngine
    +
    +
    + + + + + + + + + + + + + +

    + RemoveEngine(string) + +

    + +

    移除指定的 DispEngine

    +
    +
    + +
    + 
    public bool RemoveEngine(string sessionId)
    +
    + +

    Parameters

    +
    +
    sessionId string
    +
    +
    + +

    Returns

    +
    +
    bool
    +
    diff --git a/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Services.html b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Services.html new file mode 100644 index 00000000..a4a0d253 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/Hi.Webapi.Services.html @@ -0,0 +1,127 @@ + + + + + Namespace Hi.Webapi.Services | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + +

    Namespace Hi.Webapi.Services

    +
    +
    +
    + +

    +Classes +

    +
    +
    RenderingService
    +

    管理 DispEngine 實例和渲染操作的服務

    +
    +
    + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/HiMachining.Milling.ClMillingDevice.html b/App/wwwroot/HiAPI-docsite/api/HiMachining.Milling.ClMillingDevice.html new file mode 100644 index 00000000..572e70bb --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/HiMachining.Milling.ClMillingDevice.html @@ -0,0 +1,830 @@ + + + + + Class ClMillingDevice | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + + + +

    +Class ClMillingDevice +

    + +
    +
    Namespace
    HiMachining.Milling
    +
    Assembly
    HiMech.dll
    +
    + +

    A milling device driven by CL(Cutter Location).

    +
    +
    + +
    + 
    public class ClMillingDevice : IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary
    +
    + + + + +
    +
    Inheritance
    +
    + +
    ClMillingDevice
    +
    +
    + +
    +
    Implements
    +
    + + + + + + +
    +
    + + +
    +
    Inherited Members
    +
    + + + + + + + +
    + +
    +
    Extension Methods
    +
    + + + + + + + + + + +
    + + + + + +

    Constructors +

    + + + + +

    + ClMillingDevice() + +

    + +

    Ctor.

    +
    +
    + +
    + 
    public ClMillingDevice()
    +
    + + + + + + + + + + + + + + + +

    + ClMillingDevice(XElement, string) + +

    + +

    Initializes a new instance from XML.

    +
    +
    + +
    + 
    public ClMillingDevice(XElement src, string baseDirectory)
    +
    + +

    Parameters

    +
    +
    src XElement
    +

    The XML source element.

    +
    +
    baseDirectory string
    +

    The base directory for resolving relative paths.

    +
    +
    + + + + + + + + + + + + +

    Properties +

    + + + + +

    + Cl + +

    + +
    +
    + +
    + 
    public DVec3d Cl { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    DVec3d
    +
    +
    + + + + + + + + + + +

    + KeyBranch + +

    + +
    +
    + +
    + 
    public Branch KeyBranch { get; }
    +
    + + + + + +

    Property Value

    +
    +
    Branch
    +
    +
    + + + + + + + + + + +

    + KeyTransformer + +

    + +

    An ITransformer driven by Cl.

    +
    +
    + +
    + 
    public DynamicFreeform KeyTransformer { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    DynamicFreeform
    +
    +
    + + + + + + + + + + +

    + MachiningEquipmentGetter + +

    + +

    Runtime property. For managing CL.

    +
    +
    + +
    + 
    public Func<MachiningEquipment> MachiningEquipmentGetter { get; set; }
    +
    + + + + + +

    Property Value

    +
    +
    Func<MachiningEquipment>
    +
    +
    + + + + + + + + + + +

    + MainAsmb + +

    + +

    Main MainAsmb of this device.

    +
    +
    + +
    + 
    public Asmb MainAsmb { get; }
    +
    + + + + + +

    Property Value

    +
    +
    Asmb
    +
    +
    + + + + + + + + + + +

    + McCodes + +

    + +

    Gets the machine coordinate code sequence for decoding the MC array.

    +
    +
    + +
    + 
    public string[] McCodes { get; }
    +
    + + + + + +

    Property Value

    +
    +
    string[]
    +
    +
    + + + + + + + + + + +

    + McTransformers + +

    + +

    Gets the machine coordinate transformers.

    +
    +
    + +
    + 
    public IDynamicRegular[] McTransformers { get; }
    +
    + + + + + +

    Property Value

    +
    +
    IDynamicRegular[]
    +
    +
    + + + + + + + + + + +

    + TableBuckle + +

    + +

    Table buckle.

    +
    +
    + +
    + 
    public Anchor TableBuckle { get; }
    +
    + + + + + +

    Property Value

    +
    +
    Anchor
    +
    +
    + + + + + + + + + + +

    + ToolBuckle + +

    + +

    Tool buckle.

    +
    +
    + +
    + 
    public Anchor ToolBuckle { get; }
    +
    + + + + + +

    Property Value

    +
    +
    Anchor
    +
    +
    + + + + + + + + + + +

    + XName + +

    + +

    Name of XML element.

    +
    +
    + +
    + 
    public static string XName { get; }
    +
    + + + + + +

    Property Value

    +
    +
    string
    +
    +
    + + + + + + + + +

    Methods +

    + + + + +

    + GetAnchor() + +

    + +

    Get key anchor. (i.e. root anchor)

    +
    +
    + +
    + 
    public Anchor GetAnchor()
    +
    + + +

    Returns

    +
    +
    Anchor
    +

    key anchor

    +
    +
    + + + + + + + + + + + + + +

    + GetAnchorToSolidDictionary() + +

    + +

    Gets a dictionary that maps Anchor objects to their corresponding Solid objects.

    +
    +
    + +
    + 
    public Dictionary<Anchor, Solid> GetAnchorToSolidDictionary()
    +
    + + +

    Returns

    +
    +
    Dictionary<Anchor, Solid>
    +

    A dictionary where keys are anchors and values are their associated solids.

    +
    +
    + + + + + + + + + + + + + +

    + GetAsmb() + +

    + +

    Gets the key asmb.

    +
    +
    + +
    + 
    public Asmb GetAsmb()
    +
    + + +

    Returns

    +
    +
    Asmb
    +

    The key asmb.

    +
    +
    + + + + + + + + + + + + + +

    + GetTableBuckle() + +

    + +

    Gets the table buckle anchor point.

    +
    +
    + +
    + 
    public IGetAnchor GetTableBuckle()
    +
    + + +

    Returns

    +
    +
    IGetAnchor
    +

    The table buckle anchor point.

    +
    +
    + + + + + + + + + + + + + +

    + GetToolBuckle() + +

    + +

    Gets the tool buckle anchor point.

    +
    +
    + +
    + 
    public IGetAnchor GetToolBuckle()
    +
    + + +

    Returns

    +
    +
    IGetAnchor
    +

    The tool buckle anchor point.

    +
    +
    + + + + + + + + + + + + + +

    + 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.

    +
    + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/HiMachining.Milling.html b/App/wwwroot/HiAPI-docsite/api/HiMachining.Milling.html new file mode 100644 index 00000000..5223c075 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/api/HiMachining.Milling.html @@ -0,0 +1,127 @@ + + + + + Namespace HiMachining.Milling | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    + +

    Namespace HiMachining.Milling

    +
    +
    +
    + +

    +Classes +

    +
    +
    ClMillingDevice
    +

    A milling device driven by CL(Cutter Location).

    +
    +
    + + +
    + +
    +
    + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/api/HiNc.Grpcs.MachiningProjectGrpcServer.html b/App/wwwroot/HiAPI-docsite/api/HiNc.Grpcs.MachiningProjectGrpcServer.html index 5e8c79aa..aba30030 100644 --- a/App/wwwroot/HiAPI-docsite/api/HiNc.Grpcs.MachiningProjectGrpcServer.html +++ b/App/wwwroot/HiAPI-docsite/api/HiNc.Grpcs.MachiningProjectGrpcServer.html @@ -450,8 +450,8 @@ Class MachiningProjectGrpcServer -

    - MakeXmlSource(string, string) +

    + MakeXmlSource(string, string, bool)

    @@ -461,7 +461,7 @@ This method may also generate additional resources such as related files.

    - 
    public XElement MakeXmlSource(string baseDirectory, string relFile)
    + 
    public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

    Parameters

    @@ -471,6 +471,9 @@ This method may also generate additional resources such as related files.

    relFile string

    The relative file path for the XML source

    +
    +
    exhibitionOnly bool
    +

    if true, the extended file creation is suppressed.

    @@ -487,6 +490,11 @@ This method may also generate additional resources such as related files.

    +

    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/toc.html b/App/wwwroot/HiAPI-docsite/api/toc.html index 83e8e88c..b5f705cd 100644 --- a/App/wwwroot/HiAPI-docsite/api/toc.html +++ b/App/wwwroot/HiAPI-docsite/api/toc.html @@ -143,6 +143,19 @@ +
  • + + Hi.Collisions + + +
  • Hi.Coloring @@ -248,9 +261,6 @@
  • ExceptionUtil
    • -
  • - HiLog -
  • IAbstractNote
    • @@ -269,6 +279,9 @@
  • IGetSelectionName
    • +
  • + INameNote +
  • IPreferredFileName
    • @@ -299,6 +312,9 @@
  • InvokeUtil
    • +
  • + JsonUtil +
  • LooseRunner
    • @@ -341,9 +357,6 @@
  • ServerFileExplorerConfig
    • -
  • - SessionLogger -
  • Slice
    • @@ -484,19 +497,7 @@ BootstrapTheme
  • - FilteringMultiTagMessageQueue -
    • -
  • - IMessageHost -
    • -
  • - IMultiTagMessageQueue -
    • -
  • - LinkedListMultiTagMessageQueue -
    • -
  • - LoggingMessageQueue + IMessageKit
  • MessageBoardUtil @@ -513,9 +514,6 @@
  • MultiTagMessage
    • -
  • - MultiTagMessageQueueUtil -
  • ShowMessageBoardDelegate
    • @@ -628,7 +626,7 @@ IMakeXmlSource
  • - INameNote + IToXElement
  • SetFileDelegate @@ -704,10 +702,10 @@ Bind
  • - Box3dUtil + Box3dDispUtil
  • - Box3dUtil.BoxableExpandToBox3dDel + Box3dDispUtil.BoxableExpandToBox3dDel
  • DelegateFuncDisplayee @@ -733,6 +731,9 @@
  • Drawing
    • +
  • + FuncDisplayee +
  • GL
    • @@ -742,15 +743,12 @@
  • IGetDispEngine
    • +
  • + IGetPickable +
  • IGlContextDirver
    • -
  • - IPickableGetter -
    • -
  • - ITopoDisplayee -
  • MatStack
    • @@ -770,7 +768,7 @@ PushModelMat
  • - RawFuncDisplayee + Segment3dDispUtil
  • ShowEventPickable @@ -782,13 +780,7 @@ StringDrawing
  • - TopoDisplayee -
    • -
  • - TopoDisplayeeUtil -
    • -
  • - Tri3dUtil + Tri3dDispUtil
  • WrappedDisplayee @@ -893,6 +885,12 @@
  • Dir
    • +
  • + ExtendedCylinder +
    • +
  • + Flat3d +
  • GeomCombination
    • @@ -908,6 +906,9 @@
  • IFlat3d
    • +
  • + IGenStl +
  • IGeomProperty
    • @@ -920,9 +921,6 @@
  • IGetZrList
    • -
  • - ILinearAndRoundStlResolutionHost -
  • IStlSource
    • @@ -932,6 +930,9 @@
  • IVec<T>
    • +
  • + IZrListSourceProperty +
  • Mat4d
    • @@ -962,6 +963,9 @@
  • Polar3d
    • +
  • + Segment3d +
  • Stl
    • @@ -1003,6 +1007,22 @@ +
  • + + Hi.Geom.Resolution + + +
  • Hi.Geom.Solvers @@ -1048,6 +1068,9 @@
  • PhysicsUnit
    • +
  • + StringValueAttribute +
  • UnitConvertUtil
    • @@ -1104,6 +1127,18 @@
  • HiNcHost
    • +
  • + HostConfig +
    • +
  • + LocalApp +
    • +
  • + UserConfig +
    • +
  • + UserEnv +
  • @@ -1134,7 +1169,7 @@ +
    • +
  • + + Hi.MachiningSteps + +
    • @@ -1412,24 +1493,24 @@
  • IGetAsmb
    • -
  • - IGetBuckleAnchorList -
  • IGetFletchBuckle
  • IGetInverseTransformer
    • -
  • - IGetRootAnchor -
  • IGetTopoIndex
  • IStaticTransformer
    • +
  • + ITopo +
    • +
  • + ITopoDisplayee +
  • ITransformer
    • @@ -1451,6 +1532,12 @@
  • StaticTranslation
    • +
  • + TopoDisplayee +
    • +
  • + TopoDisplayeeUtil +
  • TopoReflection
    • @@ -1589,6 +1676,9 @@
  • MillingCutterEditorDisplayee
    • +
  • + MillingCutterEditorDisplayee.ShapeModeEnum +
  • @@ -1645,6 +1735,12 @@
  • IContourTray
    • +
  • + IFluteNumSourceProperty +
    • +
  • + IGetFluteNum +
  • ISideContour
    • @@ -1668,6 +1764,25 @@ +
  • + + Hi.Milling.MillingTools + + +
  • Hi.MillingForces @@ -1773,21 +1888,14 @@
    • -
  • - - Hi.MillingForces.ProjectedRakeFaceCuttingParas - - -
  • Hi.MillingForces.RakeFaceCuttingParas
    • -
  • - - Hi.MillingMech.MillingTools - - -
  • Hi.MillingProcs @@ -1874,39 +1966,12 @@ Hi.MillingSteps
  • @@ -2034,12 +2099,6 @@
  • ICollisionIndexPairsSource
    • -
  • - IGetSolidMachiningChain -
    • -
  • - ISolidMachiningChain -
  • @@ -2050,6 +2109,12 @@
  • Fixture
    • +
  • + FixtureEditorDisplayee +
    • +
  • + FixtureEditorDisplayeeConfig +
  • @@ -2082,6 +2147,9 @@
  • Solid
    • +
  • + Solid.RenderingModeEnum +
  • SolidFuncSource
    • @@ -2123,6 +2191,12 @@
  • Workpiece
    • +
  • + WorkpieceEditorDisplayee +
    • +
  • + WorkpieceEditorDisplayeeConfig +
  • @@ -2229,6 +2303,9 @@
  • FlexDictionaryUtil
    • +
  • + HeidenhainCoordinateEntryDisplayee +
  • IFlexDictionaryHost<T>
    • @@ -2244,6 +2321,9 @@
  • ISetSpindleSpeed
    • +
  • + IsoCoordinateEntryDisplayee +
  • IsoCoordinateTable
    • @@ -2389,6 +2469,9 @@
  • ActClLinear
    • +
  • + ActClStep +
  • ActClTeleport
    • @@ -2447,7 +2530,10 @@ ActStateRunner
  • - ActTooling + ActToolingStep +
    • +
  • + ActToolingTeleport
  • ActUnknownSkip @@ -2476,6 +2562,9 @@
  • IActSkip
    • +
  • + IActTooling +
  • IWorkTimeAttrib
    • @@ -2571,7 +2660,7 @@ +
  • + + Hi.Webapi.Hubs + + +
    • +
  • + + Hi.Webapi.Services + + +
  • Hi.WinForm.Disp @@ -2950,6 +3071,16 @@
    • +
  • + + HiMachining.Milling + + +
  • HiNc.Grpcs diff --git a/App/wwwroot/HiAPI-docsite/api/toc.json b/App/wwwroot/HiAPI-docsite/api/toc.json index 782bb855..080fbad4 100644 --- a/App/wwwroot/HiAPI-docsite/api/toc.json +++ b/App/wwwroot/HiAPI-docsite/api/toc.json @@ -1,2 +1,2 @@ -{"items":[{"name":"Hi.Cbtr","href":"Hi.Cbtr.html","topicHref":"Hi.Cbtr.html","topicUid":"Hi.Cbtr","type":"Namespace","items":[{"name":"CachedTris","href":"Hi.Cbtr.CachedTris.html","topicHref":"Hi.Cbtr.CachedTris.html","topicUid":"Hi.Cbtr.CachedTris","type":"Class"},{"name":"CachedTris.SweepingMode","href":"Hi.Cbtr.CachedTris.SweepingMode.html","topicHref":"Hi.Cbtr.CachedTris.SweepingMode.html","topicUid":"Hi.Cbtr.CachedTris.SweepingMode","type":"Enum"},{"name":"CbtrPickable","href":"Hi.Cbtr.CbtrPickable.html","topicHref":"Hi.Cbtr.CbtrPickable.html","topicUid":"Hi.Cbtr.CbtrPickable","type":"Class"},{"name":"CubeTree","href":"Hi.Cbtr.CubeTree.html","topicHref":"Hi.Cbtr.CubeTree.html","topicUid":"Hi.Cbtr.CubeTree","type":"Class"},{"name":"CubeTree.diff_response_func_t","href":"Hi.Cbtr.CubeTree.diff_response_func_t.html","topicHref":"Hi.Cbtr.CubeTree.diff_response_func_t.html","topicUid":"Hi.Cbtr.CubeTree.diff_response_func_t","type":"Delegate"},{"name":"CubeTreeFile","href":"Hi.Cbtr.CubeTreeFile.html","topicHref":"Hi.Cbtr.CubeTreeFile.html","topicUid":"Hi.Cbtr.CubeTreeFile","type":"Class"},{"name":"DiffAttachment","href":"Hi.Cbtr.DiffAttachment.html","topicHref":"Hi.Cbtr.DiffAttachment.html","topicUid":"Hi.Cbtr.DiffAttachment","type":"Class"},{"name":"GeomBoolCache","href":"Hi.Cbtr.GeomBoolCache.html","topicHref":"Hi.Cbtr.GeomBoolCache.html","topicUid":"Hi.Cbtr.GeomBoolCache","type":"Class"},{"name":"GeomBoolCacheEnum","href":"Hi.Cbtr.GeomBoolCacheEnum.html","topicHref":"Hi.Cbtr.GeomBoolCacheEnum.html","topicUid":"Hi.Cbtr.GeomBoolCacheEnum","type":"Enum"},{"name":"IGetInitStickConvex","href":"Hi.Cbtr.IGetInitStickConvex.html","topicHref":"Hi.Cbtr.IGetInitStickConvex.html","topicUid":"Hi.Cbtr.IGetInitStickConvex","type":"Interface"},{"name":"InitStickConvex","href":"Hi.Cbtr.InitStickConvex.html","topicHref":"Hi.Cbtr.InitStickConvex.html","topicUid":"Hi.Cbtr.InitStickConvex","type":"Class"},{"name":"LsStl","href":"Hi.Cbtr.LsStl.html","topicHref":"Hi.Cbtr.LsStl.html","topicUid":"Hi.Cbtr.LsStl","type":"Class"},{"name":"Substraction","href":"Hi.Cbtr.Substraction.html","topicHref":"Hi.Cbtr.Substraction.html","topicUid":"Hi.Cbtr.Substraction","type":"Class"},{"name":"UnhighlightablePickable","href":"Hi.Cbtr.UnhighlightablePickable.html","topicHref":"Hi.Cbtr.UnhighlightablePickable.html","topicUid":"Hi.Cbtr.UnhighlightablePickable","type":"Class"},{"name":"UnmanagedSubstraction","href":"Hi.Cbtr.UnmanagedSubstraction.html","topicHref":"Hi.Cbtr.UnmanagedSubstraction.html","topicUid":"Hi.Cbtr.UnmanagedSubstraction","type":"Class"},{"name":"node_diff_t","href":"Hi.Cbtr.node_diff_t.html","topicHref":"Hi.Cbtr.node_diff_t.html","topicUid":"Hi.Cbtr.node_diff_t","type":"Struct"}]},{"name":"Hi.Collision","href":"Hi.Collision.html","topicHref":"Hi.Collision.html","topicUid":"Hi.Collision","type":"Namespace","items":[{"name":"AnchoredCollidableLeaf","href":"Hi.Collision.AnchoredCollidableLeaf.html","topicHref":"Hi.Collision.AnchoredCollidableLeaf.html","topicUid":"Hi.Collision.AnchoredCollidableLeaf","type":"Class"},{"name":"AnchoredCollidablePair","href":"Hi.Collision.AnchoredCollidablePair.html","topicHref":"Hi.Collision.AnchoredCollidablePair.html","topicUid":"Hi.Collision.AnchoredCollidablePair","type":"Class"},{"name":"CollidableStl","href":"Hi.Collision.CollidableStl.html","topicHref":"Hi.Collision.CollidableStl.html","topicUid":"Hi.Collision.CollidableStl","type":"Class"},{"name":"CollisionFlag","href":"Hi.Collision.CollisionFlag.html","topicHref":"Hi.Collision.CollisionFlag.html","topicUid":"Hi.Collision.CollisionFlag","type":"Enum"},{"name":"CollisionIndexPair","href":"Hi.Collision.CollisionIndexPair.html","topicHref":"Hi.Collision.CollisionIndexPair.html","topicUid":"Hi.Collision.CollisionIndexPair","type":"Class"},{"name":"CollisionUtil","href":"Hi.Collision.CollisionUtil.html","topicHref":"Hi.Collision.CollisionUtil.html","topicUid":"Hi.Collision.CollisionUtil","type":"Class"},{"name":"FuncAnchoredCollidable","href":"Hi.Collision.FuncAnchoredCollidable.html","topicHref":"Hi.Collision.FuncAnchoredCollidable.html","topicUid":"Hi.Collision.FuncAnchoredCollidable","type":"Class"},{"name":"IAnchoredCollidableBased","href":"Hi.Collision.IAnchoredCollidableBased.html","topicHref":"Hi.Collision.IAnchoredCollidableBased.html","topicUid":"Hi.Collision.IAnchoredCollidableBased","type":"Interface"},{"name":"IAnchoredCollidableLeaf","href":"Hi.Collision.IAnchoredCollidableLeaf.html","topicHref":"Hi.Collision.IAnchoredCollidableLeaf.html","topicUid":"Hi.Collision.IAnchoredCollidableLeaf","type":"Interface"},{"name":"IAnchoredCollidableNode","href":"Hi.Collision.IAnchoredCollidableNode.html","topicHref":"Hi.Collision.IAnchoredCollidableNode.html","topicUid":"Hi.Collision.IAnchoredCollidableNode","type":"Interface"},{"name":"IAnchoredCollidableStem","href":"Hi.Collision.IAnchoredCollidableStem.html","topicHref":"Hi.Collision.IAnchoredCollidableStem.html","topicUid":"Hi.Collision.IAnchoredCollidableStem","type":"Interface"},{"name":"ICollidable","href":"Hi.Collision.ICollidable.html","topicHref":"Hi.Collision.ICollidable.html","topicUid":"Hi.Collision.ICollidable","type":"Interface"},{"name":"ICollidee","href":"Hi.Collision.ICollidee.html","topicHref":"Hi.Collision.ICollidee.html","topicUid":"Hi.Collision.ICollidee","type":"Interface"},{"name":"ICollisionArena","href":"Hi.Collision.ICollisionArena.html","topicHref":"Hi.Collision.ICollisionArena.html","topicUid":"Hi.Collision.ICollisionArena","type":"Interface"},{"name":"ICollisionIndex","href":"Hi.Collision.ICollisionIndex.html","topicHref":"Hi.Collision.ICollisionIndex.html","topicUid":"Hi.Collision.ICollisionIndex","type":"Interface"},{"name":"IGetAnchoredCollidablePairs","href":"Hi.Collision.IGetAnchoredCollidablePairs.html","topicHref":"Hi.Collision.IGetAnchoredCollidablePairs.html","topicUid":"Hi.Collision.IGetAnchoredCollidablePairs","type":"Interface"},{"name":"IGetCollidable","href":"Hi.Collision.IGetCollidable.html","topicHref":"Hi.Collision.IGetCollidable.html","topicUid":"Hi.Collision.IGetCollidable","type":"Interface"},{"name":"IGetCollisionIndexPairs","href":"Hi.Collision.IGetCollisionIndexPairs.html","topicHref":"Hi.Collision.IGetCollisionIndexPairs.html","topicUid":"Hi.Collision.IGetCollisionIndexPairs","type":"Interface"},{"name":"IGetDefaultCollidablePairs","href":"Hi.Collision.IGetDefaultCollidablePairs.html","topicHref":"Hi.Collision.IGetDefaultCollidablePairs.html","topicUid":"Hi.Collision.IGetDefaultCollidablePairs","type":"Interface"},{"name":"IGetTriTree","href":"Hi.Collision.IGetTriTree.html","topicHref":"Hi.Collision.IGetTriTree.html","topicUid":"Hi.Collision.IGetTriTree","type":"Interface"},{"name":"MechCollisionResult","href":"Hi.Collision.MechCollisionResult.html","topicHref":"Hi.Collision.MechCollisionResult.html","topicUid":"Hi.Collision.MechCollisionResult","type":"Class"},{"name":"MechCollisionUtil","href":"Hi.Collision.MechCollisionUtil.html","topicHref":"Hi.Collision.MechCollisionUtil.html","topicUid":"Hi.Collision.MechCollisionUtil","type":"Class"},{"name":"TriTree","href":"Hi.Collision.TriTree.html","topicHref":"Hi.Collision.TriTree.html","topicUid":"Hi.Collision.TriTree","type":"Class"}]},{"name":"Hi.Coloring","href":"Hi.Coloring.html","topicHref":"Hi.Coloring.html","topicUid":"Hi.Coloring","type":"Namespace","items":[{"name":"ColorUtil","href":"Hi.Coloring.ColorUtil.html","topicHref":"Hi.Coloring.ColorUtil.html","topicUid":"Hi.Coloring.ColorUtil","type":"Class"},{"name":"DictionaryColorGuide","href":"Hi.Coloring.DictionaryColorGuide.html","topicHref":"Hi.Coloring.DictionaryColorGuide.html","topicUid":"Hi.Coloring.DictionaryColorGuide","type":"Class"},{"name":"DiscreteQuantityColorGuide","href":"Hi.Coloring.DiscreteQuantityColorGuide.html","topicHref":"Hi.Coloring.DiscreteQuantityColorGuide.html","topicUid":"Hi.Coloring.DiscreteQuantityColorGuide","type":"Class"},{"name":"FilteredColorGuide","href":"Hi.Coloring.FilteredColorGuide.html","topicHref":"Hi.Coloring.FilteredColorGuide.html","topicUid":"Hi.Coloring.FilteredColorGuide","type":"Class"},{"name":"FuncRangeColorGuide","href":"Hi.Coloring.FuncRangeColorGuide.html","topicHref":"Hi.Coloring.FuncRangeColorGuide.html","topicUid":"Hi.Coloring.FuncRangeColorGuide","type":"Class"},{"name":"IColorGuide","href":"Hi.Coloring.IColorGuide.html","topicHref":"Hi.Coloring.IColorGuide.html","topicUid":"Hi.Coloring.IColorGuide","type":"Interface"},{"name":"IColorGuideProperty","href":"Hi.Coloring.IColorGuideProperty.html","topicHref":"Hi.Coloring.IColorGuideProperty.html","topicUid":"Hi.Coloring.IColorGuideProperty","type":"Interface"},{"name":"IGetColorGuide","href":"Hi.Coloring.IGetColorGuide.html","topicHref":"Hi.Coloring.IGetColorGuide.html","topicUid":"Hi.Coloring.IGetColorGuide","type":"Interface"},{"name":"IGetRangeColorRule","href":"Hi.Coloring.IGetRangeColorRule.html","topicHref":"Hi.Coloring.IGetRangeColorRule.html","topicUid":"Hi.Coloring.IGetRangeColorRule","type":"Interface"},{"name":"IGetRgb","href":"Hi.Coloring.IGetRgb.html","topicHref":"Hi.Coloring.IGetRgb.html","topicUid":"Hi.Coloring.IGetRgb","type":"Interface"},{"name":"IGetRgbWithPriority","href":"Hi.Coloring.IGetRgbWithPriority.html","topicHref":"Hi.Coloring.IGetRgbWithPriority.html","topicUid":"Hi.Coloring.IGetRgbWithPriority","type":"Interface"},{"name":"PlainColorGuide","href":"Hi.Coloring.PlainColorGuide.html","topicHref":"Hi.Coloring.PlainColorGuide.html","topicUid":"Hi.Coloring.PlainColorGuide","type":"Class"},{"name":"QuantityColorGuide","href":"Hi.Coloring.QuantityColorGuide.html","topicHref":"Hi.Coloring.QuantityColorGuide.html","topicUid":"Hi.Coloring.QuantityColorGuide","type":"Class"},{"name":"RangeColorRule","href":"Hi.Coloring.RangeColorRule.html","topicHref":"Hi.Coloring.RangeColorRule.html","topicUid":"Hi.Coloring.RangeColorRule","type":"Class"},{"name":"RatioRgbFuncEnum","href":"Hi.Coloring.RatioRgbFuncEnum.html","topicHref":"Hi.Coloring.RatioRgbFuncEnum.html","topicUid":"Hi.Coloring.RatioRgbFuncEnum","type":"Enum"},{"name":"RgbSeed","href":"Hi.Coloring.RgbSeed.html","topicHref":"Hi.Coloring.RgbSeed.html","topicUid":"Hi.Coloring.RgbSeed","type":"Class"}]},{"name":"Hi.Common","href":"Hi.Common.html","topicHref":"Hi.Common.html","topicUid":"Hi.Common","type":"Namespace","items":[{"name":"BinIoUtil","href":"Hi.Common.BinIoUtil.html","topicHref":"Hi.Common.BinIoUtil.html","topicUid":"Hi.Common.BinIoUtil","type":"Class"},{"name":"BinarySearchResult","href":"Hi.Common.BinarySearchResult.html","topicHref":"Hi.Common.BinarySearchResult.html","topicUid":"Hi.Common.BinarySearchResult","type":"Enum"},{"name":"BitUtil","href":"Hi.Common.BitUtil.html","topicHref":"Hi.Common.BitUtil.html","topicUid":"Hi.Common.BitUtil","type":"Class"},{"name":"BlockingTimer","href":"Hi.Common.BlockingTimer.html","topicHref":"Hi.Common.BlockingTimer.html","topicUid":"Hi.Common.BlockingTimer","type":"Class"},{"name":"BytesUtil","href":"Hi.Common.BytesUtil.html","topicHref":"Hi.Common.BytesUtil.html","topicUid":"Hi.Common.BytesUtil","type":"Class"},{"name":"ConcurrentTimeCounter","href":"Hi.Common.ConcurrentTimeCounter.html","topicHref":"Hi.Common.ConcurrentTimeCounter.html","topicUid":"Hi.Common.ConcurrentTimeCounter","type":"Class"},{"name":"ConsoleUtil","href":"Hi.Common.ConsoleUtil.html","topicHref":"Hi.Common.ConsoleUtil.html","topicUid":"Hi.Common.ConsoleUtil","type":"Class"},{"name":"CppLogUtil","href":"Hi.Common.CppLogUtil.html","topicHref":"Hi.Common.CppLogUtil.html","topicUid":"Hi.Common.CppLogUtil","type":"Class"},{"name":"CppLogUtil.LogDelegate","href":"Hi.Common.CppLogUtil.LogDelegate.html","topicHref":"Hi.Common.CppLogUtil.LogDelegate.html","topicUid":"Hi.Common.CppLogUtil.LogDelegate","type":"Delegate"},{"name":"CultureUtil","href":"Hi.Common.CultureUtil.html","topicHref":"Hi.Common.CultureUtil.html","topicUid":"Hi.Common.CultureUtil","type":"Class"},{"name":"DebugUtil","href":"Hi.Common.DebugUtil.html","topicHref":"Hi.Common.DebugUtil.html","topicUid":"Hi.Common.DebugUtil","type":"Class"},{"name":"DuplicateUtil","href":"Hi.Common.DuplicateUtil.html","topicHref":"Hi.Common.DuplicateUtil.html","topicUid":"Hi.Common.DuplicateUtil","type":"Class"},{"name":"EnumUtil","href":"Hi.Common.EnumUtil.html","topicHref":"Hi.Common.EnumUtil.html","topicUid":"Hi.Common.EnumUtil","type":"Class"},{"name":"EnumerablePlayer","href":"Hi.Common.EnumerablePlayer.html","topicHref":"Hi.Common.EnumerablePlayer.html","topicUid":"Hi.Common.EnumerablePlayer","type":"Class"},{"name":"ExceptionUtil","href":"Hi.Common.ExceptionUtil.html","topicHref":"Hi.Common.ExceptionUtil.html","topicUid":"Hi.Common.ExceptionUtil","type":"Class"},{"name":"HiLog","href":"Hi.Common.HiLog.html","topicHref":"Hi.Common.HiLog.html","topicUid":"Hi.Common.HiLog","type":"Class"},{"name":"IAbstractNote","href":"Hi.Common.IAbstractNote.html","topicHref":"Hi.Common.IAbstractNote.html","topicUid":"Hi.Common.IAbstractNote","type":"Interface"},{"name":"IBinaryIo","href":"Hi.Common.IBinaryIo.html","topicHref":"Hi.Common.IBinaryIo.html","topicUid":"Hi.Common.IBinaryIo","type":"Interface"},{"name":"IClearCache","href":"Hi.Common.IClearCache.html","topicHref":"Hi.Common.IClearCache.html","topicUid":"Hi.Common.IClearCache","type":"Interface"},{"name":"IDuplicate","href":"Hi.Common.IDuplicate.html","topicHref":"Hi.Common.IDuplicate.html","topicUid":"Hi.Common.IDuplicate","type":"Interface"},{"name":"IGetQuantityByKey","href":"Hi.Common.IGetQuantityByKey.html","topicHref":"Hi.Common.IGetQuantityByKey.html","topicUid":"Hi.Common.IGetQuantityByKey","type":"Interface"},{"name":"IGetSelectionName","href":"Hi.Common.IGetSelectionName.html","topicHref":"Hi.Common.IGetSelectionName.html","topicUid":"Hi.Common.IGetSelectionName","type":"Interface"},{"name":"IPreferredFileName","href":"Hi.Common.IPreferredFileName.html","topicHref":"Hi.Common.IPreferredFileName.html","topicUid":"Hi.Common.IPreferredFileName","type":"Interface"},{"name":"ISourceFile","href":"Hi.Common.ISourceFile.html","topicHref":"Hi.Common.ISourceFile.html","topicUid":"Hi.Common.ISourceFile","type":"Interface"},{"name":"IUpdateByContent","href":"Hi.Common.IUpdateByContent.html","topicHref":"Hi.Common.IUpdateByContent.html","topicUid":"Hi.Common.IUpdateByContent","type":"Interface"},{"name":"IUriGetter","href":"Hi.Common.IUriGetter.html","topicHref":"Hi.Common.IUriGetter.html","topicUid":"Hi.Common.IUriGetter","type":"Interface"},{"name":"IWriteBin","href":"Hi.Common.IWriteBin.html","topicHref":"Hi.Common.IWriteBin.html","topicUid":"Hi.Common.IWriteBin","type":"Interface"},{"name":"IndexSegment","href":"Hi.Common.IndexSegment.html","topicHref":"Hi.Common.IndexSegment.html","topicUid":"Hi.Common.IndexSegment","type":"Class"},{"name":"IntegerKeyDictionaryConverter","href":"Hi.Common.IntegerKeyDictionaryConverter.html","topicHref":"Hi.Common.IntegerKeyDictionaryConverter.html","topicUid":"Hi.Common.IntegerKeyDictionaryConverter","type":"Class"},{"name":"IntegerKeyDictionaryConverter","href":"Hi.Common.IntegerKeyDictionaryConverter-1.html","topicHref":"Hi.Common.IntegerKeyDictionaryConverter-1.html","topicUid":"Hi.Common.IntegerKeyDictionaryConverter`1","type":"Class"},{"name":"InternalException","href":"Hi.Common.InternalException.html","topicHref":"Hi.Common.InternalException.html","topicUid":"Hi.Common.InternalException","type":"Class"},{"name":"InvokeUtil","href":"Hi.Common.InvokeUtil.html","topicHref":"Hi.Common.InvokeUtil.html","topicUid":"Hi.Common.InvokeUtil","type":"Class"},{"name":"LooseRunner","href":"Hi.Common.LooseRunner.html","topicHref":"Hi.Common.LooseRunner.html","topicUid":"Hi.Common.LooseRunner","type":"Class"},{"name":"ManualUtil","href":"Hi.Common.ManualUtil.html","topicHref":"Hi.Common.ManualUtil.html","topicUid":"Hi.Common.ManualUtil","type":"Class"},{"name":"MaskUtil","href":"Hi.Common.MaskUtil.html","topicHref":"Hi.Common.MaskUtil.html","topicUid":"Hi.Common.MaskUtil","type":"Class"},{"name":"NameUtil","href":"Hi.Common.NameUtil.html","topicHref":"Hi.Common.NameUtil.html","topicUid":"Hi.Common.NameUtil","type":"Class"},{"name":"PacePlayee","href":"Hi.Common.PacePlayee.html","topicHref":"Hi.Common.PacePlayee.html","topicUid":"Hi.Common.PacePlayee","type":"Class"},{"name":"PacePlayer","href":"Hi.Common.PacePlayer.html","topicHref":"Hi.Common.PacePlayer.html","topicUid":"Hi.Common.PacePlayer","type":"Class"},{"name":"Pair","href":"Hi.Common.Pair-2.html","topicHref":"Hi.Common.Pair-2.html","topicUid":"Hi.Common.Pair`2","type":"Class"},{"name":"Range","href":"Hi.Common.Range-1.html","topicHref":"Hi.Common.Range-1.html","topicUid":"Hi.Common.Range`1","type":"Class"},{"name":"ResourceUtil","href":"Hi.Common.ResourceUtil.html","topicHref":"Hi.Common.ResourceUtil.html","topicUid":"Hi.Common.ResourceUtil","type":"Class"},{"name":"RoutineBlocker","href":"Hi.Common.RoutineBlocker.html","topicHref":"Hi.Common.RoutineBlocker.html","topicUid":"Hi.Common.RoutineBlocker","type":"Class"},{"name":"RoutineBlocker0","href":"Hi.Common.RoutineBlocker0.html","topicHref":"Hi.Common.RoutineBlocker0.html","topicUid":"Hi.Common.RoutineBlocker0","type":"Class"},{"name":"SeqPairUtil","href":"Hi.Common.SeqPairUtil.html","topicHref":"Hi.Common.SeqPairUtil.html","topicUid":"Hi.Common.SeqPairUtil","type":"Class"},{"name":"SeqPair","href":"Hi.Common.SeqPair-1.html","topicHref":"Hi.Common.SeqPair-1.html","topicUid":"Hi.Common.SeqPair`1","type":"Class"},{"name":"ServerFileExplorerConfig","href":"Hi.Common.ServerFileExplorerConfig.html","topicHref":"Hi.Common.ServerFileExplorerConfig.html","topicUid":"Hi.Common.ServerFileExplorerConfig","type":"Class"},{"name":"SessionLogger","href":"Hi.Common.SessionLogger.html","topicHref":"Hi.Common.SessionLogger.html","topicUid":"Hi.Common.SessionLogger","type":"Class"},{"name":"Slice","href":"Hi.Common.Slice.html","topicHref":"Hi.Common.Slice.html","topicUid":"Hi.Common.Slice","type":"Class"},{"name":"StringLocalizer","href":"Hi.Common.StringLocalizer.html","topicHref":"Hi.Common.StringLocalizer.html","topicUid":"Hi.Common.StringLocalizer","type":"Class"},{"name":"StringUtil","href":"Hi.Common.StringUtil.html","topicHref":"Hi.Common.StringUtil.html","topicUid":"Hi.Common.StringUtil","type":"Class"},{"name":"TaskUtil","href":"Hi.Common.TaskUtil.html","topicHref":"Hi.Common.TaskUtil.html","topicUid":"Hi.Common.TaskUtil","type":"Class"},{"name":"TimeCounter","href":"Hi.Common.TimeCounter.html","topicHref":"Hi.Common.TimeCounter.html","topicUid":"Hi.Common.TimeCounter","type":"Class"}]},{"name":"Hi.Common.Collections","href":"Hi.Common.Collections.html","topicHref":"Hi.Common.Collections.html","topicUid":"Hi.Common.Collections","type":"Namespace","items":[{"name":"DictionaryUtil","href":"Hi.Common.Collections.DictionaryUtil.html","topicHref":"Hi.Common.Collections.DictionaryUtil.html","topicUid":"Hi.Common.Collections.DictionaryUtil","type":"Class"},{"name":"EnumerableUtil","href":"Hi.Common.Collections.EnumerableUtil.html","topicHref":"Hi.Common.Collections.EnumerableUtil.html","topicUid":"Hi.Common.Collections.EnumerableUtil","type":"Class"},{"name":"FixedSizeConcurrentLinkedListUtil","href":"Hi.Common.Collections.FixedSizeConcurrentLinkedListUtil.html","topicHref":"Hi.Common.Collections.FixedSizeConcurrentLinkedListUtil.html","topicUid":"Hi.Common.Collections.FixedSizeConcurrentLinkedListUtil","type":"Class"},{"name":"ListIndexBasedEnumerable","href":"Hi.Common.Collections.ListIndexBasedEnumerable-1.html","topicHref":"Hi.Common.Collections.ListIndexBasedEnumerable-1.html","topicUid":"Hi.Common.Collections.ListIndexBasedEnumerable`1","type":"Class"},{"name":"ListIndexBasedIEnumerator","href":"Hi.Common.Collections.ListIndexBasedIEnumerator-1.html","topicHref":"Hi.Common.Collections.ListIndexBasedIEnumerator-1.html","topicUid":"Hi.Common.Collections.ListIndexBasedIEnumerator`1","type":"Class"},{"name":"ListUtil","href":"Hi.Common.Collections.ListUtil.html","topicHref":"Hi.Common.Collections.ListUtil.html","topicUid":"Hi.Common.Collections.ListUtil","type":"Class"},{"name":"ListUtil.OuterPolationMode","href":"Hi.Common.Collections.ListUtil.OuterPolationMode.html","topicHref":"Hi.Common.Collections.ListUtil.OuterPolationMode.html","topicUid":"Hi.Common.Collections.ListUtil.OuterPolationMode","type":"Enum"},{"name":"SortedListUtil","href":"Hi.Common.Collections.SortedListUtil.html","topicHref":"Hi.Common.Collections.SortedListUtil.html","topicUid":"Hi.Common.Collections.SortedListUtil","type":"Class"},{"name":"SortedListUtil.SearchMethod","href":"Hi.Common.Collections.SortedListUtil.SearchMethod.html","topicHref":"Hi.Common.Collections.SortedListUtil.SearchMethod.html","topicUid":"Hi.Common.Collections.SortedListUtil.SearchMethod","type":"Enum"},{"name":"SynList","href":"Hi.Common.Collections.SynList-1.html","topicHref":"Hi.Common.Collections.SynList-1.html","topicUid":"Hi.Common.Collections.SynList`1","type":"Class"}]},{"name":"Hi.Common.CsvUtils","href":"Hi.Common.CsvUtils.html","topicHref":"Hi.Common.CsvUtils.html","topicUid":"Hi.Common.CsvUtils","type":"Namespace","items":[{"name":"CsvInputKit","href":"Hi.Common.CsvUtils.CsvInputKit.html","topicHref":"Hi.Common.CsvUtils.CsvInputKit.html","topicUid":"Hi.Common.CsvUtils.CsvInputKit","type":"Class"},{"name":"CsvOutputKit","href":"Hi.Common.CsvUtils.CsvOutputKit.html","topicHref":"Hi.Common.CsvUtils.CsvOutputKit.html","topicUid":"Hi.Common.CsvUtils.CsvOutputKit","type":"Class"},{"name":"CsvUtil","href":"Hi.Common.CsvUtils.CsvUtil.html","topicHref":"Hi.Common.CsvUtils.CsvUtil.html","topicUid":"Hi.Common.CsvUtils.CsvUtil","type":"Class"},{"name":"ICsvRowIo","href":"Hi.Common.CsvUtils.ICsvRowIo.html","topicHref":"Hi.Common.CsvUtils.ICsvRowIo.html","topicUid":"Hi.Common.CsvUtils.ICsvRowIo","type":"Interface"},{"name":"IGetCsvDictionary","href":"Hi.Common.CsvUtils.IGetCsvDictionary.html","topicHref":"Hi.Common.CsvUtils.IGetCsvDictionary.html","topicUid":"Hi.Common.CsvUtils.IGetCsvDictionary","type":"Interface"}]},{"name":"Hi.Common.FileLines","href":"Hi.Common.FileLines.html","topicHref":"Hi.Common.FileLines.html","topicUid":"Hi.Common.FileLines","type":"Namespace","items":[{"name":"FileBeginEventArgs","href":"Hi.Common.FileLines.FileBeginEventArgs.html","topicHref":"Hi.Common.FileLines.FileBeginEventArgs.html","topicUid":"Hi.Common.FileLines.FileBeginEventArgs","type":"Class"},{"name":"FileEndEventArgs","href":"Hi.Common.FileLines.FileEndEventArgs.html","topicHref":"Hi.Common.FileLines.FileEndEventArgs.html","topicUid":"Hi.Common.FileLines.FileEndEventArgs","type":"Class"},{"name":"FileLineIndex","href":"Hi.Common.FileLines.FileLineIndex.html","topicHref":"Hi.Common.FileLines.FileLineIndex.html","topicUid":"Hi.Common.FileLines.FileLineIndex","type":"Class"},{"name":"FileLinePipingKit","href":"Hi.Common.FileLines.FileLinePipingKit.html","topicHref":"Hi.Common.FileLines.FileLinePipingKit.html","topicUid":"Hi.Common.FileLines.FileLinePipingKit","type":"Class"},{"name":"FileLineUtil","href":"Hi.Common.FileLines.FileLineUtil.html","topicHref":"Hi.Common.FileLines.FileLineUtil.html","topicUid":"Hi.Common.FileLines.FileLineUtil","type":"Class"},{"name":"FileUtil","href":"Hi.Common.FileLines.FileUtil.html","topicHref":"Hi.Common.FileLines.FileUtil.html","topicUid":"Hi.Common.FileLines.FileUtil","type":"Class"},{"name":"IFileChangedEventSupport","href":"Hi.Common.FileLines.IFileChangedEventSupport.html","topicHref":"Hi.Common.FileLines.IFileChangedEventSupport.html","topicUid":"Hi.Common.FileLines.IFileChangedEventSupport","type":"Interface"},{"name":"IFileLine","href":"Hi.Common.FileLines.IFileLine.html","topicHref":"Hi.Common.FileLines.IFileLine.html","topicUid":"Hi.Common.FileLines.IFileLine","type":"Interface"},{"name":"IFileLineIndex","href":"Hi.Common.FileLines.IFileLineIndex.html","topicHref":"Hi.Common.FileLines.IFileLineIndex.html","topicUid":"Hi.Common.FileLines.IFileLineIndex","type":"Interface"},{"name":"IGetFileLineIndex","href":"Hi.Common.FileLines.IGetFileLineIndex.html","topicHref":"Hi.Common.FileLines.IGetFileLineIndex.html","topicUid":"Hi.Common.FileLines.IGetFileLineIndex","type":"Interface"},{"name":"IGetIndexedFileLine","href":"Hi.Common.FileLines.IGetIndexedFileLine.html","topicHref":"Hi.Common.FileLines.IGetIndexedFileLine.html","topicUid":"Hi.Common.FileLines.IGetIndexedFileLine","type":"Interface"},{"name":"ILineChangedEventSupport","href":"Hi.Common.FileLines.ILineChangedEventSupport.html","topicHref":"Hi.Common.FileLines.ILineChangedEventSupport.html","topicUid":"Hi.Common.FileLines.ILineChangedEventSupport","type":"Interface"},{"name":"IndexedFile","href":"Hi.Common.FileLines.IndexedFile.html","topicHref":"Hi.Common.FileLines.IndexedFile.html","topicUid":"Hi.Common.FileLines.IndexedFile","type":"Class"},{"name":"IndexedFileLine","href":"Hi.Common.FileLines.IndexedFileLine.html","topicHref":"Hi.Common.FileLines.IndexedFileLine.html","topicUid":"Hi.Common.FileLines.IndexedFileLine","type":"Class"},{"name":"LineBeginEventArgs","href":"Hi.Common.FileLines.LineBeginEventArgs.html","topicHref":"Hi.Common.FileLines.LineBeginEventArgs.html","topicUid":"Hi.Common.FileLines.LineBeginEventArgs","type":"Class"},{"name":"LineEndEventArgs","href":"Hi.Common.FileLines.LineEndEventArgs.html","topicHref":"Hi.Common.FileLines.LineEndEventArgs.html","topicUid":"Hi.Common.FileLines.LineEndEventArgs","type":"Class"}]},{"name":"Hi.Common.Messages","href":"Hi.Common.Messages.html","topicHref":"Hi.Common.Messages.html","topicUid":"Hi.Common.Messages","type":"Namespace","items":[{"name":"BootstrapTheme","href":"Hi.Common.Messages.BootstrapTheme.html","topicHref":"Hi.Common.Messages.BootstrapTheme.html","topicUid":"Hi.Common.Messages.BootstrapTheme","type":"Enum"},{"name":"FilteringMultiTagMessageQueue","href":"Hi.Common.Messages.FilteringMultiTagMessageQueue.html","topicHref":"Hi.Common.Messages.FilteringMultiTagMessageQueue.html","topicUid":"Hi.Common.Messages.FilteringMultiTagMessageQueue","type":"Class"},{"name":"IMessageHost","href":"Hi.Common.Messages.IMessageHost.html","topicHref":"Hi.Common.Messages.IMessageHost.html","topicUid":"Hi.Common.Messages.IMessageHost","type":"Interface"},{"name":"IMultiTagMessageQueue","href":"Hi.Common.Messages.IMultiTagMessageQueue.html","topicHref":"Hi.Common.Messages.IMultiTagMessageQueue.html","topicUid":"Hi.Common.Messages.IMultiTagMessageQueue","type":"Interface"},{"name":"LinkedListMultiTagMessageQueue","href":"Hi.Common.Messages.LinkedListMultiTagMessageQueue.html","topicHref":"Hi.Common.Messages.LinkedListMultiTagMessageQueue.html","topicUid":"Hi.Common.Messages.LinkedListMultiTagMessageQueue","type":"Class"},{"name":"LoggingMessageQueue","href":"Hi.Common.Messages.LoggingMessageQueue.html","topicHref":"Hi.Common.Messages.LoggingMessageQueue.html","topicUid":"Hi.Common.Messages.LoggingMessageQueue","type":"Class"},{"name":"MessageBoardUtil","href":"Hi.Common.Messages.MessageBoardUtil.html","topicHref":"Hi.Common.Messages.MessageBoardUtil.html","topicUid":"Hi.Common.Messages.MessageBoardUtil","type":"Class"},{"name":"MessageFlag","href":"Hi.Common.Messages.MessageFlag.html","topicHref":"Hi.Common.Messages.MessageFlag.html","topicUid":"Hi.Common.Messages.MessageFlag","type":"Enum"},{"name":"MessageHostUtil","href":"Hi.Common.Messages.MessageHostUtil.html","topicHref":"Hi.Common.Messages.MessageHostUtil.html","topicUid":"Hi.Common.Messages.MessageHostUtil","type":"Class"},{"name":"MessageKit","href":"Hi.Common.Messages.MessageKit.html","topicHref":"Hi.Common.Messages.MessageKit.html","topicUid":"Hi.Common.Messages.MessageKit","type":"Class"},{"name":"MultiTagMessage","href":"Hi.Common.Messages.MultiTagMessage.html","topicHref":"Hi.Common.Messages.MultiTagMessage.html","topicUid":"Hi.Common.Messages.MultiTagMessage","type":"Class"},{"name":"MultiTagMessageQueueUtil","href":"Hi.Common.Messages.MultiTagMessageQueueUtil.html","topicHref":"Hi.Common.Messages.MultiTagMessageQueueUtil.html","topicUid":"Hi.Common.Messages.MultiTagMessageQueueUtil","type":"Class"},{"name":"ShowMessageBoardDelegate","href":"Hi.Common.Messages.ShowMessageBoardDelegate.html","topicHref":"Hi.Common.Messages.ShowMessageBoardDelegate.html","topicUid":"Hi.Common.Messages.ShowMessageBoardDelegate","type":"Delegate"}]},{"name":"Hi.Common.MinMaxUtils","href":"Hi.Common.MinMaxUtils.html","topicHref":"Hi.Common.MinMaxUtils.html","topicUid":"Hi.Common.MinMaxUtils","type":"Namespace","items":[{"name":"IndexedMinMaxPos","href":"Hi.Common.MinMaxUtils.IndexedMinMaxPos-2.html","topicHref":"Hi.Common.MinMaxUtils.IndexedMinMaxPos-2.html","topicUid":"Hi.Common.MinMaxUtils.IndexedMinMaxPos`2","type":"Class"},{"name":"MinMaxUtil","href":"Hi.Common.MinMaxUtils.MinMaxUtil.html","topicHref":"Hi.Common.MinMaxUtils.MinMaxUtil.html","topicUid":"Hi.Common.MinMaxUtils.MinMaxUtil","type":"Class"}]},{"name":"Hi.Common.NativeProgresses","href":"Hi.Common.NativeProgresses.html","topicHref":"Hi.Common.NativeProgresses.html","topicUid":"Hi.Common.NativeProgresses","type":"Namespace","items":[{"name":"IProgressReport","href":"Hi.Common.NativeProgresses.IProgressReport.html","topicHref":"Hi.Common.NativeProgresses.IProgressReport.html","topicUid":"Hi.Common.NativeProgresses.IProgressReport","type":"Interface"},{"name":"NativeProgressReport","href":"Hi.Common.NativeProgresses.NativeProgressReport.html","topicHref":"Hi.Common.NativeProgresses.NativeProgressReport.html","topicUid":"Hi.Common.NativeProgresses.NativeProgressReport","type":"Class"},{"name":"ProgressReport","href":"Hi.Common.NativeProgresses.ProgressReport.html","topicHref":"Hi.Common.NativeProgresses.ProgressReport.html","topicUid":"Hi.Common.NativeProgresses.ProgressReport","type":"Class"},{"name":"progress_monitor_t","href":"Hi.Common.NativeProgresses.progress_monitor_t.html","topicHref":"Hi.Common.NativeProgresses.progress_monitor_t.html","topicUid":"Hi.Common.NativeProgresses.progress_monitor_t","type":"Struct"},{"name":"report_progress_func_t","href":"Hi.Common.NativeProgresses.report_progress_func_t.html","topicHref":"Hi.Common.NativeProgresses.report_progress_func_t.html","topicUid":"Hi.Common.NativeProgresses.report_progress_func_t","type":"Delegate"}]},{"name":"Hi.Common.ParallelBulkUtils","href":"Hi.Common.ParallelBulkUtils.html","topicHref":"Hi.Common.ParallelBulkUtils.html","topicUid":"Hi.Common.ParallelBulkUtils","type":"Namespace","items":[{"name":"ParallelBulkReader","href":"Hi.Common.ParallelBulkUtils.ParallelBulkReader-1.html","topicHref":"Hi.Common.ParallelBulkUtils.ParallelBulkReader-1.html","topicUid":"Hi.Common.ParallelBulkUtils.ParallelBulkReader`1","type":"Class"},{"name":"ParallelBulkWriter","href":"Hi.Common.ParallelBulkUtils.ParallelBulkWriter-1.html","topicHref":"Hi.Common.ParallelBulkUtils.ParallelBulkWriter-1.html","topicUid":"Hi.Common.ParallelBulkUtils.ParallelBulkWriter`1","type":"Class"},{"name":"ReadBulkDelegate","href":"Hi.Common.ParallelBulkUtils.ReadBulkDelegate-1.html","topicHref":"Hi.Common.ParallelBulkUtils.ReadBulkDelegate-1.html","topicUid":"Hi.Common.ParallelBulkUtils.ReadBulkDelegate`1","type":"Delegate"},{"name":"SequentialBulkReader","href":"Hi.Common.ParallelBulkUtils.SequentialBulkReader-1.html","topicHref":"Hi.Common.ParallelBulkUtils.SequentialBulkReader-1.html","topicUid":"Hi.Common.ParallelBulkUtils.SequentialBulkReader`1","type":"Class"}]},{"name":"Hi.Common.PathUtils","href":"Hi.Common.PathUtils.html","topicHref":"Hi.Common.PathUtils.html","topicUid":"Hi.Common.PathUtils","type":"Namespace","items":[{"name":"BaseAndSubDirectory","href":"Hi.Common.PathUtils.BaseAndSubDirectory.html","topicHref":"Hi.Common.PathUtils.BaseAndSubDirectory.html","topicUid":"Hi.Common.PathUtils.BaseAndSubDirectory","type":"Class"},{"name":"ExtendedNamedPath","href":"Hi.Common.PathUtils.ExtendedNamedPath.html","topicHref":"Hi.Common.PathUtils.ExtendedNamedPath.html","topicUid":"Hi.Common.PathUtils.ExtendedNamedPath","type":"Class"},{"name":"HttpUtil","href":"Hi.Common.PathUtils.HttpUtil.html","topicHref":"Hi.Common.PathUtils.HttpUtil.html","topicUid":"Hi.Common.PathUtils.HttpUtil","type":"Class"},{"name":"Lang","href":"Hi.Common.PathUtils.Lang.html","topicHref":"Hi.Common.PathUtils.Lang.html","topicUid":"Hi.Common.PathUtils.Lang","type":"Class"},{"name":"NamedPath","href":"Hi.Common.PathUtils.NamedPath.html","topicHref":"Hi.Common.PathUtils.NamedPath.html","topicUid":"Hi.Common.PathUtils.NamedPath","type":"Class"},{"name":"PathRoute","href":"Hi.Common.PathUtils.PathRoute.html","topicHref":"Hi.Common.PathUtils.PathRoute.html","topicUid":"Hi.Common.PathUtils.PathRoute","type":"Class"},{"name":"PathUtil","href":"Hi.Common.PathUtils.PathUtil.html","topicHref":"Hi.Common.PathUtils.PathUtil.html","topicUid":"Hi.Common.PathUtils.PathUtil","type":"Class"}]},{"name":"Hi.Common.QueueCacheUtils","href":"Hi.Common.QueueCacheUtils.html","topicHref":"Hi.Common.QueueCacheUtils.html","topicUid":"Hi.Common.QueueCacheUtils","type":"Namespace","items":[{"name":"QueueCacherHost","href":"Hi.Common.QueueCacheUtils.QueueCacherHost-1.html","topicHref":"Hi.Common.QueueCacheUtils.QueueCacherHost-1.html","topicUid":"Hi.Common.QueueCacheUtils.QueueCacherHost`1","type":"Class"},{"name":"QueueCacher","href":"Hi.Common.QueueCacheUtils.QueueCacher-1.html","topicHref":"Hi.Common.QueueCacheUtils.QueueCacher-1.html","topicUid":"Hi.Common.QueueCacheUtils.QueueCacher`1","type":"Class"}]},{"name":"Hi.Common.XmlUtils","href":"Hi.Common.XmlUtils.html","topicHref":"Hi.Common.XmlUtils.html","topicUid":"Hi.Common.XmlUtils","type":"Namespace","items":[{"name":"GenMode","href":"Hi.Common.XmlUtils.GenMode.html","topicHref":"Hi.Common.XmlUtils.GenMode.html","topicUid":"Hi.Common.XmlUtils.GenMode","type":"Enum"},{"name":"IMakeXmlSource","href":"Hi.Common.XmlUtils.IMakeXmlSource.html","topicHref":"Hi.Common.XmlUtils.IMakeXmlSource.html","topicUid":"Hi.Common.XmlUtils.IMakeXmlSource","type":"Interface"},{"name":"INameNote","href":"Hi.Common.XmlUtils.INameNote.html","topicHref":"Hi.Common.XmlUtils.INameNote.html","topicUid":"Hi.Common.XmlUtils.INameNote","type":"Interface"},{"name":"SetFileDelegate","href":"Hi.Common.XmlUtils.SetFileDelegate.html","topicHref":"Hi.Common.XmlUtils.SetFileDelegate.html","topicUid":"Hi.Common.XmlUtils.SetFileDelegate","type":"Delegate"},{"name":"XFactory","href":"Hi.Common.XmlUtils.XFactory.html","topicHref":"Hi.Common.XmlUtils.XFactory.html","topicUid":"Hi.Common.XmlUtils.XFactory","type":"Class"},{"name":"XFactory.GenByXElementDelegate","href":"Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html","topicHref":"Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html","topicUid":"Hi.Common.XmlUtils.XFactory.GenByXElementDelegate","type":"Delegate"},{"name":"XFactory.XmlExceptionDelegate","href":"Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate.html","topicHref":"Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate.html","topicUid":"Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate","type":"Delegate"},{"name":"XmlSourceAndFile","href":"Hi.Common.XmlUtils.XmlSourceAndFile-1.html","topicHref":"Hi.Common.XmlUtils.XmlSourceAndFile-1.html","topicUid":"Hi.Common.XmlUtils.XmlSourceAndFile`1","type":"Class"},{"name":"XmlUtil","href":"Hi.Common.XmlUtils.XmlUtil.html","topicHref":"Hi.Common.XmlUtils.XmlUtil.html","topicUid":"Hi.Common.XmlUtils.XmlUtil","type":"Class"}]},{"name":"Hi.CutterLocations","href":"Hi.CutterLocations.html","topicHref":"Hi.CutterLocations.html","topicUid":"Hi.CutterLocations","type":"Namespace","items":[{"name":"IGetProgramCl","href":"Hi.CutterLocations.IGetProgramCl.html","topicHref":"Hi.CutterLocations.IGetProgramCl.html","topicUid":"Hi.CutterLocations.IGetProgramCl","type":"Interface"},{"name":"SimpleCl","href":"Hi.CutterLocations.SimpleCl.html","topicHref":"Hi.CutterLocations.SimpleCl.html","topicUid":"Hi.CutterLocations.SimpleCl","type":"Class"}]},{"name":"Hi.CutterLocations.ClPath","href":"Hi.CutterLocations.ClPath.html","topicHref":"Hi.CutterLocations.ClPath.html","topicUid":"Hi.CutterLocations.ClPath","type":"Namespace","items":[{"name":"ClCircleArc","href":"Hi.CutterLocations.ClPath.ClCircleArc.html","topicHref":"Hi.CutterLocations.ClPath.ClCircleArc.html","topicUid":"Hi.CutterLocations.ClPath.ClCircleArc","type":"Class"},{"name":"ClLinear","href":"Hi.CutterLocations.ClPath.ClLinear.html","topicHref":"Hi.CutterLocations.ClPath.ClLinear.html","topicUid":"Hi.CutterLocations.ClPath.ClLinear","type":"Class"},{"name":"IClPath","href":"Hi.CutterLocations.ClPath.IClPath.html","topicHref":"Hi.CutterLocations.ClPath.IClPath.html","topicUid":"Hi.CutterLocations.ClPath.IClPath","type":"Interface"}]},{"name":"Hi.CutterLocations.ClStrips","href":"Hi.CutterLocations.ClStrips.html","topicHref":"Hi.CutterLocations.ClStrips.html","topicUid":"Hi.CutterLocations.ClStrips","type":"Namespace","items":[{"name":"ClStrip","href":"Hi.CutterLocations.ClStrips.ClStrip.html","topicHref":"Hi.CutterLocations.ClStrips.ClStrip.html","topicUid":"Hi.CutterLocations.ClStrips.ClStrip","type":"Class"},{"name":"ClStripPos","href":"Hi.CutterLocations.ClStrips.ClStripPos.html","topicHref":"Hi.CutterLocations.ClStrips.ClStripPos.html","topicUid":"Hi.CutterLocations.ClStrips.ClStripPos","type":"Class"},{"name":"RgbFunc","href":"Hi.CutterLocations.ClStrips.RgbFunc.html","topicHref":"Hi.CutterLocations.ClStrips.RgbFunc.html","topicUid":"Hi.CutterLocations.ClStrips.RgbFunc","type":"Delegate"}]},{"name":"Hi.Disp","href":"Hi.Disp.html","topicHref":"Hi.Disp.html","topicUid":"Hi.Disp","type":"Namespace","items":[{"name":"Bind","href":"Hi.Disp.Bind.html","topicHref":"Hi.Disp.Bind.html","topicUid":"Hi.Disp.Bind","type":"Class"},{"name":"Box3dUtil","href":"Hi.Disp.Box3dUtil.html","topicHref":"Hi.Disp.Box3dUtil.html","topicUid":"Hi.Disp.Box3dUtil","type":"Class"},{"name":"Box3dUtil.BoxableExpandToBox3dDel","href":"Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel.html","topicHref":"Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel.html","topicUid":"Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel","type":"Delegate"},{"name":"DelegateFuncDisplayee","href":"Hi.Disp.DelegateFuncDisplayee.html","topicHref":"Hi.Disp.DelegateFuncDisplayee.html","topicUid":"Hi.Disp.DelegateFuncDisplayee","type":"Class"},{"name":"DispEngine","href":"Hi.Disp.DispEngine.html","topicHref":"Hi.Disp.DispEngine.html","topicUid":"Hi.Disp.DispEngine","type":"Class"},{"name":"DispEngine.ImageRequestedDelegate","href":"Hi.Disp.DispEngine.ImageRequestedDelegate.html","topicHref":"Hi.Disp.DispEngine.ImageRequestedDelegate.html","topicUid":"Hi.Disp.DispEngine.ImageRequestedDelegate","type":"Delegate"},{"name":"DispEngineConfig","href":"Hi.Disp.DispEngineConfig.html","topicHref":"Hi.Disp.DispEngineConfig.html","topicUid":"Hi.Disp.DispEngineConfig","type":"Class"},{"name":"DispFrameUtil","href":"Hi.Disp.DispFrameUtil.html","topicHref":"Hi.Disp.DispFrameUtil.html","topicUid":"Hi.Disp.DispFrameUtil","type":"Class"},{"name":"DispList","href":"Hi.Disp.DispList.html","topicHref":"Hi.Disp.DispList.html","topicUid":"Hi.Disp.DispList","type":"Class"},{"name":"DispUtil","href":"Hi.Disp.DispUtil.html","topicHref":"Hi.Disp.DispUtil.html","topicUid":"Hi.Disp.DispUtil","type":"Class"},{"name":"Drawing","href":"Hi.Disp.Drawing.html","topicHref":"Hi.Disp.Drawing.html","topicUid":"Hi.Disp.Drawing","type":"Class"},{"name":"GL","href":"Hi.Disp.GL.html","topicHref":"Hi.Disp.GL.html","topicUid":"Hi.Disp.GL","type":"Class"},{"name":"IDisplayee","href":"Hi.Disp.IDisplayee.html","topicHref":"Hi.Disp.IDisplayee.html","topicUid":"Hi.Disp.IDisplayee","type":"Interface"},{"name":"IGetDispEngine","href":"Hi.Disp.IGetDispEngine.html","topicHref":"Hi.Disp.IGetDispEngine.html","topicUid":"Hi.Disp.IGetDispEngine","type":"Interface"},{"name":"IGlContextDirver","href":"Hi.Disp.IGlContextDirver.html","topicHref":"Hi.Disp.IGlContextDirver.html","topicUid":"Hi.Disp.IGlContextDirver","type":"Interface"},{"name":"IPickableGetter","href":"Hi.Disp.IPickableGetter.html","topicHref":"Hi.Disp.IPickableGetter.html","topicUid":"Hi.Disp.IPickableGetter","type":"Interface"},{"name":"ITopoDisplayee","href":"Hi.Disp.ITopoDisplayee.html","topicHref":"Hi.Disp.ITopoDisplayee.html","topicUid":"Hi.Disp.ITopoDisplayee","type":"Interface"},{"name":"MatStack","href":"Hi.Disp.MatStack.html","topicHref":"Hi.Disp.MatStack.html","topicUid":"Hi.Disp.MatStack","type":"Class"},{"name":"MatStack.ItemDisposable","href":"Hi.Disp.MatStack.ItemDisposable.html","topicHref":"Hi.Disp.MatStack.ItemDisposable.html","topicUid":"Hi.Disp.MatStack.ItemDisposable","type":"Class"},{"name":"MvpBoxRelation","href":"Hi.Disp.MvpBoxRelation.html","topicHref":"Hi.Disp.MvpBoxRelation.html","topicUid":"Hi.Disp.MvpBoxRelation","type":"Enum"},{"name":"Pickable","href":"Hi.Disp.Pickable.html","topicHref":"Hi.Disp.Pickable.html","topicUid":"Hi.Disp.Pickable","type":"Class"},{"name":"PopModelMat","href":"Hi.Disp.PopModelMat.html","topicHref":"Hi.Disp.PopModelMat.html","topicUid":"Hi.Disp.PopModelMat","type":"Class"},{"name":"PushModelMat","href":"Hi.Disp.PushModelMat.html","topicHref":"Hi.Disp.PushModelMat.html","topicUid":"Hi.Disp.PushModelMat","type":"Class"},{"name":"RawFuncDisplayee","href":"Hi.Disp.RawFuncDisplayee.html","topicHref":"Hi.Disp.RawFuncDisplayee.html","topicUid":"Hi.Disp.RawFuncDisplayee","type":"Class"},{"name":"ShowEventPickable","href":"Hi.Disp.ShowEventPickable.html","topicHref":"Hi.Disp.ShowEventPickable.html","topicUid":"Hi.Disp.ShowEventPickable","type":"Class"},{"name":"Stamp","href":"Hi.Disp.Stamp.html","topicHref":"Hi.Disp.Stamp.html","topicUid":"Hi.Disp.Stamp","type":"Enum"},{"name":"StringDrawing","href":"Hi.Disp.StringDrawing.html","topicHref":"Hi.Disp.StringDrawing.html","topicUid":"Hi.Disp.StringDrawing","type":"Class"},{"name":"TopoDisplayee","href":"Hi.Disp.TopoDisplayee.html","topicHref":"Hi.Disp.TopoDisplayee.html","topicUid":"Hi.Disp.TopoDisplayee","type":"Class"},{"name":"TopoDisplayeeUtil","href":"Hi.Disp.TopoDisplayeeUtil.html","topicHref":"Hi.Disp.TopoDisplayeeUtil.html","topicUid":"Hi.Disp.TopoDisplayeeUtil","type":"Class"},{"name":"Tri3dUtil","href":"Hi.Disp.Tri3dUtil.html","topicHref":"Hi.Disp.Tri3dUtil.html","topicUid":"Hi.Disp.Tri3dUtil","type":"Class"},{"name":"WrappedDisplayee","href":"Hi.Disp.WrappedDisplayee.html","topicHref":"Hi.Disp.WrappedDisplayee.html","topicUid":"Hi.Disp.WrappedDisplayee","type":"Class"}]},{"name":"Hi.Disp.Flag","href":"Hi.Disp.Flag.html","topicHref":"Hi.Disp.Flag.html","topicUid":"Hi.Disp.Flag","type":"Namespace","items":[{"name":"ColorScaleBar","href":"Hi.Disp.Flag.ColorScaleBar.html","topicHref":"Hi.Disp.Flag.ColorScaleBar.html","topicUid":"Hi.Disp.Flag.ColorScaleBar","type":"Class"},{"name":"CoordinateDrawing","href":"Hi.Disp.Flag.CoordinateDrawing.html","topicHref":"Hi.Disp.Flag.CoordinateDrawing.html","topicUid":"Hi.Disp.Flag.CoordinateDrawing","type":"Class"},{"name":"CubicalFlagDrawing","href":"Hi.Disp.Flag.CubicalFlagDrawing.html","topicHref":"Hi.Disp.Flag.CubicalFlagDrawing.html","topicUid":"Hi.Disp.Flag.CubicalFlagDrawing","type":"Class"},{"name":"DimensionBar","href":"Hi.Disp.Flag.DimensionBar.html","topicHref":"Hi.Disp.Flag.DimensionBar.html","topicUid":"Hi.Disp.Flag.DimensionBar","type":"Class"},{"name":"DispCoverUtil","href":"Hi.Disp.Flag.DispCoverUtil.html","topicHref":"Hi.Disp.Flag.DispCoverUtil.html","topicUid":"Hi.Disp.Flag.DispCoverUtil","type":"Class"}]},{"name":"Hi.Disp.Treat","href":"Hi.Disp.Treat.html","topicHref":"Hi.Disp.Treat.html","topicUid":"Hi.Disp.Treat","type":"Namespace","items":[{"name":"LineWidthSwap","href":"Hi.Disp.Treat.LineWidthSwap.html","topicHref":"Hi.Disp.Treat.LineWidthSwap.html","topicUid":"Hi.Disp.Treat.LineWidthSwap","type":"Class"},{"name":"LineWidthTreat","href":"Hi.Disp.Treat.LineWidthTreat.html","topicHref":"Hi.Disp.Treat.LineWidthTreat.html","topicUid":"Hi.Disp.Treat.LineWidthTreat","type":"Class"},{"name":"PointSizeSwap","href":"Hi.Disp.Treat.PointSizeSwap.html","topicHref":"Hi.Disp.Treat.PointSizeSwap.html","topicUid":"Hi.Disp.Treat.PointSizeSwap","type":"Class"},{"name":"PointSizeTreat","href":"Hi.Disp.Treat.PointSizeTreat.html","topicHref":"Hi.Disp.Treat.PointSizeTreat.html","topicUid":"Hi.Disp.Treat.PointSizeTreat","type":"Class"},{"name":"RgbSwap","href":"Hi.Disp.Treat.RgbSwap.html","topicHref":"Hi.Disp.Treat.RgbSwap.html","topicUid":"Hi.Disp.Treat.RgbSwap","type":"Class"},{"name":"RgbTreat","href":"Hi.Disp.Treat.RgbTreat.html","topicHref":"Hi.Disp.Treat.RgbTreat.html","topicUid":"Hi.Disp.Treat.RgbTreat","type":"Class"},{"name":"RgbWrapper","href":"Hi.Disp.Treat.RgbWrapper.html","topicHref":"Hi.Disp.Treat.RgbWrapper.html","topicUid":"Hi.Disp.Treat.RgbWrapper","type":"Class"},{"name":"TransformationWrapper","href":"Hi.Disp.Treat.TransformationWrapper.html","topicHref":"Hi.Disp.Treat.TransformationWrapper.html","topicUid":"Hi.Disp.Treat.TransformationWrapper","type":"Class"}]},{"name":"Hi.Fanuc","href":"Hi.Fanuc.html","topicHref":"Hi.Fanuc.html","topicUid":"Hi.Fanuc","type":"Namespace","items":[{"name":"FanucVarTable","href":"Hi.Fanuc.FanucVarTable.html","topicHref":"Hi.Fanuc.FanucVarTable.html","topicUid":"Hi.Fanuc.FanucVarTable","type":"Class"},{"name":"FanucVarValue","href":"Hi.Fanuc.FanucVarValue.html","topicHref":"Hi.Fanuc.FanucVarValue.html","topicUid":"Hi.Fanuc.FanucVarValue","type":"Struct"}]},{"name":"Hi.Geom","href":"Hi.Geom.html","topicHref":"Hi.Geom.html","topicUid":"Hi.Geom","type":"Namespace","items":[{"name":"ArrayUtil","href":"Hi.Geom.ArrayUtil.html","topicHref":"Hi.Geom.ArrayUtil.html","topicUid":"Hi.Geom.ArrayUtil","type":"Class"},{"name":"AxisAngle4d","href":"Hi.Geom.AxisAngle4d.html","topicHref":"Hi.Geom.AxisAngle4d.html","topicUid":"Hi.Geom.AxisAngle4d","type":"Class"},{"name":"Box2d","href":"Hi.Geom.Box2d.html","topicHref":"Hi.Geom.Box2d.html","topicUid":"Hi.Geom.Box2d","type":"Class"},{"name":"Box2d.NoInit","href":"Hi.Geom.Box2d.NoInit.html","topicHref":"Hi.Geom.Box2d.NoInit.html","topicUid":"Hi.Geom.Box2d.NoInit","type":"Class"},{"name":"Box3d","href":"Hi.Geom.Box3d.html","topicHref":"Hi.Geom.Box3d.html","topicUid":"Hi.Geom.Box3d","type":"Class"},{"name":"Box3d.NoInit","href":"Hi.Geom.Box3d.NoInit.html","topicHref":"Hi.Geom.Box3d.NoInit.html","topicUid":"Hi.Geom.Box3d.NoInit","type":"Class"},{"name":"Cylindroid","href":"Hi.Geom.Cylindroid.html","topicHref":"Hi.Geom.Cylindroid.html","topicUid":"Hi.Geom.Cylindroid","type":"Class"},{"name":"DVec3d","href":"Hi.Geom.DVec3d.html","topicHref":"Hi.Geom.DVec3d.html","topicUid":"Hi.Geom.DVec3d","type":"Class"},{"name":"Dir","href":"Hi.Geom.Dir.html","topicHref":"Hi.Geom.Dir.html","topicUid":"Hi.Geom.Dir","type":"Enum"},{"name":"GeomCombination","href":"Hi.Geom.GeomCombination.html","topicHref":"Hi.Geom.GeomCombination.html","topicUid":"Hi.Geom.GeomCombination","type":"Class"},{"name":"GeomUtil","href":"Hi.Geom.GeomUtil.html","topicHref":"Hi.Geom.GeomUtil.html","topicUid":"Hi.Geom.GeomUtil","type":"Class"},{"name":"IExpandToBox2d","href":"Hi.Geom.IExpandToBox2d.html","topicHref":"Hi.Geom.IExpandToBox2d.html","topicUid":"Hi.Geom.IExpandToBox2d","type":"Interface"},{"name":"IExpandToBox3d","href":"Hi.Geom.IExpandToBox3d.html","topicHref":"Hi.Geom.IExpandToBox3d.html","topicUid":"Hi.Geom.IExpandToBox3d","type":"Interface"},{"name":"IFlat3d","href":"Hi.Geom.IFlat3d.html","topicHref":"Hi.Geom.IFlat3d.html","topicUid":"Hi.Geom.IFlat3d","type":"Interface"},{"name":"IGeomProperty","href":"Hi.Geom.IGeomProperty.html","topicHref":"Hi.Geom.IGeomProperty.html","topicUid":"Hi.Geom.IGeomProperty","type":"Interface"},{"name":"IGetStl","href":"Hi.Geom.IGetStl.html","topicHref":"Hi.Geom.IGetStl.html","topicUid":"Hi.Geom.IGetStl","type":"Interface"},{"name":"IGetZrContour","href":"Hi.Geom.IGetZrContour.html","topicHref":"Hi.Geom.IGetZrContour.html","topicUid":"Hi.Geom.IGetZrContour","type":"Interface"},{"name":"IGetZrList","href":"Hi.Geom.IGetZrList.html","topicHref":"Hi.Geom.IGetZrList.html","topicUid":"Hi.Geom.IGetZrList","type":"Interface"},{"name":"ILinearAndRoundStlResolutionHost","href":"Hi.Geom.ILinearAndRoundStlResolutionHost.html","topicHref":"Hi.Geom.ILinearAndRoundStlResolutionHost.html","topicUid":"Hi.Geom.ILinearAndRoundStlResolutionHost","type":"Interface"},{"name":"IStlSource","href":"Hi.Geom.IStlSource.html","topicHref":"Hi.Geom.IStlSource.html","topicUid":"Hi.Geom.IStlSource","type":"Interface"},{"name":"ITri3d","href":"Hi.Geom.ITri3d.html","topicHref":"Hi.Geom.ITri3d.html","topicUid":"Hi.Geom.ITri3d","type":"Interface"},{"name":"IVec","href":"Hi.Geom.IVec-1.html","topicHref":"Hi.Geom.IVec-1.html","topicUid":"Hi.Geom.IVec`1","type":"Interface"},{"name":"Mat4d","href":"Hi.Geom.Mat4d.html","topicHref":"Hi.Geom.Mat4d.html","topicUid":"Hi.Geom.Mat4d","type":"Class"},{"name":"Mat4d.IndexFlag","href":"Hi.Geom.Mat4d.IndexFlag.html","topicHref":"Hi.Geom.Mat4d.IndexFlag.html","topicUid":"Hi.Geom.Mat4d.IndexFlag","type":"Enum"},{"name":"MathNetUtil","href":"Hi.Geom.MathNetUtil.html","topicHref":"Hi.Geom.MathNetUtil.html","topicUid":"Hi.Geom.MathNetUtil","type":"Class"},{"name":"MathUtil","href":"Hi.Geom.MathUtil.html","topicHref":"Hi.Geom.MathUtil.html","topicUid":"Hi.Geom.MathUtil","type":"Class"},{"name":"NativeStl","href":"Hi.Geom.NativeStl.html","topicHref":"Hi.Geom.NativeStl.html","topicUid":"Hi.Geom.NativeStl","type":"Class"},{"name":"NativeTopoStld","href":"Hi.Geom.NativeTopoStld.html","topicHref":"Hi.Geom.NativeTopoStld.html","topicUid":"Hi.Geom.NativeTopoStld","type":"Class"},{"name":"NativeTopoStlfr","href":"Hi.Geom.NativeTopoStlfr.html","topicHref":"Hi.Geom.NativeTopoStlfr.html","topicUid":"Hi.Geom.NativeTopoStlfr","type":"Class"},{"name":"PairZr","href":"Hi.Geom.PairZr.html","topicHref":"Hi.Geom.PairZr.html","topicUid":"Hi.Geom.PairZr","type":"Class"},{"name":"PairZrUtil","href":"Hi.Geom.PairZrUtil.html","topicHref":"Hi.Geom.PairZrUtil.html","topicUid":"Hi.Geom.PairZrUtil","type":"Class"},{"name":"Polar3d","href":"Hi.Geom.Polar3d.html","topicHref":"Hi.Geom.Polar3d.html","topicUid":"Hi.Geom.Polar3d","type":"Class"},{"name":"Stl","href":"Hi.Geom.Stl.html","topicHref":"Hi.Geom.Stl.html","topicUid":"Hi.Geom.Stl","type":"Class"},{"name":"Stl.StlType","href":"Hi.Geom.Stl.StlType.html","topicHref":"Hi.Geom.Stl.StlType.html","topicUid":"Hi.Geom.Stl.StlType","type":"Enum"},{"name":"StlFile","href":"Hi.Geom.StlFile.html","topicHref":"Hi.Geom.StlFile.html","topicUid":"Hi.Geom.StlFile","type":"Class"},{"name":"StlFuncHost","href":"Hi.Geom.StlFuncHost.html","topicHref":"Hi.Geom.StlFuncHost.html","topicUid":"Hi.Geom.StlFuncHost","type":"Class"},{"name":"StlUtil","href":"Hi.Geom.StlUtil.html","topicHref":"Hi.Geom.StlUtil.html","topicUid":"Hi.Geom.StlUtil","type":"Class"},{"name":"TransformationGeom","href":"Hi.Geom.TransformationGeom.html","topicHref":"Hi.Geom.TransformationGeom.html","topicUid":"Hi.Geom.TransformationGeom","type":"Class"},{"name":"Tri3d","href":"Hi.Geom.Tri3d.html","topicHref":"Hi.Geom.Tri3d.html","topicUid":"Hi.Geom.Tri3d","type":"Class"},{"name":"Tri3dUtil","href":"Hi.Geom.Tri3dUtil.html","topicHref":"Hi.Geom.Tri3dUtil.html","topicUid":"Hi.Geom.Tri3dUtil","type":"Class"},{"name":"UnnullableDVec3d","href":"Hi.Geom.UnnullableDVec3d.html","topicHref":"Hi.Geom.UnnullableDVec3d.html","topicUid":"Hi.Geom.UnnullableDVec3d","type":"Class"},{"name":"Vec2d","href":"Hi.Geom.Vec2d.html","topicHref":"Hi.Geom.Vec2d.html","topicUid":"Hi.Geom.Vec2d","type":"Class"},{"name":"Vec2i","href":"Hi.Geom.Vec2i.html","topicHref":"Hi.Geom.Vec2i.html","topicUid":"Hi.Geom.Vec2i","type":"Class"},{"name":"Vec3d","href":"Hi.Geom.Vec3d.html","topicHref":"Hi.Geom.Vec3d.html","topicUid":"Hi.Geom.Vec3d","type":"Class"},{"name":"Vec3dUtil","href":"Hi.Geom.Vec3dUtil.html","topicHref":"Hi.Geom.Vec3dUtil.html","topicUid":"Hi.Geom.Vec3dUtil","type":"Class"}]},{"name":"Hi.Geom.Solvers","href":"Hi.Geom.Solvers.html","topicHref":"Hi.Geom.Solvers.html","topicUid":"Hi.Geom.Solvers","type":"Namespace","items":[{"name":"BinarySolverUtil","href":"Hi.Geom.Solvers.BinarySolverUtil.html","topicHref":"Hi.Geom.Solvers.BinarySolverUtil.html","topicUid":"Hi.Geom.Solvers.BinarySolverUtil","type":"Class"},{"name":"BinarySolvingStatus","href":"Hi.Geom.Solvers.BinarySolvingStatus.html","topicHref":"Hi.Geom.Solvers.BinarySolvingStatus.html","topicUid":"Hi.Geom.Solvers.BinarySolvingStatus","type":"Class"},{"name":"DeepSolvingStatus","href":"Hi.Geom.Solvers.DeepSolvingStatus.html","topicHref":"Hi.Geom.Solvers.DeepSolvingStatus.html","topicUid":"Hi.Geom.Solvers.DeepSolvingStatus","type":"Class"},{"name":"NumericalSolver","href":"Hi.Geom.Solvers.NumericalSolver.html","topicHref":"Hi.Geom.Solvers.NumericalSolver.html","topicUid":"Hi.Geom.Solvers.NumericalSolver","type":"Class"},{"name":"NumericalSolver.GetRepondsDelegate","href":"Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate.html","topicHref":"Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate.html","topicUid":"Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate","type":"Delegate"},{"name":"NumericalSolver.SetParasDelegate","href":"Hi.Geom.Solvers.NumericalSolver.SetParasDelegate.html","topicHref":"Hi.Geom.Solvers.NumericalSolver.SetParasDelegate.html","topicUid":"Hi.Geom.Solvers.NumericalSolver.SetParasDelegate","type":"Delegate"},{"name":"SolverUtil","href":"Hi.Geom.Solvers.SolverUtil.html","topicHref":"Hi.Geom.Solvers.SolverUtil.html","topicUid":"Hi.Geom.Solvers.SolverUtil","type":"Class"},{"name":"SolvingResult","href":"Hi.Geom.Solvers.SolvingResult.html","topicHref":"Hi.Geom.Solvers.SolvingResult.html","topicUid":"Hi.Geom.Solvers.SolvingResult","type":"Class"},{"name":"SolvingResultStatus","href":"Hi.Geom.Solvers.SolvingResultStatus.html","topicHref":"Hi.Geom.Solvers.SolvingResultStatus.html","topicUid":"Hi.Geom.Solvers.SolvingResultStatus","type":"Enum"},{"name":"SolvingTerm","href":"Hi.Geom.Solvers.SolvingTerm.html","topicHref":"Hi.Geom.Solvers.SolvingTerm.html","topicUid":"Hi.Geom.Solvers.SolvingTerm","type":"Enum"}]},{"name":"Hi.Geom.UnitUtils","href":"Hi.Geom.UnitUtils.html","topicHref":"Hi.Geom.UnitUtils.html","topicUid":"Hi.Geom.UnitUtils","type":"Namespace","items":[{"name":"PhysicsUnit","href":"Hi.Geom.UnitUtils.PhysicsUnit.html","topicHref":"Hi.Geom.UnitUtils.PhysicsUnit.html","topicUid":"Hi.Geom.UnitUtils.PhysicsUnit","type":"Enum"},{"name":"UnitConvertUtil","href":"Hi.Geom.UnitUtils.UnitConvertUtil.html","topicHref":"Hi.Geom.UnitUtils.UnitConvertUtil.html","topicUid":"Hi.Geom.UnitUtils.UnitConvertUtil","type":"Class"}]},{"name":"Hi.Grpcs","href":"Hi.Grpcs.html","topicHref":"Hi.Grpcs.html","topicUid":"Hi.Grpcs","type":"Namespace","items":[{"name":"ClStripService","href":"Hi.Grpcs.ClStripService.html","topicHref":"Hi.Grpcs.ClStripService.html","topicUid":"Hi.Grpcs.ClStripService","type":"Class"},{"name":"ClStripService.ClStripServiceBase","href":"Hi.Grpcs.ClStripService.ClStripServiceBase.html","topicHref":"Hi.Grpcs.ClStripService.ClStripServiceBase.html","topicUid":"Hi.Grpcs.ClStripService.ClStripServiceBase","type":"Class"},{"name":"ClStripService.ClStripServiceClient","href":"Hi.Grpcs.ClStripService.ClStripServiceClient.html","topicHref":"Hi.Grpcs.ClStripService.ClStripServiceClient.html","topicUid":"Hi.Grpcs.ClStripService.ClStripServiceClient","type":"Class"},{"name":"ClStripServiceReflection","href":"Hi.Grpcs.ClStripServiceReflection.html","topicHref":"Hi.Grpcs.ClStripServiceReflection.html","topicUid":"Hi.Grpcs.ClStripServiceReflection","type":"Class"},{"name":"ClStripServiceRunner","href":"Hi.Grpcs.ClStripServiceRunner.html","topicHref":"Hi.Grpcs.ClStripServiceRunner.html","topicUid":"Hi.Grpcs.ClStripServiceRunner","type":"Class"},{"name":"DictionaryStep","href":"Hi.Grpcs.DictionaryStep.html","topicHref":"Hi.Grpcs.DictionaryStep.html","topicUid":"Hi.Grpcs.DictionaryStep","type":"Class"},{"name":"PlayerService","href":"Hi.Grpcs.PlayerService.html","topicHref":"Hi.Grpcs.PlayerService.html","topicUid":"Hi.Grpcs.PlayerService","type":"Class"},{"name":"PlayerService.PlayerServiceBase","href":"Hi.Grpcs.PlayerService.PlayerServiceBase.html","topicHref":"Hi.Grpcs.PlayerService.PlayerServiceBase.html","topicUid":"Hi.Grpcs.PlayerService.PlayerServiceBase","type":"Class"},{"name":"PlayerService.PlayerServiceClient","href":"Hi.Grpcs.PlayerService.PlayerServiceClient.html","topicHref":"Hi.Grpcs.PlayerService.PlayerServiceClient.html","topicUid":"Hi.Grpcs.PlayerService.PlayerServiceClient","type":"Class"},{"name":"PlayerServiceReflection","href":"Hi.Grpcs.PlayerServiceReflection.html","topicHref":"Hi.Grpcs.PlayerServiceReflection.html","topicUid":"Hi.Grpcs.PlayerServiceReflection","type":"Class"},{"name":"PlayerServiceRunner","href":"Hi.Grpcs.PlayerServiceRunner.html","topicHref":"Hi.Grpcs.PlayerServiceRunner.html","topicUid":"Hi.Grpcs.PlayerServiceRunner","type":"Class"}]},{"name":"Hi.HiNcKits","href":"Hi.HiNcKits.html","topicHref":"Hi.HiNcKits.html","topicUid":"Hi.HiNcKits","type":"Namespace","items":[{"name":"BasePathEnum","href":"Hi.HiNcKits.BasePathEnum.html","topicHref":"Hi.HiNcKits.BasePathEnum.html","topicUid":"Hi.HiNcKits.BasePathEnum","type":"Enum"},{"name":"HiNcHost","href":"Hi.HiNcKits.HiNcHost.html","topicHref":"Hi.HiNcKits.HiNcHost.html","topicUid":"Hi.HiNcKits.HiNcHost","type":"Class"}]},{"name":"Hi.Licenses","href":"Hi.Licenses.html","topicHref":"Hi.Licenses.html","topicUid":"Hi.Licenses","type":"Namespace","items":[{"name":"AuthFeature","href":"Hi.Licenses.AuthFeature.html","topicHref":"Hi.Licenses.AuthFeature.html","topicUid":"Hi.Licenses.AuthFeature","type":"Enum"},{"name":"AuthorizationFailedEventArgs","href":"Hi.Licenses.AuthorizationFailedEventArgs.html","topicHref":"Hi.Licenses.AuthorizationFailedEventArgs.html","topicUid":"Hi.Licenses.AuthorizationFailedEventArgs","type":"Class"},{"name":"BlockType","href":"Hi.Licenses.BlockType.html","topicHref":"Hi.Licenses.BlockType.html","topicUid":"Hi.Licenses.BlockType","type":"Enum"},{"name":"License","href":"Hi.Licenses.License.html","topicHref":"Hi.Licenses.License.html","topicUid":"Hi.Licenses.License","type":"Class"},{"name":"LicenseType","href":"Hi.Licenses.LicenseType.html","topicHref":"Hi.Licenses.LicenseType.html","topicUid":"Hi.Licenses.LicenseType","type":"Enum"}]},{"name":"Hi.Machining","href":"Hi.Machining.html","topicHref":"Hi.Machining.html","topicUid":"Hi.Machining","type":"Namespace","items":[{"name":"FreeformCutter","href":"Hi.Machining.FreeformCutter.html","topicHref":"Hi.Machining.FreeformCutter.html","topicUid":"Hi.Machining.FreeformCutter","type":"Class"},{"name":"ICutter","href":"Hi.Machining.ICutter.html","topicHref":"Hi.Machining.ICutter.html","topicUid":"Hi.Machining.ICutter","type":"Interface"},{"name":"ICutterAnchorable","href":"Hi.Machining.ICutterAnchorable.html","topicHref":"Hi.Machining.ICutterAnchorable.html","topicUid":"Hi.Machining.ICutterAnchorable","type":"Interface"},{"name":"IGetSweptable","href":"Hi.Machining.IGetSweptable.html","topicHref":"Hi.Machining.IGetSweptable.html","topicUid":"Hi.Machining.IGetSweptable","type":"Interface"},{"name":"IMachiningTool","href":"Hi.Machining.IMachiningTool.html","topicHref":"Hi.Machining.IMachiningTool.html","topicUid":"Hi.Machining.IMachiningTool","type":"Interface"},{"name":"IVolumeRemover","href":"Hi.Machining.IVolumeRemover.html","topicHref":"Hi.Machining.IVolumeRemover.html","topicUid":"Hi.Machining.IVolumeRemover","type":"Interface"},{"name":"MachiningToolHouse","href":"Hi.Machining.MachiningToolHouse.html","topicHref":"Hi.Machining.MachiningToolHouse.html","topicUid":"Hi.Machining.MachiningToolHouse","type":"Class"},{"name":"MachiningVolumeRemovalProc","href":"Hi.Machining.MachiningVolumeRemovalProc.html","topicHref":"Hi.Machining.MachiningVolumeRemovalProc.html","topicUid":"Hi.Machining.MachiningVolumeRemovalProc","type":"Class"},{"name":"MachiningVolumeRemovalProc.StepMotionSnapshot","href":"Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.html","topicHref":"Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.html","topicUid":"Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot","type":"Class"},{"name":"MatInterpolationKit","href":"Hi.Machining.MatInterpolationKit.html","topicHref":"Hi.Machining.MatInterpolationKit.html","topicUid":"Hi.Machining.MatInterpolationKit","type":"Class"},{"name":"MatRelation","href":"Hi.Machining.MatRelation.html","topicHref":"Hi.Machining.MatRelation.html","topicUid":"Hi.Machining.MatRelation","type":"Enum"},{"name":"MatRelationUtil","href":"Hi.Machining.MatRelationUtil.html","topicHref":"Hi.Machining.MatRelationUtil.html","topicUid":"Hi.Machining.MatRelationUtil","type":"Class"},{"name":"MotionUtil","href":"Hi.Machining.MotionUtil.html","topicHref":"Hi.Machining.MotionUtil.html","topicUid":"Hi.Machining.MotionUtil","type":"Class"},{"name":"Sweptable","href":"Hi.Machining.Sweptable.html","topicHref":"Hi.Machining.Sweptable.html","topicUid":"Hi.Machining.Sweptable","type":"Class"},{"name":"SweptableUtil","href":"Hi.Machining.SweptableUtil.html","topicHref":"Hi.Machining.SweptableUtil.html","topicUid":"Hi.Machining.SweptableUtil","type":"Class"},{"name":"ToolNotFoundException","href":"Hi.Machining.ToolNotFoundException.html","topicHref":"Hi.Machining.ToolNotFoundException.html","topicUid":"Hi.Machining.ToolNotFoundException","type":"Class"}]},{"name":"Hi.Machining.MachiningEquipmentUtils","href":"Hi.Machining.MachiningEquipmentUtils.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.html","topicUid":"Hi.Machining.MachiningEquipmentUtils","type":"Namespace","items":[{"name":"CollidableComponentEnum","href":"Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum","type":"Enum"},{"name":"IGetMachiningEquipment","href":"Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment","type":"Interface"},{"name":"IMachiningEquipment","href":"Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment","type":"Interface"},{"name":"MachiningEquipment","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipment","type":"Class"},{"name":"MachiningEquipmentCollisionIndex","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex","type":"Class"},{"name":"MachiningEquipmentCollisionIndexPairsSource","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource","type":"Class"},{"name":"MachiningEquipmentUtil","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil","type":"Class"}]},{"name":"Hi.MachiningProcs","href":"Hi.MachiningProcs.html","topicHref":"Hi.MachiningProcs.html","topicUid":"Hi.MachiningProcs","type":"Namespace","items":[{"name":"ConfigStepFunc","href":"Hi.MachiningProcs.ConfigStepFunc.html","topicHref":"Hi.MachiningProcs.ConfigStepFunc.html","topicUid":"Hi.MachiningProcs.ConfigStepFunc","type":"Delegate"},{"name":"DynamicMachiningProjectDisplayee","href":"Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html","topicHref":"Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html","topicUid":"Hi.MachiningProcs.DynamicMachiningProjectDisplayee","type":"Class"},{"name":"MachiningActRunner","href":"Hi.MachiningProcs.MachiningActRunner.html","topicHref":"Hi.MachiningProcs.MachiningActRunner.html","topicUid":"Hi.MachiningProcs.MachiningActRunner","type":"Class"},{"name":"MachiningActRunner.MachiningStepBuiltDelegate","href":"Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html","topicHref":"Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html","topicUid":"Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate","type":"Delegate"},{"name":"MachiningMessage","href":"Hi.MachiningProcs.MachiningMessage.html","topicHref":"Hi.MachiningProcs.MachiningMessage.html","topicUid":"Hi.MachiningProcs.MachiningMessage","type":"Class"},{"name":"MachiningParallelProc","href":"Hi.MachiningProcs.MachiningParallelProc.html","topicHref":"Hi.MachiningProcs.MachiningParallelProc.html","topicUid":"Hi.MachiningProcs.MachiningParallelProc","type":"Class"},{"name":"MachiningParallelProc.StepTaskBundle","href":"Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html","topicHref":"Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html","topicUid":"Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle","type":"Class"},{"name":"MachiningParallelProc.SubstractionResult","href":"Hi.MachiningProcs.MachiningParallelProc.SubstractionResult.html","topicHref":"Hi.MachiningProcs.MachiningParallelProc.SubstractionResult.html","topicUid":"Hi.MachiningProcs.MachiningParallelProc.SubstractionResult","type":"Class"},{"name":"MachiningProject","href":"Hi.MachiningProcs.MachiningProject.html","topicHref":"Hi.MachiningProcs.MachiningProject.html","topicUid":"Hi.MachiningProcs.MachiningProject","type":"Class"},{"name":"MachiningProjectDisplayee","href":"Hi.MachiningProcs.MachiningProjectDisplayee.html","topicHref":"Hi.MachiningProcs.MachiningProjectDisplayee.html","topicUid":"Hi.MachiningProcs.MachiningProjectDisplayee","type":"Class"},{"name":"MachiningSession","href":"Hi.MachiningProcs.MachiningSession.html","topicHref":"Hi.MachiningProcs.MachiningSession.html","topicUid":"Hi.MachiningProcs.MachiningSession","type":"Class"},{"name":"MillingActRunnerConfig","href":"Hi.MachiningProcs.MillingActRunnerConfig.html","topicHref":"Hi.MachiningProcs.MillingActRunnerConfig.html","topicUid":"Hi.MachiningProcs.MillingActRunnerConfig","type":"Class"},{"name":"MillingUtil","href":"Hi.MachiningProcs.MillingUtil.html","topicHref":"Hi.MachiningProcs.MillingUtil.html","topicUid":"Hi.MachiningProcs.MillingUtil","type":"Class"},{"name":"RenderingFlag","href":"Hi.MachiningProcs.RenderingFlag.html","topicHref":"Hi.MachiningProcs.RenderingFlag.html","topicUid":"Hi.MachiningProcs.RenderingFlag","type":"Enum"},{"name":"SessionMessageHost","href":"Hi.MachiningProcs.SessionMessageHost.html","topicHref":"Hi.MachiningProcs.SessionMessageHost.html","topicUid":"Hi.MachiningProcs.SessionMessageHost","type":"Class"},{"name":"SessionMessageHost.AlwaysStableTorch","href":"Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch.html","topicHref":"Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch.html","topicUid":"Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch","type":"Class"},{"name":"SessionMessagePack","href":"Hi.MachiningProcs.SessionMessagePack.html","topicHref":"Hi.MachiningProcs.SessionMessagePack.html","topicUid":"Hi.MachiningProcs.SessionMessagePack","type":"Class"},{"name":"ShellApi","href":"Hi.MachiningProcs.ShellApi.html","topicHref":"Hi.MachiningProcs.ShellApi.html","topicUid":"Hi.MachiningProcs.ShellApi","type":"Class"}]},{"name":"Hi.Mapping","href":"Hi.Mapping.html","topicHref":"Hi.Mapping.html","topicUid":"Hi.Mapping","type":"Namespace","items":[{"name":"CsvNcStep","href":"Hi.Mapping.CsvNcStep.html","topicHref":"Hi.Mapping.CsvNcStep.html","topicUid":"Hi.Mapping.CsvNcStep","type":"Class"},{"name":"CsvNcStep.StepInterpoationMode","href":"Hi.Mapping.CsvNcStep.StepInterpoationMode.html","topicHref":"Hi.Mapping.CsvNcStep.StepInterpoationMode.html","topicUid":"Hi.Mapping.CsvNcStep.StepInterpoationMode","type":"Enum"},{"name":"FileToTimeShotMapping","href":"Hi.Mapping.FileToTimeShotMapping.html","topicHref":"Hi.Mapping.FileToTimeShotMapping.html","topicUid":"Hi.Mapping.FileToTimeShotMapping","type":"Class"},{"name":"IAccelerationShot","href":"Hi.Mapping.IAccelerationShot.html","topicHref":"Hi.Mapping.IAccelerationShot.html","topicUid":"Hi.Mapping.IAccelerationShot","type":"Interface"},{"name":"IForceShot","href":"Hi.Mapping.IForceShot.html","topicHref":"Hi.Mapping.IForceShot.html","topicUid":"Hi.Mapping.IForceShot","type":"Interface"},{"name":"IMomentShot","href":"Hi.Mapping.IMomentShot.html","topicHref":"Hi.Mapping.IMomentShot.html","topicUid":"Hi.Mapping.IMomentShot","type":"Interface"},{"name":"ITimeShot","href":"Hi.Mapping.ITimeShot.html","topicHref":"Hi.Mapping.ITimeShot.html","topicUid":"Hi.Mapping.ITimeShot","type":"Interface"},{"name":"StepTimeShotUtil","href":"Hi.Mapping.StepTimeShotUtil.html","topicHref":"Hi.Mapping.StepTimeShotUtil.html","topicUid":"Hi.Mapping.StepTimeShotUtil","type":"Class"},{"name":"StepTimeShotUtil.CycleSamplingMode","href":"Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html","topicHref":"Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html","topicUid":"Hi.Mapping.StepTimeShotUtil.CycleSamplingMode","type":"Enum"},{"name":"StepTimeShotUtil.GetTimeShotByFileDelegate","href":"Hi.Mapping.StepTimeShotUtil.GetTimeShotByFileDelegate.html","topicHref":"Hi.Mapping.StepTimeShotUtil.GetTimeShotByFileDelegate.html","topicUid":"Hi.Mapping.StepTimeShotUtil.GetTimeShotByFileDelegate","type":"Delegate"},{"name":"TimeMapping","href":"Hi.Mapping.TimeMapping.html","topicHref":"Hi.Mapping.TimeMapping.html","topicUid":"Hi.Mapping.TimeMapping","type":"Class"}]},{"name":"Hi.Mappings","href":"Hi.Mappings.html","topicHref":"Hi.Mappings.html","topicUid":"Hi.Mappings","type":"Namespace","items":[{"name":"FileTimeSection","href":"Hi.Mappings.FileTimeSection.html","topicHref":"Hi.Mappings.FileTimeSection.html","topicUid":"Hi.Mappings.FileTimeSection","type":"Class"},{"name":"FileTimeSection.TimeOption","href":"Hi.Mappings.FileTimeSection.TimeOption.html","topicHref":"Hi.Mappings.FileTimeSection.TimeOption.html","topicUid":"Hi.Mappings.FileTimeSection.TimeOption","type":"Enum"}]},{"name":"Hi.Mech","href":"Hi.Mech.html","topicHref":"Hi.Mech.html","topicUid":"Hi.Mech","type":"Namespace","items":[{"name":"GeneralMechanism","href":"Hi.Mech.GeneralMechanism.html","topicHref":"Hi.Mech.GeneralMechanism.html","topicUid":"Hi.Mech.GeneralMechanism","type":"Class"},{"name":"IGetAnchorToSolidDictionary","href":"Hi.Mech.IGetAnchorToSolidDictionary.html","topicHref":"Hi.Mech.IGetAnchorToSolidDictionary.html","topicUid":"Hi.Mech.IGetAnchorToSolidDictionary","type":"Interface"},{"name":"IGetMachiningChain","href":"Hi.Mech.IGetMachiningChain.html","topicHref":"Hi.Mech.IGetMachiningChain.html","topicUid":"Hi.Mech.IGetMachiningChain","type":"Interface"},{"name":"IMachiningChain","href":"Hi.Mech.IMachiningChain.html","topicHref":"Hi.Mech.IMachiningChain.html","topicUid":"Hi.Mech.IMachiningChain","type":"Interface"},{"name":"IMachiningChainSource","href":"Hi.Mech.IMachiningChainSource.html","topicHref":"Hi.Mech.IMachiningChainSource.html","topicUid":"Hi.Mech.IMachiningChainSource","type":"Interface"},{"name":"MachiningChainUtil","href":"Hi.Mech.MachiningChainUtil.html","topicHref":"Hi.Mech.MachiningChainUtil.html","topicUid":"Hi.Mech.MachiningChainUtil","type":"Class"}]},{"name":"Hi.Mech.Topo","href":"Hi.Mech.Topo.html","topicHref":"Hi.Mech.Topo.html","topicUid":"Hi.Mech.Topo","type":"Namespace","items":[{"name":"Anchor","href":"Hi.Mech.Topo.Anchor.html","topicHref":"Hi.Mech.Topo.Anchor.html","topicUid":"Hi.Mech.Topo.Anchor","type":"Class"},{"name":"AnchorFuncSource","href":"Hi.Mech.Topo.AnchorFuncSource.html","topicHref":"Hi.Mech.Topo.AnchorFuncSource.html","topicUid":"Hi.Mech.Topo.AnchorFuncSource","type":"Class"},{"name":"AnchoredBoxable","href":"Hi.Mech.Topo.AnchoredBoxable.html","topicHref":"Hi.Mech.Topo.AnchoredBoxable.html","topicUid":"Hi.Mech.Topo.AnchoredBoxable","type":"Class"},{"name":"AnchoredDisplayee","href":"Hi.Mech.Topo.AnchoredDisplayee.html","topicHref":"Hi.Mech.Topo.AnchoredDisplayee.html","topicUid":"Hi.Mech.Topo.AnchoredDisplayee","type":"Class"},{"name":"Asmb","href":"Hi.Mech.Topo.Asmb.html","topicHref":"Hi.Mech.Topo.Asmb.html","topicUid":"Hi.Mech.Topo.Asmb","type":"Class"},{"name":"AsmbDraw","href":"Hi.Mech.Topo.AsmbDraw.html","topicHref":"Hi.Mech.Topo.AsmbDraw.html","topicUid":"Hi.Mech.Topo.AsmbDraw","type":"Class"},{"name":"Branch","href":"Hi.Mech.Topo.Branch.html","topicHref":"Hi.Mech.Topo.Branch.html","topicUid":"Hi.Mech.Topo.Branch","type":"Class"},{"name":"DirectionBranchPack","href":"Hi.Mech.Topo.DirectionBranchPack.html","topicHref":"Hi.Mech.Topo.DirectionBranchPack.html","topicUid":"Hi.Mech.Topo.DirectionBranchPack","type":"Class"},{"name":"DirectionBranchPackUtil","href":"Hi.Mech.Topo.DirectionBranchPackUtil.html","topicHref":"Hi.Mech.Topo.DirectionBranchPackUtil.html","topicUid":"Hi.Mech.Topo.DirectionBranchPackUtil","type":"Class"},{"name":"DynamicFreeform","href":"Hi.Mech.Topo.DynamicFreeform.html","topicHref":"Hi.Mech.Topo.DynamicFreeform.html","topicUid":"Hi.Mech.Topo.DynamicFreeform","type":"Class"},{"name":"DynamicRotation","href":"Hi.Mech.Topo.DynamicRotation.html","topicHref":"Hi.Mech.Topo.DynamicRotation.html","topicUid":"Hi.Mech.Topo.DynamicRotation","type":"Class"},{"name":"DynamicTranslation","href":"Hi.Mech.Topo.DynamicTranslation.html","topicHref":"Hi.Mech.Topo.DynamicTranslation.html","topicUid":"Hi.Mech.Topo.DynamicTranslation","type":"Class"},{"name":"GeneralTransform","href":"Hi.Mech.Topo.GeneralTransform.html","topicHref":"Hi.Mech.Topo.GeneralTransform.html","topicUid":"Hi.Mech.Topo.GeneralTransform","type":"Class"},{"name":"IAnchoredDisplayee","href":"Hi.Mech.Topo.IAnchoredDisplayee.html","topicHref":"Hi.Mech.Topo.IAnchoredDisplayee.html","topicUid":"Hi.Mech.Topo.IAnchoredDisplayee","type":"Interface"},{"name":"IDynamicRegular","href":"Hi.Mech.Topo.IDynamicRegular.html","topicHref":"Hi.Mech.Topo.IDynamicRegular.html","topicUid":"Hi.Mech.Topo.IDynamicRegular","type":"Interface"},{"name":"IDynamicTransformer","href":"Hi.Mech.Topo.IDynamicTransformer.html","topicHref":"Hi.Mech.Topo.IDynamicTransformer.html","topicUid":"Hi.Mech.Topo.IDynamicTransformer","type":"Interface"},{"name":"IGetAnchor","href":"Hi.Mech.Topo.IGetAnchor.html","topicHref":"Hi.Mech.Topo.IGetAnchor.html","topicUid":"Hi.Mech.Topo.IGetAnchor","type":"Interface"},{"name":"IGetAnchoredDisplayeeList","href":"Hi.Mech.Topo.IGetAnchoredDisplayeeList.html","topicHref":"Hi.Mech.Topo.IGetAnchoredDisplayeeList.html","topicUid":"Hi.Mech.Topo.IGetAnchoredDisplayeeList","type":"Interface"},{"name":"IGetAsmb","href":"Hi.Mech.Topo.IGetAsmb.html","topicHref":"Hi.Mech.Topo.IGetAsmb.html","topicUid":"Hi.Mech.Topo.IGetAsmb","type":"Interface"},{"name":"IGetBuckleAnchorList","href":"Hi.Mech.Topo.IGetBuckleAnchorList.html","topicHref":"Hi.Mech.Topo.IGetBuckleAnchorList.html","topicUid":"Hi.Mech.Topo.IGetBuckleAnchorList","type":"Interface"},{"name":"IGetFletchBuckle","href":"Hi.Mech.Topo.IGetFletchBuckle.html","topicHref":"Hi.Mech.Topo.IGetFletchBuckle.html","topicUid":"Hi.Mech.Topo.IGetFletchBuckle","type":"Interface"},{"name":"IGetInverseTransformer","href":"Hi.Mech.Topo.IGetInverseTransformer.html","topicHref":"Hi.Mech.Topo.IGetInverseTransformer.html","topicUid":"Hi.Mech.Topo.IGetInverseTransformer","type":"Interface"},{"name":"IGetRootAnchor","href":"Hi.Mech.Topo.IGetRootAnchor.html","topicHref":"Hi.Mech.Topo.IGetRootAnchor.html","topicUid":"Hi.Mech.Topo.IGetRootAnchor","type":"Interface"},{"name":"IGetTopoIndex","href":"Hi.Mech.Topo.IGetTopoIndex.html","topicHref":"Hi.Mech.Topo.IGetTopoIndex.html","topicUid":"Hi.Mech.Topo.IGetTopoIndex","type":"Interface"},{"name":"IStaticTransformer","href":"Hi.Mech.Topo.IStaticTransformer.html","topicHref":"Hi.Mech.Topo.IStaticTransformer.html","topicUid":"Hi.Mech.Topo.IStaticTransformer","type":"Interface"},{"name":"ITransformer","href":"Hi.Mech.Topo.ITransformer.html","topicHref":"Hi.Mech.Topo.ITransformer.html","topicUid":"Hi.Mech.Topo.ITransformer","type":"Interface"},{"name":"ITransformerProperty","href":"Hi.Mech.Topo.ITransformerProperty.html","topicHref":"Hi.Mech.Topo.ITransformerProperty.html","topicUid":"Hi.Mech.Topo.ITransformerProperty","type":"Interface"},{"name":"NoTransform","href":"Hi.Mech.Topo.NoTransform.html","topicHref":"Hi.Mech.Topo.NoTransform.html","topicUid":"Hi.Mech.Topo.NoTransform","type":"Class"},{"name":"StackTransformer","href":"Hi.Mech.Topo.StackTransformer.html","topicHref":"Hi.Mech.Topo.StackTransformer.html","topicUid":"Hi.Mech.Topo.StackTransformer","type":"Class"},{"name":"StaticFreeform","href":"Hi.Mech.Topo.StaticFreeform.html","topicHref":"Hi.Mech.Topo.StaticFreeform.html","topicUid":"Hi.Mech.Topo.StaticFreeform","type":"Class"},{"name":"StaticRotation","href":"Hi.Mech.Topo.StaticRotation.html","topicHref":"Hi.Mech.Topo.StaticRotation.html","topicUid":"Hi.Mech.Topo.StaticRotation","type":"Class"},{"name":"StaticTranslation","href":"Hi.Mech.Topo.StaticTranslation.html","topicHref":"Hi.Mech.Topo.StaticTranslation.html","topicUid":"Hi.Mech.Topo.StaticTranslation","type":"Class"},{"name":"TopoReflection","href":"Hi.Mech.Topo.TopoReflection.html","topicHref":"Hi.Mech.Topo.TopoReflection.html","topicUid":"Hi.Mech.Topo.TopoReflection","type":"Class"},{"name":"TopoUtil","href":"Hi.Mech.Topo.TopoUtil.html","topicHref":"Hi.Mech.Topo.TopoUtil.html","topicUid":"Hi.Mech.Topo.TopoUtil","type":"Class"},{"name":"TransformerUtil","href":"Hi.Mech.Topo.TransformerUtil.html","topicHref":"Hi.Mech.Topo.TransformerUtil.html","topicUid":"Hi.Mech.Topo.TransformerUtil","type":"Class"}]},{"name":"Hi.Milling","href":"Hi.Milling.html","topicHref":"Hi.Milling.html","topicUid":"Hi.Milling","type":"Namespace","items":[{"name":"IGetDiameter","href":"Hi.Milling.IGetDiameter.html","topicHref":"Hi.Milling.IGetDiameter.html","topicUid":"Hi.Milling.IGetDiameter","type":"Interface"},{"name":"IGetFluteHeight","href":"Hi.Milling.IGetFluteHeight.html","topicHref":"Hi.Milling.IGetFluteHeight.html","topicUid":"Hi.Milling.IGetFluteHeight","type":"Interface"},{"name":"IGetMillingGeomBrief","href":"Hi.Milling.IGetMillingGeomBrief.html","topicHref":"Hi.Milling.IGetMillingGeomBrief.html","topicUid":"Hi.Milling.IGetMillingGeomBrief","type":"Interface"},{"name":"IGetRadialReliefAngle","href":"Hi.Milling.IGetRadialReliefAngle.html","topicHref":"Hi.Milling.IGetRadialReliefAngle.html","topicUid":"Hi.Milling.IGetRadialReliefAngle","type":"Interface"},{"name":"IMillingGeomBriefAccessor","href":"Hi.Milling.IMillingGeomBriefAccessor.html","topicHref":"Hi.Milling.IMillingGeomBriefAccessor.html","topicUid":"Hi.Milling.IMillingGeomBriefAccessor","type":"Interface"},{"name":"MillingGeomBrief","href":"Hi.Milling.MillingGeomBrief.html","topicHref":"Hi.Milling.MillingGeomBrief.html","topicUid":"Hi.Milling.MillingGeomBrief","type":"Class"},{"name":"MillingRemovalUtil","href":"Hi.Milling.MillingRemovalUtil.html","topicHref":"Hi.Milling.MillingRemovalUtil.html","topicUid":"Hi.Milling.MillingRemovalUtil","type":"Class"},{"name":"SpindleCapability","href":"Hi.Milling.SpindleCapability.html","topicHref":"Hi.Milling.SpindleCapability.html","topicUid":"Hi.Milling.SpindleCapability","type":"Class"}]},{"name":"Hi.Milling.Apts","href":"Hi.Milling.Apts.html","topicHref":"Hi.Milling.Apts.html","topicUid":"Hi.Milling.Apts","type":"Namespace","items":[{"name":"AptDerivative","href":"Hi.Milling.Apts.AptDerivative.html","topicHref":"Hi.Milling.Apts.AptDerivative.html","topicUid":"Hi.Milling.Apts.AptDerivative","type":"Class"},{"name":"BallApt","href":"Hi.Milling.Apts.BallApt.html","topicHref":"Hi.Milling.Apts.BallApt.html","topicUid":"Hi.Milling.Apts.BallApt","type":"Class"},{"name":"BullNoseApt","href":"Hi.Milling.Apts.BullNoseApt.html","topicHref":"Hi.Milling.Apts.BullNoseApt.html","topicUid":"Hi.Milling.Apts.BullNoseApt","type":"Class"},{"name":"ColumnApt","href":"Hi.Milling.Apts.ColumnApt.html","topicHref":"Hi.Milling.Apts.ColumnApt.html","topicUid":"Hi.Milling.Apts.ColumnApt","type":"Class"},{"name":"ConeApt","href":"Hi.Milling.Apts.ConeApt.html","topicHref":"Hi.Milling.Apts.ConeApt.html","topicUid":"Hi.Milling.Apts.ConeApt","type":"Class"},{"name":"ExactColumnApt","href":"Hi.Milling.Apts.ExactColumnApt.html","topicHref":"Hi.Milling.Apts.ExactColumnApt.html","topicUid":"Hi.Milling.Apts.ExactColumnApt","type":"Class"},{"name":"GeneralApt","href":"Hi.Milling.Apts.GeneralApt.html","topicHref":"Hi.Milling.Apts.GeneralApt.html","topicUid":"Hi.Milling.Apts.GeneralApt","type":"Class"},{"name":"IAptAlpha","href":"Hi.Milling.Apts.IAptAlpha.html","topicHref":"Hi.Milling.Apts.IAptAlpha.html","topicUid":"Hi.Milling.Apts.IAptAlpha","type":"Interface"},{"name":"IAptBased","href":"Hi.Milling.Apts.IAptBased.html","topicHref":"Hi.Milling.Apts.IAptBased.html","topicUid":"Hi.Milling.Apts.IAptBased","type":"Interface"},{"name":"IAptBeta","href":"Hi.Milling.Apts.IAptBeta.html","topicHref":"Hi.Milling.Apts.IAptBeta.html","topicUid":"Hi.Milling.Apts.IAptBeta","type":"Interface"},{"name":"IAptRc","href":"Hi.Milling.Apts.IAptRc.html","topicHref":"Hi.Milling.Apts.IAptRc.html","topicUid":"Hi.Milling.Apts.IAptRc","type":"Interface"},{"name":"IAptRr","href":"Hi.Milling.Apts.IAptRr.html","topicHref":"Hi.Milling.Apts.IAptRr.html","topicUid":"Hi.Milling.Apts.IAptRr","type":"Interface"},{"name":"IAptRz","href":"Hi.Milling.Apts.IAptRz.html","topicHref":"Hi.Milling.Apts.IAptRz.html","topicUid":"Hi.Milling.Apts.IAptRz","type":"Interface"},{"name":"IGetApt","href":"Hi.Milling.Apts.IGetApt.html","topicHref":"Hi.Milling.Apts.IGetApt.html","topicUid":"Hi.Milling.Apts.IGetApt","type":"Interface"},{"name":"IGetGeneralApt","href":"Hi.Milling.Apts.IGetGeneralApt.html","topicHref":"Hi.Milling.Apts.IGetGeneralApt.html","topicUid":"Hi.Milling.Apts.IGetGeneralApt","type":"Interface"},{"name":"TaperApt","href":"Hi.Milling.Apts.TaperApt.html","topicHref":"Hi.Milling.Apts.TaperApt.html","topicUid":"Hi.Milling.Apts.TaperApt","type":"Class"},{"name":"apt_t","href":"Hi.Milling.Apts.apt_t.html","topicHref":"Hi.Milling.Apts.apt_t.html","topicUid":"Hi.Milling.Apts.apt_t","type":"Struct"}]},{"name":"Hi.Milling.Cutters","href":"Hi.Milling.Cutters.html","topicHref":"Hi.Milling.Cutters.html","topicUid":"Hi.Milling.Cutters","type":"Namespace","items":[{"name":"AptProfile","href":"Hi.Milling.Cutters.AptProfile.html","topicHref":"Hi.Milling.Cutters.AptProfile.html","topicUid":"Hi.Milling.Cutters.AptProfile","type":"Class"},{"name":"ConstRatioProfile","href":"Hi.Milling.Cutters.ConstRatioProfile.html","topicHref":"Hi.Milling.Cutters.ConstRatioProfile.html","topicUid":"Hi.Milling.Cutters.ConstRatioProfile","type":"Class"},{"name":"CustomSpinningProfile","href":"Hi.Milling.Cutters.CustomSpinningProfile.html","topicHref":"Hi.Milling.Cutters.CustomSpinningProfile.html","topicUid":"Hi.Milling.Cutters.CustomSpinningProfile","type":"Class"},{"name":"CutterUtil","href":"Hi.Milling.Cutters.CutterUtil.html","topicHref":"Hi.Milling.Cutters.CutterUtil.html","topicUid":"Hi.Milling.Cutters.CutterUtil","type":"Class"},{"name":"FluteContourDisplayee","href":"Hi.Milling.Cutters.FluteContourDisplayee.html","topicHref":"Hi.Milling.Cutters.FluteContourDisplayee.html","topicUid":"Hi.Milling.Cutters.FluteContourDisplayee","type":"Class"},{"name":"FluteDependentRatioProfile","href":"Hi.Milling.Cutters.FluteDependentRatioProfile.html","topicHref":"Hi.Milling.Cutters.FluteDependentRatioProfile.html","topicUid":"Hi.Milling.Cutters.FluteDependentRatioProfile","type":"Class"},{"name":"IShaperProfile","href":"Hi.Milling.Cutters.IShaperProfile.html","topicHref":"Hi.Milling.Cutters.IShaperProfile.html","topicUid":"Hi.Milling.Cutters.IShaperProfile","type":"Interface"},{"name":"MillingCutter","href":"Hi.Milling.Cutters.MillingCutter.html","topicHref":"Hi.Milling.Cutters.MillingCutter.html","topicUid":"Hi.Milling.Cutters.MillingCutter","type":"Class"},{"name":"MillingCutter.IntegralModeEnum","href":"Hi.Milling.Cutters.MillingCutter.IntegralModeEnum.html","topicHref":"Hi.Milling.Cutters.MillingCutter.IntegralModeEnum.html","topicUid":"Hi.Milling.Cutters.MillingCutter.IntegralModeEnum","type":"Enum"},{"name":"MillingCutter.MassAssignmentMode","href":"Hi.Milling.Cutters.MillingCutter.MassAssignmentMode.html","topicHref":"Hi.Milling.Cutters.MillingCutter.MassAssignmentMode.html","topicUid":"Hi.Milling.Cutters.MillingCutter.MassAssignmentMode","type":"Enum"},{"name":"MillingCutterEditorDisplayee","href":"Hi.Milling.Cutters.MillingCutterEditorDisplayee.html","topicHref":"Hi.Milling.Cutters.MillingCutterEditorDisplayee.html","topicUid":"Hi.Milling.Cutters.MillingCutterEditorDisplayee","type":"Class"}]},{"name":"Hi.Milling.Engagements","href":"Hi.Milling.Engagements.html","topicHref":"Hi.Milling.Engagements.html","topicUid":"Hi.Milling.Engagements","type":"Namespace","items":[{"name":"BitwiseMillingEngagement","href":"Hi.Milling.Engagements.BitwiseMillingEngagement.html","topicHref":"Hi.Milling.Engagements.BitwiseMillingEngagement.html","topicUid":"Hi.Milling.Engagements.BitwiseMillingEngagement","type":"Class"},{"name":"EngagementLayer","href":"Hi.Milling.Engagements.EngagementLayer.html","topicHref":"Hi.Milling.Engagements.EngagementLayer.html","topicUid":"Hi.Milling.Engagements.EngagementLayer","type":"Class"},{"name":"EngagementSlice","href":"Hi.Milling.Engagements.EngagementSlice.html","topicHref":"Hi.Milling.Engagements.EngagementSlice.html","topicUid":"Hi.Milling.Engagements.EngagementSlice","type":"Class"},{"name":"IBitwiseMillingEngagementSupport","href":"Hi.Milling.Engagements.IBitwiseMillingEngagementSupport.html","topicHref":"Hi.Milling.Engagements.IBitwiseMillingEngagementSupport.html","topicUid":"Hi.Milling.Engagements.IBitwiseMillingEngagementSupport","type":"Interface"},{"name":"IGetLayerMillingEngagement","href":"Hi.Milling.Engagements.IGetLayerMillingEngagement.html","topicHref":"Hi.Milling.Engagements.IGetLayerMillingEngagement.html","topicUid":"Hi.Milling.Engagements.IGetLayerMillingEngagement","type":"Interface"},{"name":"LayerMillingEngagement","href":"Hi.Milling.Engagements.LayerMillingEngagement.html","topicHref":"Hi.Milling.Engagements.LayerMillingEngagement.html","topicUid":"Hi.Milling.Engagements.LayerMillingEngagement","type":"Class"},{"name":"MillingEngagementUtil","href":"Hi.Milling.Engagements.MillingEngagementUtil.html","topicHref":"Hi.Milling.Engagements.MillingEngagementUtil.html","topicUid":"Hi.Milling.Engagements.MillingEngagementUtil","type":"Class"}]},{"name":"Hi.Milling.FluteContours","href":"Hi.Milling.FluteContours.html","topicHref":"Hi.Milling.FluteContours.html","topicUid":"Hi.Milling.FluteContours","type":"Namespace","items":[{"name":"ConstHelixSideContour","href":"Hi.Milling.FluteContours.ConstHelixSideContour.html","topicHref":"Hi.Milling.FluteContours.ConstHelixSideContour.html","topicUid":"Hi.Milling.FluteContours.ConstHelixSideContour","type":"Class"},{"name":"FluteContour","href":"Hi.Milling.FluteContours.FluteContour.html","topicHref":"Hi.Milling.FluteContours.FluteContour.html","topicUid":"Hi.Milling.FluteContours.FluteContour","type":"Class"},{"name":"FluteContourUtil","href":"Hi.Milling.FluteContours.FluteContourUtil.html","topicHref":"Hi.Milling.FluteContours.FluteContourUtil.html","topicUid":"Hi.Milling.FluteContours.FluteContourUtil","type":"Class"},{"name":"FreeContourTray","href":"Hi.Milling.FluteContours.FreeContourTray.html","topicHref":"Hi.Milling.FluteContours.FreeContourTray.html","topicUid":"Hi.Milling.FluteContours.FreeContourTray","type":"Class"},{"name":"FreeformSideContour","href":"Hi.Milling.FluteContours.FreeformSideContour.html","topicHref":"Hi.Milling.FluteContours.FreeformSideContour.html","topicUid":"Hi.Milling.FluteContours.FreeformSideContour","type":"Class"},{"name":"IBottomContour","href":"Hi.Milling.FluteContours.IBottomContour.html","topicHref":"Hi.Milling.FluteContours.IBottomContour.html","topicUid":"Hi.Milling.FluteContours.IBottomContour","type":"Interface"},{"name":"IContourTray","href":"Hi.Milling.FluteContours.IContourTray.html","topicHref":"Hi.Milling.FluteContours.IContourTray.html","topicUid":"Hi.Milling.FluteContours.IContourTray","type":"Interface"},{"name":"ISideContour","href":"Hi.Milling.FluteContours.ISideContour.html","topicHref":"Hi.Milling.FluteContours.ISideContour.html","topicUid":"Hi.Milling.FluteContours.ISideContour","type":"Interface"},{"name":"IWorkingContour","href":"Hi.Milling.FluteContours.IWorkingContour.html","topicHref":"Hi.Milling.FluteContours.IWorkingContour.html","topicUid":"Hi.Milling.FluteContours.IWorkingContour","type":"Interface"},{"name":"ShiftedWorkingContour","href":"Hi.Milling.FluteContours.ShiftedWorkingContour.html","topicHref":"Hi.Milling.FluteContours.ShiftedWorkingContour.html","topicUid":"Hi.Milling.FluteContours.ShiftedWorkingContour","type":"Class"},{"name":"SideContourDisplayee","href":"Hi.Milling.FluteContours.SideContourDisplayee.html","topicHref":"Hi.Milling.FluteContours.SideContourDisplayee.html","topicUid":"Hi.Milling.FluteContours.SideContourDisplayee","type":"Class"},{"name":"SlideBottomContour","href":"Hi.Milling.FluteContours.SlideBottomContour.html","topicHref":"Hi.Milling.FluteContours.SlideBottomContour.html","topicUid":"Hi.Milling.FluteContours.SlideBottomContour","type":"Class"},{"name":"SpanContourPos4d","href":"Hi.Milling.FluteContours.SpanContourPos4d.html","topicHref":"Hi.Milling.FluteContours.SpanContourPos4d.html","topicUid":"Hi.Milling.FluteContours.SpanContourPos4d","type":"Class"},{"name":"UniformContourTray","href":"Hi.Milling.FluteContours.UniformContourTray.html","topicHref":"Hi.Milling.FluteContours.UniformContourTray.html","topicUid":"Hi.Milling.FluteContours.UniformContourTray","type":"Class"}]},{"name":"Hi.MillingForces","href":"Hi.MillingForces.html","topicHref":"Hi.MillingForces.html","topicUid":"Hi.MillingForces","type":"Namespace","items":[{"name":"FluteZData","href":"Hi.MillingForces.FluteZData.html","topicHref":"Hi.MillingForces.FluteZData.html","topicUid":"Hi.MillingForces.FluteZData","type":"Class"},{"name":"IGetMillingForce","href":"Hi.MillingForces.IGetMillingForce.html","topicHref":"Hi.MillingForces.IGetMillingForce.html","topicUid":"Hi.MillingForces.IGetMillingForce","type":"Interface"},{"name":"IMillingForceAccessor","href":"Hi.MillingForces.IMillingForceAccessor.html","topicHref":"Hi.MillingForces.IMillingForceAccessor.html","topicUid":"Hi.MillingForces.IMillingForceAccessor","type":"Interface"},{"name":"MillingForce","href":"Hi.MillingForces.MillingForce.html","topicHref":"Hi.MillingForces.MillingForce.html","topicUid":"Hi.MillingForces.MillingForce","type":"Class"},{"name":"MillingForceLicense","href":"Hi.MillingForces.MillingForceLicense.html","topicHref":"Hi.MillingForces.MillingForceLicense.html","topicUid":"Hi.MillingForces.MillingForceLicense","type":"Class"},{"name":"MillingForceLuggage","href":"Hi.MillingForces.MillingForceLuggage.html","topicHref":"Hi.MillingForces.MillingForceLuggage.html","topicUid":"Hi.MillingForces.MillingForceLuggage","type":"Class"},{"name":"MillingForceUtil","href":"Hi.MillingForces.MillingForceUtil.html","topicHref":"Hi.MillingForces.MillingForceUtil.html","topicUid":"Hi.MillingForces.MillingForceUtil","type":"Class"},{"name":"MillingForceUtil.AnglePack","href":"Hi.MillingForces.MillingForceUtil.AnglePack.html","topicHref":"Hi.MillingForces.MillingForceUtil.AnglePack.html","topicUid":"Hi.MillingForces.MillingForceUtil.AnglePack","type":"Class"},{"name":"RakeFacePhysicsBrief","href":"Hi.MillingForces.RakeFacePhysicsBrief.html","topicHref":"Hi.MillingForces.RakeFacePhysicsBrief.html","topicUid":"Hi.MillingForces.RakeFacePhysicsBrief","type":"Class"},{"name":"ToolObservationReference","href":"Hi.MillingForces.ToolObservationReference.html","topicHref":"Hi.MillingForces.ToolObservationReference.html","topicUid":"Hi.MillingForces.ToolObservationReference","type":"Enum"}]},{"name":"Hi.MillingForces.Fittings","href":"Hi.MillingForces.Fittings.html","topicHref":"Hi.MillingForces.Fittings.html","topicUid":"Hi.MillingForces.Fittings","type":"Namespace","items":[{"name":"CuttingParaUtil","href":"Hi.MillingForces.Fittings.CuttingParaUtil.html","topicHref":"Hi.MillingForces.Fittings.CuttingParaUtil.html","topicUid":"Hi.MillingForces.Fittings.CuttingParaUtil","type":"Class"},{"name":"ICuttingPara","href":"Hi.MillingForces.Fittings.ICuttingPara.html","topicHref":"Hi.MillingForces.Fittings.ICuttingPara.html","topicUid":"Hi.MillingForces.Fittings.ICuttingPara","type":"Interface"},{"name":"IGetCuttingPara","href":"Hi.MillingForces.Fittings.IGetCuttingPara.html","topicHref":"Hi.MillingForces.Fittings.IGetCuttingPara.html","topicUid":"Hi.MillingForces.Fittings.IGetCuttingPara","type":"Interface"},{"name":"SampleCategory","href":"Hi.MillingForces.Fittings.SampleCategory.html","topicHref":"Hi.MillingForces.Fittings.SampleCategory.html","topicUid":"Hi.MillingForces.Fittings.SampleCategory","type":"Class"},{"name":"SampleFlag","href":"Hi.MillingForces.Fittings.SampleFlag.html","topicHref":"Hi.MillingForces.Fittings.SampleFlag.html","topicUid":"Hi.MillingForces.Fittings.SampleFlag","type":"Enum"},{"name":"SampleFlagUtil","href":"Hi.MillingForces.Fittings.SampleFlagUtil.html","topicHref":"Hi.MillingForces.Fittings.SampleFlagUtil.html","topicUid":"Hi.MillingForces.Fittings.SampleFlagUtil","type":"Class"},{"name":"SampleInstance","href":"Hi.MillingForces.Fittings.SampleInstance.html","topicHref":"Hi.MillingForces.Fittings.SampleInstance.html","topicUid":"Hi.MillingForces.Fittings.SampleInstance","type":"Class"},{"name":"TimeForce","href":"Hi.MillingForces.Fittings.TimeForce.html","topicHref":"Hi.MillingForces.Fittings.TimeForce.html","topicUid":"Hi.MillingForces.Fittings.TimeForce","type":"Class"},{"name":"TimeForceFrequencyDomain","href":"Hi.MillingForces.Fittings.TimeForceFrequencyDomain.html","topicHref":"Hi.MillingForces.Fittings.TimeForceFrequencyDomain.html","topicUid":"Hi.MillingForces.Fittings.TimeForceFrequencyDomain","type":"Class"},{"name":"TimeForceSeries","href":"Hi.MillingForces.Fittings.TimeForceSeries.html","topicHref":"Hi.MillingForces.Fittings.TimeForceSeries.html","topicUid":"Hi.MillingForces.Fittings.TimeForceSeries","type":"Class"},{"name":"TimeForceUtil","href":"Hi.MillingForces.Fittings.TimeForceUtil.html","topicHref":"Hi.MillingForces.Fittings.TimeForceUtil.html","topicUid":"Hi.MillingForces.Fittings.TimeForceUtil","type":"Class"},{"name":"TimeVsForceSeries","href":"Hi.MillingForces.Fittings.TimeVsForceSeries.html","topicHref":"Hi.MillingForces.Fittings.TimeVsForceSeries.html","topicUid":"Hi.MillingForces.Fittings.TimeVsForceSeries","type":"Class"},{"name":"TimeVsTorqueSeries","href":"Hi.MillingForces.Fittings.TimeVsTorqueSeries.html","topicHref":"Hi.MillingForces.Fittings.TimeVsTorqueSeries.html","topicUid":"Hi.MillingForces.Fittings.TimeVsTorqueSeries","type":"Class"},{"name":"TrainingSample","href":"Hi.MillingForces.Fittings.TrainingSample.html","topicHref":"Hi.MillingForces.Fittings.TrainingSample.html","topicUid":"Hi.MillingForces.Fittings.TrainingSample","type":"Class"}]},{"name":"Hi.MillingForces.ProfileMillingParas","href":"Hi.MillingForces.ProfileMillingParas.html","topicHref":"Hi.MillingForces.ProfileMillingParas.html","topicUid":"Hi.MillingForces.ProfileMillingParas","type":"Namespace","items":[{"name":"IGetLocalProfileMillingPara","href":"Hi.MillingForces.ProfileMillingParas.IGetLocalProfileMillingPara.html","topicHref":"Hi.MillingForces.ProfileMillingParas.IGetLocalProfileMillingPara.html","topicUid":"Hi.MillingForces.ProfileMillingParas.IGetLocalProfileMillingPara","type":"Interface"},{"name":"LocalProfileMillingPara","href":"Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html","topicHref":"Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html","topicUid":"Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara","type":"Class"},{"name":"ProfileMillingParaMap","href":"Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html","topicHref":"Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html","topicUid":"Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap","type":"Class"},{"name":"RtaMillingParaKey","href":"Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey.html","topicHref":"Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey.html","topicUid":"Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey","type":"Enum"}]},{"name":"Hi.MillingForces.ProjectedRakeFaceCuttingParas","href":"Hi.MillingForces.ProjectedRakeFaceCuttingParas.html","topicHref":"Hi.MillingForces.ProjectedRakeFaceCuttingParas.html","topicUid":"Hi.MillingForces.ProjectedRakeFaceCuttingParas","type":"Namespace","items":[{"name":"RakeFace2DCuttingPara","href":"Hi.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara.html","topicHref":"Hi.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara.html","topicUid":"Hi.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara","type":"Class"}]},{"name":"Hi.MillingForces.RakeFaceCuttingParas","href":"Hi.MillingForces.RakeFaceCuttingParas.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas","type":"Namespace","items":[{"name":"MillingPhysicsUtil","href":"Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil","type":"Class"},{"name":"MultiFormRakeFaceCuttingPara","href":"Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara","type":"Class"},{"name":"RakeFaceCuttingPara","href":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara","type":"Class"},{"name":"RakeFaceCuttingParaMap","href":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap","type":"Class"}]},{"name":"Hi.MillingForces.Training","href":"Hi.MillingForces.Training.html","topicHref":"Hi.MillingForces.Training.html","topicUid":"Hi.MillingForces.Training","type":"Namespace","items":[{"name":"MillingTraining","href":"Hi.MillingForces.Training.MillingTraining.html","topicHref":"Hi.MillingForces.Training.MillingTraining.html","topicUid":"Hi.MillingForces.Training.MillingTraining","type":"Class"}]},{"name":"Hi.MillingMech.MillingTools","href":"Hi.MillingMech.MillingTools.html","topicHref":"Hi.MillingMech.MillingTools.html","topicUid":"Hi.MillingMech.MillingTools","type":"Namespace","items":[{"name":"MillingToolAnchorReference","href":"Hi.MillingMech.MillingTools.MillingToolAnchorReference.html","topicHref":"Hi.MillingMech.MillingTools.MillingToolAnchorReference.html","topicUid":"Hi.MillingMech.MillingTools.MillingToolAnchorReference","type":"Enum"},{"name":"MillingToolUtil","href":"Hi.MillingMech.MillingTools.MillingToolUtil.html","topicHref":"Hi.MillingMech.MillingTools.MillingToolUtil.html","topicUid":"Hi.MillingMech.MillingTools.MillingToolUtil","type":"Class"},{"name":"StickMachiningTool","href":"Hi.MillingMech.MillingTools.StickMachiningTool.html","topicHref":"Hi.MillingMech.MillingTools.StickMachiningTool.html","topicUid":"Hi.MillingMech.MillingTools.StickMachiningTool","type":"Class"},{"name":"StickMachiningTool.CutterAlignmentMode","href":"Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode.html","topicHref":"Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode.html","topicUid":"Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode","type":"Enum"}]},{"name":"Hi.MillingProcs","href":"Hi.MillingProcs.html","topicHref":"Hi.MillingProcs.html","topicUid":"Hi.MillingProcs","type":"Namespace","items":[{"name":"MillingGuide","href":"Hi.MillingProcs.MillingGuide.html","topicHref":"Hi.MillingProcs.MillingGuide.html","topicUid":"Hi.MillingProcs.MillingGuide","type":"Class"}]},{"name":"Hi.MillingStepUtils","href":"Hi.MillingStepUtils.html","topicHref":"Hi.MillingStepUtils.html","topicUid":"Hi.MillingStepUtils","type":"Namespace","items":[{"name":"ClStripChartConfig","href":"Hi.MillingStepUtils.ClStripChartConfig.html","topicHref":"Hi.MillingStepUtils.ClStripChartConfig.html","topicUid":"Hi.MillingStepUtils.ClStripChartConfig","type":"Class"},{"name":"ClStripChartItemConfig","href":"Hi.MillingStepUtils.ClStripChartItemConfig.html","topicHref":"Hi.MillingStepUtils.ClStripChartItemConfig.html","topicUid":"Hi.MillingStepUtils.ClStripChartItemConfig","type":"Class"},{"name":"ForceCycleFlag","href":"Hi.MillingStepUtils.ForceCycleFlag.html","topicHref":"Hi.MillingStepUtils.ForceCycleFlag.html","topicUid":"Hi.MillingStepUtils.ForceCycleFlag","type":"Enum"},{"name":"ForceCycleLineDivConfig","href":"Hi.MillingStepUtils.ForceCycleLineDivConfig.html","topicHref":"Hi.MillingStepUtils.ForceCycleLineDivConfig.html","topicUid":"Hi.MillingStepUtils.ForceCycleLineDivConfig","type":"Class"},{"name":"LineChartVRangeMode","href":"Hi.MillingStepUtils.LineChartVRangeMode.html","topicHref":"Hi.MillingStepUtils.LineChartVRangeMode.html","topicUid":"Hi.MillingStepUtils.LineChartVRangeMode","type":"Enum"},{"name":"SpindleMomentCycleLineDivConfig","href":"Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html","topicHref":"Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html","topicUid":"Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig","type":"Class"},{"name":"TimeChartYConfig","href":"Hi.MillingStepUtils.TimeChartYConfig.html","topicHref":"Hi.MillingStepUtils.TimeChartYConfig.html","topicUid":"Hi.MillingStepUtils.TimeChartYConfig","type":"Class"}]},{"name":"Hi.MillingSteps","href":"Hi.MillingSteps.html","topicHref":"Hi.MillingSteps.html","topicUid":"Hi.MillingSteps","type":"Namespace","items":[{"name":"IGetSourceCommand","href":"Hi.MillingSteps.IGetSourceCommand.html","topicHref":"Hi.MillingSteps.IGetSourceCommand.html","topicUid":"Hi.MillingSteps.IGetSourceCommand","type":"Interface"},{"name":"IMachiningStepHost","href":"Hi.MillingSteps.IMachiningStepHost.html","topicHref":"Hi.MillingSteps.IMachiningStepHost.html","topicUid":"Hi.MillingSteps.IMachiningStepHost","type":"Interface"},{"name":"ISourceCommand","href":"Hi.MillingSteps.ISourceCommand.html","topicHref":"Hi.MillingSteps.ISourceCommand.html","topicUid":"Hi.MillingSteps.ISourceCommand","type":"Interface"},{"name":"MachineMotionStep","href":"Hi.MillingSteps.MachineMotionStep.html","topicHref":"Hi.MillingSteps.MachineMotionStep.html","topicUid":"Hi.MillingSteps.MachineMotionStep","type":"Class"},{"name":"MachiningStep","href":"Hi.MillingSteps.MachiningStep.html","topicHref":"Hi.MillingSteps.MachiningStep.html","topicUid":"Hi.MillingSteps.MachiningStep","type":"Class"},{"name":"MillingPhysicsStep","href":"Hi.MillingSteps.MillingPhysicsStep.html","topicHref":"Hi.MillingSteps.MillingPhysicsStep.html","topicUid":"Hi.MillingSteps.MillingPhysicsStep","type":"Class"},{"name":"MillingStepLuggage","href":"Hi.MillingSteps.MillingStepLuggage.html","topicHref":"Hi.MillingSteps.MillingStepLuggage.html","topicUid":"Hi.MillingSteps.MillingStepLuggage","type":"Class"},{"name":"MillingStepUtil","href":"Hi.MillingSteps.MillingStepUtil.html","topicHref":"Hi.MillingSteps.MillingStepUtil.html","topicUid":"Hi.MillingSteps.MillingStepUtil","type":"Class"},{"name":"PresentAttribute","href":"Hi.MillingSteps.PresentAttribute.html","topicHref":"Hi.MillingSteps.PresentAttribute.html","topicUid":"Hi.MillingSteps.PresentAttribute","type":"Class"},{"name":"StepPropertyAccess","href":"Hi.MillingSteps.StepPropertyAccess.html","topicHref":"Hi.MillingSteps.StepPropertyAccess.html","topicUid":"Hi.MillingSteps.StepPropertyAccess","type":"Class"},{"name":"StringValueAttribute","href":"Hi.MillingSteps.StringValueAttribute.html","topicHref":"Hi.MillingSteps.StringValueAttribute.html","topicUid":"Hi.MillingSteps.StringValueAttribute","type":"Class"}]},{"name":"Hi.MongoUtils","href":"Hi.MongoUtils.html","topicHref":"Hi.MongoUtils.html","topicUid":"Hi.MongoUtils","type":"Namespace","items":[{"name":"IMongoRunner","href":"Hi.MongoUtils.IMongoRunner.html","topicHref":"Hi.MongoUtils.IMongoRunner.html","topicUid":"Hi.MongoUtils.IMongoRunner","type":"Interface"},{"name":"MongoRunnerOptions","href":"Hi.MongoUtils.MongoRunnerOptions.html","topicHref":"Hi.MongoUtils.MongoRunnerOptions.html","topicUid":"Hi.MongoUtils.MongoRunnerOptions","type":"Class"},{"name":"MongoServer","href":"Hi.MongoUtils.MongoServer.html","topicHref":"Hi.MongoUtils.MongoServer.html","topicUid":"Hi.MongoUtils.MongoServer","type":"Class"}]},{"name":"Hi.Motion.MatValves","href":"Hi.Motion.MatValves.html","topicHref":"Hi.Motion.MatValves.html","topicUid":"Hi.Motion.MatValves","type":"Namespace","items":[{"name":"ClMachiningValve","href":"Hi.Motion.MatValves.ClMachiningValve.html","topicHref":"Hi.Motion.MatValves.ClMachiningValve.html","topicUid":"Hi.Motion.MatValves.ClMachiningValve","type":"Class"},{"name":"IMotionValve","href":"Hi.Motion.MatValves.IMotionValve.html","topicHref":"Hi.Motion.MatValves.IMotionValve.html","topicUid":"Hi.Motion.MatValves.IMotionValve","type":"Interface"},{"name":"MacroMotionValve","href":"Hi.Motion.MatValves.MacroMotionValve.html","topicHref":"Hi.Motion.MatValves.MacroMotionValve.html","topicUid":"Hi.Motion.MatValves.MacroMotionValve","type":"Class"},{"name":"StepMotionValve","href":"Hi.Motion.MatValves.StepMotionValve.html","topicHref":"Hi.Motion.MatValves.StepMotionValve.html","topicUid":"Hi.Motion.MatValves.StepMotionValve","type":"Class"}]},{"name":"Hi.Native","href":"Hi.Native.html","topicHref":"Hi.Native.html","topicUid":"Hi.Native","type":"Namespace","items":[{"name":"StopSource","href":"Hi.Native.StopSource.html","topicHref":"Hi.Native.StopSource.html","topicUid":"Hi.Native.StopSource","type":"Class"},{"name":"StopToken","href":"Hi.Native.StopToken.html","topicHref":"Hi.Native.StopToken.html","topicUid":"Hi.Native.StopToken","type":"Class"},{"name":"StopTokenKit","href":"Hi.Native.StopTokenKit.html","topicHref":"Hi.Native.StopTokenKit.html","topicUid":"Hi.Native.StopTokenKit","type":"Class"},{"name":"StopTokenUtil","href":"Hi.Native.StopTokenUtil.html","topicHref":"Hi.Native.StopTokenUtil.html","topicUid":"Hi.Native.StopTokenUtil","type":"Class"},{"name":"bind_t","href":"Hi.Native.bind_t.html","topicHref":"Hi.Native.bind_t.html","topicUid":"Hi.Native.bind_t","type":"Struct"},{"name":"box2d","href":"Hi.Native.box2d.html","topicHref":"Hi.Native.box2d.html","topicUid":"Hi.Native.box2d","type":"Struct"},{"name":"box3d","href":"Hi.Native.box3d.html","topicHref":"Hi.Native.box3d.html","topicUid":"Hi.Native.box3d","type":"Struct"},{"name":"expand_to_box3d_func_t","href":"Hi.Native.expand_to_box3d_func_t.html","topicHref":"Hi.Native.expand_to_box3d_func_t.html","topicUid":"Hi.Native.expand_to_box3d_func_t","type":"Delegate"},{"name":"key_event_t","href":"Hi.Native.key_event_t.html","topicHref":"Hi.Native.key_event_t.html","topicUid":"Hi.Native.key_event_t","type":"Struct"},{"name":"key_table__transform_view_by_key_pressing_t","href":"Hi.Native.key_table__transform_view_by_key_pressing_t.html","topicHref":"Hi.Native.key_table__transform_view_by_key_pressing_t.html","topicUid":"Hi.Native.key_table__transform_view_by_key_pressing_t","type":"Struct"},{"name":"mat4d","href":"Hi.Native.mat4d.html","topicHref":"Hi.Native.mat4d.html","topicUid":"Hi.Native.mat4d","type":"Struct"},{"name":"mat_stack_t","href":"Hi.Native.mat_stack_t.html","topicHref":"Hi.Native.mat_stack_t.html","topicUid":"Hi.Native.mat_stack_t","type":"Struct"},{"name":"mouse_button_event_t","href":"Hi.Native.mouse_button_event_t.html","topicHref":"Hi.Native.mouse_button_event_t.html","topicUid":"Hi.Native.mouse_button_event_t","type":"Struct"},{"name":"mouse_button_table__transform_view_by_mouse_drag_t","href":"Hi.Native.mouse_button_table__transform_view_by_mouse_drag_t.html","topicHref":"Hi.Native.mouse_button_table__transform_view_by_mouse_drag_t.html","topicUid":"Hi.Native.mouse_button_table__transform_view_by_mouse_drag_t","type":"Struct"},{"name":"mouse_move_event_t","href":"Hi.Native.mouse_move_event_t.html","topicHref":"Hi.Native.mouse_move_event_t.html","topicUid":"Hi.Native.mouse_move_event_t","type":"Struct"},{"name":"mouse_wheel_event_t","href":"Hi.Native.mouse_wheel_event_t.html","topicHref":"Hi.Native.mouse_wheel_event_t.html","topicUid":"Hi.Native.mouse_wheel_event_t","type":"Struct"},{"name":"panel_state_t","href":"Hi.Native.panel_state_t.html","topicHref":"Hi.Native.panel_state_t.html","topicUid":"Hi.Native.panel_state_t","type":"Struct"},{"name":"picking_event_t","href":"Hi.Native.picking_event_t.html","topicHref":"Hi.Native.picking_event_t.html","topicUid":"Hi.Native.picking_event_t","type":"Struct"},{"name":"picking_func_t","href":"Hi.Native.picking_func_t.html","topicHref":"Hi.Native.picking_func_t.html","topicUid":"Hi.Native.picking_func_t","type":"Delegate"},{"name":"picking_mark_t","href":"Hi.Native.picking_mark_t.html","topicHref":"Hi.Native.picking_mark_t.html","topicUid":"Hi.Native.picking_mark_t","type":"Struct"},{"name":"tri3d","href":"Hi.Native.tri3d.html","topicHref":"Hi.Native.tri3d.html","topicUid":"Hi.Native.tri3d","type":"Struct"},{"name":"ui_event_type","href":"Hi.Native.ui_event_type.html","topicHref":"Hi.Native.ui_event_type.html","topicUid":"Hi.Native.ui_event_type","type":"Enum"},{"name":"vec2d","href":"Hi.Native.vec2d.html","topicHref":"Hi.Native.vec2d.html","topicUid":"Hi.Native.vec2d","type":"Struct"},{"name":"vec3d","href":"Hi.Native.vec3d.html","topicHref":"Hi.Native.vec3d.html","topicUid":"Hi.Native.vec3d","type":"Struct"},{"name":"vec3f","href":"Hi.Native.vec3f.html","topicHref":"Hi.Native.vec3f.html","topicUid":"Hi.Native.vec3f","type":"Struct"}]},{"name":"Hi.NcMech","href":"Hi.NcMech.html","topicHref":"Hi.NcMech.html","topicUid":"Hi.NcMech","type":"Namespace","items":[{"name":"ICollisionIndexPairsSource","href":"Hi.NcMech.ICollisionIndexPairsSource.html","topicHref":"Hi.NcMech.ICollisionIndexPairsSource.html","topicUid":"Hi.NcMech.ICollisionIndexPairsSource","type":"Interface"},{"name":"IGetSolidMachiningChain","href":"Hi.NcMech.IGetSolidMachiningChain.html","topicHref":"Hi.NcMech.IGetSolidMachiningChain.html","topicUid":"Hi.NcMech.IGetSolidMachiningChain","type":"Interface"},{"name":"ISolidMachiningChain","href":"Hi.NcMech.ISolidMachiningChain.html","topicHref":"Hi.NcMech.ISolidMachiningChain.html","topicUid":"Hi.NcMech.ISolidMachiningChain","type":"Interface"}]},{"name":"Hi.NcMech.Fixtures","href":"Hi.NcMech.Fixtures.html","topicHref":"Hi.NcMech.Fixtures.html","topicUid":"Hi.NcMech.Fixtures","type":"Namespace","items":[{"name":"Fixture","href":"Hi.NcMech.Fixtures.Fixture.html","topicHref":"Hi.NcMech.Fixtures.Fixture.html","topicUid":"Hi.NcMech.Fixtures.Fixture","type":"Class"}]},{"name":"Hi.NcMech.Holders","href":"Hi.NcMech.Holders.html","topicHref":"Hi.NcMech.Holders.html","topicUid":"Hi.NcMech.Holders","type":"Namespace","items":[{"name":"CylindroidHolder","href":"Hi.NcMech.Holders.CylindroidHolder.html","topicHref":"Hi.NcMech.Holders.CylindroidHolder.html","topicUid":"Hi.NcMech.Holders.CylindroidHolder","type":"Class"},{"name":"FreeformHolder","href":"Hi.NcMech.Holders.FreeformHolder.html","topicHref":"Hi.NcMech.Holders.FreeformHolder.html","topicUid":"Hi.NcMech.Holders.FreeformHolder","type":"Class"},{"name":"HolderEditorDisplayee","href":"Hi.NcMech.Holders.HolderEditorDisplayee.html","topicHref":"Hi.NcMech.Holders.HolderEditorDisplayee.html","topicUid":"Hi.NcMech.Holders.HolderEditorDisplayee","type":"Class"},{"name":"IHolder","href":"Hi.NcMech.Holders.IHolder.html","topicHref":"Hi.NcMech.Holders.IHolder.html","topicUid":"Hi.NcMech.Holders.IHolder","type":"Interface"}]},{"name":"Hi.NcMech.Solids","href":"Hi.NcMech.Solids.html","topicHref":"Hi.NcMech.Solids.html","topicUid":"Hi.NcMech.Solids","type":"Namespace","items":[{"name":"IGetSolid","href":"Hi.NcMech.Solids.IGetSolid.html","topicHref":"Hi.NcMech.Solids.IGetSolid.html","topicUid":"Hi.NcMech.Solids.IGetSolid","type":"Interface"},{"name":"Solid","href":"Hi.NcMech.Solids.Solid.html","topicHref":"Hi.NcMech.Solids.Solid.html","topicUid":"Hi.NcMech.Solids.Solid","type":"Class"},{"name":"SolidFuncSource","href":"Hi.NcMech.Solids.SolidFuncSource.html","topicHref":"Hi.NcMech.Solids.SolidFuncSource.html","topicUid":"Hi.NcMech.Solids.SolidFuncSource","type":"Class"}]},{"name":"Hi.NcMech.Topo","href":"Hi.NcMech.Topo.html","topicHref":"Hi.NcMech.Topo.html","topicUid":"Hi.NcMech.Topo","type":"Namespace","items":[{"name":"INcStroke","href":"Hi.NcMech.Topo.INcStroke.html","topicHref":"Hi.NcMech.Topo.INcStroke.html","topicUid":"Hi.NcMech.Topo.INcStroke","type":"Interface"},{"name":"INcTransformer","href":"Hi.NcMech.Topo.INcTransformer.html","topicHref":"Hi.NcMech.Topo.INcTransformer.html","topicUid":"Hi.NcMech.Topo.INcTransformer","type":"Interface"},{"name":"ITopoBrick","href":"Hi.NcMech.Topo.ITopoBrick.html","topicHref":"Hi.NcMech.Topo.ITopoBrick.html","topicUid":"Hi.NcMech.Topo.ITopoBrick","type":"Interface"},{"name":"NcRotation","href":"Hi.NcMech.Topo.NcRotation.html","topicHref":"Hi.NcMech.Topo.NcRotation.html","topicUid":"Hi.NcMech.Topo.NcRotation","type":"Class"},{"name":"NcTranslation","href":"Hi.NcMech.Topo.NcTranslation.html","topicHref":"Hi.NcMech.Topo.NcTranslation.html","topicUid":"Hi.NcMech.Topo.NcTranslation","type":"Class"},{"name":"SolidSourceTopoBrick","href":"Hi.NcMech.Topo.SolidSourceTopoBrick.html","topicHref":"Hi.NcMech.Topo.SolidSourceTopoBrick.html","topicUid":"Hi.NcMech.Topo.SolidSourceTopoBrick","type":"Class"},{"name":"StlSourceTopoBrick","href":"Hi.NcMech.Topo.StlSourceTopoBrick.html","topicHref":"Hi.NcMech.Topo.StlSourceTopoBrick.html","topicUid":"Hi.NcMech.Topo.StlSourceTopoBrick","type":"Class"}]},{"name":"Hi.NcMech.Workpieces","href":"Hi.NcMech.Workpieces.html","topicHref":"Hi.NcMech.Workpieces.html","topicUid":"Hi.NcMech.Workpieces","type":"Namespace","items":[{"name":"Workpiece","href":"Hi.NcMech.Workpieces.Workpiece.html","topicHref":"Hi.NcMech.Workpieces.Workpiece.html","topicUid":"Hi.NcMech.Workpieces.Workpiece","type":"Class"}]},{"name":"Hi.NcMech.Xyzabc","href":"Hi.NcMech.Xyzabc.html","topicHref":"Hi.NcMech.Xyzabc.html","topicUid":"Hi.NcMech.Xyzabc","type":"Namespace","items":[{"name":"CodeXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.CodeXyzabcMachineTool","type":"Class"},{"name":"CodeXyzabcMachineToolUri","href":"Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html","topicHref":"Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html","topicUid":"Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri","type":"Class"},{"name":"GeneralXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool","type":"Class"},{"name":"IGetCodeXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool","type":"Interface"},{"name":"IXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.IXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.IXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.IXyzabcMachineTool","type":"Interface"}]},{"name":"Hi.NcOpt","href":"Hi.NcOpt.html","topicHref":"Hi.NcOpt.html","topicUid":"Hi.NcOpt","type":"Namespace","items":[{"name":"CuttingVelocityOptLimit","href":"Hi.NcOpt.CuttingVelocityOptLimit.html","topicHref":"Hi.NcOpt.CuttingVelocityOptLimit.html","topicUid":"Hi.NcOpt.CuttingVelocityOptLimit","type":"Class"},{"name":"FixedFeedPerCycleOptLimit","href":"Hi.NcOpt.FixedFeedPerCycleOptLimit.html","topicHref":"Hi.NcOpt.FixedFeedPerCycleOptLimit.html","topicUid":"Hi.NcOpt.FixedFeedPerCycleOptLimit","type":"Class"},{"name":"FixedFeedPerToothOptLimit","href":"Hi.NcOpt.FixedFeedPerToothOptLimit.html","topicHref":"Hi.NcOpt.FixedFeedPerToothOptLimit.html","topicUid":"Hi.NcOpt.FixedFeedPerToothOptLimit","type":"Class"},{"name":"ICutterOptLimit","href":"Hi.NcOpt.ICutterOptLimit.html","topicHref":"Hi.NcOpt.ICutterOptLimit.html","topicUid":"Hi.NcOpt.ICutterOptLimit","type":"Interface"},{"name":"ICutterOptLimitHost","href":"Hi.NcOpt.ICutterOptLimitHost.html","topicHref":"Hi.NcOpt.ICutterOptLimitHost.html","topicUid":"Hi.NcOpt.ICutterOptLimitHost","type":"Interface"},{"name":"ICuttingVelocityOptLimit","href":"Hi.NcOpt.ICuttingVelocityOptLimit.html","topicHref":"Hi.NcOpt.ICuttingVelocityOptLimit.html","topicUid":"Hi.NcOpt.ICuttingVelocityOptLimit","type":"Interface"},{"name":"IFeedPerToothOptLimit","href":"Hi.NcOpt.IFeedPerToothOptLimit.html","topicHref":"Hi.NcOpt.IFeedPerToothOptLimit.html","topicUid":"Hi.NcOpt.IFeedPerToothOptLimit","type":"Interface"},{"name":"MillingCutterOptLimit","href":"Hi.NcOpt.MillingCutterOptLimit.html","topicHref":"Hi.NcOpt.MillingCutterOptLimit.html","topicUid":"Hi.NcOpt.MillingCutterOptLimit","type":"Class"},{"name":"NcOptOption","href":"Hi.NcOpt.NcOptOption.html","topicHref":"Hi.NcOpt.NcOptOption.html","topicUid":"Hi.NcOpt.NcOptOption","type":"Class"},{"name":"NcOptProc","href":"Hi.NcOpt.NcOptProc.html","topicHref":"Hi.NcOpt.NcOptProc.html","topicUid":"Hi.NcOpt.NcOptProc","type":"Class"},{"name":"ShapeBasedCutterOptLimit","href":"Hi.NcOpt.ShapeBasedCutterOptLimit.html","topicHref":"Hi.NcOpt.ShapeBasedCutterOptLimit.html","topicUid":"Hi.NcOpt.ShapeBasedCutterOptLimit","type":"Class"}]},{"name":"Hi.NcStepUtils","href":"Hi.NcStepUtils.html","topicHref":"Hi.NcStepUtils.html","topicUid":"Hi.NcStepUtils","type":"Namespace","items":[{"name":"IGetNcStep","href":"Hi.NcStepUtils.IGetNcStep.html","topicHref":"Hi.NcStepUtils.IGetNcStep.html","topicUid":"Hi.NcStepUtils.IGetNcStep","type":"Interface"},{"name":"INcStep0","href":"Hi.NcStepUtils.INcStep0.html","topicHref":"Hi.NcStepUtils.INcStep0.html","topicUid":"Hi.NcStepUtils.INcStep0","type":"Interface"},{"name":"INcStepMonitee","href":"Hi.NcStepUtils.INcStepMonitee.html","topicHref":"Hi.NcStepUtils.INcStepMonitee.html","topicUid":"Hi.NcStepUtils.INcStepMonitee","type":"Interface"},{"name":"NcStepUtil","href":"Hi.NcStepUtils.NcStepUtil.html","topicHref":"Hi.NcStepUtils.NcStepUtil.html","topicUid":"Hi.NcStepUtils.NcStepUtil","type":"Class"}]},{"name":"Hi.Numerical","href":"Hi.Numerical.html","topicHref":"Hi.Numerical.html","topicUid":"Hi.Numerical","type":"Namespace","items":[{"name":"CncBrand","href":"Hi.Numerical.CncBrand.html","topicHref":"Hi.Numerical.CncBrand.html","topicUid":"Hi.Numerical.CncBrand","type":"Enum"},{"name":"CommentMarkEnum","href":"Hi.Numerical.CommentMarkEnum.html","topicHref":"Hi.Numerical.CommentMarkEnum.html","topicUid":"Hi.Numerical.CommentMarkEnum","type":"Enum"},{"name":"CoordinateEntryDisplayee","href":"Hi.Numerical.CoordinateEntryDisplayee.html","topicHref":"Hi.Numerical.CoordinateEntryDisplayee.html","topicUid":"Hi.Numerical.CoordinateEntryDisplayee","type":"Class"},{"name":"CoordinateEntryRenderingFlag","href":"Hi.Numerical.CoordinateEntryRenderingFlag.html","topicHref":"Hi.Numerical.CoordinateEntryRenderingFlag.html","topicUid":"Hi.Numerical.CoordinateEntryRenderingFlag","type":"Enum"},{"name":"CoordinateInterpolationMode","href":"Hi.Numerical.CoordinateInterpolationMode.html","topicHref":"Hi.Numerical.CoordinateInterpolationMode.html","topicUid":"Hi.Numerical.CoordinateInterpolationMode","type":"Enum"},{"name":"FlexDictionaryUtil","href":"Hi.Numerical.FlexDictionaryUtil.html","topicHref":"Hi.Numerical.FlexDictionaryUtil.html","topicUid":"Hi.Numerical.FlexDictionaryUtil","type":"Class"},{"name":"IFlexDictionaryHost","href":"Hi.Numerical.IFlexDictionaryHost-1.html","topicHref":"Hi.Numerical.IFlexDictionaryHost-1.html","topicUid":"Hi.Numerical.IFlexDictionaryHost`1","type":"Interface"},{"name":"IGetFeedrate","href":"Hi.Numerical.IGetFeedrate.html","topicHref":"Hi.Numerical.IGetFeedrate.html","topicUid":"Hi.Numerical.IGetFeedrate","type":"Interface"},{"name":"IGetSpindleSpeed","href":"Hi.Numerical.IGetSpindleSpeed.html","topicHref":"Hi.Numerical.IGetSpindleSpeed.html","topicUid":"Hi.Numerical.IGetSpindleSpeed","type":"Interface"},{"name":"ISetFeedrate","href":"Hi.Numerical.ISetFeedrate.html","topicHref":"Hi.Numerical.ISetFeedrate.html","topicUid":"Hi.Numerical.ISetFeedrate","type":"Interface"},{"name":"ISetSpindleSpeed","href":"Hi.Numerical.ISetSpindleSpeed.html","topicHref":"Hi.Numerical.ISetSpindleSpeed.html","topicUid":"Hi.Numerical.ISetSpindleSpeed","type":"Interface"},{"name":"IsoCoordinateTable","href":"Hi.Numerical.IsoCoordinateTable.html","topicHref":"Hi.Numerical.IsoCoordinateTable.html","topicUid":"Hi.Numerical.IsoCoordinateTable","type":"Class"},{"name":"MechNcUtil","href":"Hi.Numerical.MechNcUtil.html","topicHref":"Hi.Numerical.MechNcUtil.html","topicUid":"Hi.Numerical.MechNcUtil","type":"Class"},{"name":"MillingToolOffsetTable","href":"Hi.Numerical.MillingToolOffsetTable.html","topicHref":"Hi.Numerical.MillingToolOffsetTable.html","topicUid":"Hi.Numerical.MillingToolOffsetTable","type":"Class"},{"name":"MillingToolOffsetTableRow","href":"Hi.Numerical.MillingToolOffsetTableRow.html","topicHref":"Hi.Numerical.MillingToolOffsetTableRow.html","topicUid":"Hi.Numerical.MillingToolOffsetTableRow","type":"Class"},{"name":"NcComment","href":"Hi.Numerical.NcComment.html","topicHref":"Hi.Numerical.NcComment.html","topicUid":"Hi.Numerical.NcComment","type":"Class"},{"name":"NcEnv","href":"Hi.Numerical.NcEnv.html","topicHref":"Hi.Numerical.NcEnv.html","topicUid":"Hi.Numerical.NcEnv","type":"Class"},{"name":"NcFlag","href":"Hi.Numerical.NcFlag.html","topicHref":"Hi.Numerical.NcFlag.html","topicUid":"Hi.Numerical.NcFlag","type":"Enum"},{"name":"NcFlagUtil","href":"Hi.Numerical.NcFlagUtil.html","topicHref":"Hi.Numerical.NcFlagUtil.html","topicUid":"Hi.Numerical.NcFlagUtil","type":"Class"},{"name":"NcGroup00","href":"Hi.Numerical.NcGroup00.html","topicHref":"Hi.Numerical.NcGroup00.html","topicUid":"Hi.Numerical.NcGroup00","type":"Enum"},{"name":"NcGroup01","href":"Hi.Numerical.NcGroup01.html","topicHref":"Hi.Numerical.NcGroup01.html","topicUid":"Hi.Numerical.NcGroup01","type":"Enum"},{"name":"NcGroup02","href":"Hi.Numerical.NcGroup02.html","topicHref":"Hi.Numerical.NcGroup02.html","topicUid":"Hi.Numerical.NcGroup02","type":"Enum"},{"name":"NcGroup03","href":"Hi.Numerical.NcGroup03.html","topicHref":"Hi.Numerical.NcGroup03.html","topicUid":"Hi.Numerical.NcGroup03","type":"Enum"},{"name":"NcGroup05","href":"Hi.Numerical.NcGroup05.html","topicHref":"Hi.Numerical.NcGroup05.html","topicUid":"Hi.Numerical.NcGroup05","type":"Enum"},{"name":"NcGroup06","href":"Hi.Numerical.NcGroup06.html","topicHref":"Hi.Numerical.NcGroup06.html","topicUid":"Hi.Numerical.NcGroup06","type":"Enum"},{"name":"NcGroup07","href":"Hi.Numerical.NcGroup07.html","topicHref":"Hi.Numerical.NcGroup07.html","topicUid":"Hi.Numerical.NcGroup07","type":"Enum"},{"name":"NcGroup08","href":"Hi.Numerical.NcGroup08.html","topicHref":"Hi.Numerical.NcGroup08.html","topicUid":"Hi.Numerical.NcGroup08","type":"Enum"},{"name":"NcGroup09","href":"Hi.Numerical.NcGroup09.html","topicHref":"Hi.Numerical.NcGroup09.html","topicUid":"Hi.Numerical.NcGroup09","type":"Enum"},{"name":"NcGroup10","href":"Hi.Numerical.NcGroup10.html","topicHref":"Hi.Numerical.NcGroup10.html","topicUid":"Hi.Numerical.NcGroup10","type":"Enum"},{"name":"NcGroup14","href":"Hi.Numerical.NcGroup14.html","topicHref":"Hi.Numerical.NcGroup14.html","topicUid":"Hi.Numerical.NcGroup14","type":"Enum"},{"name":"NcGroup16","href":"Hi.Numerical.NcGroup16.html","topicHref":"Hi.Numerical.NcGroup16.html","topicUid":"Hi.Numerical.NcGroup16","type":"Enum"},{"name":"NcGroup21","href":"Hi.Numerical.NcGroup21.html","topicHref":"Hi.Numerical.NcGroup21.html","topicUid":"Hi.Numerical.NcGroup21","type":"Enum"},{"name":"NcGroupAttribute","href":"Hi.Numerical.NcGroupAttribute.html","topicHref":"Hi.Numerical.NcGroupAttribute.html","topicUid":"Hi.Numerical.NcGroupAttribute","type":"Class"},{"name":"NcGroupHeidenhainM107M108","href":"Hi.Numerical.NcGroupHeidenhainM107M108.html","topicHref":"Hi.Numerical.NcGroupHeidenhainM107M108.html","topicUid":"Hi.Numerical.NcGroupHeidenhainM107M108","type":"Enum"},{"name":"NcGroupHeidenhainPlane","href":"Hi.Numerical.NcGroupHeidenhainPlane.html","topicHref":"Hi.Numerical.NcGroupHeidenhainPlane.html","topicUid":"Hi.Numerical.NcGroupHeidenhainPlane","type":"Enum"},{"name":"NcGroupHeidenhainShortestRotaryPath","href":"Hi.Numerical.NcGroupHeidenhainShortestRotaryPath.html","topicHref":"Hi.Numerical.NcGroupHeidenhainShortestRotaryPath.html","topicUid":"Hi.Numerical.NcGroupHeidenhainShortestRotaryPath","type":"Enum"},{"name":"NcGroupSpindleRotation","href":"Hi.Numerical.NcGroupSpindleRotation.html","topicHref":"Hi.Numerical.NcGroupSpindleRotation.html","topicUid":"Hi.Numerical.NcGroupSpindleRotation","type":"Enum"},{"name":"NcLifeCycleAttribute","href":"Hi.Numerical.NcLifeCycleAttribute.html","topicHref":"Hi.Numerical.NcLifeCycleAttribute.html","topicUid":"Hi.Numerical.NcLifeCycleAttribute","type":"Class"},{"name":"NcLifeCycleMode","href":"Hi.Numerical.NcLifeCycleMode.html","topicHref":"Hi.Numerical.NcLifeCycleMode.html","topicUid":"Hi.Numerical.NcLifeCycleMode","type":"Enum"},{"name":"NcLine","href":"Hi.Numerical.NcLine.html","topicHref":"Hi.Numerical.NcLine.html","topicUid":"Hi.Numerical.NcLine","type":"Class"},{"name":"NcNameAttribute","href":"Hi.Numerical.NcNameAttribute.html","topicHref":"Hi.Numerical.NcNameAttribute.html","topicUid":"Hi.Numerical.NcNameAttribute","type":"Class"},{"name":"NcNoteCache","href":"Hi.Numerical.NcNoteCache.html","topicHref":"Hi.Numerical.NcNoteCache.html","topicUid":"Hi.Numerical.NcNoteCache","type":"Class"},{"name":"NcProc","href":"Hi.Numerical.NcProc.html","topicHref":"Hi.Numerical.NcProc.html","topicUid":"Hi.Numerical.NcProc","type":"Class"},{"name":"NcStepFileOutputKit","href":"Hi.Numerical.NcStepFileOutputKit.html","topicHref":"Hi.Numerical.NcStepFileOutputKit.html","topicUid":"Hi.Numerical.NcStepFileOutputKit","type":"Class"},{"name":"NcStepMonitor","href":"Hi.Numerical.NcStepMonitor.html","topicHref":"Hi.Numerical.NcStepMonitor.html","topicUid":"Hi.Numerical.NcStepMonitor","type":"Class"},{"name":"NcUtil","href":"Hi.Numerical.NcUtil.html","topicHref":"Hi.Numerical.NcUtil.html","topicUid":"Hi.Numerical.NcUtil","type":"Class"},{"name":"NcWarningSceneEnum","href":"Hi.Numerical.NcWarningSceneEnum.html","topicHref":"Hi.Numerical.NcWarningSceneEnum.html","topicUid":"Hi.Numerical.NcWarningSceneEnum","type":"Enum"},{"name":"NumericUtil","href":"Hi.Numerical.NumericUtil.html","topicHref":"Hi.Numerical.NumericUtil.html","topicUid":"Hi.Numerical.NumericUtil","type":"Class"},{"name":"PolarEntry","href":"Hi.Numerical.PolarEntry.html","topicHref":"Hi.Numerical.PolarEntry.html","topicUid":"Hi.Numerical.PolarEntry","type":"Class"},{"name":"PolarEntry.PolarModeDirEnum","href":"Hi.Numerical.PolarEntry.PolarModeDirEnum.html","topicHref":"Hi.Numerical.PolarEntry.PolarModeDirEnum.html","topicUid":"Hi.Numerical.PolarEntry.PolarModeDirEnum","type":"Enum"},{"name":"RadiusCompensationBuf","href":"Hi.Numerical.RadiusCompensationBuf.html","topicHref":"Hi.Numerical.RadiusCompensationBuf.html","topicUid":"Hi.Numerical.RadiusCompensationBuf","type":"Class"},{"name":"SpindleDirection","href":"Hi.Numerical.SpindleDirection.html","topicHref":"Hi.Numerical.SpindleDirection.html","topicUid":"Hi.Numerical.SpindleDirection","type":"Enum"},{"name":"SubStringKit","href":"Hi.Numerical.SubStringKit.html","topicHref":"Hi.Numerical.SubStringKit.html","topicUid":"Hi.Numerical.SubStringKit","type":"Class"},{"name":"SubStringKit.ActivationMode","href":"Hi.Numerical.SubStringKit.ActivationMode.html","topicHref":"Hi.Numerical.SubStringKit.ActivationMode.html","topicUid":"Hi.Numerical.SubStringKit.ActivationMode","type":"Enum"},{"name":"ToolConfigNotFoundException","href":"Hi.Numerical.ToolConfigNotFoundException.html","topicHref":"Hi.Numerical.ToolConfigNotFoundException.html","topicUid":"Hi.Numerical.ToolConfigNotFoundException","type":"Class"}]},{"name":"Hi.Numerical.Acts","href":"Hi.Numerical.Acts.html","topicHref":"Hi.Numerical.Acts.html","topicUid":"Hi.Numerical.Acts","type":"Namespace","items":[{"name":"ActClArc","href":"Hi.Numerical.Acts.ActClArc.html","topicHref":"Hi.Numerical.Acts.ActClArc.html","topicUid":"Hi.Numerical.Acts.ActClArc","type":"Class"},{"name":"ActClLinear","href":"Hi.Numerical.Acts.ActClLinear.html","topicHref":"Hi.Numerical.Acts.ActClLinear.html","topicUid":"Hi.Numerical.Acts.ActClLinear","type":"Class"},{"name":"ActClTeleport","href":"Hi.Numerical.Acts.ActClTeleport.html","topicHref":"Hi.Numerical.Acts.ActClTeleport.html","topicUid":"Hi.Numerical.Acts.ActClTeleport","type":"Class"},{"name":"ActCooling","href":"Hi.Numerical.Acts.ActCooling.html","topicHref":"Hi.Numerical.Acts.ActCooling.html","topicUid":"Hi.Numerical.Acts.ActCooling","type":"Class"},{"name":"ActDelay","href":"Hi.Numerical.Acts.ActDelay.html","topicHref":"Hi.Numerical.Acts.ActDelay.html","topicUid":"Hi.Numerical.Acts.ActDelay","type":"Class"},{"name":"ActFeedrate","href":"Hi.Numerical.Acts.ActFeedrate.html","topicHref":"Hi.Numerical.Acts.ActFeedrate.html","topicUid":"Hi.Numerical.Acts.ActFeedrate","type":"Class"},{"name":"ActHiddenStateChanged","href":"Hi.Numerical.Acts.ActHiddenStateChanged.html","topicHref":"Hi.Numerical.Acts.ActHiddenStateChanged.html","topicUid":"Hi.Numerical.Acts.ActHiddenStateChanged","type":"Class"},{"name":"ActIntentionalSkip","href":"Hi.Numerical.Acts.ActIntentionalSkip.html","topicHref":"Hi.Numerical.Acts.ActIntentionalSkip.html","topicUid":"Hi.Numerical.Acts.ActIntentionalSkip","type":"Class"},{"name":"ActLineBegin","href":"Hi.Numerical.Acts.ActLineBegin.html","topicHref":"Hi.Numerical.Acts.ActLineBegin.html","topicUid":"Hi.Numerical.Acts.ActLineBegin","type":"Class"},{"name":"ActLineCsScript","href":"Hi.Numerical.Acts.ActLineCsScript.html","topicHref":"Hi.Numerical.Acts.ActLineCsScript.html","topicUid":"Hi.Numerical.Acts.ActLineCsScript","type":"Class"},{"name":"ActLineEnd","href":"Hi.Numerical.Acts.ActLineEnd.html","topicHref":"Hi.Numerical.Acts.ActLineEnd.html","topicUid":"Hi.Numerical.Acts.ActLineEnd","type":"Class"},{"name":"ActLinearClAndLinearMcAbcMcXyzabcContour","href":"Hi.Numerical.Acts.ActLinearClAndLinearMcAbcMcXyzabcContour.html","topicHref":"Hi.Numerical.Acts.ActLinearClAndLinearMcAbcMcXyzabcContour.html","topicUid":"Hi.Numerical.Acts.ActLinearClAndLinearMcAbcMcXyzabcContour","type":"Class"},{"name":"ActMcPolarLinearContour","href":"Hi.Numerical.Acts.ActMcPolarLinearContour.html","topicHref":"Hi.Numerical.Acts.ActMcPolarLinearContour.html","topicUid":"Hi.Numerical.Acts.ActMcPolarLinearContour","type":"Class"},{"name":"ActMcXyzLinearContour","href":"Hi.Numerical.Acts.ActMcXyzLinearContour.html","topicHref":"Hi.Numerical.Acts.ActMcXyzLinearContour.html","topicUid":"Hi.Numerical.Acts.ActMcXyzLinearContour","type":"Class"},{"name":"ActMcXyzStep","href":"Hi.Numerical.Acts.ActMcXyzStep.html","topicHref":"Hi.Numerical.Acts.ActMcXyzStep.html","topicUid":"Hi.Numerical.Acts.ActMcXyzStep","type":"Class"},{"name":"ActMcXyzabcOrientableLinearContour","href":"Hi.Numerical.Acts.ActMcXyzabcOrientableLinearContour.html","topicHref":"Hi.Numerical.Acts.ActMcXyzabcOrientableLinearContour.html","topicUid":"Hi.Numerical.Acts.ActMcXyzabcOrientableLinearContour","type":"Class"},{"name":"ActMcXyzabcStep","href":"Hi.Numerical.Acts.ActMcXyzabcStep.html","topicHref":"Hi.Numerical.Acts.ActMcXyzabcStep.html","topicUid":"Hi.Numerical.Acts.ActMcXyzabcStep","type":"Class"},{"name":"ActRapid","href":"Hi.Numerical.Acts.ActRapid.html","topicHref":"Hi.Numerical.Acts.ActRapid.html","topicUid":"Hi.Numerical.Acts.ActRapid","type":"Class"},{"name":"ActSpindleSpeed","href":"Hi.Numerical.Acts.ActSpindleSpeed.html","topicHref":"Hi.Numerical.Acts.ActSpindleSpeed.html","topicUid":"Hi.Numerical.Acts.ActSpindleSpeed","type":"Class"},{"name":"ActSpiralMcXyzContour","href":"Hi.Numerical.Acts.ActSpiralMcXyzContour.html","topicHref":"Hi.Numerical.Acts.ActSpiralMcXyzContour.html","topicUid":"Hi.Numerical.Acts.ActSpiralMcXyzContour","type":"Class"},{"name":"ActStateRunner","href":"Hi.Numerical.Acts.ActStateRunner.html","topicHref":"Hi.Numerical.Acts.ActStateRunner.html","topicUid":"Hi.Numerical.Acts.ActStateRunner","type":"Class"},{"name":"ActTooling","href":"Hi.Numerical.Acts.ActTooling.html","topicHref":"Hi.Numerical.Acts.ActTooling.html","topicUid":"Hi.Numerical.Acts.ActTooling","type":"Class"},{"name":"ActUnknownSkip","href":"Hi.Numerical.Acts.ActUnknownSkip.html","topicHref":"Hi.Numerical.Acts.ActUnknownSkip.html","topicUid":"Hi.Numerical.Acts.ActUnknownSkip","type":"Class"},{"name":"ActUtil","href":"Hi.Numerical.Acts.ActUtil.html","topicHref":"Hi.Numerical.Acts.ActUtil.html","topicUid":"Hi.Numerical.Acts.ActUtil","type":"Class"},{"name":"IAct","href":"Hi.Numerical.Acts.IAct.html","topicHref":"Hi.Numerical.Acts.IAct.html","topicUid":"Hi.Numerical.Acts.IAct","type":"Interface"},{"name":"IActClMove","href":"Hi.Numerical.Acts.IActClMove.html","topicHref":"Hi.Numerical.Acts.IActClMove.html","topicUid":"Hi.Numerical.Acts.IActClMove","type":"Interface"},{"name":"IActDuration","href":"Hi.Numerical.Acts.IActDuration.html","topicHref":"Hi.Numerical.Acts.IActDuration.html","topicUid":"Hi.Numerical.Acts.IActDuration","type":"Interface"},{"name":"IActMachineStep","href":"Hi.Numerical.Acts.IActMachineStep.html","topicHref":"Hi.Numerical.Acts.IActMachineStep.html","topicUid":"Hi.Numerical.Acts.IActMachineStep","type":"Interface"},{"name":"IActMcXyzContour","href":"Hi.Numerical.Acts.IActMcXyzContour.html","topicHref":"Hi.Numerical.Acts.IActMcXyzContour.html","topicUid":"Hi.Numerical.Acts.IActMcXyzContour","type":"Interface"},{"name":"IActMcXyzabcContour","href":"Hi.Numerical.Acts.IActMcXyzabcContour.html","topicHref":"Hi.Numerical.Acts.IActMcXyzabcContour.html","topicUid":"Hi.Numerical.Acts.IActMcXyzabcContour","type":"Interface"},{"name":"IActSkip","href":"Hi.Numerical.Acts.IActSkip.html","topicHref":"Hi.Numerical.Acts.IActSkip.html","topicUid":"Hi.Numerical.Acts.IActSkip","type":"Interface"},{"name":"IWorkTimeAttrib","href":"Hi.Numerical.Acts.IWorkTimeAttrib.html","topicHref":"Hi.Numerical.Acts.IWorkTimeAttrib.html","topicUid":"Hi.Numerical.Acts.IWorkTimeAttrib","type":"Interface"},{"name":"IWorkTimeGetter","href":"Hi.Numerical.Acts.IWorkTimeGetter.html","topicHref":"Hi.Numerical.Acts.IWorkTimeGetter.html","topicUid":"Hi.Numerical.Acts.IWorkTimeGetter","type":"Interface"},{"name":"IWorkTimeSetter","href":"Hi.Numerical.Acts.IWorkTimeSetter.html","topicHref":"Hi.Numerical.Acts.IWorkTimeSetter.html","topicUid":"Hi.Numerical.Acts.IWorkTimeSetter","type":"Interface"}]},{"name":"Hi.Numerical.FilePlayers","href":"Hi.Numerical.FilePlayers.html","topicHref":"Hi.Numerical.FilePlayers.html","topicUid":"Hi.Numerical.FilePlayers","type":"Namespace","items":[{"name":"NcRunner","href":"Hi.Numerical.FilePlayers.NcRunner.html","topicHref":"Hi.Numerical.FilePlayers.NcRunner.html","topicUid":"Hi.Numerical.FilePlayers.NcRunner","type":"Class"}]},{"name":"Hi.Numerical.MachiningMotionResolutionUtils","href":"Hi.Numerical.MachiningMotionResolutionUtils.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils","type":"Namespace","items":[{"name":"FeedPerCycleMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution","type":"Class"},{"name":"FeedPerToothMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution","type":"Class"},{"name":"FeedPerToothNcResolution0","href":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0","type":"Class"},{"name":"FixedMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution","type":"Class"},{"name":"IMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution","type":"Interface"}]},{"name":"Hi.Numerical.NcArgs","href":"Hi.Numerical.NcArgs.html","topicHref":"Hi.Numerical.NcArgs.html","topicUid":"Hi.Numerical.NcArgs","type":"Namespace","items":[{"name":"ArcNcArg","href":"Hi.Numerical.NcArgs.ArcNcArg.html","topicHref":"Hi.Numerical.NcArgs.ArcNcArg.html","topicUid":"Hi.Numerical.NcArgs.ArcNcArg","type":"Class"},{"name":"G28Arg","href":"Hi.Numerical.NcArgs.G28Arg.html","topicHref":"Hi.Numerical.NcArgs.G28Arg.html","topicUid":"Hi.Numerical.NcArgs.G28Arg","type":"Class"},{"name":"Group07NcArg","href":"Hi.Numerical.NcArgs.Group07NcArg.html","topicHref":"Hi.Numerical.NcArgs.Group07NcArg.html","topicUid":"Hi.Numerical.NcArgs.Group07NcArg","type":"Class"},{"name":"Group09NcArg","href":"Hi.Numerical.NcArgs.Group09NcArg.html","topicHref":"Hi.Numerical.NcArgs.Group09NcArg.html","topicUid":"Hi.Numerical.NcArgs.Group09NcArg","type":"Class"},{"name":"HeidenhainCycleDef7Arg","href":"Hi.Numerical.NcArgs.HeidenhainCycleDef7Arg.html","topicHref":"Hi.Numerical.NcArgs.HeidenhainCycleDef7Arg.html","topicUid":"Hi.Numerical.NcArgs.HeidenhainCycleDef7Arg","type":"Class"},{"name":"HeidenhainPlaneSpatialArg","href":"Hi.Numerical.NcArgs.HeidenhainPlaneSpatialArg.html","topicHref":"Hi.Numerical.NcArgs.HeidenhainPlaneSpatialArg.html","topicUid":"Hi.Numerical.NcArgs.HeidenhainPlaneSpatialArg","type":"Class"},{"name":"IHeidenhainBlockCacheArg","href":"Hi.Numerical.NcArgs.IHeidenhainBlockCacheArg.html","topicHref":"Hi.Numerical.NcArgs.IHeidenhainBlockCacheArg.html","topicUid":"Hi.Numerical.NcArgs.IHeidenhainBlockCacheArg","type":"Interface"},{"name":"IHeidenhainPlaneArg","href":"Hi.Numerical.NcArgs.IHeidenhainPlaneArg.html","topicHref":"Hi.Numerical.NcArgs.IHeidenhainPlaneArg.html","topicUid":"Hi.Numerical.NcArgs.IHeidenhainPlaneArg","type":"Interface"},{"name":"ITiltPlaneNcArg","href":"Hi.Numerical.NcArgs.ITiltPlaneNcArg.html","topicHref":"Hi.Numerical.NcArgs.ITiltPlaneNcArg.html","topicUid":"Hi.Numerical.NcArgs.ITiltPlaneNcArg","type":"Interface"},{"name":"NcArgCycle800","href":"Hi.Numerical.NcArgs.NcArgCycle800.html","topicHref":"Hi.Numerical.NcArgs.NcArgCycle800.html","topicUid":"Hi.Numerical.NcArgs.NcArgCycle800","type":"Class"},{"name":"NcArgG68","href":"Hi.Numerical.NcArgs.NcArgG68.html","topicHref":"Hi.Numerical.NcArgs.NcArgG68.html","topicUid":"Hi.Numerical.NcArgs.NcArgG68","type":"Class"},{"name":"NcArgG68p2","href":"Hi.Numerical.NcArgs.NcArgG68p2.html","topicHref":"Hi.Numerical.NcArgs.NcArgG68p2.html","topicUid":"Hi.Numerical.NcArgs.NcArgG68p2","type":"Class"},{"name":"PausingNcArg","href":"Hi.Numerical.NcArgs.PausingNcArg.html","topicHref":"Hi.Numerical.NcArgs.PausingNcArg.html","topicUid":"Hi.Numerical.NcArgs.PausingNcArg","type":"Class"}]},{"name":"Hi.Numerical.StepSelectionUtils","href":"Hi.Numerical.StepSelectionUtils.html","topicHref":"Hi.Numerical.StepSelectionUtils.html","topicUid":"Hi.Numerical.StepSelectionUtils","type":"Namespace","items":[{"name":"BoundAnchorMode","href":"Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundAnchorMode","type":"Enum"},{"name":"BoundSelector","href":"Hi.Numerical.StepSelectionUtils.BoundSelector.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelector.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelector","type":"Class"},{"name":"BoundSelectorHost","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorHost","type":"Class"},{"name":"BoundSelectorPair","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair","type":"Class"},{"name":"BoundSelectorPair.BoundLocale","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale","type":"Enum"},{"name":"BoundSelectorStepSectionBundle","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle","type":"Class"},{"name":"BoundSelectorUtil","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorUtil.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorUtil.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorUtil","type":"Class"},{"name":"DistanceShift","href":"Hi.Numerical.StepSelectionUtils.DistanceShift.html","topicHref":"Hi.Numerical.StepSelectionUtils.DistanceShift.html","topicUid":"Hi.Numerical.StepSelectionUtils.DistanceShift","type":"Class"},{"name":"IStepShift","href":"Hi.Numerical.StepSelectionUtils.IStepShift.html","topicHref":"Hi.Numerical.StepSelectionUtils.IStepShift.html","topicUid":"Hi.Numerical.StepSelectionUtils.IStepShift","type":"Interface"},{"name":"TimeShift","href":"Hi.Numerical.StepSelectionUtils.TimeShift.html","topicHref":"Hi.Numerical.StepSelectionUtils.TimeShift.html","topicUid":"Hi.Numerical.StepSelectionUtils.TimeShift","type":"Class"}]},{"name":"Hi.Numerical.Xyzabc","href":"Hi.Numerical.Xyzabc.html","topicHref":"Hi.Numerical.Xyzabc.html","topicUid":"Hi.Numerical.Xyzabc","type":"Namespace","items":[{"name":"Abc","href":"Hi.Numerical.Xyzabc.Abc.html","topicHref":"Hi.Numerical.Xyzabc.Abc.html","topicUid":"Hi.Numerical.Xyzabc.Abc","type":"Struct"},{"name":"CodeXyzabcChain","href":"Hi.Numerical.Xyzabc.CodeXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.CodeXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.CodeXyzabcChain","type":"Class"},{"name":"GeneralXyzabcChain","href":"Hi.Numerical.Xyzabc.GeneralXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.GeneralXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.GeneralXyzabcChain","type":"Class"},{"name":"ICoordinateConverter","href":"Hi.Numerical.Xyzabc.ICoordinateConverter.html","topicHref":"Hi.Numerical.Xyzabc.ICoordinateConverter.html","topicUid":"Hi.Numerical.Xyzabc.ICoordinateConverter","type":"Interface"},{"name":"IGetMcXyzabc","href":"Hi.Numerical.Xyzabc.IGetMcXyzabc.html","topicHref":"Hi.Numerical.Xyzabc.IGetMcXyzabc.html","topicUid":"Hi.Numerical.Xyzabc.IGetMcXyzabc","type":"Interface"},{"name":"IGetXyzabcChain","href":"Hi.Numerical.Xyzabc.IGetXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.IGetXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.IGetXyzabcChain","type":"Interface"},{"name":"IXyzabcChain","href":"Hi.Numerical.Xyzabc.IXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.IXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.IXyzabcChain","type":"Interface"},{"name":"ReflectedXyzabcChain","href":"Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.ReflectedXyzabcChain","type":"Class"},{"name":"SimpleChainCoordinateConverter","href":"Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html","topicHref":"Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html","topicUid":"Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter","type":"Class"},{"name":"XyzabcChainMillingCoordinateConverter","href":"Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html","topicHref":"Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html","topicUid":"Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter","type":"Class"},{"name":"XyzabcSolver","href":"Hi.Numerical.Xyzabc.XyzabcSolver.html","topicHref":"Hi.Numerical.Xyzabc.XyzabcSolver.html","topicUid":"Hi.Numerical.Xyzabc.XyzabcSolver","type":"Class"},{"name":"XyzabcUtil","href":"Hi.Numerical.Xyzabc.XyzabcUtil.html","topicHref":"Hi.Numerical.Xyzabc.XyzabcUtil.html","topicUid":"Hi.Numerical.Xyzabc.XyzabcUtil","type":"Class"}]},{"name":"Hi.PanelModels","href":"Hi.PanelModels.html","topicHref":"Hi.PanelModels.html","topicUid":"Hi.PanelModels","type":"Namespace","items":[{"name":"HiKey","href":"Hi.PanelModels.HiKey.html","topicHref":"Hi.PanelModels.HiKey.html","topicUid":"Hi.PanelModels.HiKey","type":"Enum"},{"name":"HiKeyEvent","href":"Hi.PanelModels.HiKeyEvent.html","topicHref":"Hi.PanelModels.HiKeyEvent.html","topicUid":"Hi.PanelModels.HiKeyEvent","type":"Class"},{"name":"HiModifierKeys","href":"Hi.PanelModels.HiModifierKeys.html","topicHref":"Hi.PanelModels.HiModifierKeys.html","topicUid":"Hi.PanelModels.HiModifierKeys","type":"Enum"},{"name":"HiMouseButton","href":"Hi.PanelModels.HiMouseButton.html","topicHref":"Hi.PanelModels.HiMouseButton.html","topicUid":"Hi.PanelModels.HiMouseButton","type":"Enum"},{"name":"HiMouseButtonEvent","href":"Hi.PanelModels.HiMouseButtonEvent.html","topicHref":"Hi.PanelModels.HiMouseButtonEvent.html","topicUid":"Hi.PanelModels.HiMouseButtonEvent","type":"Class"},{"name":"HiMouseButtonMask","href":"Hi.PanelModels.HiMouseButtonMask.html","topicHref":"Hi.PanelModels.HiMouseButtonMask.html","topicUid":"Hi.PanelModels.HiMouseButtonMask","type":"Enum"},{"name":"HiMouseButtonMaskUtil","href":"Hi.PanelModels.HiMouseButtonMaskUtil.html","topicHref":"Hi.PanelModels.HiMouseButtonMaskUtil.html","topicUid":"Hi.PanelModels.HiMouseButtonMaskUtil","type":"Class"},{"name":"HiMouseMoveEvent","href":"Hi.PanelModels.HiMouseMoveEvent.html","topicHref":"Hi.PanelModels.HiMouseMoveEvent.html","topicUid":"Hi.PanelModels.HiMouseMoveEvent","type":"Class"},{"name":"HiMouseWheelEvent","href":"Hi.PanelModels.HiMouseWheelEvent.html","topicHref":"Hi.PanelModels.HiMouseWheelEvent.html","topicUid":"Hi.PanelModels.HiMouseWheelEvent","type":"Class"},{"name":"PanelModel","href":"Hi.PanelModels.PanelModel.html","topicHref":"Hi.PanelModels.PanelModel.html","topicUid":"Hi.PanelModels.PanelModel","type":"Class"}]},{"name":"Hi.Parallels","href":"Hi.Parallels.html","topicHref":"Hi.Parallels.html","topicUid":"Hi.Parallels","type":"Namespace","items":[{"name":"CurrentThreadTaskScheduler","href":"Hi.Parallels.CurrentThreadTaskScheduler.html","topicHref":"Hi.Parallels.CurrentThreadTaskScheduler.html","topicUid":"Hi.Parallels.CurrentThreadTaskScheduler","type":"Class"},{"name":"DistributedQueueTaskScheduler","href":"Hi.Parallels.DistributedQueueTaskScheduler.html","topicHref":"Hi.Parallels.DistributedQueueTaskScheduler.html","topicUid":"Hi.Parallels.DistributedQueueTaskScheduler","type":"Class"},{"name":"DistributedQueueTaskStarter","href":"Hi.Parallels.DistributedQueueTaskStarter.html","topicHref":"Hi.Parallels.DistributedQueueTaskStarter.html","topicUid":"Hi.Parallels.DistributedQueueTaskStarter","type":"Class"},{"name":"LockUtil","href":"Hi.Parallels.LockUtil.html","topicHref":"Hi.Parallels.LockUtil.html","topicUid":"Hi.Parallels.LockUtil","type":"Class"},{"name":"QueueTaskScheduler","href":"Hi.Parallels.QueueTaskScheduler.html","topicHref":"Hi.Parallels.QueueTaskScheduler.html","topicUid":"Hi.Parallels.QueueTaskScheduler","type":"Class"},{"name":"ReaderWriterLockUtil","href":"Hi.Parallels.ReaderWriterLockUtil.html","topicHref":"Hi.Parallels.ReaderWriterLockUtil.html","topicUid":"Hi.Parallels.ReaderWriterLockUtil","type":"Class"},{"name":"SemaphoreUtil","href":"Hi.Parallels.SemaphoreUtil.html","topicHref":"Hi.Parallels.SemaphoreUtil.html","topicUid":"Hi.Parallels.SemaphoreUtil","type":"Class"},{"name":"ThreadSafeSet","href":"Hi.Parallels.ThreadSafeSet-1.html","topicHref":"Hi.Parallels.ThreadSafeSet-1.html","topicUid":"Hi.Parallels.ThreadSafeSet`1","type":"Class"}]},{"name":"Hi.Physics","href":"Hi.Physics.html","topicHref":"Hi.Physics.html","topicUid":"Hi.Physics","type":"Namespace","items":[{"name":"AmpPhase","href":"Hi.Physics.AmpPhase.html","topicHref":"Hi.Physics.AmpPhase.html","topicUid":"Hi.Physics.AmpPhase","type":"Class"},{"name":"CoatingMaterial","href":"Hi.Physics.CoatingMaterial.html","topicHref":"Hi.Physics.CoatingMaterial.html","topicUid":"Hi.Physics.CoatingMaterial","type":"Class"},{"name":"CoolantHeatCondition","href":"Hi.Physics.CoolantHeatCondition.html","topicHref":"Hi.Physics.CoolantHeatCondition.html","topicUid":"Hi.Physics.CoolantHeatCondition","type":"Class"},{"name":"CutterMaterial","href":"Hi.Physics.CutterMaterial.html","topicHref":"Hi.Physics.CutterMaterial.html","topicUid":"Hi.Physics.CutterMaterial","type":"Class"},{"name":"IGetThermalLayerList","href":"Hi.Physics.IGetThermalLayerList.html","topicHref":"Hi.Physics.IGetThermalLayerList.html","topicUid":"Hi.Physics.IGetThermalLayerList","type":"Interface"},{"name":"IStructureMaterial","href":"Hi.Physics.IStructureMaterial.html","topicHref":"Hi.Physics.IStructureMaterial.html","topicUid":"Hi.Physics.IStructureMaterial","type":"Interface"},{"name":"ISuccessivePhysicsBriefAccessor","href":"Hi.Physics.ISuccessivePhysicsBriefAccessor.html","topicHref":"Hi.Physics.ISuccessivePhysicsBriefAccessor.html","topicUid":"Hi.Physics.ISuccessivePhysicsBriefAccessor","type":"Interface"},{"name":"ISurfaceMaterial","href":"Hi.Physics.ISurfaceMaterial.html","topicHref":"Hi.Physics.ISurfaceMaterial.html","topicUid":"Hi.Physics.ISurfaceMaterial","type":"Interface"},{"name":"ITimeGetter","href":"Hi.Physics.ITimeGetter.html","topicHref":"Hi.Physics.ITimeGetter.html","topicUid":"Hi.Physics.ITimeGetter","type":"Interface"},{"name":"MillingTemperatureUtil","href":"Hi.Physics.MillingTemperatureUtil.html","topicHref":"Hi.Physics.MillingTemperatureUtil.html","topicUid":"Hi.Physics.MillingTemperatureUtil","type":"Class"},{"name":"SeqPhysicsBrief","href":"Hi.Physics.SeqPhysicsBrief.html","topicHref":"Hi.Physics.SeqPhysicsBrief.html","topicUid":"Hi.Physics.SeqPhysicsBrief","type":"Class"},{"name":"StructureMaterial","href":"Hi.Physics.StructureMaterial.html","topicHref":"Hi.Physics.StructureMaterial.html","topicUid":"Hi.Physics.StructureMaterial","type":"Class"},{"name":"TemperatureUtil","href":"Hi.Physics.TemperatureUtil.html","topicHref":"Hi.Physics.TemperatureUtil.html","topicUid":"Hi.Physics.TemperatureUtil","type":"Class"},{"name":"TemperatureVsHardness","href":"Hi.Physics.TemperatureVsHardness.html","topicHref":"Hi.Physics.TemperatureVsHardness.html","topicUid":"Hi.Physics.TemperatureVsHardness","type":"Class"},{"name":"ThermalLayer1D","href":"Hi.Physics.ThermalLayer1D.html","topicHref":"Hi.Physics.ThermalLayer1D.html","topicUid":"Hi.Physics.ThermalLayer1D","type":"Class"},{"name":"TimeSeriesUtil","href":"Hi.Physics.TimeSeriesUtil.html","topicHref":"Hi.Physics.TimeSeriesUtil.html","topicUid":"Hi.Physics.TimeSeriesUtil","type":"Class"},{"name":"TimeValue","href":"Hi.Physics.TimeValue.html","topicHref":"Hi.Physics.TimeValue.html","topicUid":"Hi.Physics.TimeValue","type":"Class"},{"name":"WorkpieceMaterial","href":"Hi.Physics.WorkpieceMaterial.html","topicHref":"Hi.Physics.WorkpieceMaterial.html","topicUid":"Hi.Physics.WorkpieceMaterial","type":"Class"}]},{"name":"Hi.ScriptApiUtils","href":"Hi.ScriptApiUtils.html","topicHref":"Hi.ScriptApiUtils.html","topicUid":"Hi.ScriptApiUtils","type":"Namespace","items":[{"name":"ICsScriptApi","href":"Hi.ScriptApiUtils.ICsScriptApi.html","topicHref":"Hi.ScriptApiUtils.ICsScriptApi.html","topicUid":"Hi.ScriptApiUtils.ICsScriptApi","type":"Interface"},{"name":"JsAceAttribute","href":"Hi.ScriptApiUtils.JsAceAttribute.html","topicHref":"Hi.ScriptApiUtils.JsAceAttribute.html","topicUid":"Hi.ScriptApiUtils.JsAceAttribute","type":"Class"}]},{"name":"Hi.ShellCommandUtils","href":"Hi.ShellCommandUtils.html","topicHref":"Hi.ShellCommandUtils.html","topicUid":"Hi.ShellCommandUtils","type":"Namespace","items":[{"name":"CommandEntry","href":"Hi.ShellCommandUtils.CommandEntry.html","topicHref":"Hi.ShellCommandUtils.CommandEntry.html","topicUid":"Hi.ShellCommandUtils.CommandEntry","type":"Class"},{"name":"GeomDiffCommand","href":"Hi.ShellCommandUtils.GeomDiffCommand.html","topicHref":"Hi.ShellCommandUtils.GeomDiffCommand.html","topicUid":"Hi.ShellCommandUtils.GeomDiffCommand","type":"Class"},{"name":"IShellCommand","href":"Hi.ShellCommandUtils.IShellCommand.html","topicHref":"Hi.ShellCommandUtils.IShellCommand.html","topicUid":"Hi.ShellCommandUtils.IShellCommand","type":"Interface"},{"name":"Lang","href":"Hi.ShellCommandUtils.Lang.html","topicHref":"Hi.ShellCommandUtils.Lang.html","topicUid":"Hi.ShellCommandUtils.Lang","type":"Class"},{"name":"ListCommand","href":"Hi.ShellCommandUtils.ListCommand.html","topicHref":"Hi.ShellCommandUtils.ListCommand.html","topicUid":"Hi.ShellCommandUtils.ListCommand","type":"Class"},{"name":"MachiningMotionResolutionCommand","href":"Hi.ShellCommandUtils.MachiningMotionResolutionCommand.html","topicHref":"Hi.ShellCommandUtils.MachiningMotionResolutionCommand.html","topicUid":"Hi.ShellCommandUtils.MachiningMotionResolutionCommand","type":"Class"},{"name":"NcCodeCommand","href":"Hi.ShellCommandUtils.NcCodeCommand.html","topicHref":"Hi.ShellCommandUtils.NcCodeCommand.html","topicUid":"Hi.ShellCommandUtils.NcCodeCommand","type":"Class"},{"name":"NcFileCommand","href":"Hi.ShellCommandUtils.NcFileCommand.html","topicHref":"Hi.ShellCommandUtils.NcFileCommand.html","topicUid":"Hi.ShellCommandUtils.NcFileCommand","type":"Class"},{"name":"NcFileListCommand","href":"Hi.ShellCommandUtils.NcFileListCommand.html","topicHref":"Hi.ShellCommandUtils.NcFileListCommand.html","topicUid":"Hi.ShellCommandUtils.NcFileListCommand","type":"Class"},{"name":"OptimizeToFilesCommand","href":"Hi.ShellCommandUtils.OptimizeToFilesCommand.html","topicHref":"Hi.ShellCommandUtils.OptimizeToFilesCommand.html","topicUid":"Hi.ShellCommandUtils.OptimizeToFilesCommand","type":"Class"},{"name":"RecordRuntimeGeomActionEnum","href":"Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum.html","topicHref":"Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum.html","topicUid":"Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum","type":"Enum"},{"name":"RecordRuntimeGeomCommand","href":"Hi.ShellCommandUtils.RecordRuntimeGeomCommand.html","topicHref":"Hi.ShellCommandUtils.RecordRuntimeGeomCommand.html","topicUid":"Hi.ShellCommandUtils.RecordRuntimeGeomCommand","type":"Class"},{"name":"RuntimeCommand","href":"Hi.ShellCommandUtils.RuntimeCommand.html","topicHref":"Hi.ShellCommandUtils.RuntimeCommand.html","topicUid":"Hi.ShellCommandUtils.RuntimeCommand","type":"Class"},{"name":"ScriptCommand","href":"Hi.ShellCommandUtils.ScriptCommand.html","topicHref":"Hi.ShellCommandUtils.ScriptCommand.html","topicUid":"Hi.ShellCommandUtils.ScriptCommand","type":"Class"},{"name":"WriteRuntimeGeomToStlCommand","href":"Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand.html","topicHref":"Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand.html","topicUid":"Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand","type":"Class"},{"name":"WriteShotFilesCommand","href":"Hi.ShellCommandUtils.WriteShotFilesCommand.html","topicHref":"Hi.ShellCommandUtils.WriteShotFilesCommand.html","topicUid":"Hi.ShellCommandUtils.WriteShotFilesCommand","type":"Class"},{"name":"WriteStepFilesCommand","href":"Hi.ShellCommandUtils.WriteStepFilesCommand.html","topicHref":"Hi.ShellCommandUtils.WriteStepFilesCommand.html","topicUid":"Hi.ShellCommandUtils.WriteStepFilesCommand","type":"Class"}]},{"name":"Hi.Test","href":"Hi.Test.html","topicHref":"Hi.Test.html","topicUid":"Hi.Test","type":"Namespace","items":[{"name":"TestCollision","href":"Hi.Test.TestCollision.html","topicHref":"Hi.Test.TestCollision.html","topicUid":"Hi.Test.TestCollision","type":"Class"}]},{"name":"Hi.UiExtensions","href":"Hi.UiExtensions.html","topicHref":"Hi.UiExtensions.html","topicUid":"Hi.UiExtensions","type":"Namespace","items":[{"name":"ChartBoundary","href":"Hi.UiExtensions.ChartBoundary.html","topicHref":"Hi.UiExtensions.ChartBoundary.html","topicUid":"Hi.UiExtensions.ChartBoundary","type":"Class"},{"name":"ChartBoundaryEnum","href":"Hi.UiExtensions.ChartBoundaryEnum.html","topicHref":"Hi.UiExtensions.ChartBoundaryEnum.html","topicUid":"Hi.UiExtensions.ChartBoundaryEnum","type":"Enum"},{"name":"NativeVisibility","href":"Hi.UiExtensions.NativeVisibility.html","topicHref":"Hi.UiExtensions.NativeVisibility.html","topicUid":"Hi.UiExtensions.NativeVisibility","type":"Enum"},{"name":"UiUtil","href":"Hi.UiExtensions.UiUtil.html","topicHref":"Hi.UiExtensions.UiUtil.html","topicUid":"Hi.UiExtensions.UiUtil","type":"Class"},{"name":"UiUtil.InvokeFunc","href":"Hi.UiExtensions.UiUtil.InvokeFunc.html","topicHref":"Hi.UiExtensions.UiUtil.InvokeFunc.html","topicUid":"Hi.UiExtensions.UiUtil.InvokeFunc","type":"Delegate"}]},{"name":"Hi.UniversalNc","href":"Hi.UniversalNc.html","topicHref":"Hi.UniversalNc.html","topicUid":"Hi.UniversalNc","type":"Namespace","items":[{"name":"Lang","href":"Hi.UniversalNc.Lang.html","topicHref":"Hi.UniversalNc.Lang.html","topicUid":"Hi.UniversalNc.Lang","type":"Class"},{"name":"UniversalNcStep","href":"Hi.UniversalNc.UniversalNcStep.html","topicHref":"Hi.UniversalNc.UniversalNcStep.html","topicUid":"Hi.UniversalNc.UniversalNcStep","type":"Class"}]},{"name":"Hi.Vibrations","href":"Hi.Vibrations.html","topicHref":"Hi.Vibrations.html","topicUid":"Hi.Vibrations","type":"Namespace","items":[{"name":"AngularVelocityUtil","href":"Hi.Vibrations.AngularVelocityUtil.html","topicHref":"Hi.Vibrations.AngularVelocityUtil.html","topicUid":"Hi.Vibrations.AngularVelocityUtil","type":"Class"},{"name":"ForceAccelAmpPhase","href":"Hi.Vibrations.ForceAccelAmpPhase.html","topicHref":"Hi.Vibrations.ForceAccelAmpPhase.html","topicUid":"Hi.Vibrations.ForceAccelAmpPhase","type":"Class"},{"name":"ForceAccelFourierSeries","href":"Hi.Vibrations.ForceAccelFourierSeries.html","topicHref":"Hi.Vibrations.ForceAccelFourierSeries.html","topicUid":"Hi.Vibrations.ForceAccelFourierSeries","type":"Class"},{"name":"ForceAccelShot","href":"Hi.Vibrations.ForceAccelShot.html","topicHref":"Hi.Vibrations.ForceAccelShot.html","topicUid":"Hi.Vibrations.ForceAccelShot","type":"Class"},{"name":"ForceAccelUtil","href":"Hi.Vibrations.ForceAccelUtil.html","topicHref":"Hi.Vibrations.ForceAccelUtil.html","topicUid":"Hi.Vibrations.ForceAccelUtil","type":"Class"},{"name":"IAngularVelocityOwner","href":"Hi.Vibrations.IAngularVelocityOwner.html","topicHref":"Hi.Vibrations.IAngularVelocityOwner.html","topicUid":"Hi.Vibrations.IAngularVelocityOwner","type":"Interface"},{"name":"VibrationUtil","href":"Hi.Vibrations.VibrationUtil.html","topicHref":"Hi.Vibrations.VibrationUtil.html","topicUid":"Hi.Vibrations.VibrationUtil","type":"Class"},{"name":"WAmpPhase","href":"Hi.Vibrations.WAmpPhase.html","topicHref":"Hi.Vibrations.WAmpPhase.html","topicUid":"Hi.Vibrations.WAmpPhase","type":"Class"},{"name":"WAmpPhaseXyzTransformation","href":"Hi.Vibrations.WAmpPhaseXyzTransformation.html","topicHref":"Hi.Vibrations.WAmpPhaseXyzTransformation.html","topicUid":"Hi.Vibrations.WAmpPhaseXyzTransformation","type":"Class"}]},{"name":"Hi.WinForm.Disp","href":"Hi.WinForm.Disp.html","topicHref":"Hi.WinForm.Disp.html","topicUid":"Hi.WinForm.Disp","type":"Namespace","items":[{"name":"RenderingCanvas","href":"Hi.WinForm.Disp.RenderingCanvas.html","topicHref":"Hi.WinForm.Disp.RenderingCanvas.html","topicUid":"Hi.WinForm.Disp.RenderingCanvas","type":"Class"},{"name":"RenderingForm","href":"Hi.WinForm.Disp.RenderingForm.html","topicHref":"Hi.WinForm.Disp.RenderingForm.html","topicUid":"Hi.WinForm.Disp.RenderingForm","type":"Class"}]},{"name":"Hi.Wpf.Disp","href":"Hi.Wpf.Disp.html","topicHref":"Hi.Wpf.Disp.html","topicUid":"Hi.Wpf.Disp","type":"Namespace","items":[{"name":"RenderingCanvas","href":"Hi.Wpf.Disp.RenderingCanvas.html","topicHref":"Hi.Wpf.Disp.RenderingCanvas.html","topicUid":"Hi.Wpf.Disp.RenderingCanvas","type":"Class"},{"name":"RenderingWindow","href":"Hi.Wpf.Disp.RenderingWindow.html","topicHref":"Hi.Wpf.Disp.RenderingWindow.html","topicUid":"Hi.Wpf.Disp.RenderingWindow","type":"Class"}]},{"name":"HiNc.Grpcs","href":"HiNc.Grpcs.html","topicHref":"HiNc.Grpcs.html","topicUid":"HiNc.Grpcs","type":"Namespace","items":[{"name":"MachiningProjectGrpcServer","href":"HiNc.Grpcs.MachiningProjectGrpcServer.html","topicHref":"HiNc.Grpcs.MachiningProjectGrpcServer.html","topicUid":"HiNc.Grpcs.MachiningProjectGrpcServer","type":"Class"}]},{"name":"numerical","href":"numerical.html","topicHref":"numerical.html","topicUid":"numerical","type":"Namespace","items":[{"name":"Empty","href":"numerical.Empty.html","topicHref":"numerical.Empty.html","topicUid":"numerical.Empty","type":"Class"},{"name":"GrpcCsvRowDictionary","href":"numerical.GrpcCsvRowDictionary.html","topicHref":"numerical.GrpcCsvRowDictionary.html","topicUid":"numerical.GrpcCsvRowDictionary","type":"Class"},{"name":"GrpcNcStep","href":"numerical.GrpcNcStep.html","topicHref":"numerical.GrpcNcStep.html","topicUid":"numerical.GrpcNcStep","type":"Class"},{"name":"NumericalReflection","href":"numerical.NumericalReflection.html","topicHref":"numerical.NumericalReflection.html","topicUid":"numerical.NumericalReflection","type":"Class"},{"name":"NumericalService","href":"numerical.NumericalService.html","topicHref":"numerical.NumericalService.html","topicUid":"numerical.NumericalService","type":"Class"},{"name":"NumericalService.NumericalServiceBase","href":"numerical.NumericalService.NumericalServiceBase.html","topicHref":"numerical.NumericalService.NumericalServiceBase.html","topicUid":"numerical.NumericalService.NumericalServiceBase","type":"Class"},{"name":"NumericalService.NumericalServiceClient","href":"numerical.NumericalService.NumericalServiceClient.html","topicHref":"numerical.NumericalService.NumericalServiceClient.html","topicUid":"numerical.NumericalService.NumericalServiceClient","type":"Class"},{"name":"UniversalNcReflection","href":"numerical.UniversalNcReflection.html","topicHref":"numerical.UniversalNcReflection.html","topicUid":"numerical.UniversalNcReflection","type":"Class"},{"name":"UniversalNcService","href":"numerical.UniversalNcService.html","topicHref":"numerical.UniversalNcService.html","topicUid":"numerical.UniversalNcService","type":"Class"},{"name":"UniversalNcService.UniversalNcServiceBase","href":"numerical.UniversalNcService.UniversalNcServiceBase.html","topicHref":"numerical.UniversalNcService.UniversalNcServiceBase.html","topicUid":"numerical.UniversalNcService.UniversalNcServiceBase","type":"Class"},{"name":"UniversalNcService.UniversalNcServiceClient","href":"numerical.UniversalNcService.UniversalNcServiceClient.html","topicHref":"numerical.UniversalNcService.UniversalNcServiceClient.html","topicUid":"numerical.UniversalNcService.UniversalNcServiceClient","type":"Class"}]}],"memberLayout":"SamePage"} +{"items":[{"name":"Hi.Cbtr","href":"Hi.Cbtr.html","topicHref":"Hi.Cbtr.html","topicUid":"Hi.Cbtr","type":"Namespace","items":[{"name":"CachedTris","href":"Hi.Cbtr.CachedTris.html","topicHref":"Hi.Cbtr.CachedTris.html","topicUid":"Hi.Cbtr.CachedTris","type":"Class"},{"name":"CachedTris.SweepingMode","href":"Hi.Cbtr.CachedTris.SweepingMode.html","topicHref":"Hi.Cbtr.CachedTris.SweepingMode.html","topicUid":"Hi.Cbtr.CachedTris.SweepingMode","type":"Enum"},{"name":"CbtrPickable","href":"Hi.Cbtr.CbtrPickable.html","topicHref":"Hi.Cbtr.CbtrPickable.html","topicUid":"Hi.Cbtr.CbtrPickable","type":"Class"},{"name":"CubeTree","href":"Hi.Cbtr.CubeTree.html","topicHref":"Hi.Cbtr.CubeTree.html","topicUid":"Hi.Cbtr.CubeTree","type":"Class"},{"name":"CubeTree.diff_response_func_t","href":"Hi.Cbtr.CubeTree.diff_response_func_t.html","topicHref":"Hi.Cbtr.CubeTree.diff_response_func_t.html","topicUid":"Hi.Cbtr.CubeTree.diff_response_func_t","type":"Delegate"},{"name":"CubeTreeFile","href":"Hi.Cbtr.CubeTreeFile.html","topicHref":"Hi.Cbtr.CubeTreeFile.html","topicUid":"Hi.Cbtr.CubeTreeFile","type":"Class"},{"name":"DiffAttachment","href":"Hi.Cbtr.DiffAttachment.html","topicHref":"Hi.Cbtr.DiffAttachment.html","topicUid":"Hi.Cbtr.DiffAttachment","type":"Class"},{"name":"GeomBoolCache","href":"Hi.Cbtr.GeomBoolCache.html","topicHref":"Hi.Cbtr.GeomBoolCache.html","topicUid":"Hi.Cbtr.GeomBoolCache","type":"Class"},{"name":"GeomBoolCacheEnum","href":"Hi.Cbtr.GeomBoolCacheEnum.html","topicHref":"Hi.Cbtr.GeomBoolCacheEnum.html","topicUid":"Hi.Cbtr.GeomBoolCacheEnum","type":"Enum"},{"name":"IGetInitStickConvex","href":"Hi.Cbtr.IGetInitStickConvex.html","topicHref":"Hi.Cbtr.IGetInitStickConvex.html","topicUid":"Hi.Cbtr.IGetInitStickConvex","type":"Interface"},{"name":"InitStickConvex","href":"Hi.Cbtr.InitStickConvex.html","topicHref":"Hi.Cbtr.InitStickConvex.html","topicUid":"Hi.Cbtr.InitStickConvex","type":"Class"},{"name":"LsStl","href":"Hi.Cbtr.LsStl.html","topicHref":"Hi.Cbtr.LsStl.html","topicUid":"Hi.Cbtr.LsStl","type":"Class"},{"name":"Substraction","href":"Hi.Cbtr.Substraction.html","topicHref":"Hi.Cbtr.Substraction.html","topicUid":"Hi.Cbtr.Substraction","type":"Class"},{"name":"UnhighlightablePickable","href":"Hi.Cbtr.UnhighlightablePickable.html","topicHref":"Hi.Cbtr.UnhighlightablePickable.html","topicUid":"Hi.Cbtr.UnhighlightablePickable","type":"Class"},{"name":"UnmanagedSubstraction","href":"Hi.Cbtr.UnmanagedSubstraction.html","topicHref":"Hi.Cbtr.UnmanagedSubstraction.html","topicUid":"Hi.Cbtr.UnmanagedSubstraction","type":"Class"},{"name":"node_diff_t","href":"Hi.Cbtr.node_diff_t.html","topicHref":"Hi.Cbtr.node_diff_t.html","topicUid":"Hi.Cbtr.node_diff_t","type":"Struct"}]},{"name":"Hi.Collision","href":"Hi.Collision.html","topicHref":"Hi.Collision.html","topicUid":"Hi.Collision","type":"Namespace","items":[{"name":"AnchoredCollidableLeaf","href":"Hi.Collision.AnchoredCollidableLeaf.html","topicHref":"Hi.Collision.AnchoredCollidableLeaf.html","topicUid":"Hi.Collision.AnchoredCollidableLeaf","type":"Class"},{"name":"AnchoredCollidablePair","href":"Hi.Collision.AnchoredCollidablePair.html","topicHref":"Hi.Collision.AnchoredCollidablePair.html","topicUid":"Hi.Collision.AnchoredCollidablePair","type":"Class"},{"name":"CollidableStl","href":"Hi.Collision.CollidableStl.html","topicHref":"Hi.Collision.CollidableStl.html","topicUid":"Hi.Collision.CollidableStl","type":"Class"},{"name":"CollisionFlag","href":"Hi.Collision.CollisionFlag.html","topicHref":"Hi.Collision.CollisionFlag.html","topicUid":"Hi.Collision.CollisionFlag","type":"Enum"},{"name":"CollisionIndexPair","href":"Hi.Collision.CollisionIndexPair.html","topicHref":"Hi.Collision.CollisionIndexPair.html","topicUid":"Hi.Collision.CollisionIndexPair","type":"Class"},{"name":"CollisionUtil","href":"Hi.Collision.CollisionUtil.html","topicHref":"Hi.Collision.CollisionUtil.html","topicUid":"Hi.Collision.CollisionUtil","type":"Class"},{"name":"FuncAnchoredCollidable","href":"Hi.Collision.FuncAnchoredCollidable.html","topicHref":"Hi.Collision.FuncAnchoredCollidable.html","topicUid":"Hi.Collision.FuncAnchoredCollidable","type":"Class"},{"name":"IAnchoredCollidableBased","href":"Hi.Collision.IAnchoredCollidableBased.html","topicHref":"Hi.Collision.IAnchoredCollidableBased.html","topicUid":"Hi.Collision.IAnchoredCollidableBased","type":"Interface"},{"name":"IAnchoredCollidableLeaf","href":"Hi.Collision.IAnchoredCollidableLeaf.html","topicHref":"Hi.Collision.IAnchoredCollidableLeaf.html","topicUid":"Hi.Collision.IAnchoredCollidableLeaf","type":"Interface"},{"name":"IAnchoredCollidableNode","href":"Hi.Collision.IAnchoredCollidableNode.html","topicHref":"Hi.Collision.IAnchoredCollidableNode.html","topicUid":"Hi.Collision.IAnchoredCollidableNode","type":"Interface"},{"name":"IAnchoredCollidableStem","href":"Hi.Collision.IAnchoredCollidableStem.html","topicHref":"Hi.Collision.IAnchoredCollidableStem.html","topicUid":"Hi.Collision.IAnchoredCollidableStem","type":"Interface"},{"name":"ICollidable","href":"Hi.Collision.ICollidable.html","topicHref":"Hi.Collision.ICollidable.html","topicUid":"Hi.Collision.ICollidable","type":"Interface"},{"name":"ICollidee","href":"Hi.Collision.ICollidee.html","topicHref":"Hi.Collision.ICollidee.html","topicUid":"Hi.Collision.ICollidee","type":"Interface"},{"name":"ICollisionArena","href":"Hi.Collision.ICollisionArena.html","topicHref":"Hi.Collision.ICollisionArena.html","topicUid":"Hi.Collision.ICollisionArena","type":"Interface"},{"name":"ICollisionIndex","href":"Hi.Collision.ICollisionIndex.html","topicHref":"Hi.Collision.ICollisionIndex.html","topicUid":"Hi.Collision.ICollisionIndex","type":"Interface"},{"name":"IGetAnchoredCollidablePairs","href":"Hi.Collision.IGetAnchoredCollidablePairs.html","topicHref":"Hi.Collision.IGetAnchoredCollidablePairs.html","topicUid":"Hi.Collision.IGetAnchoredCollidablePairs","type":"Interface"},{"name":"IGetCollidable","href":"Hi.Collision.IGetCollidable.html","topicHref":"Hi.Collision.IGetCollidable.html","topicUid":"Hi.Collision.IGetCollidable","type":"Interface"},{"name":"IGetCollisionIndexPairs","href":"Hi.Collision.IGetCollisionIndexPairs.html","topicHref":"Hi.Collision.IGetCollisionIndexPairs.html","topicUid":"Hi.Collision.IGetCollisionIndexPairs","type":"Interface"},{"name":"IGetDefaultCollidablePairs","href":"Hi.Collision.IGetDefaultCollidablePairs.html","topicHref":"Hi.Collision.IGetDefaultCollidablePairs.html","topicUid":"Hi.Collision.IGetDefaultCollidablePairs","type":"Interface"},{"name":"IGetTriTree","href":"Hi.Collision.IGetTriTree.html","topicHref":"Hi.Collision.IGetTriTree.html","topicUid":"Hi.Collision.IGetTriTree","type":"Interface"},{"name":"MechCollisionResult","href":"Hi.Collision.MechCollisionResult.html","topicHref":"Hi.Collision.MechCollisionResult.html","topicUid":"Hi.Collision.MechCollisionResult","type":"Class"},{"name":"MechCollisionUtil","href":"Hi.Collision.MechCollisionUtil.html","topicHref":"Hi.Collision.MechCollisionUtil.html","topicUid":"Hi.Collision.MechCollisionUtil","type":"Class"},{"name":"TriTree","href":"Hi.Collision.TriTree.html","topicHref":"Hi.Collision.TriTree.html","topicUid":"Hi.Collision.TriTree","type":"Class"}]},{"name":"Hi.Collisions","href":"Hi.Collisions.html","topicHref":"Hi.Collisions.html","topicUid":"Hi.Collisions","type":"Namespace","items":[{"name":"AnchoredCollidabled","href":"Hi.Collisions.AnchoredCollidabled.html","topicHref":"Hi.Collisions.AnchoredCollidabled.html","topicUid":"Hi.Collisions.AnchoredCollidabled","type":"Class"},{"name":"IAnchoredCollidabled","href":"Hi.Collisions.IAnchoredCollidabled.html","topicHref":"Hi.Collisions.IAnchoredCollidabled.html","topicUid":"Hi.Collisions.IAnchoredCollidabled","type":"Interface"}]},{"name":"Hi.Coloring","href":"Hi.Coloring.html","topicHref":"Hi.Coloring.html","topicUid":"Hi.Coloring","type":"Namespace","items":[{"name":"ColorUtil","href":"Hi.Coloring.ColorUtil.html","topicHref":"Hi.Coloring.ColorUtil.html","topicUid":"Hi.Coloring.ColorUtil","type":"Class"},{"name":"DictionaryColorGuide","href":"Hi.Coloring.DictionaryColorGuide.html","topicHref":"Hi.Coloring.DictionaryColorGuide.html","topicUid":"Hi.Coloring.DictionaryColorGuide","type":"Class"},{"name":"DiscreteQuantityColorGuide","href":"Hi.Coloring.DiscreteQuantityColorGuide.html","topicHref":"Hi.Coloring.DiscreteQuantityColorGuide.html","topicUid":"Hi.Coloring.DiscreteQuantityColorGuide","type":"Class"},{"name":"FilteredColorGuide","href":"Hi.Coloring.FilteredColorGuide.html","topicHref":"Hi.Coloring.FilteredColorGuide.html","topicUid":"Hi.Coloring.FilteredColorGuide","type":"Class"},{"name":"FuncRangeColorGuide","href":"Hi.Coloring.FuncRangeColorGuide.html","topicHref":"Hi.Coloring.FuncRangeColorGuide.html","topicUid":"Hi.Coloring.FuncRangeColorGuide","type":"Class"},{"name":"IColorGuide","href":"Hi.Coloring.IColorGuide.html","topicHref":"Hi.Coloring.IColorGuide.html","topicUid":"Hi.Coloring.IColorGuide","type":"Interface"},{"name":"IColorGuideProperty","href":"Hi.Coloring.IColorGuideProperty.html","topicHref":"Hi.Coloring.IColorGuideProperty.html","topicUid":"Hi.Coloring.IColorGuideProperty","type":"Interface"},{"name":"IGetColorGuide","href":"Hi.Coloring.IGetColorGuide.html","topicHref":"Hi.Coloring.IGetColorGuide.html","topicUid":"Hi.Coloring.IGetColorGuide","type":"Interface"},{"name":"IGetRangeColorRule","href":"Hi.Coloring.IGetRangeColorRule.html","topicHref":"Hi.Coloring.IGetRangeColorRule.html","topicUid":"Hi.Coloring.IGetRangeColorRule","type":"Interface"},{"name":"IGetRgb","href":"Hi.Coloring.IGetRgb.html","topicHref":"Hi.Coloring.IGetRgb.html","topicUid":"Hi.Coloring.IGetRgb","type":"Interface"},{"name":"IGetRgbWithPriority","href":"Hi.Coloring.IGetRgbWithPriority.html","topicHref":"Hi.Coloring.IGetRgbWithPriority.html","topicUid":"Hi.Coloring.IGetRgbWithPriority","type":"Interface"},{"name":"PlainColorGuide","href":"Hi.Coloring.PlainColorGuide.html","topicHref":"Hi.Coloring.PlainColorGuide.html","topicUid":"Hi.Coloring.PlainColorGuide","type":"Class"},{"name":"QuantityColorGuide","href":"Hi.Coloring.QuantityColorGuide.html","topicHref":"Hi.Coloring.QuantityColorGuide.html","topicUid":"Hi.Coloring.QuantityColorGuide","type":"Class"},{"name":"RangeColorRule","href":"Hi.Coloring.RangeColorRule.html","topicHref":"Hi.Coloring.RangeColorRule.html","topicUid":"Hi.Coloring.RangeColorRule","type":"Class"},{"name":"RatioRgbFuncEnum","href":"Hi.Coloring.RatioRgbFuncEnum.html","topicHref":"Hi.Coloring.RatioRgbFuncEnum.html","topicUid":"Hi.Coloring.RatioRgbFuncEnum","type":"Enum"},{"name":"RgbSeed","href":"Hi.Coloring.RgbSeed.html","topicHref":"Hi.Coloring.RgbSeed.html","topicUid":"Hi.Coloring.RgbSeed","type":"Class"}]},{"name":"Hi.Common","href":"Hi.Common.html","topicHref":"Hi.Common.html","topicUid":"Hi.Common","type":"Namespace","items":[{"name":"BinIoUtil","href":"Hi.Common.BinIoUtil.html","topicHref":"Hi.Common.BinIoUtil.html","topicUid":"Hi.Common.BinIoUtil","type":"Class"},{"name":"BinarySearchResult","href":"Hi.Common.BinarySearchResult.html","topicHref":"Hi.Common.BinarySearchResult.html","topicUid":"Hi.Common.BinarySearchResult","type":"Enum"},{"name":"BitUtil","href":"Hi.Common.BitUtil.html","topicHref":"Hi.Common.BitUtil.html","topicUid":"Hi.Common.BitUtil","type":"Class"},{"name":"BlockingTimer","href":"Hi.Common.BlockingTimer.html","topicHref":"Hi.Common.BlockingTimer.html","topicUid":"Hi.Common.BlockingTimer","type":"Class"},{"name":"BytesUtil","href":"Hi.Common.BytesUtil.html","topicHref":"Hi.Common.BytesUtil.html","topicUid":"Hi.Common.BytesUtil","type":"Class"},{"name":"ConcurrentTimeCounter","href":"Hi.Common.ConcurrentTimeCounter.html","topicHref":"Hi.Common.ConcurrentTimeCounter.html","topicUid":"Hi.Common.ConcurrentTimeCounter","type":"Class"},{"name":"ConsoleUtil","href":"Hi.Common.ConsoleUtil.html","topicHref":"Hi.Common.ConsoleUtil.html","topicUid":"Hi.Common.ConsoleUtil","type":"Class"},{"name":"CppLogUtil","href":"Hi.Common.CppLogUtil.html","topicHref":"Hi.Common.CppLogUtil.html","topicUid":"Hi.Common.CppLogUtil","type":"Class"},{"name":"CppLogUtil.LogDelegate","href":"Hi.Common.CppLogUtil.LogDelegate.html","topicHref":"Hi.Common.CppLogUtil.LogDelegate.html","topicUid":"Hi.Common.CppLogUtil.LogDelegate","type":"Delegate"},{"name":"CultureUtil","href":"Hi.Common.CultureUtil.html","topicHref":"Hi.Common.CultureUtil.html","topicUid":"Hi.Common.CultureUtil","type":"Class"},{"name":"DebugUtil","href":"Hi.Common.DebugUtil.html","topicHref":"Hi.Common.DebugUtil.html","topicUid":"Hi.Common.DebugUtil","type":"Class"},{"name":"DuplicateUtil","href":"Hi.Common.DuplicateUtil.html","topicHref":"Hi.Common.DuplicateUtil.html","topicUid":"Hi.Common.DuplicateUtil","type":"Class"},{"name":"EnumUtil","href":"Hi.Common.EnumUtil.html","topicHref":"Hi.Common.EnumUtil.html","topicUid":"Hi.Common.EnumUtil","type":"Class"},{"name":"EnumerablePlayer","href":"Hi.Common.EnumerablePlayer.html","topicHref":"Hi.Common.EnumerablePlayer.html","topicUid":"Hi.Common.EnumerablePlayer","type":"Class"},{"name":"ExceptionUtil","href":"Hi.Common.ExceptionUtil.html","topicHref":"Hi.Common.ExceptionUtil.html","topicUid":"Hi.Common.ExceptionUtil","type":"Class"},{"name":"IAbstractNote","href":"Hi.Common.IAbstractNote.html","topicHref":"Hi.Common.IAbstractNote.html","topicUid":"Hi.Common.IAbstractNote","type":"Interface"},{"name":"IBinaryIo","href":"Hi.Common.IBinaryIo.html","topicHref":"Hi.Common.IBinaryIo.html","topicUid":"Hi.Common.IBinaryIo","type":"Interface"},{"name":"IClearCache","href":"Hi.Common.IClearCache.html","topicHref":"Hi.Common.IClearCache.html","topicUid":"Hi.Common.IClearCache","type":"Interface"},{"name":"IDuplicate","href":"Hi.Common.IDuplicate.html","topicHref":"Hi.Common.IDuplicate.html","topicUid":"Hi.Common.IDuplicate","type":"Interface"},{"name":"IGetQuantityByKey","href":"Hi.Common.IGetQuantityByKey.html","topicHref":"Hi.Common.IGetQuantityByKey.html","topicUid":"Hi.Common.IGetQuantityByKey","type":"Interface"},{"name":"IGetSelectionName","href":"Hi.Common.IGetSelectionName.html","topicHref":"Hi.Common.IGetSelectionName.html","topicUid":"Hi.Common.IGetSelectionName","type":"Interface"},{"name":"INameNote","href":"Hi.Common.INameNote.html","topicHref":"Hi.Common.INameNote.html","topicUid":"Hi.Common.INameNote","type":"Interface"},{"name":"IPreferredFileName","href":"Hi.Common.IPreferredFileName.html","topicHref":"Hi.Common.IPreferredFileName.html","topicUid":"Hi.Common.IPreferredFileName","type":"Interface"},{"name":"ISourceFile","href":"Hi.Common.ISourceFile.html","topicHref":"Hi.Common.ISourceFile.html","topicUid":"Hi.Common.ISourceFile","type":"Interface"},{"name":"IUpdateByContent","href":"Hi.Common.IUpdateByContent.html","topicHref":"Hi.Common.IUpdateByContent.html","topicUid":"Hi.Common.IUpdateByContent","type":"Interface"},{"name":"IUriGetter","href":"Hi.Common.IUriGetter.html","topicHref":"Hi.Common.IUriGetter.html","topicUid":"Hi.Common.IUriGetter","type":"Interface"},{"name":"IWriteBin","href":"Hi.Common.IWriteBin.html","topicHref":"Hi.Common.IWriteBin.html","topicUid":"Hi.Common.IWriteBin","type":"Interface"},{"name":"IndexSegment","href":"Hi.Common.IndexSegment.html","topicHref":"Hi.Common.IndexSegment.html","topicUid":"Hi.Common.IndexSegment","type":"Class"},{"name":"IntegerKeyDictionaryConverter","href":"Hi.Common.IntegerKeyDictionaryConverter.html","topicHref":"Hi.Common.IntegerKeyDictionaryConverter.html","topicUid":"Hi.Common.IntegerKeyDictionaryConverter","type":"Class"},{"name":"IntegerKeyDictionaryConverter","href":"Hi.Common.IntegerKeyDictionaryConverter-1.html","topicHref":"Hi.Common.IntegerKeyDictionaryConverter-1.html","topicUid":"Hi.Common.IntegerKeyDictionaryConverter`1","type":"Class"},{"name":"InternalException","href":"Hi.Common.InternalException.html","topicHref":"Hi.Common.InternalException.html","topicUid":"Hi.Common.InternalException","type":"Class"},{"name":"InvokeUtil","href":"Hi.Common.InvokeUtil.html","topicHref":"Hi.Common.InvokeUtil.html","topicUid":"Hi.Common.InvokeUtil","type":"Class"},{"name":"JsonUtil","href":"Hi.Common.JsonUtil.html","topicHref":"Hi.Common.JsonUtil.html","topicUid":"Hi.Common.JsonUtil","type":"Class"},{"name":"LooseRunner","href":"Hi.Common.LooseRunner.html","topicHref":"Hi.Common.LooseRunner.html","topicUid":"Hi.Common.LooseRunner","type":"Class"},{"name":"ManualUtil","href":"Hi.Common.ManualUtil.html","topicHref":"Hi.Common.ManualUtil.html","topicUid":"Hi.Common.ManualUtil","type":"Class"},{"name":"MaskUtil","href":"Hi.Common.MaskUtil.html","topicHref":"Hi.Common.MaskUtil.html","topicUid":"Hi.Common.MaskUtil","type":"Class"},{"name":"NameUtil","href":"Hi.Common.NameUtil.html","topicHref":"Hi.Common.NameUtil.html","topicUid":"Hi.Common.NameUtil","type":"Class"},{"name":"PacePlayee","href":"Hi.Common.PacePlayee.html","topicHref":"Hi.Common.PacePlayee.html","topicUid":"Hi.Common.PacePlayee","type":"Class"},{"name":"PacePlayer","href":"Hi.Common.PacePlayer.html","topicHref":"Hi.Common.PacePlayer.html","topicUid":"Hi.Common.PacePlayer","type":"Class"},{"name":"Pair","href":"Hi.Common.Pair-2.html","topicHref":"Hi.Common.Pair-2.html","topicUid":"Hi.Common.Pair`2","type":"Class"},{"name":"Range","href":"Hi.Common.Range-1.html","topicHref":"Hi.Common.Range-1.html","topicUid":"Hi.Common.Range`1","type":"Class"},{"name":"ResourceUtil","href":"Hi.Common.ResourceUtil.html","topicHref":"Hi.Common.ResourceUtil.html","topicUid":"Hi.Common.ResourceUtil","type":"Class"},{"name":"RoutineBlocker","href":"Hi.Common.RoutineBlocker.html","topicHref":"Hi.Common.RoutineBlocker.html","topicUid":"Hi.Common.RoutineBlocker","type":"Class"},{"name":"RoutineBlocker0","href":"Hi.Common.RoutineBlocker0.html","topicHref":"Hi.Common.RoutineBlocker0.html","topicUid":"Hi.Common.RoutineBlocker0","type":"Class"},{"name":"SeqPairUtil","href":"Hi.Common.SeqPairUtil.html","topicHref":"Hi.Common.SeqPairUtil.html","topicUid":"Hi.Common.SeqPairUtil","type":"Class"},{"name":"SeqPair","href":"Hi.Common.SeqPair-1.html","topicHref":"Hi.Common.SeqPair-1.html","topicUid":"Hi.Common.SeqPair`1","type":"Class"},{"name":"ServerFileExplorerConfig","href":"Hi.Common.ServerFileExplorerConfig.html","topicHref":"Hi.Common.ServerFileExplorerConfig.html","topicUid":"Hi.Common.ServerFileExplorerConfig","type":"Class"},{"name":"Slice","href":"Hi.Common.Slice.html","topicHref":"Hi.Common.Slice.html","topicUid":"Hi.Common.Slice","type":"Class"},{"name":"StringLocalizer","href":"Hi.Common.StringLocalizer.html","topicHref":"Hi.Common.StringLocalizer.html","topicUid":"Hi.Common.StringLocalizer","type":"Class"},{"name":"StringUtil","href":"Hi.Common.StringUtil.html","topicHref":"Hi.Common.StringUtil.html","topicUid":"Hi.Common.StringUtil","type":"Class"},{"name":"TaskUtil","href":"Hi.Common.TaskUtil.html","topicHref":"Hi.Common.TaskUtil.html","topicUid":"Hi.Common.TaskUtil","type":"Class"},{"name":"TimeCounter","href":"Hi.Common.TimeCounter.html","topicHref":"Hi.Common.TimeCounter.html","topicUid":"Hi.Common.TimeCounter","type":"Class"}]},{"name":"Hi.Common.Collections","href":"Hi.Common.Collections.html","topicHref":"Hi.Common.Collections.html","topicUid":"Hi.Common.Collections","type":"Namespace","items":[{"name":"DictionaryUtil","href":"Hi.Common.Collections.DictionaryUtil.html","topicHref":"Hi.Common.Collections.DictionaryUtil.html","topicUid":"Hi.Common.Collections.DictionaryUtil","type":"Class"},{"name":"EnumerableUtil","href":"Hi.Common.Collections.EnumerableUtil.html","topicHref":"Hi.Common.Collections.EnumerableUtil.html","topicUid":"Hi.Common.Collections.EnumerableUtil","type":"Class"},{"name":"FixedSizeConcurrentLinkedListUtil","href":"Hi.Common.Collections.FixedSizeConcurrentLinkedListUtil.html","topicHref":"Hi.Common.Collections.FixedSizeConcurrentLinkedListUtil.html","topicUid":"Hi.Common.Collections.FixedSizeConcurrentLinkedListUtil","type":"Class"},{"name":"ListIndexBasedEnumerable","href":"Hi.Common.Collections.ListIndexBasedEnumerable-1.html","topicHref":"Hi.Common.Collections.ListIndexBasedEnumerable-1.html","topicUid":"Hi.Common.Collections.ListIndexBasedEnumerable`1","type":"Class"},{"name":"ListIndexBasedIEnumerator","href":"Hi.Common.Collections.ListIndexBasedIEnumerator-1.html","topicHref":"Hi.Common.Collections.ListIndexBasedIEnumerator-1.html","topicUid":"Hi.Common.Collections.ListIndexBasedIEnumerator`1","type":"Class"},{"name":"ListUtil","href":"Hi.Common.Collections.ListUtil.html","topicHref":"Hi.Common.Collections.ListUtil.html","topicUid":"Hi.Common.Collections.ListUtil","type":"Class"},{"name":"ListUtil.OuterPolationMode","href":"Hi.Common.Collections.ListUtil.OuterPolationMode.html","topicHref":"Hi.Common.Collections.ListUtil.OuterPolationMode.html","topicUid":"Hi.Common.Collections.ListUtil.OuterPolationMode","type":"Enum"},{"name":"SortedListUtil","href":"Hi.Common.Collections.SortedListUtil.html","topicHref":"Hi.Common.Collections.SortedListUtil.html","topicUid":"Hi.Common.Collections.SortedListUtil","type":"Class"},{"name":"SortedListUtil.SearchMethod","href":"Hi.Common.Collections.SortedListUtil.SearchMethod.html","topicHref":"Hi.Common.Collections.SortedListUtil.SearchMethod.html","topicUid":"Hi.Common.Collections.SortedListUtil.SearchMethod","type":"Enum"},{"name":"SynList","href":"Hi.Common.Collections.SynList-1.html","topicHref":"Hi.Common.Collections.SynList-1.html","topicUid":"Hi.Common.Collections.SynList`1","type":"Class"}]},{"name":"Hi.Common.CsvUtils","href":"Hi.Common.CsvUtils.html","topicHref":"Hi.Common.CsvUtils.html","topicUid":"Hi.Common.CsvUtils","type":"Namespace","items":[{"name":"CsvInputKit","href":"Hi.Common.CsvUtils.CsvInputKit.html","topicHref":"Hi.Common.CsvUtils.CsvInputKit.html","topicUid":"Hi.Common.CsvUtils.CsvInputKit","type":"Class"},{"name":"CsvOutputKit","href":"Hi.Common.CsvUtils.CsvOutputKit.html","topicHref":"Hi.Common.CsvUtils.CsvOutputKit.html","topicUid":"Hi.Common.CsvUtils.CsvOutputKit","type":"Class"},{"name":"CsvUtil","href":"Hi.Common.CsvUtils.CsvUtil.html","topicHref":"Hi.Common.CsvUtils.CsvUtil.html","topicUid":"Hi.Common.CsvUtils.CsvUtil","type":"Class"},{"name":"ICsvRowIo","href":"Hi.Common.CsvUtils.ICsvRowIo.html","topicHref":"Hi.Common.CsvUtils.ICsvRowIo.html","topicUid":"Hi.Common.CsvUtils.ICsvRowIo","type":"Interface"},{"name":"IGetCsvDictionary","href":"Hi.Common.CsvUtils.IGetCsvDictionary.html","topicHref":"Hi.Common.CsvUtils.IGetCsvDictionary.html","topicUid":"Hi.Common.CsvUtils.IGetCsvDictionary","type":"Interface"}]},{"name":"Hi.Common.FileLines","href":"Hi.Common.FileLines.html","topicHref":"Hi.Common.FileLines.html","topicUid":"Hi.Common.FileLines","type":"Namespace","items":[{"name":"FileBeginEventArgs","href":"Hi.Common.FileLines.FileBeginEventArgs.html","topicHref":"Hi.Common.FileLines.FileBeginEventArgs.html","topicUid":"Hi.Common.FileLines.FileBeginEventArgs","type":"Class"},{"name":"FileEndEventArgs","href":"Hi.Common.FileLines.FileEndEventArgs.html","topicHref":"Hi.Common.FileLines.FileEndEventArgs.html","topicUid":"Hi.Common.FileLines.FileEndEventArgs","type":"Class"},{"name":"FileLineIndex","href":"Hi.Common.FileLines.FileLineIndex.html","topicHref":"Hi.Common.FileLines.FileLineIndex.html","topicUid":"Hi.Common.FileLines.FileLineIndex","type":"Class"},{"name":"FileLinePipingKit","href":"Hi.Common.FileLines.FileLinePipingKit.html","topicHref":"Hi.Common.FileLines.FileLinePipingKit.html","topicUid":"Hi.Common.FileLines.FileLinePipingKit","type":"Class"},{"name":"FileLineUtil","href":"Hi.Common.FileLines.FileLineUtil.html","topicHref":"Hi.Common.FileLines.FileLineUtil.html","topicUid":"Hi.Common.FileLines.FileLineUtil","type":"Class"},{"name":"FileUtil","href":"Hi.Common.FileLines.FileUtil.html","topicHref":"Hi.Common.FileLines.FileUtil.html","topicUid":"Hi.Common.FileLines.FileUtil","type":"Class"},{"name":"IFileChangedEventSupport","href":"Hi.Common.FileLines.IFileChangedEventSupport.html","topicHref":"Hi.Common.FileLines.IFileChangedEventSupport.html","topicUid":"Hi.Common.FileLines.IFileChangedEventSupport","type":"Interface"},{"name":"IFileLine","href":"Hi.Common.FileLines.IFileLine.html","topicHref":"Hi.Common.FileLines.IFileLine.html","topicUid":"Hi.Common.FileLines.IFileLine","type":"Interface"},{"name":"IFileLineIndex","href":"Hi.Common.FileLines.IFileLineIndex.html","topicHref":"Hi.Common.FileLines.IFileLineIndex.html","topicUid":"Hi.Common.FileLines.IFileLineIndex","type":"Interface"},{"name":"IGetFileLineIndex","href":"Hi.Common.FileLines.IGetFileLineIndex.html","topicHref":"Hi.Common.FileLines.IGetFileLineIndex.html","topicUid":"Hi.Common.FileLines.IGetFileLineIndex","type":"Interface"},{"name":"IGetIndexedFileLine","href":"Hi.Common.FileLines.IGetIndexedFileLine.html","topicHref":"Hi.Common.FileLines.IGetIndexedFileLine.html","topicUid":"Hi.Common.FileLines.IGetIndexedFileLine","type":"Interface"},{"name":"ILineChangedEventSupport","href":"Hi.Common.FileLines.ILineChangedEventSupport.html","topicHref":"Hi.Common.FileLines.ILineChangedEventSupport.html","topicUid":"Hi.Common.FileLines.ILineChangedEventSupport","type":"Interface"},{"name":"IndexedFile","href":"Hi.Common.FileLines.IndexedFile.html","topicHref":"Hi.Common.FileLines.IndexedFile.html","topicUid":"Hi.Common.FileLines.IndexedFile","type":"Class"},{"name":"IndexedFileLine","href":"Hi.Common.FileLines.IndexedFileLine.html","topicHref":"Hi.Common.FileLines.IndexedFileLine.html","topicUid":"Hi.Common.FileLines.IndexedFileLine","type":"Class"},{"name":"LineBeginEventArgs","href":"Hi.Common.FileLines.LineBeginEventArgs.html","topicHref":"Hi.Common.FileLines.LineBeginEventArgs.html","topicUid":"Hi.Common.FileLines.LineBeginEventArgs","type":"Class"},{"name":"LineEndEventArgs","href":"Hi.Common.FileLines.LineEndEventArgs.html","topicHref":"Hi.Common.FileLines.LineEndEventArgs.html","topicUid":"Hi.Common.FileLines.LineEndEventArgs","type":"Class"}]},{"name":"Hi.Common.Messages","href":"Hi.Common.Messages.html","topicHref":"Hi.Common.Messages.html","topicUid":"Hi.Common.Messages","type":"Namespace","items":[{"name":"BootstrapTheme","href":"Hi.Common.Messages.BootstrapTheme.html","topicHref":"Hi.Common.Messages.BootstrapTheme.html","topicUid":"Hi.Common.Messages.BootstrapTheme","type":"Enum"},{"name":"IMessageKit","href":"Hi.Common.Messages.IMessageKit.html","topicHref":"Hi.Common.Messages.IMessageKit.html","topicUid":"Hi.Common.Messages.IMessageKit","type":"Interface"},{"name":"MessageBoardUtil","href":"Hi.Common.Messages.MessageBoardUtil.html","topicHref":"Hi.Common.Messages.MessageBoardUtil.html","topicUid":"Hi.Common.Messages.MessageBoardUtil","type":"Class"},{"name":"MessageFlag","href":"Hi.Common.Messages.MessageFlag.html","topicHref":"Hi.Common.Messages.MessageFlag.html","topicUid":"Hi.Common.Messages.MessageFlag","type":"Enum"},{"name":"MessageHostUtil","href":"Hi.Common.Messages.MessageHostUtil.html","topicHref":"Hi.Common.Messages.MessageHostUtil.html","topicUid":"Hi.Common.Messages.MessageHostUtil","type":"Class"},{"name":"MessageKit","href":"Hi.Common.Messages.MessageKit.html","topicHref":"Hi.Common.Messages.MessageKit.html","topicUid":"Hi.Common.Messages.MessageKit","type":"Class"},{"name":"MultiTagMessage","href":"Hi.Common.Messages.MultiTagMessage.html","topicHref":"Hi.Common.Messages.MultiTagMessage.html","topicUid":"Hi.Common.Messages.MultiTagMessage","type":"Class"},{"name":"ShowMessageBoardDelegate","href":"Hi.Common.Messages.ShowMessageBoardDelegate.html","topicHref":"Hi.Common.Messages.ShowMessageBoardDelegate.html","topicUid":"Hi.Common.Messages.ShowMessageBoardDelegate","type":"Delegate"}]},{"name":"Hi.Common.MinMaxUtils","href":"Hi.Common.MinMaxUtils.html","topicHref":"Hi.Common.MinMaxUtils.html","topicUid":"Hi.Common.MinMaxUtils","type":"Namespace","items":[{"name":"IndexedMinMaxPos","href":"Hi.Common.MinMaxUtils.IndexedMinMaxPos-2.html","topicHref":"Hi.Common.MinMaxUtils.IndexedMinMaxPos-2.html","topicUid":"Hi.Common.MinMaxUtils.IndexedMinMaxPos`2","type":"Class"},{"name":"MinMaxUtil","href":"Hi.Common.MinMaxUtils.MinMaxUtil.html","topicHref":"Hi.Common.MinMaxUtils.MinMaxUtil.html","topicUid":"Hi.Common.MinMaxUtils.MinMaxUtil","type":"Class"}]},{"name":"Hi.Common.NativeProgresses","href":"Hi.Common.NativeProgresses.html","topicHref":"Hi.Common.NativeProgresses.html","topicUid":"Hi.Common.NativeProgresses","type":"Namespace","items":[{"name":"IProgressReport","href":"Hi.Common.NativeProgresses.IProgressReport.html","topicHref":"Hi.Common.NativeProgresses.IProgressReport.html","topicUid":"Hi.Common.NativeProgresses.IProgressReport","type":"Interface"},{"name":"NativeProgressReport","href":"Hi.Common.NativeProgresses.NativeProgressReport.html","topicHref":"Hi.Common.NativeProgresses.NativeProgressReport.html","topicUid":"Hi.Common.NativeProgresses.NativeProgressReport","type":"Class"},{"name":"ProgressReport","href":"Hi.Common.NativeProgresses.ProgressReport.html","topicHref":"Hi.Common.NativeProgresses.ProgressReport.html","topicUid":"Hi.Common.NativeProgresses.ProgressReport","type":"Class"},{"name":"progress_monitor_t","href":"Hi.Common.NativeProgresses.progress_monitor_t.html","topicHref":"Hi.Common.NativeProgresses.progress_monitor_t.html","topicUid":"Hi.Common.NativeProgresses.progress_monitor_t","type":"Struct"},{"name":"report_progress_func_t","href":"Hi.Common.NativeProgresses.report_progress_func_t.html","topicHref":"Hi.Common.NativeProgresses.report_progress_func_t.html","topicUid":"Hi.Common.NativeProgresses.report_progress_func_t","type":"Delegate"}]},{"name":"Hi.Common.ParallelBulkUtils","href":"Hi.Common.ParallelBulkUtils.html","topicHref":"Hi.Common.ParallelBulkUtils.html","topicUid":"Hi.Common.ParallelBulkUtils","type":"Namespace","items":[{"name":"ParallelBulkReader","href":"Hi.Common.ParallelBulkUtils.ParallelBulkReader-1.html","topicHref":"Hi.Common.ParallelBulkUtils.ParallelBulkReader-1.html","topicUid":"Hi.Common.ParallelBulkUtils.ParallelBulkReader`1","type":"Class"},{"name":"ParallelBulkWriter","href":"Hi.Common.ParallelBulkUtils.ParallelBulkWriter-1.html","topicHref":"Hi.Common.ParallelBulkUtils.ParallelBulkWriter-1.html","topicUid":"Hi.Common.ParallelBulkUtils.ParallelBulkWriter`1","type":"Class"},{"name":"ReadBulkDelegate","href":"Hi.Common.ParallelBulkUtils.ReadBulkDelegate-1.html","topicHref":"Hi.Common.ParallelBulkUtils.ReadBulkDelegate-1.html","topicUid":"Hi.Common.ParallelBulkUtils.ReadBulkDelegate`1","type":"Delegate"},{"name":"SequentialBulkReader","href":"Hi.Common.ParallelBulkUtils.SequentialBulkReader-1.html","topicHref":"Hi.Common.ParallelBulkUtils.SequentialBulkReader-1.html","topicUid":"Hi.Common.ParallelBulkUtils.SequentialBulkReader`1","type":"Class"}]},{"name":"Hi.Common.PathUtils","href":"Hi.Common.PathUtils.html","topicHref":"Hi.Common.PathUtils.html","topicUid":"Hi.Common.PathUtils","type":"Namespace","items":[{"name":"BaseAndSubDirectory","href":"Hi.Common.PathUtils.BaseAndSubDirectory.html","topicHref":"Hi.Common.PathUtils.BaseAndSubDirectory.html","topicUid":"Hi.Common.PathUtils.BaseAndSubDirectory","type":"Class"},{"name":"ExtendedNamedPath","href":"Hi.Common.PathUtils.ExtendedNamedPath.html","topicHref":"Hi.Common.PathUtils.ExtendedNamedPath.html","topicUid":"Hi.Common.PathUtils.ExtendedNamedPath","type":"Class"},{"name":"HttpUtil","href":"Hi.Common.PathUtils.HttpUtil.html","topicHref":"Hi.Common.PathUtils.HttpUtil.html","topicUid":"Hi.Common.PathUtils.HttpUtil","type":"Class"},{"name":"Lang","href":"Hi.Common.PathUtils.Lang.html","topicHref":"Hi.Common.PathUtils.Lang.html","topicUid":"Hi.Common.PathUtils.Lang","type":"Class"},{"name":"NamedPath","href":"Hi.Common.PathUtils.NamedPath.html","topicHref":"Hi.Common.PathUtils.NamedPath.html","topicUid":"Hi.Common.PathUtils.NamedPath","type":"Class"},{"name":"PathRoute","href":"Hi.Common.PathUtils.PathRoute.html","topicHref":"Hi.Common.PathUtils.PathRoute.html","topicUid":"Hi.Common.PathUtils.PathRoute","type":"Class"},{"name":"PathUtil","href":"Hi.Common.PathUtils.PathUtil.html","topicHref":"Hi.Common.PathUtils.PathUtil.html","topicUid":"Hi.Common.PathUtils.PathUtil","type":"Class"}]},{"name":"Hi.Common.QueueCacheUtils","href":"Hi.Common.QueueCacheUtils.html","topicHref":"Hi.Common.QueueCacheUtils.html","topicUid":"Hi.Common.QueueCacheUtils","type":"Namespace","items":[{"name":"QueueCacherHost","href":"Hi.Common.QueueCacheUtils.QueueCacherHost-1.html","topicHref":"Hi.Common.QueueCacheUtils.QueueCacherHost-1.html","topicUid":"Hi.Common.QueueCacheUtils.QueueCacherHost`1","type":"Class"},{"name":"QueueCacher","href":"Hi.Common.QueueCacheUtils.QueueCacher-1.html","topicHref":"Hi.Common.QueueCacheUtils.QueueCacher-1.html","topicUid":"Hi.Common.QueueCacheUtils.QueueCacher`1","type":"Class"}]},{"name":"Hi.Common.XmlUtils","href":"Hi.Common.XmlUtils.html","topicHref":"Hi.Common.XmlUtils.html","topicUid":"Hi.Common.XmlUtils","type":"Namespace","items":[{"name":"GenMode","href":"Hi.Common.XmlUtils.GenMode.html","topicHref":"Hi.Common.XmlUtils.GenMode.html","topicUid":"Hi.Common.XmlUtils.GenMode","type":"Enum"},{"name":"IMakeXmlSource","href":"Hi.Common.XmlUtils.IMakeXmlSource.html","topicHref":"Hi.Common.XmlUtils.IMakeXmlSource.html","topicUid":"Hi.Common.XmlUtils.IMakeXmlSource","type":"Interface"},{"name":"IToXElement","href":"Hi.Common.XmlUtils.IToXElement.html","topicHref":"Hi.Common.XmlUtils.IToXElement.html","topicUid":"Hi.Common.XmlUtils.IToXElement","type":"Interface"},{"name":"SetFileDelegate","href":"Hi.Common.XmlUtils.SetFileDelegate.html","topicHref":"Hi.Common.XmlUtils.SetFileDelegate.html","topicUid":"Hi.Common.XmlUtils.SetFileDelegate","type":"Delegate"},{"name":"XFactory","href":"Hi.Common.XmlUtils.XFactory.html","topicHref":"Hi.Common.XmlUtils.XFactory.html","topicUid":"Hi.Common.XmlUtils.XFactory","type":"Class"},{"name":"XFactory.GenByXElementDelegate","href":"Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html","topicHref":"Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html","topicUid":"Hi.Common.XmlUtils.XFactory.GenByXElementDelegate","type":"Delegate"},{"name":"XFactory.XmlExceptionDelegate","href":"Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate.html","topicHref":"Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate.html","topicUid":"Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate","type":"Delegate"},{"name":"XmlSourceAndFile","href":"Hi.Common.XmlUtils.XmlSourceAndFile-1.html","topicHref":"Hi.Common.XmlUtils.XmlSourceAndFile-1.html","topicUid":"Hi.Common.XmlUtils.XmlSourceAndFile`1","type":"Class"},{"name":"XmlUtil","href":"Hi.Common.XmlUtils.XmlUtil.html","topicHref":"Hi.Common.XmlUtils.XmlUtil.html","topicUid":"Hi.Common.XmlUtils.XmlUtil","type":"Class"}]},{"name":"Hi.CutterLocations","href":"Hi.CutterLocations.html","topicHref":"Hi.CutterLocations.html","topicUid":"Hi.CutterLocations","type":"Namespace","items":[{"name":"IGetProgramCl","href":"Hi.CutterLocations.IGetProgramCl.html","topicHref":"Hi.CutterLocations.IGetProgramCl.html","topicUid":"Hi.CutterLocations.IGetProgramCl","type":"Interface"},{"name":"SimpleCl","href":"Hi.CutterLocations.SimpleCl.html","topicHref":"Hi.CutterLocations.SimpleCl.html","topicUid":"Hi.CutterLocations.SimpleCl","type":"Class"}]},{"name":"Hi.CutterLocations.ClPath","href":"Hi.CutterLocations.ClPath.html","topicHref":"Hi.CutterLocations.ClPath.html","topicUid":"Hi.CutterLocations.ClPath","type":"Namespace","items":[{"name":"ClCircleArc","href":"Hi.CutterLocations.ClPath.ClCircleArc.html","topicHref":"Hi.CutterLocations.ClPath.ClCircleArc.html","topicUid":"Hi.CutterLocations.ClPath.ClCircleArc","type":"Class"},{"name":"ClLinear","href":"Hi.CutterLocations.ClPath.ClLinear.html","topicHref":"Hi.CutterLocations.ClPath.ClLinear.html","topicUid":"Hi.CutterLocations.ClPath.ClLinear","type":"Class"},{"name":"IClPath","href":"Hi.CutterLocations.ClPath.IClPath.html","topicHref":"Hi.CutterLocations.ClPath.IClPath.html","topicUid":"Hi.CutterLocations.ClPath.IClPath","type":"Interface"}]},{"name":"Hi.CutterLocations.ClStrips","href":"Hi.CutterLocations.ClStrips.html","topicHref":"Hi.CutterLocations.ClStrips.html","topicUid":"Hi.CutterLocations.ClStrips","type":"Namespace","items":[{"name":"ClStrip","href":"Hi.CutterLocations.ClStrips.ClStrip.html","topicHref":"Hi.CutterLocations.ClStrips.ClStrip.html","topicUid":"Hi.CutterLocations.ClStrips.ClStrip","type":"Class"},{"name":"ClStripPos","href":"Hi.CutterLocations.ClStrips.ClStripPos.html","topicHref":"Hi.CutterLocations.ClStrips.ClStripPos.html","topicUid":"Hi.CutterLocations.ClStrips.ClStripPos","type":"Class"},{"name":"RgbFunc","href":"Hi.CutterLocations.ClStrips.RgbFunc.html","topicHref":"Hi.CutterLocations.ClStrips.RgbFunc.html","topicUid":"Hi.CutterLocations.ClStrips.RgbFunc","type":"Delegate"}]},{"name":"Hi.Disp","href":"Hi.Disp.html","topicHref":"Hi.Disp.html","topicUid":"Hi.Disp","type":"Namespace","items":[{"name":"Bind","href":"Hi.Disp.Bind.html","topicHref":"Hi.Disp.Bind.html","topicUid":"Hi.Disp.Bind","type":"Class"},{"name":"Box3dDispUtil","href":"Hi.Disp.Box3dDispUtil.html","topicHref":"Hi.Disp.Box3dDispUtil.html","topicUid":"Hi.Disp.Box3dDispUtil","type":"Class"},{"name":"Box3dDispUtil.BoxableExpandToBox3dDel","href":"Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel.html","topicHref":"Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel.html","topicUid":"Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel","type":"Delegate"},{"name":"DelegateFuncDisplayee","href":"Hi.Disp.DelegateFuncDisplayee.html","topicHref":"Hi.Disp.DelegateFuncDisplayee.html","topicUid":"Hi.Disp.DelegateFuncDisplayee","type":"Class"},{"name":"DispEngine","href":"Hi.Disp.DispEngine.html","topicHref":"Hi.Disp.DispEngine.html","topicUid":"Hi.Disp.DispEngine","type":"Class"},{"name":"DispEngine.ImageRequestedDelegate","href":"Hi.Disp.DispEngine.ImageRequestedDelegate.html","topicHref":"Hi.Disp.DispEngine.ImageRequestedDelegate.html","topicUid":"Hi.Disp.DispEngine.ImageRequestedDelegate","type":"Delegate"},{"name":"DispEngineConfig","href":"Hi.Disp.DispEngineConfig.html","topicHref":"Hi.Disp.DispEngineConfig.html","topicUid":"Hi.Disp.DispEngineConfig","type":"Class"},{"name":"DispFrameUtil","href":"Hi.Disp.DispFrameUtil.html","topicHref":"Hi.Disp.DispFrameUtil.html","topicUid":"Hi.Disp.DispFrameUtil","type":"Class"},{"name":"DispList","href":"Hi.Disp.DispList.html","topicHref":"Hi.Disp.DispList.html","topicUid":"Hi.Disp.DispList","type":"Class"},{"name":"DispUtil","href":"Hi.Disp.DispUtil.html","topicHref":"Hi.Disp.DispUtil.html","topicUid":"Hi.Disp.DispUtil","type":"Class"},{"name":"Drawing","href":"Hi.Disp.Drawing.html","topicHref":"Hi.Disp.Drawing.html","topicUid":"Hi.Disp.Drawing","type":"Class"},{"name":"FuncDisplayee","href":"Hi.Disp.FuncDisplayee.html","topicHref":"Hi.Disp.FuncDisplayee.html","topicUid":"Hi.Disp.FuncDisplayee","type":"Class"},{"name":"GL","href":"Hi.Disp.GL.html","topicHref":"Hi.Disp.GL.html","topicUid":"Hi.Disp.GL","type":"Class"},{"name":"IDisplayee","href":"Hi.Disp.IDisplayee.html","topicHref":"Hi.Disp.IDisplayee.html","topicUid":"Hi.Disp.IDisplayee","type":"Interface"},{"name":"IGetDispEngine","href":"Hi.Disp.IGetDispEngine.html","topicHref":"Hi.Disp.IGetDispEngine.html","topicUid":"Hi.Disp.IGetDispEngine","type":"Interface"},{"name":"IGetPickable","href":"Hi.Disp.IGetPickable.html","topicHref":"Hi.Disp.IGetPickable.html","topicUid":"Hi.Disp.IGetPickable","type":"Interface"},{"name":"IGlContextDirver","href":"Hi.Disp.IGlContextDirver.html","topicHref":"Hi.Disp.IGlContextDirver.html","topicUid":"Hi.Disp.IGlContextDirver","type":"Interface"},{"name":"MatStack","href":"Hi.Disp.MatStack.html","topicHref":"Hi.Disp.MatStack.html","topicUid":"Hi.Disp.MatStack","type":"Class"},{"name":"MatStack.ItemDisposable","href":"Hi.Disp.MatStack.ItemDisposable.html","topicHref":"Hi.Disp.MatStack.ItemDisposable.html","topicUid":"Hi.Disp.MatStack.ItemDisposable","type":"Class"},{"name":"MvpBoxRelation","href":"Hi.Disp.MvpBoxRelation.html","topicHref":"Hi.Disp.MvpBoxRelation.html","topicUid":"Hi.Disp.MvpBoxRelation","type":"Enum"},{"name":"Pickable","href":"Hi.Disp.Pickable.html","topicHref":"Hi.Disp.Pickable.html","topicUid":"Hi.Disp.Pickable","type":"Class"},{"name":"PopModelMat","href":"Hi.Disp.PopModelMat.html","topicHref":"Hi.Disp.PopModelMat.html","topicUid":"Hi.Disp.PopModelMat","type":"Class"},{"name":"PushModelMat","href":"Hi.Disp.PushModelMat.html","topicHref":"Hi.Disp.PushModelMat.html","topicUid":"Hi.Disp.PushModelMat","type":"Class"},{"name":"Segment3dDispUtil","href":"Hi.Disp.Segment3dDispUtil.html","topicHref":"Hi.Disp.Segment3dDispUtil.html","topicUid":"Hi.Disp.Segment3dDispUtil","type":"Class"},{"name":"ShowEventPickable","href":"Hi.Disp.ShowEventPickable.html","topicHref":"Hi.Disp.ShowEventPickable.html","topicUid":"Hi.Disp.ShowEventPickable","type":"Class"},{"name":"Stamp","href":"Hi.Disp.Stamp.html","topicHref":"Hi.Disp.Stamp.html","topicUid":"Hi.Disp.Stamp","type":"Enum"},{"name":"StringDrawing","href":"Hi.Disp.StringDrawing.html","topicHref":"Hi.Disp.StringDrawing.html","topicUid":"Hi.Disp.StringDrawing","type":"Class"},{"name":"Tri3dDispUtil","href":"Hi.Disp.Tri3dDispUtil.html","topicHref":"Hi.Disp.Tri3dDispUtil.html","topicUid":"Hi.Disp.Tri3dDispUtil","type":"Class"},{"name":"WrappedDisplayee","href":"Hi.Disp.WrappedDisplayee.html","topicHref":"Hi.Disp.WrappedDisplayee.html","topicUid":"Hi.Disp.WrappedDisplayee","type":"Class"}]},{"name":"Hi.Disp.Flag","href":"Hi.Disp.Flag.html","topicHref":"Hi.Disp.Flag.html","topicUid":"Hi.Disp.Flag","type":"Namespace","items":[{"name":"ColorScaleBar","href":"Hi.Disp.Flag.ColorScaleBar.html","topicHref":"Hi.Disp.Flag.ColorScaleBar.html","topicUid":"Hi.Disp.Flag.ColorScaleBar","type":"Class"},{"name":"CoordinateDrawing","href":"Hi.Disp.Flag.CoordinateDrawing.html","topicHref":"Hi.Disp.Flag.CoordinateDrawing.html","topicUid":"Hi.Disp.Flag.CoordinateDrawing","type":"Class"},{"name":"CubicalFlagDrawing","href":"Hi.Disp.Flag.CubicalFlagDrawing.html","topicHref":"Hi.Disp.Flag.CubicalFlagDrawing.html","topicUid":"Hi.Disp.Flag.CubicalFlagDrawing","type":"Class"},{"name":"DimensionBar","href":"Hi.Disp.Flag.DimensionBar.html","topicHref":"Hi.Disp.Flag.DimensionBar.html","topicUid":"Hi.Disp.Flag.DimensionBar","type":"Class"},{"name":"DispCoverUtil","href":"Hi.Disp.Flag.DispCoverUtil.html","topicHref":"Hi.Disp.Flag.DispCoverUtil.html","topicUid":"Hi.Disp.Flag.DispCoverUtil","type":"Class"}]},{"name":"Hi.Disp.Treat","href":"Hi.Disp.Treat.html","topicHref":"Hi.Disp.Treat.html","topicUid":"Hi.Disp.Treat","type":"Namespace","items":[{"name":"LineWidthSwap","href":"Hi.Disp.Treat.LineWidthSwap.html","topicHref":"Hi.Disp.Treat.LineWidthSwap.html","topicUid":"Hi.Disp.Treat.LineWidthSwap","type":"Class"},{"name":"LineWidthTreat","href":"Hi.Disp.Treat.LineWidthTreat.html","topicHref":"Hi.Disp.Treat.LineWidthTreat.html","topicUid":"Hi.Disp.Treat.LineWidthTreat","type":"Class"},{"name":"PointSizeSwap","href":"Hi.Disp.Treat.PointSizeSwap.html","topicHref":"Hi.Disp.Treat.PointSizeSwap.html","topicUid":"Hi.Disp.Treat.PointSizeSwap","type":"Class"},{"name":"PointSizeTreat","href":"Hi.Disp.Treat.PointSizeTreat.html","topicHref":"Hi.Disp.Treat.PointSizeTreat.html","topicUid":"Hi.Disp.Treat.PointSizeTreat","type":"Class"},{"name":"RgbSwap","href":"Hi.Disp.Treat.RgbSwap.html","topicHref":"Hi.Disp.Treat.RgbSwap.html","topicUid":"Hi.Disp.Treat.RgbSwap","type":"Class"},{"name":"RgbTreat","href":"Hi.Disp.Treat.RgbTreat.html","topicHref":"Hi.Disp.Treat.RgbTreat.html","topicUid":"Hi.Disp.Treat.RgbTreat","type":"Class"},{"name":"RgbWrapper","href":"Hi.Disp.Treat.RgbWrapper.html","topicHref":"Hi.Disp.Treat.RgbWrapper.html","topicUid":"Hi.Disp.Treat.RgbWrapper","type":"Class"},{"name":"TransformationWrapper","href":"Hi.Disp.Treat.TransformationWrapper.html","topicHref":"Hi.Disp.Treat.TransformationWrapper.html","topicUid":"Hi.Disp.Treat.TransformationWrapper","type":"Class"}]},{"name":"Hi.Fanuc","href":"Hi.Fanuc.html","topicHref":"Hi.Fanuc.html","topicUid":"Hi.Fanuc","type":"Namespace","items":[{"name":"FanucVarTable","href":"Hi.Fanuc.FanucVarTable.html","topicHref":"Hi.Fanuc.FanucVarTable.html","topicUid":"Hi.Fanuc.FanucVarTable","type":"Class"},{"name":"FanucVarValue","href":"Hi.Fanuc.FanucVarValue.html","topicHref":"Hi.Fanuc.FanucVarValue.html","topicUid":"Hi.Fanuc.FanucVarValue","type":"Struct"}]},{"name":"Hi.Geom","href":"Hi.Geom.html","topicHref":"Hi.Geom.html","topicUid":"Hi.Geom","type":"Namespace","items":[{"name":"ArrayUtil","href":"Hi.Geom.ArrayUtil.html","topicHref":"Hi.Geom.ArrayUtil.html","topicUid":"Hi.Geom.ArrayUtil","type":"Class"},{"name":"AxisAngle4d","href":"Hi.Geom.AxisAngle4d.html","topicHref":"Hi.Geom.AxisAngle4d.html","topicUid":"Hi.Geom.AxisAngle4d","type":"Class"},{"name":"Box2d","href":"Hi.Geom.Box2d.html","topicHref":"Hi.Geom.Box2d.html","topicUid":"Hi.Geom.Box2d","type":"Class"},{"name":"Box2d.NoInit","href":"Hi.Geom.Box2d.NoInit.html","topicHref":"Hi.Geom.Box2d.NoInit.html","topicUid":"Hi.Geom.Box2d.NoInit","type":"Class"},{"name":"Box3d","href":"Hi.Geom.Box3d.html","topicHref":"Hi.Geom.Box3d.html","topicUid":"Hi.Geom.Box3d","type":"Class"},{"name":"Box3d.NoInit","href":"Hi.Geom.Box3d.NoInit.html","topicHref":"Hi.Geom.Box3d.NoInit.html","topicUid":"Hi.Geom.Box3d.NoInit","type":"Class"},{"name":"Cylindroid","href":"Hi.Geom.Cylindroid.html","topicHref":"Hi.Geom.Cylindroid.html","topicUid":"Hi.Geom.Cylindroid","type":"Class"},{"name":"DVec3d","href":"Hi.Geom.DVec3d.html","topicHref":"Hi.Geom.DVec3d.html","topicUid":"Hi.Geom.DVec3d","type":"Class"},{"name":"Dir","href":"Hi.Geom.Dir.html","topicHref":"Hi.Geom.Dir.html","topicUid":"Hi.Geom.Dir","type":"Enum"},{"name":"ExtendedCylinder","href":"Hi.Geom.ExtendedCylinder.html","topicHref":"Hi.Geom.ExtendedCylinder.html","topicUid":"Hi.Geom.ExtendedCylinder","type":"Class"},{"name":"Flat3d","href":"Hi.Geom.Flat3d.html","topicHref":"Hi.Geom.Flat3d.html","topicUid":"Hi.Geom.Flat3d","type":"Class"},{"name":"GeomCombination","href":"Hi.Geom.GeomCombination.html","topicHref":"Hi.Geom.GeomCombination.html","topicUid":"Hi.Geom.GeomCombination","type":"Class"},{"name":"GeomUtil","href":"Hi.Geom.GeomUtil.html","topicHref":"Hi.Geom.GeomUtil.html","topicUid":"Hi.Geom.GeomUtil","type":"Class"},{"name":"IExpandToBox2d","href":"Hi.Geom.IExpandToBox2d.html","topicHref":"Hi.Geom.IExpandToBox2d.html","topicUid":"Hi.Geom.IExpandToBox2d","type":"Interface"},{"name":"IExpandToBox3d","href":"Hi.Geom.IExpandToBox3d.html","topicHref":"Hi.Geom.IExpandToBox3d.html","topicUid":"Hi.Geom.IExpandToBox3d","type":"Interface"},{"name":"IFlat3d","href":"Hi.Geom.IFlat3d.html","topicHref":"Hi.Geom.IFlat3d.html","topicUid":"Hi.Geom.IFlat3d","type":"Interface"},{"name":"IGenStl","href":"Hi.Geom.IGenStl.html","topicHref":"Hi.Geom.IGenStl.html","topicUid":"Hi.Geom.IGenStl","type":"Interface"},{"name":"IGeomProperty","href":"Hi.Geom.IGeomProperty.html","topicHref":"Hi.Geom.IGeomProperty.html","topicUid":"Hi.Geom.IGeomProperty","type":"Interface"},{"name":"IGetStl","href":"Hi.Geom.IGetStl.html","topicHref":"Hi.Geom.IGetStl.html","topicUid":"Hi.Geom.IGetStl","type":"Interface"},{"name":"IGetZrContour","href":"Hi.Geom.IGetZrContour.html","topicHref":"Hi.Geom.IGetZrContour.html","topicUid":"Hi.Geom.IGetZrContour","type":"Interface"},{"name":"IGetZrList","href":"Hi.Geom.IGetZrList.html","topicHref":"Hi.Geom.IGetZrList.html","topicUid":"Hi.Geom.IGetZrList","type":"Interface"},{"name":"IStlSource","href":"Hi.Geom.IStlSource.html","topicHref":"Hi.Geom.IStlSource.html","topicUid":"Hi.Geom.IStlSource","type":"Interface"},{"name":"ITri3d","href":"Hi.Geom.ITri3d.html","topicHref":"Hi.Geom.ITri3d.html","topicUid":"Hi.Geom.ITri3d","type":"Interface"},{"name":"IVec","href":"Hi.Geom.IVec-1.html","topicHref":"Hi.Geom.IVec-1.html","topicUid":"Hi.Geom.IVec`1","type":"Interface"},{"name":"IZrListSourceProperty","href":"Hi.Geom.IZrListSourceProperty.html","topicHref":"Hi.Geom.IZrListSourceProperty.html","topicUid":"Hi.Geom.IZrListSourceProperty","type":"Interface"},{"name":"Mat4d","href":"Hi.Geom.Mat4d.html","topicHref":"Hi.Geom.Mat4d.html","topicUid":"Hi.Geom.Mat4d","type":"Class"},{"name":"Mat4d.IndexFlag","href":"Hi.Geom.Mat4d.IndexFlag.html","topicHref":"Hi.Geom.Mat4d.IndexFlag.html","topicUid":"Hi.Geom.Mat4d.IndexFlag","type":"Enum"},{"name":"MathNetUtil","href":"Hi.Geom.MathNetUtil.html","topicHref":"Hi.Geom.MathNetUtil.html","topicUid":"Hi.Geom.MathNetUtil","type":"Class"},{"name":"MathUtil","href":"Hi.Geom.MathUtil.html","topicHref":"Hi.Geom.MathUtil.html","topicUid":"Hi.Geom.MathUtil","type":"Class"},{"name":"NativeStl","href":"Hi.Geom.NativeStl.html","topicHref":"Hi.Geom.NativeStl.html","topicUid":"Hi.Geom.NativeStl","type":"Class"},{"name":"NativeTopoStld","href":"Hi.Geom.NativeTopoStld.html","topicHref":"Hi.Geom.NativeTopoStld.html","topicUid":"Hi.Geom.NativeTopoStld","type":"Class"},{"name":"NativeTopoStlfr","href":"Hi.Geom.NativeTopoStlfr.html","topicHref":"Hi.Geom.NativeTopoStlfr.html","topicUid":"Hi.Geom.NativeTopoStlfr","type":"Class"},{"name":"PairZr","href":"Hi.Geom.PairZr.html","topicHref":"Hi.Geom.PairZr.html","topicUid":"Hi.Geom.PairZr","type":"Class"},{"name":"PairZrUtil","href":"Hi.Geom.PairZrUtil.html","topicHref":"Hi.Geom.PairZrUtil.html","topicUid":"Hi.Geom.PairZrUtil","type":"Class"},{"name":"Polar3d","href":"Hi.Geom.Polar3d.html","topicHref":"Hi.Geom.Polar3d.html","topicUid":"Hi.Geom.Polar3d","type":"Class"},{"name":"Segment3d","href":"Hi.Geom.Segment3d.html","topicHref":"Hi.Geom.Segment3d.html","topicUid":"Hi.Geom.Segment3d","type":"Class"},{"name":"Stl","href":"Hi.Geom.Stl.html","topicHref":"Hi.Geom.Stl.html","topicUid":"Hi.Geom.Stl","type":"Class"},{"name":"Stl.StlType","href":"Hi.Geom.Stl.StlType.html","topicHref":"Hi.Geom.Stl.StlType.html","topicUid":"Hi.Geom.Stl.StlType","type":"Enum"},{"name":"StlFile","href":"Hi.Geom.StlFile.html","topicHref":"Hi.Geom.StlFile.html","topicUid":"Hi.Geom.StlFile","type":"Class"},{"name":"StlFuncHost","href":"Hi.Geom.StlFuncHost.html","topicHref":"Hi.Geom.StlFuncHost.html","topicUid":"Hi.Geom.StlFuncHost","type":"Class"},{"name":"StlUtil","href":"Hi.Geom.StlUtil.html","topicHref":"Hi.Geom.StlUtil.html","topicUid":"Hi.Geom.StlUtil","type":"Class"},{"name":"TransformationGeom","href":"Hi.Geom.TransformationGeom.html","topicHref":"Hi.Geom.TransformationGeom.html","topicUid":"Hi.Geom.TransformationGeom","type":"Class"},{"name":"Tri3d","href":"Hi.Geom.Tri3d.html","topicHref":"Hi.Geom.Tri3d.html","topicUid":"Hi.Geom.Tri3d","type":"Class"},{"name":"Tri3dUtil","href":"Hi.Geom.Tri3dUtil.html","topicHref":"Hi.Geom.Tri3dUtil.html","topicUid":"Hi.Geom.Tri3dUtil","type":"Class"},{"name":"UnnullableDVec3d","href":"Hi.Geom.UnnullableDVec3d.html","topicHref":"Hi.Geom.UnnullableDVec3d.html","topicUid":"Hi.Geom.UnnullableDVec3d","type":"Class"},{"name":"Vec2d","href":"Hi.Geom.Vec2d.html","topicHref":"Hi.Geom.Vec2d.html","topicUid":"Hi.Geom.Vec2d","type":"Class"},{"name":"Vec2i","href":"Hi.Geom.Vec2i.html","topicHref":"Hi.Geom.Vec2i.html","topicUid":"Hi.Geom.Vec2i","type":"Class"},{"name":"Vec3d","href":"Hi.Geom.Vec3d.html","topicHref":"Hi.Geom.Vec3d.html","topicUid":"Hi.Geom.Vec3d","type":"Class"},{"name":"Vec3dUtil","href":"Hi.Geom.Vec3dUtil.html","topicHref":"Hi.Geom.Vec3dUtil.html","topicUid":"Hi.Geom.Vec3dUtil","type":"Class"}]},{"name":"Hi.Geom.Resolution","href":"Hi.Geom.Resolution.html","topicHref":"Hi.Geom.Resolution.html","topicUid":"Hi.Geom.Resolution","type":"Namespace","items":[{"name":"IPolarResolution2d","href":"Hi.Geom.Resolution.IPolarResolution2d.html","topicHref":"Hi.Geom.Resolution.IPolarResolution2d.html","topicUid":"Hi.Geom.Resolution.IPolarResolution2d","type":"Interface"},{"name":"IPolarResolution2dSourceProperty","href":"Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html","topicHref":"Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html","topicUid":"Hi.Geom.Resolution.IPolarResolution2dSourceProperty","type":"Interface"},{"name":"PolarResolution2d","href":"Hi.Geom.Resolution.PolarResolution2d.html","topicHref":"Hi.Geom.Resolution.PolarResolution2d.html","topicUid":"Hi.Geom.Resolution.PolarResolution2d","type":"Class"}]},{"name":"Hi.Geom.Solvers","href":"Hi.Geom.Solvers.html","topicHref":"Hi.Geom.Solvers.html","topicUid":"Hi.Geom.Solvers","type":"Namespace","items":[{"name":"BinarySolverUtil","href":"Hi.Geom.Solvers.BinarySolverUtil.html","topicHref":"Hi.Geom.Solvers.BinarySolverUtil.html","topicUid":"Hi.Geom.Solvers.BinarySolverUtil","type":"Class"},{"name":"BinarySolvingStatus","href":"Hi.Geom.Solvers.BinarySolvingStatus.html","topicHref":"Hi.Geom.Solvers.BinarySolvingStatus.html","topicUid":"Hi.Geom.Solvers.BinarySolvingStatus","type":"Class"},{"name":"DeepSolvingStatus","href":"Hi.Geom.Solvers.DeepSolvingStatus.html","topicHref":"Hi.Geom.Solvers.DeepSolvingStatus.html","topicUid":"Hi.Geom.Solvers.DeepSolvingStatus","type":"Class"},{"name":"NumericalSolver","href":"Hi.Geom.Solvers.NumericalSolver.html","topicHref":"Hi.Geom.Solvers.NumericalSolver.html","topicUid":"Hi.Geom.Solvers.NumericalSolver","type":"Class"},{"name":"NumericalSolver.GetRepondsDelegate","href":"Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate.html","topicHref":"Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate.html","topicUid":"Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate","type":"Delegate"},{"name":"NumericalSolver.SetParasDelegate","href":"Hi.Geom.Solvers.NumericalSolver.SetParasDelegate.html","topicHref":"Hi.Geom.Solvers.NumericalSolver.SetParasDelegate.html","topicUid":"Hi.Geom.Solvers.NumericalSolver.SetParasDelegate","type":"Delegate"},{"name":"SolverUtil","href":"Hi.Geom.Solvers.SolverUtil.html","topicHref":"Hi.Geom.Solvers.SolverUtil.html","topicUid":"Hi.Geom.Solvers.SolverUtil","type":"Class"},{"name":"SolvingResult","href":"Hi.Geom.Solvers.SolvingResult.html","topicHref":"Hi.Geom.Solvers.SolvingResult.html","topicUid":"Hi.Geom.Solvers.SolvingResult","type":"Class"},{"name":"SolvingResultStatus","href":"Hi.Geom.Solvers.SolvingResultStatus.html","topicHref":"Hi.Geom.Solvers.SolvingResultStatus.html","topicUid":"Hi.Geom.Solvers.SolvingResultStatus","type":"Enum"},{"name":"SolvingTerm","href":"Hi.Geom.Solvers.SolvingTerm.html","topicHref":"Hi.Geom.Solvers.SolvingTerm.html","topicUid":"Hi.Geom.Solvers.SolvingTerm","type":"Enum"}]},{"name":"Hi.Geom.UnitUtils","href":"Hi.Geom.UnitUtils.html","topicHref":"Hi.Geom.UnitUtils.html","topicUid":"Hi.Geom.UnitUtils","type":"Namespace","items":[{"name":"PhysicsUnit","href":"Hi.Geom.UnitUtils.PhysicsUnit.html","topicHref":"Hi.Geom.UnitUtils.PhysicsUnit.html","topicUid":"Hi.Geom.UnitUtils.PhysicsUnit","type":"Enum"},{"name":"StringValueAttribute","href":"Hi.Geom.UnitUtils.StringValueAttribute.html","topicHref":"Hi.Geom.UnitUtils.StringValueAttribute.html","topicUid":"Hi.Geom.UnitUtils.StringValueAttribute","type":"Class"},{"name":"UnitConvertUtil","href":"Hi.Geom.UnitUtils.UnitConvertUtil.html","topicHref":"Hi.Geom.UnitUtils.UnitConvertUtil.html","topicUid":"Hi.Geom.UnitUtils.UnitConvertUtil","type":"Class"}]},{"name":"Hi.Grpcs","href":"Hi.Grpcs.html","topicHref":"Hi.Grpcs.html","topicUid":"Hi.Grpcs","type":"Namespace","items":[{"name":"ClStripService","href":"Hi.Grpcs.ClStripService.html","topicHref":"Hi.Grpcs.ClStripService.html","topicUid":"Hi.Grpcs.ClStripService","type":"Class"},{"name":"ClStripService.ClStripServiceBase","href":"Hi.Grpcs.ClStripService.ClStripServiceBase.html","topicHref":"Hi.Grpcs.ClStripService.ClStripServiceBase.html","topicUid":"Hi.Grpcs.ClStripService.ClStripServiceBase","type":"Class"},{"name":"ClStripService.ClStripServiceClient","href":"Hi.Grpcs.ClStripService.ClStripServiceClient.html","topicHref":"Hi.Grpcs.ClStripService.ClStripServiceClient.html","topicUid":"Hi.Grpcs.ClStripService.ClStripServiceClient","type":"Class"},{"name":"ClStripServiceReflection","href":"Hi.Grpcs.ClStripServiceReflection.html","topicHref":"Hi.Grpcs.ClStripServiceReflection.html","topicUid":"Hi.Grpcs.ClStripServiceReflection","type":"Class"},{"name":"ClStripServiceRunner","href":"Hi.Grpcs.ClStripServiceRunner.html","topicHref":"Hi.Grpcs.ClStripServiceRunner.html","topicUid":"Hi.Grpcs.ClStripServiceRunner","type":"Class"},{"name":"DictionaryStep","href":"Hi.Grpcs.DictionaryStep.html","topicHref":"Hi.Grpcs.DictionaryStep.html","topicUid":"Hi.Grpcs.DictionaryStep","type":"Class"},{"name":"PlayerService","href":"Hi.Grpcs.PlayerService.html","topicHref":"Hi.Grpcs.PlayerService.html","topicUid":"Hi.Grpcs.PlayerService","type":"Class"},{"name":"PlayerService.PlayerServiceBase","href":"Hi.Grpcs.PlayerService.PlayerServiceBase.html","topicHref":"Hi.Grpcs.PlayerService.PlayerServiceBase.html","topicUid":"Hi.Grpcs.PlayerService.PlayerServiceBase","type":"Class"},{"name":"PlayerService.PlayerServiceClient","href":"Hi.Grpcs.PlayerService.PlayerServiceClient.html","topicHref":"Hi.Grpcs.PlayerService.PlayerServiceClient.html","topicUid":"Hi.Grpcs.PlayerService.PlayerServiceClient","type":"Class"},{"name":"PlayerServiceReflection","href":"Hi.Grpcs.PlayerServiceReflection.html","topicHref":"Hi.Grpcs.PlayerServiceReflection.html","topicUid":"Hi.Grpcs.PlayerServiceReflection","type":"Class"},{"name":"PlayerServiceRunner","href":"Hi.Grpcs.PlayerServiceRunner.html","topicHref":"Hi.Grpcs.PlayerServiceRunner.html","topicUid":"Hi.Grpcs.PlayerServiceRunner","type":"Class"}]},{"name":"Hi.HiNcKits","href":"Hi.HiNcKits.html","topicHref":"Hi.HiNcKits.html","topicUid":"Hi.HiNcKits","type":"Namespace","items":[{"name":"BasePathEnum","href":"Hi.HiNcKits.BasePathEnum.html","topicHref":"Hi.HiNcKits.BasePathEnum.html","topicUid":"Hi.HiNcKits.BasePathEnum","type":"Enum"},{"name":"HiNcHost","href":"Hi.HiNcKits.HiNcHost.html","topicHref":"Hi.HiNcKits.HiNcHost.html","topicUid":"Hi.HiNcKits.HiNcHost","type":"Class"},{"name":"HostConfig","href":"Hi.HiNcKits.HostConfig.html","topicHref":"Hi.HiNcKits.HostConfig.html","topicUid":"Hi.HiNcKits.HostConfig","type":"Class"},{"name":"LocalApp","href":"Hi.HiNcKits.LocalApp.html","topicHref":"Hi.HiNcKits.LocalApp.html","topicUid":"Hi.HiNcKits.LocalApp","type":"Class"},{"name":"UserConfig","href":"Hi.HiNcKits.UserConfig.html","topicHref":"Hi.HiNcKits.UserConfig.html","topicUid":"Hi.HiNcKits.UserConfig","type":"Class"},{"name":"UserEnv","href":"Hi.HiNcKits.UserEnv.html","topicHref":"Hi.HiNcKits.UserEnv.html","topicUid":"Hi.HiNcKits.UserEnv","type":"Class"}]},{"name":"Hi.Licenses","href":"Hi.Licenses.html","topicHref":"Hi.Licenses.html","topicUid":"Hi.Licenses","type":"Namespace","items":[{"name":"AuthFeature","href":"Hi.Licenses.AuthFeature.html","topicHref":"Hi.Licenses.AuthFeature.html","topicUid":"Hi.Licenses.AuthFeature","type":"Enum"},{"name":"AuthorizationFailedEventArgs","href":"Hi.Licenses.AuthorizationFailedEventArgs.html","topicHref":"Hi.Licenses.AuthorizationFailedEventArgs.html","topicUid":"Hi.Licenses.AuthorizationFailedEventArgs","type":"Class"},{"name":"BlockType","href":"Hi.Licenses.BlockType.html","topicHref":"Hi.Licenses.BlockType.html","topicUid":"Hi.Licenses.BlockType","type":"Enum"},{"name":"License","href":"Hi.Licenses.License.html","topicHref":"Hi.Licenses.License.html","topicUid":"Hi.Licenses.License","type":"Class"},{"name":"LicenseType","href":"Hi.Licenses.LicenseType.html","topicHref":"Hi.Licenses.LicenseType.html","topicUid":"Hi.Licenses.LicenseType","type":"Enum"}]},{"name":"Hi.Machining","href":"Hi.Machining.html","topicHref":"Hi.Machining.html","topicUid":"Hi.Machining","type":"Namespace","items":[{"name":"FreeformRemover","href":"Hi.Machining.FreeformRemover.html","topicHref":"Hi.Machining.FreeformRemover.html","topicUid":"Hi.Machining.FreeformRemover","type":"Class"},{"name":"ICutter","href":"Hi.Machining.ICutter.html","topicHref":"Hi.Machining.ICutter.html","topicUid":"Hi.Machining.ICutter","type":"Interface"},{"name":"ICutterAnchorable","href":"Hi.Machining.ICutterAnchorable.html","topicHref":"Hi.Machining.ICutterAnchorable.html","topicUid":"Hi.Machining.ICutterAnchorable","type":"Interface"},{"name":"IGetSweptable","href":"Hi.Machining.IGetSweptable.html","topicHref":"Hi.Machining.IGetSweptable.html","topicUid":"Hi.Machining.IGetSweptable","type":"Interface"},{"name":"IMachiningTool","href":"Hi.Machining.IMachiningTool.html","topicHref":"Hi.Machining.IMachiningTool.html","topicUid":"Hi.Machining.IMachiningTool","type":"Interface"},{"name":"IVolumeRemover","href":"Hi.Machining.IVolumeRemover.html","topicHref":"Hi.Machining.IVolumeRemover.html","topicUid":"Hi.Machining.IVolumeRemover","type":"Interface"},{"name":"MachiningToolHouse","href":"Hi.Machining.MachiningToolHouse.html","topicHref":"Hi.Machining.MachiningToolHouse.html","topicUid":"Hi.Machining.MachiningToolHouse","type":"Class"},{"name":"MachiningVolumeRemovalProc","href":"Hi.Machining.MachiningVolumeRemovalProc.html","topicHref":"Hi.Machining.MachiningVolumeRemovalProc.html","topicUid":"Hi.Machining.MachiningVolumeRemovalProc","type":"Class"},{"name":"MachiningVolumeRemovalProc.StepMotionSnapshot","href":"Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.html","topicHref":"Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.html","topicUid":"Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot","type":"Class"},{"name":"MatInterpolationKit","href":"Hi.Machining.MatInterpolationKit.html","topicHref":"Hi.Machining.MatInterpolationKit.html","topicUid":"Hi.Machining.MatInterpolationKit","type":"Class"},{"name":"MatRelation","href":"Hi.Machining.MatRelation.html","topicHref":"Hi.Machining.MatRelation.html","topicUid":"Hi.Machining.MatRelation","type":"Enum"},{"name":"MatRelationUtil","href":"Hi.Machining.MatRelationUtil.html","topicHref":"Hi.Machining.MatRelationUtil.html","topicUid":"Hi.Machining.MatRelationUtil","type":"Class"},{"name":"MotionUtil","href":"Hi.Machining.MotionUtil.html","topicHref":"Hi.Machining.MotionUtil.html","topicUid":"Hi.Machining.MotionUtil","type":"Class"},{"name":"Sweptable","href":"Hi.Machining.Sweptable.html","topicHref":"Hi.Machining.Sweptable.html","topicUid":"Hi.Machining.Sweptable","type":"Class"},{"name":"SweptableUtil","href":"Hi.Machining.SweptableUtil.html","topicHref":"Hi.Machining.SweptableUtil.html","topicUid":"Hi.Machining.SweptableUtil","type":"Class"},{"name":"ToolNotFoundException","href":"Hi.Machining.ToolNotFoundException.html","topicHref":"Hi.Machining.ToolNotFoundException.html","topicUid":"Hi.Machining.ToolNotFoundException","type":"Class"}]},{"name":"Hi.Machining.MachiningEquipmentUtils","href":"Hi.Machining.MachiningEquipmentUtils.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.html","topicUid":"Hi.Machining.MachiningEquipmentUtils","type":"Namespace","items":[{"name":"CollidableComponentEnum","href":"Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.CollidableComponentEnum","type":"Enum"},{"name":"IGetMachiningEquipment","href":"Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.IGetMachiningEquipment","type":"Interface"},{"name":"IMachiningEquipment","href":"Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment","type":"Interface"},{"name":"MachiningEquipment","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipment","type":"Class"},{"name":"MachiningEquipmentCollisionIndex","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex","type":"Class"},{"name":"MachiningEquipmentCollisionIndexPairsSource","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource","type":"Class"},{"name":"MachiningEquipmentUtil","href":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html","topicHref":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html","topicUid":"Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil","type":"Class"}]},{"name":"Hi.MachiningProcs","href":"Hi.MachiningProcs.html","topicHref":"Hi.MachiningProcs.html","topicUid":"Hi.MachiningProcs","type":"Namespace","items":[{"name":"ConfigStepFunc","href":"Hi.MachiningProcs.ConfigStepFunc.html","topicHref":"Hi.MachiningProcs.ConfigStepFunc.html","topicUid":"Hi.MachiningProcs.ConfigStepFunc","type":"Delegate"},{"name":"DynamicMachiningProjectDisplayee","href":"Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html","topicHref":"Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html","topicUid":"Hi.MachiningProcs.DynamicMachiningProjectDisplayee","type":"Class"},{"name":"IMachiningProjectGetter","href":"Hi.MachiningProcs.IMachiningProjectGetter.html","topicHref":"Hi.MachiningProcs.IMachiningProjectGetter.html","topicUid":"Hi.MachiningProcs.IMachiningProjectGetter","type":"Interface"},{"name":"IMachiningProjectHost","href":"Hi.MachiningProcs.IMachiningProjectHost.html","topicHref":"Hi.MachiningProcs.IMachiningProjectHost.html","topicUid":"Hi.MachiningProcs.IMachiningProjectHost","type":"Interface"},{"name":"IPathedMachiningProjectHost","href":"Hi.MachiningProcs.IPathedMachiningProjectHost.html","topicHref":"Hi.MachiningProcs.IPathedMachiningProjectHost.html","topicUid":"Hi.MachiningProcs.IPathedMachiningProjectHost","type":"Interface"},{"name":"MachiningActRunner","href":"Hi.MachiningProcs.MachiningActRunner.html","topicHref":"Hi.MachiningProcs.MachiningActRunner.html","topicUid":"Hi.MachiningProcs.MachiningActRunner","type":"Class"},{"name":"MachiningActRunner.MachiningStepBuiltDelegate","href":"Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html","topicHref":"Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html","topicUid":"Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate","type":"Delegate"},{"name":"MachiningParallelProc","href":"Hi.MachiningProcs.MachiningParallelProc.html","topicHref":"Hi.MachiningProcs.MachiningParallelProc.html","topicUid":"Hi.MachiningProcs.MachiningParallelProc","type":"Class"},{"name":"MachiningParallelProc.StepTaskBundle","href":"Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html","topicHref":"Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html","topicUid":"Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle","type":"Class"},{"name":"MachiningParallelProc.SubstractionResult","href":"Hi.MachiningProcs.MachiningParallelProc.SubstractionResult.html","topicHref":"Hi.MachiningProcs.MachiningParallelProc.SubstractionResult.html","topicUid":"Hi.MachiningProcs.MachiningParallelProc.SubstractionResult","type":"Class"},{"name":"MachiningProject","href":"Hi.MachiningProcs.MachiningProject.html","topicHref":"Hi.MachiningProcs.MachiningProject.html","topicUid":"Hi.MachiningProcs.MachiningProject","type":"Class"},{"name":"MachiningProjectDisplayee","href":"Hi.MachiningProcs.MachiningProjectDisplayee.html","topicHref":"Hi.MachiningProcs.MachiningProjectDisplayee.html","topicUid":"Hi.MachiningProcs.MachiningProjectDisplayee","type":"Class"},{"name":"MachiningSession","href":"Hi.MachiningProcs.MachiningSession.html","topicHref":"Hi.MachiningProcs.MachiningSession.html","topicUid":"Hi.MachiningProcs.MachiningSession","type":"Class"},{"name":"MillingActRunnerConfig","href":"Hi.MachiningProcs.MillingActRunnerConfig.html","topicHref":"Hi.MachiningProcs.MillingActRunnerConfig.html","topicUid":"Hi.MachiningProcs.MillingActRunnerConfig","type":"Class"},{"name":"MillingUtil","href":"Hi.MachiningProcs.MillingUtil.html","topicHref":"Hi.MachiningProcs.MillingUtil.html","topicUid":"Hi.MachiningProcs.MillingUtil","type":"Class"},{"name":"RenderingFlag","href":"Hi.MachiningProcs.RenderingFlag.html","topicHref":"Hi.MachiningProcs.RenderingFlag.html","topicUid":"Hi.MachiningProcs.RenderingFlag","type":"Enum"},{"name":"RuntimeController","href":"Hi.MachiningProcs.RuntimeController.html","topicHref":"Hi.MachiningProcs.RuntimeController.html","topicUid":"Hi.MachiningProcs.RuntimeController","type":"Class"},{"name":"SessionMessage","href":"Hi.MachiningProcs.SessionMessage.html","topicHref":"Hi.MachiningProcs.SessionMessage.html","topicUid":"Hi.MachiningProcs.SessionMessage","type":"Class"},{"name":"SessionMessageHost","href":"Hi.MachiningProcs.SessionMessageHost.html","topicHref":"Hi.MachiningProcs.SessionMessageHost.html","topicUid":"Hi.MachiningProcs.SessionMessageHost","type":"Class"},{"name":"SessionMessageHost.FilterFlag","href":"Hi.MachiningProcs.SessionMessageHost.FilterFlag.html","topicHref":"Hi.MachiningProcs.SessionMessageHost.FilterFlag.html","topicUid":"Hi.MachiningProcs.SessionMessageHost.FilterFlag","type":"Enum"},{"name":"SessionMessagePack","href":"Hi.MachiningProcs.SessionMessagePack.html","topicHref":"Hi.MachiningProcs.SessionMessagePack.html","topicUid":"Hi.MachiningProcs.SessionMessagePack","type":"Class"},{"name":"SetupController","href":"Hi.MachiningProcs.SetupController.html","topicHref":"Hi.MachiningProcs.SetupController.html","topicUid":"Hi.MachiningProcs.SetupController","type":"Class"}]},{"name":"Hi.MachiningSteps","href":"Hi.MachiningSteps.html","topicHref":"Hi.MachiningSteps.html","topicUid":"Hi.MachiningSteps","type":"Namespace","items":[{"name":"IGetSourceCommand","href":"Hi.MachiningSteps.IGetSourceCommand.html","topicHref":"Hi.MachiningSteps.IGetSourceCommand.html","topicUid":"Hi.MachiningSteps.IGetSourceCommand","type":"Interface"},{"name":"IMachiningStepHost","href":"Hi.MachiningSteps.IMachiningStepHost.html","topicHref":"Hi.MachiningSteps.IMachiningStepHost.html","topicUid":"Hi.MachiningSteps.IMachiningStepHost","type":"Interface"},{"name":"ISourceCommand","href":"Hi.MachiningSteps.ISourceCommand.html","topicHref":"Hi.MachiningSteps.ISourceCommand.html","topicUid":"Hi.MachiningSteps.ISourceCommand","type":"Interface"},{"name":"MachineMotionStep","href":"Hi.MachiningSteps.MachineMotionStep.html","topicHref":"Hi.MachiningSteps.MachineMotionStep.html","topicUid":"Hi.MachiningSteps.MachineMotionStep","type":"Class"},{"name":"MachiningStep","href":"Hi.MachiningSteps.MachiningStep.html","topicHref":"Hi.MachiningSteps.MachiningStep.html","topicUid":"Hi.MachiningSteps.MachiningStep","type":"Class"},{"name":"MachiningStepUtil","href":"Hi.MachiningSteps.MachiningStepUtil.html","topicHref":"Hi.MachiningSteps.MachiningStepUtil.html","topicUid":"Hi.MachiningSteps.MachiningStepUtil","type":"Class"},{"name":"PresentAccess","href":"Hi.MachiningSteps.PresentAccess.html","topicHref":"Hi.MachiningSteps.PresentAccess.html","topicUid":"Hi.MachiningSteps.PresentAccess","type":"Class"},{"name":"PresentAttribute","href":"Hi.MachiningSteps.PresentAttribute.html","topicHref":"Hi.MachiningSteps.PresentAttribute.html","topicUid":"Hi.MachiningSteps.PresentAttribute","type":"Class"},{"name":"PropertyAccess","href":"Hi.MachiningSteps.PropertyAccess-1.html","topicHref":"Hi.MachiningSteps.PropertyAccess-1.html","topicUid":"Hi.MachiningSteps.PropertyAccess`1","type":"Class"}]},{"name":"Hi.Mapping","href":"Hi.Mapping.html","topicHref":"Hi.Mapping.html","topicUid":"Hi.Mapping","type":"Namespace","items":[{"name":"CsvNcStep","href":"Hi.Mapping.CsvNcStep.html","topicHref":"Hi.Mapping.CsvNcStep.html","topicUid":"Hi.Mapping.CsvNcStep","type":"Class"},{"name":"CsvNcStep.StepInterpoationMode","href":"Hi.Mapping.CsvNcStep.StepInterpoationMode.html","topicHref":"Hi.Mapping.CsvNcStep.StepInterpoationMode.html","topicUid":"Hi.Mapping.CsvNcStep.StepInterpoationMode","type":"Enum"},{"name":"FileToTimeShotMapping","href":"Hi.Mapping.FileToTimeShotMapping.html","topicHref":"Hi.Mapping.FileToTimeShotMapping.html","topicUid":"Hi.Mapping.FileToTimeShotMapping","type":"Class"},{"name":"IAccelerationShot","href":"Hi.Mapping.IAccelerationShot.html","topicHref":"Hi.Mapping.IAccelerationShot.html","topicUid":"Hi.Mapping.IAccelerationShot","type":"Interface"},{"name":"IForceShot","href":"Hi.Mapping.IForceShot.html","topicHref":"Hi.Mapping.IForceShot.html","topicUid":"Hi.Mapping.IForceShot","type":"Interface"},{"name":"IMomentShot","href":"Hi.Mapping.IMomentShot.html","topicHref":"Hi.Mapping.IMomentShot.html","topicUid":"Hi.Mapping.IMomentShot","type":"Interface"},{"name":"ITimeShot","href":"Hi.Mapping.ITimeShot.html","topicHref":"Hi.Mapping.ITimeShot.html","topicUid":"Hi.Mapping.ITimeShot","type":"Interface"},{"name":"StepTimeShotUtil","href":"Hi.Mapping.StepTimeShotUtil.html","topicHref":"Hi.Mapping.StepTimeShotUtil.html","topicUid":"Hi.Mapping.StepTimeShotUtil","type":"Class"},{"name":"StepTimeShotUtil.CycleSamplingMode","href":"Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html","topicHref":"Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html","topicUid":"Hi.Mapping.StepTimeShotUtil.CycleSamplingMode","type":"Enum"},{"name":"StepTimeShotUtil.GetTimeShotByFileDelegate","href":"Hi.Mapping.StepTimeShotUtil.GetTimeShotByFileDelegate.html","topicHref":"Hi.Mapping.StepTimeShotUtil.GetTimeShotByFileDelegate.html","topicUid":"Hi.Mapping.StepTimeShotUtil.GetTimeShotByFileDelegate","type":"Delegate"},{"name":"TimeMapping","href":"Hi.Mapping.TimeMapping.html","topicHref":"Hi.Mapping.TimeMapping.html","topicUid":"Hi.Mapping.TimeMapping","type":"Class"}]},{"name":"Hi.Mappings","href":"Hi.Mappings.html","topicHref":"Hi.Mappings.html","topicUid":"Hi.Mappings","type":"Namespace","items":[{"name":"FileTimeSection","href":"Hi.Mappings.FileTimeSection.html","topicHref":"Hi.Mappings.FileTimeSection.html","topicUid":"Hi.Mappings.FileTimeSection","type":"Class"},{"name":"FileTimeSection.TimeOption","href":"Hi.Mappings.FileTimeSection.TimeOption.html","topicHref":"Hi.Mappings.FileTimeSection.TimeOption.html","topicUid":"Hi.Mappings.FileTimeSection.TimeOption","type":"Enum"}]},{"name":"Hi.Mech","href":"Hi.Mech.html","topicHref":"Hi.Mech.html","topicUid":"Hi.Mech","type":"Namespace","items":[{"name":"GeneralMechanism","href":"Hi.Mech.GeneralMechanism.html","topicHref":"Hi.Mech.GeneralMechanism.html","topicUid":"Hi.Mech.GeneralMechanism","type":"Class"},{"name":"IGetAnchorToSolidDictionary","href":"Hi.Mech.IGetAnchorToSolidDictionary.html","topicHref":"Hi.Mech.IGetAnchorToSolidDictionary.html","topicUid":"Hi.Mech.IGetAnchorToSolidDictionary","type":"Interface"},{"name":"IGetMachiningChain","href":"Hi.Mech.IGetMachiningChain.html","topicHref":"Hi.Mech.IGetMachiningChain.html","topicUid":"Hi.Mech.IGetMachiningChain","type":"Interface"},{"name":"IMachiningChain","href":"Hi.Mech.IMachiningChain.html","topicHref":"Hi.Mech.IMachiningChain.html","topicUid":"Hi.Mech.IMachiningChain","type":"Interface"},{"name":"IMachiningChainSource","href":"Hi.Mech.IMachiningChainSource.html","topicHref":"Hi.Mech.IMachiningChainSource.html","topicUid":"Hi.Mech.IMachiningChainSource","type":"Interface"},{"name":"MachiningChainUtil","href":"Hi.Mech.MachiningChainUtil.html","topicHref":"Hi.Mech.MachiningChainUtil.html","topicUid":"Hi.Mech.MachiningChainUtil","type":"Class"}]},{"name":"Hi.Mech.Topo","href":"Hi.Mech.Topo.html","topicHref":"Hi.Mech.Topo.html","topicUid":"Hi.Mech.Topo","type":"Namespace","items":[{"name":"Anchor","href":"Hi.Mech.Topo.Anchor.html","topicHref":"Hi.Mech.Topo.Anchor.html","topicUid":"Hi.Mech.Topo.Anchor","type":"Class"},{"name":"AnchorFuncSource","href":"Hi.Mech.Topo.AnchorFuncSource.html","topicHref":"Hi.Mech.Topo.AnchorFuncSource.html","topicUid":"Hi.Mech.Topo.AnchorFuncSource","type":"Class"},{"name":"AnchoredBoxable","href":"Hi.Mech.Topo.AnchoredBoxable.html","topicHref":"Hi.Mech.Topo.AnchoredBoxable.html","topicUid":"Hi.Mech.Topo.AnchoredBoxable","type":"Class"},{"name":"AnchoredDisplayee","href":"Hi.Mech.Topo.AnchoredDisplayee.html","topicHref":"Hi.Mech.Topo.AnchoredDisplayee.html","topicUid":"Hi.Mech.Topo.AnchoredDisplayee","type":"Class"},{"name":"Asmb","href":"Hi.Mech.Topo.Asmb.html","topicHref":"Hi.Mech.Topo.Asmb.html","topicUid":"Hi.Mech.Topo.Asmb","type":"Class"},{"name":"AsmbDraw","href":"Hi.Mech.Topo.AsmbDraw.html","topicHref":"Hi.Mech.Topo.AsmbDraw.html","topicUid":"Hi.Mech.Topo.AsmbDraw","type":"Class"},{"name":"Branch","href":"Hi.Mech.Topo.Branch.html","topicHref":"Hi.Mech.Topo.Branch.html","topicUid":"Hi.Mech.Topo.Branch","type":"Class"},{"name":"DirectionBranchPack","href":"Hi.Mech.Topo.DirectionBranchPack.html","topicHref":"Hi.Mech.Topo.DirectionBranchPack.html","topicUid":"Hi.Mech.Topo.DirectionBranchPack","type":"Class"},{"name":"DirectionBranchPackUtil","href":"Hi.Mech.Topo.DirectionBranchPackUtil.html","topicHref":"Hi.Mech.Topo.DirectionBranchPackUtil.html","topicUid":"Hi.Mech.Topo.DirectionBranchPackUtil","type":"Class"},{"name":"DynamicFreeform","href":"Hi.Mech.Topo.DynamicFreeform.html","topicHref":"Hi.Mech.Topo.DynamicFreeform.html","topicUid":"Hi.Mech.Topo.DynamicFreeform","type":"Class"},{"name":"DynamicRotation","href":"Hi.Mech.Topo.DynamicRotation.html","topicHref":"Hi.Mech.Topo.DynamicRotation.html","topicUid":"Hi.Mech.Topo.DynamicRotation","type":"Class"},{"name":"DynamicTranslation","href":"Hi.Mech.Topo.DynamicTranslation.html","topicHref":"Hi.Mech.Topo.DynamicTranslation.html","topicUid":"Hi.Mech.Topo.DynamicTranslation","type":"Class"},{"name":"GeneralTransform","href":"Hi.Mech.Topo.GeneralTransform.html","topicHref":"Hi.Mech.Topo.GeneralTransform.html","topicUid":"Hi.Mech.Topo.GeneralTransform","type":"Class"},{"name":"IAnchoredDisplayee","href":"Hi.Mech.Topo.IAnchoredDisplayee.html","topicHref":"Hi.Mech.Topo.IAnchoredDisplayee.html","topicUid":"Hi.Mech.Topo.IAnchoredDisplayee","type":"Interface"},{"name":"IDynamicRegular","href":"Hi.Mech.Topo.IDynamicRegular.html","topicHref":"Hi.Mech.Topo.IDynamicRegular.html","topicUid":"Hi.Mech.Topo.IDynamicRegular","type":"Interface"},{"name":"IDynamicTransformer","href":"Hi.Mech.Topo.IDynamicTransformer.html","topicHref":"Hi.Mech.Topo.IDynamicTransformer.html","topicUid":"Hi.Mech.Topo.IDynamicTransformer","type":"Interface"},{"name":"IGetAnchor","href":"Hi.Mech.Topo.IGetAnchor.html","topicHref":"Hi.Mech.Topo.IGetAnchor.html","topicUid":"Hi.Mech.Topo.IGetAnchor","type":"Interface"},{"name":"IGetAnchoredDisplayeeList","href":"Hi.Mech.Topo.IGetAnchoredDisplayeeList.html","topicHref":"Hi.Mech.Topo.IGetAnchoredDisplayeeList.html","topicUid":"Hi.Mech.Topo.IGetAnchoredDisplayeeList","type":"Interface"},{"name":"IGetAsmb","href":"Hi.Mech.Topo.IGetAsmb.html","topicHref":"Hi.Mech.Topo.IGetAsmb.html","topicUid":"Hi.Mech.Topo.IGetAsmb","type":"Interface"},{"name":"IGetFletchBuckle","href":"Hi.Mech.Topo.IGetFletchBuckle.html","topicHref":"Hi.Mech.Topo.IGetFletchBuckle.html","topicUid":"Hi.Mech.Topo.IGetFletchBuckle","type":"Interface"},{"name":"IGetInverseTransformer","href":"Hi.Mech.Topo.IGetInverseTransformer.html","topicHref":"Hi.Mech.Topo.IGetInverseTransformer.html","topicUid":"Hi.Mech.Topo.IGetInverseTransformer","type":"Interface"},{"name":"IGetTopoIndex","href":"Hi.Mech.Topo.IGetTopoIndex.html","topicHref":"Hi.Mech.Topo.IGetTopoIndex.html","topicUid":"Hi.Mech.Topo.IGetTopoIndex","type":"Interface"},{"name":"IStaticTransformer","href":"Hi.Mech.Topo.IStaticTransformer.html","topicHref":"Hi.Mech.Topo.IStaticTransformer.html","topicUid":"Hi.Mech.Topo.IStaticTransformer","type":"Interface"},{"name":"ITopo","href":"Hi.Mech.Topo.ITopo.html","topicHref":"Hi.Mech.Topo.ITopo.html","topicUid":"Hi.Mech.Topo.ITopo","type":"Interface"},{"name":"ITopoDisplayee","href":"Hi.Mech.Topo.ITopoDisplayee.html","topicHref":"Hi.Mech.Topo.ITopoDisplayee.html","topicUid":"Hi.Mech.Topo.ITopoDisplayee","type":"Interface"},{"name":"ITransformer","href":"Hi.Mech.Topo.ITransformer.html","topicHref":"Hi.Mech.Topo.ITransformer.html","topicUid":"Hi.Mech.Topo.ITransformer","type":"Interface"},{"name":"ITransformerProperty","href":"Hi.Mech.Topo.ITransformerProperty.html","topicHref":"Hi.Mech.Topo.ITransformerProperty.html","topicUid":"Hi.Mech.Topo.ITransformerProperty","type":"Interface"},{"name":"NoTransform","href":"Hi.Mech.Topo.NoTransform.html","topicHref":"Hi.Mech.Topo.NoTransform.html","topicUid":"Hi.Mech.Topo.NoTransform","type":"Class"},{"name":"StackTransformer","href":"Hi.Mech.Topo.StackTransformer.html","topicHref":"Hi.Mech.Topo.StackTransformer.html","topicUid":"Hi.Mech.Topo.StackTransformer","type":"Class"},{"name":"StaticFreeform","href":"Hi.Mech.Topo.StaticFreeform.html","topicHref":"Hi.Mech.Topo.StaticFreeform.html","topicUid":"Hi.Mech.Topo.StaticFreeform","type":"Class"},{"name":"StaticRotation","href":"Hi.Mech.Topo.StaticRotation.html","topicHref":"Hi.Mech.Topo.StaticRotation.html","topicUid":"Hi.Mech.Topo.StaticRotation","type":"Class"},{"name":"StaticTranslation","href":"Hi.Mech.Topo.StaticTranslation.html","topicHref":"Hi.Mech.Topo.StaticTranslation.html","topicUid":"Hi.Mech.Topo.StaticTranslation","type":"Class"},{"name":"TopoDisplayee","href":"Hi.Mech.Topo.TopoDisplayee.html","topicHref":"Hi.Mech.Topo.TopoDisplayee.html","topicUid":"Hi.Mech.Topo.TopoDisplayee","type":"Class"},{"name":"TopoDisplayeeUtil","href":"Hi.Mech.Topo.TopoDisplayeeUtil.html","topicHref":"Hi.Mech.Topo.TopoDisplayeeUtil.html","topicUid":"Hi.Mech.Topo.TopoDisplayeeUtil","type":"Class"},{"name":"TopoReflection","href":"Hi.Mech.Topo.TopoReflection.html","topicHref":"Hi.Mech.Topo.TopoReflection.html","topicUid":"Hi.Mech.Topo.TopoReflection","type":"Class"},{"name":"TopoUtil","href":"Hi.Mech.Topo.TopoUtil.html","topicHref":"Hi.Mech.Topo.TopoUtil.html","topicUid":"Hi.Mech.Topo.TopoUtil","type":"Class"},{"name":"TransformerUtil","href":"Hi.Mech.Topo.TransformerUtil.html","topicHref":"Hi.Mech.Topo.TransformerUtil.html","topicUid":"Hi.Mech.Topo.TransformerUtil","type":"Class"}]},{"name":"Hi.Milling","href":"Hi.Milling.html","topicHref":"Hi.Milling.html","topicUid":"Hi.Milling","type":"Namespace","items":[{"name":"IGetDiameter","href":"Hi.Milling.IGetDiameter.html","topicHref":"Hi.Milling.IGetDiameter.html","topicUid":"Hi.Milling.IGetDiameter","type":"Interface"},{"name":"IGetFluteHeight","href":"Hi.Milling.IGetFluteHeight.html","topicHref":"Hi.Milling.IGetFluteHeight.html","topicUid":"Hi.Milling.IGetFluteHeight","type":"Interface"},{"name":"IGetMillingGeomBrief","href":"Hi.Milling.IGetMillingGeomBrief.html","topicHref":"Hi.Milling.IGetMillingGeomBrief.html","topicUid":"Hi.Milling.IGetMillingGeomBrief","type":"Interface"},{"name":"IGetRadialReliefAngle","href":"Hi.Milling.IGetRadialReliefAngle.html","topicHref":"Hi.Milling.IGetRadialReliefAngle.html","topicUid":"Hi.Milling.IGetRadialReliefAngle","type":"Interface"},{"name":"IMillingGeomBriefAccessor","href":"Hi.Milling.IMillingGeomBriefAccessor.html","topicHref":"Hi.Milling.IMillingGeomBriefAccessor.html","topicUid":"Hi.Milling.IMillingGeomBriefAccessor","type":"Interface"},{"name":"MillingGeomBrief","href":"Hi.Milling.MillingGeomBrief.html","topicHref":"Hi.Milling.MillingGeomBrief.html","topicUid":"Hi.Milling.MillingGeomBrief","type":"Class"},{"name":"MillingRemovalUtil","href":"Hi.Milling.MillingRemovalUtil.html","topicHref":"Hi.Milling.MillingRemovalUtil.html","topicUid":"Hi.Milling.MillingRemovalUtil","type":"Class"},{"name":"SpindleCapability","href":"Hi.Milling.SpindleCapability.html","topicHref":"Hi.Milling.SpindleCapability.html","topicUid":"Hi.Milling.SpindleCapability","type":"Class"}]},{"name":"Hi.Milling.Apts","href":"Hi.Milling.Apts.html","topicHref":"Hi.Milling.Apts.html","topicUid":"Hi.Milling.Apts","type":"Namespace","items":[{"name":"AptDerivative","href":"Hi.Milling.Apts.AptDerivative.html","topicHref":"Hi.Milling.Apts.AptDerivative.html","topicUid":"Hi.Milling.Apts.AptDerivative","type":"Class"},{"name":"BallApt","href":"Hi.Milling.Apts.BallApt.html","topicHref":"Hi.Milling.Apts.BallApt.html","topicUid":"Hi.Milling.Apts.BallApt","type":"Class"},{"name":"BullNoseApt","href":"Hi.Milling.Apts.BullNoseApt.html","topicHref":"Hi.Milling.Apts.BullNoseApt.html","topicUid":"Hi.Milling.Apts.BullNoseApt","type":"Class"},{"name":"ColumnApt","href":"Hi.Milling.Apts.ColumnApt.html","topicHref":"Hi.Milling.Apts.ColumnApt.html","topicUid":"Hi.Milling.Apts.ColumnApt","type":"Class"},{"name":"ConeApt","href":"Hi.Milling.Apts.ConeApt.html","topicHref":"Hi.Milling.Apts.ConeApt.html","topicUid":"Hi.Milling.Apts.ConeApt","type":"Class"},{"name":"ExactColumnApt","href":"Hi.Milling.Apts.ExactColumnApt.html","topicHref":"Hi.Milling.Apts.ExactColumnApt.html","topicUid":"Hi.Milling.Apts.ExactColumnApt","type":"Class"},{"name":"GeneralApt","href":"Hi.Milling.Apts.GeneralApt.html","topicHref":"Hi.Milling.Apts.GeneralApt.html","topicUid":"Hi.Milling.Apts.GeneralApt","type":"Class"},{"name":"IAptAlpha","href":"Hi.Milling.Apts.IAptAlpha.html","topicHref":"Hi.Milling.Apts.IAptAlpha.html","topicUid":"Hi.Milling.Apts.IAptAlpha","type":"Interface"},{"name":"IAptBased","href":"Hi.Milling.Apts.IAptBased.html","topicHref":"Hi.Milling.Apts.IAptBased.html","topicUid":"Hi.Milling.Apts.IAptBased","type":"Interface"},{"name":"IAptBeta","href":"Hi.Milling.Apts.IAptBeta.html","topicHref":"Hi.Milling.Apts.IAptBeta.html","topicUid":"Hi.Milling.Apts.IAptBeta","type":"Interface"},{"name":"IAptRc","href":"Hi.Milling.Apts.IAptRc.html","topicHref":"Hi.Milling.Apts.IAptRc.html","topicUid":"Hi.Milling.Apts.IAptRc","type":"Interface"},{"name":"IAptRr","href":"Hi.Milling.Apts.IAptRr.html","topicHref":"Hi.Milling.Apts.IAptRr.html","topicUid":"Hi.Milling.Apts.IAptRr","type":"Interface"},{"name":"IAptRz","href":"Hi.Milling.Apts.IAptRz.html","topicHref":"Hi.Milling.Apts.IAptRz.html","topicUid":"Hi.Milling.Apts.IAptRz","type":"Interface"},{"name":"IGetApt","href":"Hi.Milling.Apts.IGetApt.html","topicHref":"Hi.Milling.Apts.IGetApt.html","topicUid":"Hi.Milling.Apts.IGetApt","type":"Interface"},{"name":"IGetGeneralApt","href":"Hi.Milling.Apts.IGetGeneralApt.html","topicHref":"Hi.Milling.Apts.IGetGeneralApt.html","topicUid":"Hi.Milling.Apts.IGetGeneralApt","type":"Interface"},{"name":"TaperApt","href":"Hi.Milling.Apts.TaperApt.html","topicHref":"Hi.Milling.Apts.TaperApt.html","topicUid":"Hi.Milling.Apts.TaperApt","type":"Class"},{"name":"apt_t","href":"Hi.Milling.Apts.apt_t.html","topicHref":"Hi.Milling.Apts.apt_t.html","topicUid":"Hi.Milling.Apts.apt_t","type":"Struct"}]},{"name":"Hi.Milling.Cutters","href":"Hi.Milling.Cutters.html","topicHref":"Hi.Milling.Cutters.html","topicUid":"Hi.Milling.Cutters","type":"Namespace","items":[{"name":"AptProfile","href":"Hi.Milling.Cutters.AptProfile.html","topicHref":"Hi.Milling.Cutters.AptProfile.html","topicUid":"Hi.Milling.Cutters.AptProfile","type":"Class"},{"name":"ConstRatioProfile","href":"Hi.Milling.Cutters.ConstRatioProfile.html","topicHref":"Hi.Milling.Cutters.ConstRatioProfile.html","topicUid":"Hi.Milling.Cutters.ConstRatioProfile","type":"Class"},{"name":"CustomSpinningProfile","href":"Hi.Milling.Cutters.CustomSpinningProfile.html","topicHref":"Hi.Milling.Cutters.CustomSpinningProfile.html","topicUid":"Hi.Milling.Cutters.CustomSpinningProfile","type":"Class"},{"name":"CutterUtil","href":"Hi.Milling.Cutters.CutterUtil.html","topicHref":"Hi.Milling.Cutters.CutterUtil.html","topicUid":"Hi.Milling.Cutters.CutterUtil","type":"Class"},{"name":"FluteContourDisplayee","href":"Hi.Milling.Cutters.FluteContourDisplayee.html","topicHref":"Hi.Milling.Cutters.FluteContourDisplayee.html","topicUid":"Hi.Milling.Cutters.FluteContourDisplayee","type":"Class"},{"name":"FluteDependentRatioProfile","href":"Hi.Milling.Cutters.FluteDependentRatioProfile.html","topicHref":"Hi.Milling.Cutters.FluteDependentRatioProfile.html","topicUid":"Hi.Milling.Cutters.FluteDependentRatioProfile","type":"Class"},{"name":"IShaperProfile","href":"Hi.Milling.Cutters.IShaperProfile.html","topicHref":"Hi.Milling.Cutters.IShaperProfile.html","topicUid":"Hi.Milling.Cutters.IShaperProfile","type":"Interface"},{"name":"MillingCutter","href":"Hi.Milling.Cutters.MillingCutter.html","topicHref":"Hi.Milling.Cutters.MillingCutter.html","topicUid":"Hi.Milling.Cutters.MillingCutter","type":"Class"},{"name":"MillingCutter.IntegralModeEnum","href":"Hi.Milling.Cutters.MillingCutter.IntegralModeEnum.html","topicHref":"Hi.Milling.Cutters.MillingCutter.IntegralModeEnum.html","topicUid":"Hi.Milling.Cutters.MillingCutter.IntegralModeEnum","type":"Enum"},{"name":"MillingCutter.MassAssignmentMode","href":"Hi.Milling.Cutters.MillingCutter.MassAssignmentMode.html","topicHref":"Hi.Milling.Cutters.MillingCutter.MassAssignmentMode.html","topicUid":"Hi.Milling.Cutters.MillingCutter.MassAssignmentMode","type":"Enum"},{"name":"MillingCutterEditorDisplayee","href":"Hi.Milling.Cutters.MillingCutterEditorDisplayee.html","topicHref":"Hi.Milling.Cutters.MillingCutterEditorDisplayee.html","topicUid":"Hi.Milling.Cutters.MillingCutterEditorDisplayee","type":"Class"},{"name":"MillingCutterEditorDisplayee.ShapeModeEnum","href":"Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html","topicHref":"Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html","topicUid":"Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum","type":"Enum"}]},{"name":"Hi.Milling.Engagements","href":"Hi.Milling.Engagements.html","topicHref":"Hi.Milling.Engagements.html","topicUid":"Hi.Milling.Engagements","type":"Namespace","items":[{"name":"BitwiseMillingEngagement","href":"Hi.Milling.Engagements.BitwiseMillingEngagement.html","topicHref":"Hi.Milling.Engagements.BitwiseMillingEngagement.html","topicUid":"Hi.Milling.Engagements.BitwiseMillingEngagement","type":"Class"},{"name":"EngagementLayer","href":"Hi.Milling.Engagements.EngagementLayer.html","topicHref":"Hi.Milling.Engagements.EngagementLayer.html","topicUid":"Hi.Milling.Engagements.EngagementLayer","type":"Class"},{"name":"EngagementSlice","href":"Hi.Milling.Engagements.EngagementSlice.html","topicHref":"Hi.Milling.Engagements.EngagementSlice.html","topicUid":"Hi.Milling.Engagements.EngagementSlice","type":"Class"},{"name":"IBitwiseMillingEngagementSupport","href":"Hi.Milling.Engagements.IBitwiseMillingEngagementSupport.html","topicHref":"Hi.Milling.Engagements.IBitwiseMillingEngagementSupport.html","topicUid":"Hi.Milling.Engagements.IBitwiseMillingEngagementSupport","type":"Interface"},{"name":"IGetLayerMillingEngagement","href":"Hi.Milling.Engagements.IGetLayerMillingEngagement.html","topicHref":"Hi.Milling.Engagements.IGetLayerMillingEngagement.html","topicUid":"Hi.Milling.Engagements.IGetLayerMillingEngagement","type":"Interface"},{"name":"LayerMillingEngagement","href":"Hi.Milling.Engagements.LayerMillingEngagement.html","topicHref":"Hi.Milling.Engagements.LayerMillingEngagement.html","topicUid":"Hi.Milling.Engagements.LayerMillingEngagement","type":"Class"},{"name":"MillingEngagementUtil","href":"Hi.Milling.Engagements.MillingEngagementUtil.html","topicHref":"Hi.Milling.Engagements.MillingEngagementUtil.html","topicUid":"Hi.Milling.Engagements.MillingEngagementUtil","type":"Class"}]},{"name":"Hi.Milling.FluteContours","href":"Hi.Milling.FluteContours.html","topicHref":"Hi.Milling.FluteContours.html","topicUid":"Hi.Milling.FluteContours","type":"Namespace","items":[{"name":"ConstHelixSideContour","href":"Hi.Milling.FluteContours.ConstHelixSideContour.html","topicHref":"Hi.Milling.FluteContours.ConstHelixSideContour.html","topicUid":"Hi.Milling.FluteContours.ConstHelixSideContour","type":"Class"},{"name":"FluteContour","href":"Hi.Milling.FluteContours.FluteContour.html","topicHref":"Hi.Milling.FluteContours.FluteContour.html","topicUid":"Hi.Milling.FluteContours.FluteContour","type":"Class"},{"name":"FluteContourUtil","href":"Hi.Milling.FluteContours.FluteContourUtil.html","topicHref":"Hi.Milling.FluteContours.FluteContourUtil.html","topicUid":"Hi.Milling.FluteContours.FluteContourUtil","type":"Class"},{"name":"FreeContourTray","href":"Hi.Milling.FluteContours.FreeContourTray.html","topicHref":"Hi.Milling.FluteContours.FreeContourTray.html","topicUid":"Hi.Milling.FluteContours.FreeContourTray","type":"Class"},{"name":"FreeformSideContour","href":"Hi.Milling.FluteContours.FreeformSideContour.html","topicHref":"Hi.Milling.FluteContours.FreeformSideContour.html","topicUid":"Hi.Milling.FluteContours.FreeformSideContour","type":"Class"},{"name":"IBottomContour","href":"Hi.Milling.FluteContours.IBottomContour.html","topicHref":"Hi.Milling.FluteContours.IBottomContour.html","topicUid":"Hi.Milling.FluteContours.IBottomContour","type":"Interface"},{"name":"IContourTray","href":"Hi.Milling.FluteContours.IContourTray.html","topicHref":"Hi.Milling.FluteContours.IContourTray.html","topicUid":"Hi.Milling.FluteContours.IContourTray","type":"Interface"},{"name":"IFluteNumSourceProperty","href":"Hi.Milling.FluteContours.IFluteNumSourceProperty.html","topicHref":"Hi.Milling.FluteContours.IFluteNumSourceProperty.html","topicUid":"Hi.Milling.FluteContours.IFluteNumSourceProperty","type":"Interface"},{"name":"IGetFluteNum","href":"Hi.Milling.FluteContours.IGetFluteNum.html","topicHref":"Hi.Milling.FluteContours.IGetFluteNum.html","topicUid":"Hi.Milling.FluteContours.IGetFluteNum","type":"Interface"},{"name":"ISideContour","href":"Hi.Milling.FluteContours.ISideContour.html","topicHref":"Hi.Milling.FluteContours.ISideContour.html","topicUid":"Hi.Milling.FluteContours.ISideContour","type":"Interface"},{"name":"IWorkingContour","href":"Hi.Milling.FluteContours.IWorkingContour.html","topicHref":"Hi.Milling.FluteContours.IWorkingContour.html","topicUid":"Hi.Milling.FluteContours.IWorkingContour","type":"Interface"},{"name":"ShiftedWorkingContour","href":"Hi.Milling.FluteContours.ShiftedWorkingContour.html","topicHref":"Hi.Milling.FluteContours.ShiftedWorkingContour.html","topicUid":"Hi.Milling.FluteContours.ShiftedWorkingContour","type":"Class"},{"name":"SideContourDisplayee","href":"Hi.Milling.FluteContours.SideContourDisplayee.html","topicHref":"Hi.Milling.FluteContours.SideContourDisplayee.html","topicUid":"Hi.Milling.FluteContours.SideContourDisplayee","type":"Class"},{"name":"SlideBottomContour","href":"Hi.Milling.FluteContours.SlideBottomContour.html","topicHref":"Hi.Milling.FluteContours.SlideBottomContour.html","topicUid":"Hi.Milling.FluteContours.SlideBottomContour","type":"Class"},{"name":"SpanContourPos4d","href":"Hi.Milling.FluteContours.SpanContourPos4d.html","topicHref":"Hi.Milling.FluteContours.SpanContourPos4d.html","topicUid":"Hi.Milling.FluteContours.SpanContourPos4d","type":"Class"},{"name":"UniformContourTray","href":"Hi.Milling.FluteContours.UniformContourTray.html","topicHref":"Hi.Milling.FluteContours.UniformContourTray.html","topicUid":"Hi.Milling.FluteContours.UniformContourTray","type":"Class"}]},{"name":"Hi.Milling.MillingTools","href":"Hi.Milling.MillingTools.html","topicHref":"Hi.Milling.MillingTools.html","topicUid":"Hi.Milling.MillingTools","type":"Namespace","items":[{"name":"MillingTool","href":"Hi.Milling.MillingTools.MillingTool.html","topicHref":"Hi.Milling.MillingTools.MillingTool.html","topicUid":"Hi.Milling.MillingTools.MillingTool","type":"Class"},{"name":"MillingToolAnchorReference","href":"Hi.Milling.MillingTools.MillingToolAnchorReference.html","topicHref":"Hi.Milling.MillingTools.MillingToolAnchorReference.html","topicUid":"Hi.Milling.MillingTools.MillingToolAnchorReference","type":"Enum"},{"name":"MillingToolEditorDisplayee","href":"Hi.Milling.MillingTools.MillingToolEditorDisplayee.html","topicHref":"Hi.Milling.MillingTools.MillingToolEditorDisplayee.html","topicUid":"Hi.Milling.MillingTools.MillingToolEditorDisplayee","type":"Class"},{"name":"MillingToolUtil","href":"Hi.Milling.MillingTools.MillingToolUtil.html","topicHref":"Hi.Milling.MillingTools.MillingToolUtil.html","topicUid":"Hi.Milling.MillingTools.MillingToolUtil","type":"Class"}]},{"name":"Hi.MillingForces","href":"Hi.MillingForces.html","topicHref":"Hi.MillingForces.html","topicUid":"Hi.MillingForces","type":"Namespace","items":[{"name":"FluteZData","href":"Hi.MillingForces.FluteZData.html","topicHref":"Hi.MillingForces.FluteZData.html","topicUid":"Hi.MillingForces.FluteZData","type":"Class"},{"name":"IGetMillingForce","href":"Hi.MillingForces.IGetMillingForce.html","topicHref":"Hi.MillingForces.IGetMillingForce.html","topicUid":"Hi.MillingForces.IGetMillingForce","type":"Interface"},{"name":"IMillingForceAccessor","href":"Hi.MillingForces.IMillingForceAccessor.html","topicHref":"Hi.MillingForces.IMillingForceAccessor.html","topicUid":"Hi.MillingForces.IMillingForceAccessor","type":"Interface"},{"name":"MillingForce","href":"Hi.MillingForces.MillingForce.html","topicHref":"Hi.MillingForces.MillingForce.html","topicUid":"Hi.MillingForces.MillingForce","type":"Class"},{"name":"MillingForceLicense","href":"Hi.MillingForces.MillingForceLicense.html","topicHref":"Hi.MillingForces.MillingForceLicense.html","topicUid":"Hi.MillingForces.MillingForceLicense","type":"Class"},{"name":"MillingForceLuggage","href":"Hi.MillingForces.MillingForceLuggage.html","topicHref":"Hi.MillingForces.MillingForceLuggage.html","topicUid":"Hi.MillingForces.MillingForceLuggage","type":"Class"},{"name":"MillingForceUtil","href":"Hi.MillingForces.MillingForceUtil.html","topicHref":"Hi.MillingForces.MillingForceUtil.html","topicUid":"Hi.MillingForces.MillingForceUtil","type":"Class"},{"name":"MillingForceUtil.AnglePack","href":"Hi.MillingForces.MillingForceUtil.AnglePack.html","topicHref":"Hi.MillingForces.MillingForceUtil.AnglePack.html","topicUid":"Hi.MillingForces.MillingForceUtil.AnglePack","type":"Class"},{"name":"RakeFacePhysicsBrief","href":"Hi.MillingForces.RakeFacePhysicsBrief.html","topicHref":"Hi.MillingForces.RakeFacePhysicsBrief.html","topicUid":"Hi.MillingForces.RakeFacePhysicsBrief","type":"Class"},{"name":"ToolObservationReference","href":"Hi.MillingForces.ToolObservationReference.html","topicHref":"Hi.MillingForces.ToolObservationReference.html","topicUid":"Hi.MillingForces.ToolObservationReference","type":"Enum"}]},{"name":"Hi.MillingForces.Fittings","href":"Hi.MillingForces.Fittings.html","topicHref":"Hi.MillingForces.Fittings.html","topicUid":"Hi.MillingForces.Fittings","type":"Namespace","items":[{"name":"CuttingParaUtil","href":"Hi.MillingForces.Fittings.CuttingParaUtil.html","topicHref":"Hi.MillingForces.Fittings.CuttingParaUtil.html","topicUid":"Hi.MillingForces.Fittings.CuttingParaUtil","type":"Class"},{"name":"ICuttingPara","href":"Hi.MillingForces.Fittings.ICuttingPara.html","topicHref":"Hi.MillingForces.Fittings.ICuttingPara.html","topicUid":"Hi.MillingForces.Fittings.ICuttingPara","type":"Interface"},{"name":"IGetCuttingPara","href":"Hi.MillingForces.Fittings.IGetCuttingPara.html","topicHref":"Hi.MillingForces.Fittings.IGetCuttingPara.html","topicUid":"Hi.MillingForces.Fittings.IGetCuttingPara","type":"Interface"},{"name":"SampleCategory","href":"Hi.MillingForces.Fittings.SampleCategory.html","topicHref":"Hi.MillingForces.Fittings.SampleCategory.html","topicUid":"Hi.MillingForces.Fittings.SampleCategory","type":"Class"},{"name":"SampleFlag","href":"Hi.MillingForces.Fittings.SampleFlag.html","topicHref":"Hi.MillingForces.Fittings.SampleFlag.html","topicUid":"Hi.MillingForces.Fittings.SampleFlag","type":"Enum"},{"name":"SampleFlagUtil","href":"Hi.MillingForces.Fittings.SampleFlagUtil.html","topicHref":"Hi.MillingForces.Fittings.SampleFlagUtil.html","topicUid":"Hi.MillingForces.Fittings.SampleFlagUtil","type":"Class"},{"name":"SampleInstance","href":"Hi.MillingForces.Fittings.SampleInstance.html","topicHref":"Hi.MillingForces.Fittings.SampleInstance.html","topicUid":"Hi.MillingForces.Fittings.SampleInstance","type":"Class"},{"name":"TimeForce","href":"Hi.MillingForces.Fittings.TimeForce.html","topicHref":"Hi.MillingForces.Fittings.TimeForce.html","topicUid":"Hi.MillingForces.Fittings.TimeForce","type":"Class"},{"name":"TimeForceFrequencyDomain","href":"Hi.MillingForces.Fittings.TimeForceFrequencyDomain.html","topicHref":"Hi.MillingForces.Fittings.TimeForceFrequencyDomain.html","topicUid":"Hi.MillingForces.Fittings.TimeForceFrequencyDomain","type":"Class"},{"name":"TimeForceSeries","href":"Hi.MillingForces.Fittings.TimeForceSeries.html","topicHref":"Hi.MillingForces.Fittings.TimeForceSeries.html","topicUid":"Hi.MillingForces.Fittings.TimeForceSeries","type":"Class"},{"name":"TimeForceUtil","href":"Hi.MillingForces.Fittings.TimeForceUtil.html","topicHref":"Hi.MillingForces.Fittings.TimeForceUtil.html","topicUid":"Hi.MillingForces.Fittings.TimeForceUtil","type":"Class"},{"name":"TimeVsForceSeries","href":"Hi.MillingForces.Fittings.TimeVsForceSeries.html","topicHref":"Hi.MillingForces.Fittings.TimeVsForceSeries.html","topicUid":"Hi.MillingForces.Fittings.TimeVsForceSeries","type":"Class"},{"name":"TimeVsTorqueSeries","href":"Hi.MillingForces.Fittings.TimeVsTorqueSeries.html","topicHref":"Hi.MillingForces.Fittings.TimeVsTorqueSeries.html","topicUid":"Hi.MillingForces.Fittings.TimeVsTorqueSeries","type":"Class"},{"name":"TrainingSample","href":"Hi.MillingForces.Fittings.TrainingSample.html","topicHref":"Hi.MillingForces.Fittings.TrainingSample.html","topicUid":"Hi.MillingForces.Fittings.TrainingSample","type":"Class"}]},{"name":"Hi.MillingForces.ProfileMillingParas","href":"Hi.MillingForces.ProfileMillingParas.html","topicHref":"Hi.MillingForces.ProfileMillingParas.html","topicUid":"Hi.MillingForces.ProfileMillingParas","type":"Namespace","items":[{"name":"IGetLocalProfileMillingPara","href":"Hi.MillingForces.ProfileMillingParas.IGetLocalProfileMillingPara.html","topicHref":"Hi.MillingForces.ProfileMillingParas.IGetLocalProfileMillingPara.html","topicUid":"Hi.MillingForces.ProfileMillingParas.IGetLocalProfileMillingPara","type":"Interface"},{"name":"LocalProfileMillingPara","href":"Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html","topicHref":"Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html","topicUid":"Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara","type":"Class"},{"name":"ProfileMillingParaMap","href":"Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html","topicHref":"Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html","topicUid":"Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap","type":"Class"},{"name":"RtaMillingParaKey","href":"Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey.html","topicHref":"Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey.html","topicUid":"Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey","type":"Enum"}]},{"name":"Hi.MillingForces.RakeFaceCuttingParas","href":"Hi.MillingForces.RakeFaceCuttingParas.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas","type":"Namespace","items":[{"name":"IRakeFaceCuttingPara","href":"Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara","type":"Interface"},{"name":"MillingPhysicsUtil","href":"Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil","type":"Class"},{"name":"MultiFormRakeFaceCuttingPara","href":"Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara","type":"Class"},{"name":"RakeFaceCuttingPara2d","href":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d","type":"Class"},{"name":"RakeFaceCuttingPara3d","href":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d","type":"Class"},{"name":"RakeFaceCuttingParaMap","href":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html","topicHref":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html","topicUid":"Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap","type":"Class"}]},{"name":"Hi.MillingForces.Training","href":"Hi.MillingForces.Training.html","topicHref":"Hi.MillingForces.Training.html","topicUid":"Hi.MillingForces.Training","type":"Namespace","items":[{"name":"MillingTraining","href":"Hi.MillingForces.Training.MillingTraining.html","topicHref":"Hi.MillingForces.Training.MillingTraining.html","topicUid":"Hi.MillingForces.Training.MillingTraining","type":"Class"}]},{"name":"Hi.MillingProcs","href":"Hi.MillingProcs.html","topicHref":"Hi.MillingProcs.html","topicUid":"Hi.MillingProcs","type":"Namespace","items":[{"name":"MillingGuide","href":"Hi.MillingProcs.MillingGuide.html","topicHref":"Hi.MillingProcs.MillingGuide.html","topicUid":"Hi.MillingProcs.MillingGuide","type":"Class"}]},{"name":"Hi.MillingStepUtils","href":"Hi.MillingStepUtils.html","topicHref":"Hi.MillingStepUtils.html","topicUid":"Hi.MillingStepUtils","type":"Namespace","items":[{"name":"ClStripChartConfig","href":"Hi.MillingStepUtils.ClStripChartConfig.html","topicHref":"Hi.MillingStepUtils.ClStripChartConfig.html","topicUid":"Hi.MillingStepUtils.ClStripChartConfig","type":"Class"},{"name":"ClStripChartItemConfig","href":"Hi.MillingStepUtils.ClStripChartItemConfig.html","topicHref":"Hi.MillingStepUtils.ClStripChartItemConfig.html","topicUid":"Hi.MillingStepUtils.ClStripChartItemConfig","type":"Class"},{"name":"ForceCycleFlag","href":"Hi.MillingStepUtils.ForceCycleFlag.html","topicHref":"Hi.MillingStepUtils.ForceCycleFlag.html","topicUid":"Hi.MillingStepUtils.ForceCycleFlag","type":"Enum"},{"name":"ForceCycleLineDivConfig","href":"Hi.MillingStepUtils.ForceCycleLineDivConfig.html","topicHref":"Hi.MillingStepUtils.ForceCycleLineDivConfig.html","topicUid":"Hi.MillingStepUtils.ForceCycleLineDivConfig","type":"Class"},{"name":"LineChartVRangeMode","href":"Hi.MillingStepUtils.LineChartVRangeMode.html","topicHref":"Hi.MillingStepUtils.LineChartVRangeMode.html","topicUid":"Hi.MillingStepUtils.LineChartVRangeMode","type":"Enum"},{"name":"SpindleMomentCycleLineDivConfig","href":"Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html","topicHref":"Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html","topicUid":"Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig","type":"Class"},{"name":"TimeChartYConfig","href":"Hi.MillingStepUtils.TimeChartYConfig.html","topicHref":"Hi.MillingStepUtils.TimeChartYConfig.html","topicUid":"Hi.MillingStepUtils.TimeChartYConfig","type":"Class"}]},{"name":"Hi.MillingSteps","href":"Hi.MillingSteps.html","topicHref":"Hi.MillingSteps.html","topicUid":"Hi.MillingSteps","type":"Namespace","items":[{"name":"MillingPhysicsStep","href":"Hi.MillingSteps.MillingPhysicsStep.html","topicHref":"Hi.MillingSteps.MillingPhysicsStep.html","topicUid":"Hi.MillingSteps.MillingPhysicsStep","type":"Class"},{"name":"MillingStepLuggage","href":"Hi.MillingSteps.MillingStepLuggage.html","topicHref":"Hi.MillingSteps.MillingStepLuggage.html","topicUid":"Hi.MillingSteps.MillingStepLuggage","type":"Class"}]},{"name":"Hi.MongoUtils","href":"Hi.MongoUtils.html","topicHref":"Hi.MongoUtils.html","topicUid":"Hi.MongoUtils","type":"Namespace","items":[{"name":"IMongoRunner","href":"Hi.MongoUtils.IMongoRunner.html","topicHref":"Hi.MongoUtils.IMongoRunner.html","topicUid":"Hi.MongoUtils.IMongoRunner","type":"Interface"},{"name":"MongoRunnerOptions","href":"Hi.MongoUtils.MongoRunnerOptions.html","topicHref":"Hi.MongoUtils.MongoRunnerOptions.html","topicUid":"Hi.MongoUtils.MongoRunnerOptions","type":"Class"},{"name":"MongoServer","href":"Hi.MongoUtils.MongoServer.html","topicHref":"Hi.MongoUtils.MongoServer.html","topicUid":"Hi.MongoUtils.MongoServer","type":"Class"}]},{"name":"Hi.Motion.MatValves","href":"Hi.Motion.MatValves.html","topicHref":"Hi.Motion.MatValves.html","topicUid":"Hi.Motion.MatValves","type":"Namespace","items":[{"name":"ClMachiningValve","href":"Hi.Motion.MatValves.ClMachiningValve.html","topicHref":"Hi.Motion.MatValves.ClMachiningValve.html","topicUid":"Hi.Motion.MatValves.ClMachiningValve","type":"Class"},{"name":"IMotionValve","href":"Hi.Motion.MatValves.IMotionValve.html","topicHref":"Hi.Motion.MatValves.IMotionValve.html","topicUid":"Hi.Motion.MatValves.IMotionValve","type":"Interface"},{"name":"MacroMotionValve","href":"Hi.Motion.MatValves.MacroMotionValve.html","topicHref":"Hi.Motion.MatValves.MacroMotionValve.html","topicUid":"Hi.Motion.MatValves.MacroMotionValve","type":"Class"},{"name":"StepMotionValve","href":"Hi.Motion.MatValves.StepMotionValve.html","topicHref":"Hi.Motion.MatValves.StepMotionValve.html","topicUid":"Hi.Motion.MatValves.StepMotionValve","type":"Class"}]},{"name":"Hi.Native","href":"Hi.Native.html","topicHref":"Hi.Native.html","topicUid":"Hi.Native","type":"Namespace","items":[{"name":"StopSource","href":"Hi.Native.StopSource.html","topicHref":"Hi.Native.StopSource.html","topicUid":"Hi.Native.StopSource","type":"Class"},{"name":"StopToken","href":"Hi.Native.StopToken.html","topicHref":"Hi.Native.StopToken.html","topicUid":"Hi.Native.StopToken","type":"Class"},{"name":"StopTokenKit","href":"Hi.Native.StopTokenKit.html","topicHref":"Hi.Native.StopTokenKit.html","topicUid":"Hi.Native.StopTokenKit","type":"Class"},{"name":"StopTokenUtil","href":"Hi.Native.StopTokenUtil.html","topicHref":"Hi.Native.StopTokenUtil.html","topicUid":"Hi.Native.StopTokenUtil","type":"Class"},{"name":"bind_t","href":"Hi.Native.bind_t.html","topicHref":"Hi.Native.bind_t.html","topicUid":"Hi.Native.bind_t","type":"Struct"},{"name":"box2d","href":"Hi.Native.box2d.html","topicHref":"Hi.Native.box2d.html","topicUid":"Hi.Native.box2d","type":"Struct"},{"name":"box3d","href":"Hi.Native.box3d.html","topicHref":"Hi.Native.box3d.html","topicUid":"Hi.Native.box3d","type":"Struct"},{"name":"expand_to_box3d_func_t","href":"Hi.Native.expand_to_box3d_func_t.html","topicHref":"Hi.Native.expand_to_box3d_func_t.html","topicUid":"Hi.Native.expand_to_box3d_func_t","type":"Delegate"},{"name":"key_event_t","href":"Hi.Native.key_event_t.html","topicHref":"Hi.Native.key_event_t.html","topicUid":"Hi.Native.key_event_t","type":"Struct"},{"name":"key_table__transform_view_by_key_pressing_t","href":"Hi.Native.key_table__transform_view_by_key_pressing_t.html","topicHref":"Hi.Native.key_table__transform_view_by_key_pressing_t.html","topicUid":"Hi.Native.key_table__transform_view_by_key_pressing_t","type":"Struct"},{"name":"mat4d","href":"Hi.Native.mat4d.html","topicHref":"Hi.Native.mat4d.html","topicUid":"Hi.Native.mat4d","type":"Struct"},{"name":"mat_stack_t","href":"Hi.Native.mat_stack_t.html","topicHref":"Hi.Native.mat_stack_t.html","topicUid":"Hi.Native.mat_stack_t","type":"Struct"},{"name":"mouse_button_event_t","href":"Hi.Native.mouse_button_event_t.html","topicHref":"Hi.Native.mouse_button_event_t.html","topicUid":"Hi.Native.mouse_button_event_t","type":"Struct"},{"name":"mouse_button_table__transform_view_by_mouse_drag_t","href":"Hi.Native.mouse_button_table__transform_view_by_mouse_drag_t.html","topicHref":"Hi.Native.mouse_button_table__transform_view_by_mouse_drag_t.html","topicUid":"Hi.Native.mouse_button_table__transform_view_by_mouse_drag_t","type":"Struct"},{"name":"mouse_move_event_t","href":"Hi.Native.mouse_move_event_t.html","topicHref":"Hi.Native.mouse_move_event_t.html","topicUid":"Hi.Native.mouse_move_event_t","type":"Struct"},{"name":"mouse_wheel_event_t","href":"Hi.Native.mouse_wheel_event_t.html","topicHref":"Hi.Native.mouse_wheel_event_t.html","topicUid":"Hi.Native.mouse_wheel_event_t","type":"Struct"},{"name":"panel_state_t","href":"Hi.Native.panel_state_t.html","topicHref":"Hi.Native.panel_state_t.html","topicUid":"Hi.Native.panel_state_t","type":"Struct"},{"name":"picking_event_t","href":"Hi.Native.picking_event_t.html","topicHref":"Hi.Native.picking_event_t.html","topicUid":"Hi.Native.picking_event_t","type":"Struct"},{"name":"picking_func_t","href":"Hi.Native.picking_func_t.html","topicHref":"Hi.Native.picking_func_t.html","topicUid":"Hi.Native.picking_func_t","type":"Delegate"},{"name":"picking_mark_t","href":"Hi.Native.picking_mark_t.html","topicHref":"Hi.Native.picking_mark_t.html","topicUid":"Hi.Native.picking_mark_t","type":"Struct"},{"name":"tri3d","href":"Hi.Native.tri3d.html","topicHref":"Hi.Native.tri3d.html","topicUid":"Hi.Native.tri3d","type":"Struct"},{"name":"ui_event_type","href":"Hi.Native.ui_event_type.html","topicHref":"Hi.Native.ui_event_type.html","topicUid":"Hi.Native.ui_event_type","type":"Enum"},{"name":"vec2d","href":"Hi.Native.vec2d.html","topicHref":"Hi.Native.vec2d.html","topicUid":"Hi.Native.vec2d","type":"Struct"},{"name":"vec3d","href":"Hi.Native.vec3d.html","topicHref":"Hi.Native.vec3d.html","topicUid":"Hi.Native.vec3d","type":"Struct"},{"name":"vec3f","href":"Hi.Native.vec3f.html","topicHref":"Hi.Native.vec3f.html","topicUid":"Hi.Native.vec3f","type":"Struct"}]},{"name":"Hi.NcMech","href":"Hi.NcMech.html","topicHref":"Hi.NcMech.html","topicUid":"Hi.NcMech","type":"Namespace","items":[{"name":"ICollisionIndexPairsSource","href":"Hi.NcMech.ICollisionIndexPairsSource.html","topicHref":"Hi.NcMech.ICollisionIndexPairsSource.html","topicUid":"Hi.NcMech.ICollisionIndexPairsSource","type":"Interface"}]},{"name":"Hi.NcMech.Fixtures","href":"Hi.NcMech.Fixtures.html","topicHref":"Hi.NcMech.Fixtures.html","topicUid":"Hi.NcMech.Fixtures","type":"Namespace","items":[{"name":"Fixture","href":"Hi.NcMech.Fixtures.Fixture.html","topicHref":"Hi.NcMech.Fixtures.Fixture.html","topicUid":"Hi.NcMech.Fixtures.Fixture","type":"Class"},{"name":"FixtureEditorDisplayee","href":"Hi.NcMech.Fixtures.FixtureEditorDisplayee.html","topicHref":"Hi.NcMech.Fixtures.FixtureEditorDisplayee.html","topicUid":"Hi.NcMech.Fixtures.FixtureEditorDisplayee","type":"Class"},{"name":"FixtureEditorDisplayeeConfig","href":"Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html","topicHref":"Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html","topicUid":"Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig","type":"Class"}]},{"name":"Hi.NcMech.Holders","href":"Hi.NcMech.Holders.html","topicHref":"Hi.NcMech.Holders.html","topicUid":"Hi.NcMech.Holders","type":"Namespace","items":[{"name":"CylindroidHolder","href":"Hi.NcMech.Holders.CylindroidHolder.html","topicHref":"Hi.NcMech.Holders.CylindroidHolder.html","topicUid":"Hi.NcMech.Holders.CylindroidHolder","type":"Class"},{"name":"FreeformHolder","href":"Hi.NcMech.Holders.FreeformHolder.html","topicHref":"Hi.NcMech.Holders.FreeformHolder.html","topicUid":"Hi.NcMech.Holders.FreeformHolder","type":"Class"},{"name":"HolderEditorDisplayee","href":"Hi.NcMech.Holders.HolderEditorDisplayee.html","topicHref":"Hi.NcMech.Holders.HolderEditorDisplayee.html","topicUid":"Hi.NcMech.Holders.HolderEditorDisplayee","type":"Class"},{"name":"IHolder","href":"Hi.NcMech.Holders.IHolder.html","topicHref":"Hi.NcMech.Holders.IHolder.html","topicUid":"Hi.NcMech.Holders.IHolder","type":"Interface"}]},{"name":"Hi.NcMech.Solids","href":"Hi.NcMech.Solids.html","topicHref":"Hi.NcMech.Solids.html","topicUid":"Hi.NcMech.Solids","type":"Namespace","items":[{"name":"IGetSolid","href":"Hi.NcMech.Solids.IGetSolid.html","topicHref":"Hi.NcMech.Solids.IGetSolid.html","topicUid":"Hi.NcMech.Solids.IGetSolid","type":"Interface"},{"name":"Solid","href":"Hi.NcMech.Solids.Solid.html","topicHref":"Hi.NcMech.Solids.Solid.html","topicUid":"Hi.NcMech.Solids.Solid","type":"Class"},{"name":"Solid.RenderingModeEnum","href":"Hi.NcMech.Solids.Solid.RenderingModeEnum.html","topicHref":"Hi.NcMech.Solids.Solid.RenderingModeEnum.html","topicUid":"Hi.NcMech.Solids.Solid.RenderingModeEnum","type":"Enum"},{"name":"SolidFuncSource","href":"Hi.NcMech.Solids.SolidFuncSource.html","topicHref":"Hi.NcMech.Solids.SolidFuncSource.html","topicUid":"Hi.NcMech.Solids.SolidFuncSource","type":"Class"}]},{"name":"Hi.NcMech.Topo","href":"Hi.NcMech.Topo.html","topicHref":"Hi.NcMech.Topo.html","topicUid":"Hi.NcMech.Topo","type":"Namespace","items":[{"name":"INcStroke","href":"Hi.NcMech.Topo.INcStroke.html","topicHref":"Hi.NcMech.Topo.INcStroke.html","topicUid":"Hi.NcMech.Topo.INcStroke","type":"Interface"},{"name":"INcTransformer","href":"Hi.NcMech.Topo.INcTransformer.html","topicHref":"Hi.NcMech.Topo.INcTransformer.html","topicUid":"Hi.NcMech.Topo.INcTransformer","type":"Interface"},{"name":"ITopoBrick","href":"Hi.NcMech.Topo.ITopoBrick.html","topicHref":"Hi.NcMech.Topo.ITopoBrick.html","topicUid":"Hi.NcMech.Topo.ITopoBrick","type":"Interface"},{"name":"NcRotation","href":"Hi.NcMech.Topo.NcRotation.html","topicHref":"Hi.NcMech.Topo.NcRotation.html","topicUid":"Hi.NcMech.Topo.NcRotation","type":"Class"},{"name":"NcTranslation","href":"Hi.NcMech.Topo.NcTranslation.html","topicHref":"Hi.NcMech.Topo.NcTranslation.html","topicUid":"Hi.NcMech.Topo.NcTranslation","type":"Class"},{"name":"SolidSourceTopoBrick","href":"Hi.NcMech.Topo.SolidSourceTopoBrick.html","topicHref":"Hi.NcMech.Topo.SolidSourceTopoBrick.html","topicUid":"Hi.NcMech.Topo.SolidSourceTopoBrick","type":"Class"},{"name":"StlSourceTopoBrick","href":"Hi.NcMech.Topo.StlSourceTopoBrick.html","topicHref":"Hi.NcMech.Topo.StlSourceTopoBrick.html","topicUid":"Hi.NcMech.Topo.StlSourceTopoBrick","type":"Class"}]},{"name":"Hi.NcMech.Workpieces","href":"Hi.NcMech.Workpieces.html","topicHref":"Hi.NcMech.Workpieces.html","topicUid":"Hi.NcMech.Workpieces","type":"Namespace","items":[{"name":"Workpiece","href":"Hi.NcMech.Workpieces.Workpiece.html","topicHref":"Hi.NcMech.Workpieces.Workpiece.html","topicUid":"Hi.NcMech.Workpieces.Workpiece","type":"Class"},{"name":"WorkpieceEditorDisplayee","href":"Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html","topicHref":"Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html","topicUid":"Hi.NcMech.Workpieces.WorkpieceEditorDisplayee","type":"Class"},{"name":"WorkpieceEditorDisplayeeConfig","href":"Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html","topicHref":"Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html","topicUid":"Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig","type":"Class"}]},{"name":"Hi.NcMech.Xyzabc","href":"Hi.NcMech.Xyzabc.html","topicHref":"Hi.NcMech.Xyzabc.html","topicUid":"Hi.NcMech.Xyzabc","type":"Namespace","items":[{"name":"CodeXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.CodeXyzabcMachineTool","type":"Class"},{"name":"CodeXyzabcMachineToolUri","href":"Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html","topicHref":"Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html","topicUid":"Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri","type":"Class"},{"name":"GeneralXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool","type":"Class"},{"name":"IGetCodeXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool","type":"Interface"},{"name":"IXyzabcMachineTool","href":"Hi.NcMech.Xyzabc.IXyzabcMachineTool.html","topicHref":"Hi.NcMech.Xyzabc.IXyzabcMachineTool.html","topicUid":"Hi.NcMech.Xyzabc.IXyzabcMachineTool","type":"Interface"}]},{"name":"Hi.NcOpt","href":"Hi.NcOpt.html","topicHref":"Hi.NcOpt.html","topicUid":"Hi.NcOpt","type":"Namespace","items":[{"name":"CuttingVelocityOptLimit","href":"Hi.NcOpt.CuttingVelocityOptLimit.html","topicHref":"Hi.NcOpt.CuttingVelocityOptLimit.html","topicUid":"Hi.NcOpt.CuttingVelocityOptLimit","type":"Class"},{"name":"FixedFeedPerCycleOptLimit","href":"Hi.NcOpt.FixedFeedPerCycleOptLimit.html","topicHref":"Hi.NcOpt.FixedFeedPerCycleOptLimit.html","topicUid":"Hi.NcOpt.FixedFeedPerCycleOptLimit","type":"Class"},{"name":"FixedFeedPerToothOptLimit","href":"Hi.NcOpt.FixedFeedPerToothOptLimit.html","topicHref":"Hi.NcOpt.FixedFeedPerToothOptLimit.html","topicUid":"Hi.NcOpt.FixedFeedPerToothOptLimit","type":"Class"},{"name":"ICutterOptLimit","href":"Hi.NcOpt.ICutterOptLimit.html","topicHref":"Hi.NcOpt.ICutterOptLimit.html","topicUid":"Hi.NcOpt.ICutterOptLimit","type":"Interface"},{"name":"ICutterOptLimitHost","href":"Hi.NcOpt.ICutterOptLimitHost.html","topicHref":"Hi.NcOpt.ICutterOptLimitHost.html","topicUid":"Hi.NcOpt.ICutterOptLimitHost","type":"Interface"},{"name":"ICuttingVelocityOptLimit","href":"Hi.NcOpt.ICuttingVelocityOptLimit.html","topicHref":"Hi.NcOpt.ICuttingVelocityOptLimit.html","topicUid":"Hi.NcOpt.ICuttingVelocityOptLimit","type":"Interface"},{"name":"IFeedPerToothOptLimit","href":"Hi.NcOpt.IFeedPerToothOptLimit.html","topicHref":"Hi.NcOpt.IFeedPerToothOptLimit.html","topicUid":"Hi.NcOpt.IFeedPerToothOptLimit","type":"Interface"},{"name":"MillingCutterOptLimit","href":"Hi.NcOpt.MillingCutterOptLimit.html","topicHref":"Hi.NcOpt.MillingCutterOptLimit.html","topicUid":"Hi.NcOpt.MillingCutterOptLimit","type":"Class"},{"name":"NcOptOption","href":"Hi.NcOpt.NcOptOption.html","topicHref":"Hi.NcOpt.NcOptOption.html","topicUid":"Hi.NcOpt.NcOptOption","type":"Class"},{"name":"NcOptProc","href":"Hi.NcOpt.NcOptProc.html","topicHref":"Hi.NcOpt.NcOptProc.html","topicUid":"Hi.NcOpt.NcOptProc","type":"Class"},{"name":"ShapeBasedCutterOptLimit","href":"Hi.NcOpt.ShapeBasedCutterOptLimit.html","topicHref":"Hi.NcOpt.ShapeBasedCutterOptLimit.html","topicUid":"Hi.NcOpt.ShapeBasedCutterOptLimit","type":"Class"}]},{"name":"Hi.NcStepUtils","href":"Hi.NcStepUtils.html","topicHref":"Hi.NcStepUtils.html","topicUid":"Hi.NcStepUtils","type":"Namespace","items":[{"name":"IGetNcStep","href":"Hi.NcStepUtils.IGetNcStep.html","topicHref":"Hi.NcStepUtils.IGetNcStep.html","topicUid":"Hi.NcStepUtils.IGetNcStep","type":"Interface"},{"name":"INcStep0","href":"Hi.NcStepUtils.INcStep0.html","topicHref":"Hi.NcStepUtils.INcStep0.html","topicUid":"Hi.NcStepUtils.INcStep0","type":"Interface"},{"name":"INcStepMonitee","href":"Hi.NcStepUtils.INcStepMonitee.html","topicHref":"Hi.NcStepUtils.INcStepMonitee.html","topicUid":"Hi.NcStepUtils.INcStepMonitee","type":"Interface"},{"name":"NcStepUtil","href":"Hi.NcStepUtils.NcStepUtil.html","topicHref":"Hi.NcStepUtils.NcStepUtil.html","topicUid":"Hi.NcStepUtils.NcStepUtil","type":"Class"}]},{"name":"Hi.Numerical","href":"Hi.Numerical.html","topicHref":"Hi.Numerical.html","topicUid":"Hi.Numerical","type":"Namespace","items":[{"name":"CncBrand","href":"Hi.Numerical.CncBrand.html","topicHref":"Hi.Numerical.CncBrand.html","topicUid":"Hi.Numerical.CncBrand","type":"Enum"},{"name":"CommentMarkEnum","href":"Hi.Numerical.CommentMarkEnum.html","topicHref":"Hi.Numerical.CommentMarkEnum.html","topicUid":"Hi.Numerical.CommentMarkEnum","type":"Enum"},{"name":"CoordinateEntryDisplayee","href":"Hi.Numerical.CoordinateEntryDisplayee.html","topicHref":"Hi.Numerical.CoordinateEntryDisplayee.html","topicUid":"Hi.Numerical.CoordinateEntryDisplayee","type":"Class"},{"name":"CoordinateEntryRenderingFlag","href":"Hi.Numerical.CoordinateEntryRenderingFlag.html","topicHref":"Hi.Numerical.CoordinateEntryRenderingFlag.html","topicUid":"Hi.Numerical.CoordinateEntryRenderingFlag","type":"Enum"},{"name":"CoordinateInterpolationMode","href":"Hi.Numerical.CoordinateInterpolationMode.html","topicHref":"Hi.Numerical.CoordinateInterpolationMode.html","topicUid":"Hi.Numerical.CoordinateInterpolationMode","type":"Enum"},{"name":"FlexDictionaryUtil","href":"Hi.Numerical.FlexDictionaryUtil.html","topicHref":"Hi.Numerical.FlexDictionaryUtil.html","topicUid":"Hi.Numerical.FlexDictionaryUtil","type":"Class"},{"name":"HeidenhainCoordinateEntryDisplayee","href":"Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html","topicHref":"Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html","topicUid":"Hi.Numerical.HeidenhainCoordinateEntryDisplayee","type":"Class"},{"name":"IFlexDictionaryHost","href":"Hi.Numerical.IFlexDictionaryHost-1.html","topicHref":"Hi.Numerical.IFlexDictionaryHost-1.html","topicUid":"Hi.Numerical.IFlexDictionaryHost`1","type":"Interface"},{"name":"IGetFeedrate","href":"Hi.Numerical.IGetFeedrate.html","topicHref":"Hi.Numerical.IGetFeedrate.html","topicUid":"Hi.Numerical.IGetFeedrate","type":"Interface"},{"name":"IGetSpindleSpeed","href":"Hi.Numerical.IGetSpindleSpeed.html","topicHref":"Hi.Numerical.IGetSpindleSpeed.html","topicUid":"Hi.Numerical.IGetSpindleSpeed","type":"Interface"},{"name":"ISetFeedrate","href":"Hi.Numerical.ISetFeedrate.html","topicHref":"Hi.Numerical.ISetFeedrate.html","topicUid":"Hi.Numerical.ISetFeedrate","type":"Interface"},{"name":"ISetSpindleSpeed","href":"Hi.Numerical.ISetSpindleSpeed.html","topicHref":"Hi.Numerical.ISetSpindleSpeed.html","topicUid":"Hi.Numerical.ISetSpindleSpeed","type":"Interface"},{"name":"IsoCoordinateEntryDisplayee","href":"Hi.Numerical.IsoCoordinateEntryDisplayee.html","topicHref":"Hi.Numerical.IsoCoordinateEntryDisplayee.html","topicUid":"Hi.Numerical.IsoCoordinateEntryDisplayee","type":"Class"},{"name":"IsoCoordinateTable","href":"Hi.Numerical.IsoCoordinateTable.html","topicHref":"Hi.Numerical.IsoCoordinateTable.html","topicUid":"Hi.Numerical.IsoCoordinateTable","type":"Class"},{"name":"MechNcUtil","href":"Hi.Numerical.MechNcUtil.html","topicHref":"Hi.Numerical.MechNcUtil.html","topicUid":"Hi.Numerical.MechNcUtil","type":"Class"},{"name":"MillingToolOffsetTable","href":"Hi.Numerical.MillingToolOffsetTable.html","topicHref":"Hi.Numerical.MillingToolOffsetTable.html","topicUid":"Hi.Numerical.MillingToolOffsetTable","type":"Class"},{"name":"MillingToolOffsetTableRow","href":"Hi.Numerical.MillingToolOffsetTableRow.html","topicHref":"Hi.Numerical.MillingToolOffsetTableRow.html","topicUid":"Hi.Numerical.MillingToolOffsetTableRow","type":"Class"},{"name":"NcComment","href":"Hi.Numerical.NcComment.html","topicHref":"Hi.Numerical.NcComment.html","topicUid":"Hi.Numerical.NcComment","type":"Class"},{"name":"NcEnv","href":"Hi.Numerical.NcEnv.html","topicHref":"Hi.Numerical.NcEnv.html","topicUid":"Hi.Numerical.NcEnv","type":"Class"},{"name":"NcFlag","href":"Hi.Numerical.NcFlag.html","topicHref":"Hi.Numerical.NcFlag.html","topicUid":"Hi.Numerical.NcFlag","type":"Enum"},{"name":"NcFlagUtil","href":"Hi.Numerical.NcFlagUtil.html","topicHref":"Hi.Numerical.NcFlagUtil.html","topicUid":"Hi.Numerical.NcFlagUtil","type":"Class"},{"name":"NcGroup00","href":"Hi.Numerical.NcGroup00.html","topicHref":"Hi.Numerical.NcGroup00.html","topicUid":"Hi.Numerical.NcGroup00","type":"Enum"},{"name":"NcGroup01","href":"Hi.Numerical.NcGroup01.html","topicHref":"Hi.Numerical.NcGroup01.html","topicUid":"Hi.Numerical.NcGroup01","type":"Enum"},{"name":"NcGroup02","href":"Hi.Numerical.NcGroup02.html","topicHref":"Hi.Numerical.NcGroup02.html","topicUid":"Hi.Numerical.NcGroup02","type":"Enum"},{"name":"NcGroup03","href":"Hi.Numerical.NcGroup03.html","topicHref":"Hi.Numerical.NcGroup03.html","topicUid":"Hi.Numerical.NcGroup03","type":"Enum"},{"name":"NcGroup05","href":"Hi.Numerical.NcGroup05.html","topicHref":"Hi.Numerical.NcGroup05.html","topicUid":"Hi.Numerical.NcGroup05","type":"Enum"},{"name":"NcGroup06","href":"Hi.Numerical.NcGroup06.html","topicHref":"Hi.Numerical.NcGroup06.html","topicUid":"Hi.Numerical.NcGroup06","type":"Enum"},{"name":"NcGroup07","href":"Hi.Numerical.NcGroup07.html","topicHref":"Hi.Numerical.NcGroup07.html","topicUid":"Hi.Numerical.NcGroup07","type":"Enum"},{"name":"NcGroup08","href":"Hi.Numerical.NcGroup08.html","topicHref":"Hi.Numerical.NcGroup08.html","topicUid":"Hi.Numerical.NcGroup08","type":"Enum"},{"name":"NcGroup09","href":"Hi.Numerical.NcGroup09.html","topicHref":"Hi.Numerical.NcGroup09.html","topicUid":"Hi.Numerical.NcGroup09","type":"Enum"},{"name":"NcGroup10","href":"Hi.Numerical.NcGroup10.html","topicHref":"Hi.Numerical.NcGroup10.html","topicUid":"Hi.Numerical.NcGroup10","type":"Enum"},{"name":"NcGroup14","href":"Hi.Numerical.NcGroup14.html","topicHref":"Hi.Numerical.NcGroup14.html","topicUid":"Hi.Numerical.NcGroup14","type":"Enum"},{"name":"NcGroup16","href":"Hi.Numerical.NcGroup16.html","topicHref":"Hi.Numerical.NcGroup16.html","topicUid":"Hi.Numerical.NcGroup16","type":"Enum"},{"name":"NcGroup21","href":"Hi.Numerical.NcGroup21.html","topicHref":"Hi.Numerical.NcGroup21.html","topicUid":"Hi.Numerical.NcGroup21","type":"Enum"},{"name":"NcGroupAttribute","href":"Hi.Numerical.NcGroupAttribute.html","topicHref":"Hi.Numerical.NcGroupAttribute.html","topicUid":"Hi.Numerical.NcGroupAttribute","type":"Class"},{"name":"NcGroupHeidenhainM107M108","href":"Hi.Numerical.NcGroupHeidenhainM107M108.html","topicHref":"Hi.Numerical.NcGroupHeidenhainM107M108.html","topicUid":"Hi.Numerical.NcGroupHeidenhainM107M108","type":"Enum"},{"name":"NcGroupHeidenhainPlane","href":"Hi.Numerical.NcGroupHeidenhainPlane.html","topicHref":"Hi.Numerical.NcGroupHeidenhainPlane.html","topicUid":"Hi.Numerical.NcGroupHeidenhainPlane","type":"Enum"},{"name":"NcGroupHeidenhainShortestRotaryPath","href":"Hi.Numerical.NcGroupHeidenhainShortestRotaryPath.html","topicHref":"Hi.Numerical.NcGroupHeidenhainShortestRotaryPath.html","topicUid":"Hi.Numerical.NcGroupHeidenhainShortestRotaryPath","type":"Enum"},{"name":"NcGroupSpindleRotation","href":"Hi.Numerical.NcGroupSpindleRotation.html","topicHref":"Hi.Numerical.NcGroupSpindleRotation.html","topicUid":"Hi.Numerical.NcGroupSpindleRotation","type":"Enum"},{"name":"NcLifeCycleAttribute","href":"Hi.Numerical.NcLifeCycleAttribute.html","topicHref":"Hi.Numerical.NcLifeCycleAttribute.html","topicUid":"Hi.Numerical.NcLifeCycleAttribute","type":"Class"},{"name":"NcLifeCycleMode","href":"Hi.Numerical.NcLifeCycleMode.html","topicHref":"Hi.Numerical.NcLifeCycleMode.html","topicUid":"Hi.Numerical.NcLifeCycleMode","type":"Enum"},{"name":"NcLine","href":"Hi.Numerical.NcLine.html","topicHref":"Hi.Numerical.NcLine.html","topicUid":"Hi.Numerical.NcLine","type":"Class"},{"name":"NcNameAttribute","href":"Hi.Numerical.NcNameAttribute.html","topicHref":"Hi.Numerical.NcNameAttribute.html","topicUid":"Hi.Numerical.NcNameAttribute","type":"Class"},{"name":"NcNoteCache","href":"Hi.Numerical.NcNoteCache.html","topicHref":"Hi.Numerical.NcNoteCache.html","topicUid":"Hi.Numerical.NcNoteCache","type":"Class"},{"name":"NcProc","href":"Hi.Numerical.NcProc.html","topicHref":"Hi.Numerical.NcProc.html","topicUid":"Hi.Numerical.NcProc","type":"Class"},{"name":"NcStepFileOutputKit","href":"Hi.Numerical.NcStepFileOutputKit.html","topicHref":"Hi.Numerical.NcStepFileOutputKit.html","topicUid":"Hi.Numerical.NcStepFileOutputKit","type":"Class"},{"name":"NcStepMonitor","href":"Hi.Numerical.NcStepMonitor.html","topicHref":"Hi.Numerical.NcStepMonitor.html","topicUid":"Hi.Numerical.NcStepMonitor","type":"Class"},{"name":"NcUtil","href":"Hi.Numerical.NcUtil.html","topicHref":"Hi.Numerical.NcUtil.html","topicUid":"Hi.Numerical.NcUtil","type":"Class"},{"name":"NcWarningSceneEnum","href":"Hi.Numerical.NcWarningSceneEnum.html","topicHref":"Hi.Numerical.NcWarningSceneEnum.html","topicUid":"Hi.Numerical.NcWarningSceneEnum","type":"Enum"},{"name":"NumericUtil","href":"Hi.Numerical.NumericUtil.html","topicHref":"Hi.Numerical.NumericUtil.html","topicUid":"Hi.Numerical.NumericUtil","type":"Class"},{"name":"PolarEntry","href":"Hi.Numerical.PolarEntry.html","topicHref":"Hi.Numerical.PolarEntry.html","topicUid":"Hi.Numerical.PolarEntry","type":"Class"},{"name":"PolarEntry.PolarModeDirEnum","href":"Hi.Numerical.PolarEntry.PolarModeDirEnum.html","topicHref":"Hi.Numerical.PolarEntry.PolarModeDirEnum.html","topicUid":"Hi.Numerical.PolarEntry.PolarModeDirEnum","type":"Enum"},{"name":"RadiusCompensationBuf","href":"Hi.Numerical.RadiusCompensationBuf.html","topicHref":"Hi.Numerical.RadiusCompensationBuf.html","topicUid":"Hi.Numerical.RadiusCompensationBuf","type":"Class"},{"name":"SpindleDirection","href":"Hi.Numerical.SpindleDirection.html","topicHref":"Hi.Numerical.SpindleDirection.html","topicUid":"Hi.Numerical.SpindleDirection","type":"Enum"},{"name":"SubStringKit","href":"Hi.Numerical.SubStringKit.html","topicHref":"Hi.Numerical.SubStringKit.html","topicUid":"Hi.Numerical.SubStringKit","type":"Class"},{"name":"SubStringKit.ActivationMode","href":"Hi.Numerical.SubStringKit.ActivationMode.html","topicHref":"Hi.Numerical.SubStringKit.ActivationMode.html","topicUid":"Hi.Numerical.SubStringKit.ActivationMode","type":"Enum"},{"name":"ToolConfigNotFoundException","href":"Hi.Numerical.ToolConfigNotFoundException.html","topicHref":"Hi.Numerical.ToolConfigNotFoundException.html","topicUid":"Hi.Numerical.ToolConfigNotFoundException","type":"Class"}]},{"name":"Hi.Numerical.Acts","href":"Hi.Numerical.Acts.html","topicHref":"Hi.Numerical.Acts.html","topicUid":"Hi.Numerical.Acts","type":"Namespace","items":[{"name":"ActClArc","href":"Hi.Numerical.Acts.ActClArc.html","topicHref":"Hi.Numerical.Acts.ActClArc.html","topicUid":"Hi.Numerical.Acts.ActClArc","type":"Class"},{"name":"ActClLinear","href":"Hi.Numerical.Acts.ActClLinear.html","topicHref":"Hi.Numerical.Acts.ActClLinear.html","topicUid":"Hi.Numerical.Acts.ActClLinear","type":"Class"},{"name":"ActClStep","href":"Hi.Numerical.Acts.ActClStep.html","topicHref":"Hi.Numerical.Acts.ActClStep.html","topicUid":"Hi.Numerical.Acts.ActClStep","type":"Class"},{"name":"ActClTeleport","href":"Hi.Numerical.Acts.ActClTeleport.html","topicHref":"Hi.Numerical.Acts.ActClTeleport.html","topicUid":"Hi.Numerical.Acts.ActClTeleport","type":"Class"},{"name":"ActCooling","href":"Hi.Numerical.Acts.ActCooling.html","topicHref":"Hi.Numerical.Acts.ActCooling.html","topicUid":"Hi.Numerical.Acts.ActCooling","type":"Class"},{"name":"ActDelay","href":"Hi.Numerical.Acts.ActDelay.html","topicHref":"Hi.Numerical.Acts.ActDelay.html","topicUid":"Hi.Numerical.Acts.ActDelay","type":"Class"},{"name":"ActFeedrate","href":"Hi.Numerical.Acts.ActFeedrate.html","topicHref":"Hi.Numerical.Acts.ActFeedrate.html","topicUid":"Hi.Numerical.Acts.ActFeedrate","type":"Class"},{"name":"ActHiddenStateChanged","href":"Hi.Numerical.Acts.ActHiddenStateChanged.html","topicHref":"Hi.Numerical.Acts.ActHiddenStateChanged.html","topicUid":"Hi.Numerical.Acts.ActHiddenStateChanged","type":"Class"},{"name":"ActIntentionalSkip","href":"Hi.Numerical.Acts.ActIntentionalSkip.html","topicHref":"Hi.Numerical.Acts.ActIntentionalSkip.html","topicUid":"Hi.Numerical.Acts.ActIntentionalSkip","type":"Class"},{"name":"ActLineBegin","href":"Hi.Numerical.Acts.ActLineBegin.html","topicHref":"Hi.Numerical.Acts.ActLineBegin.html","topicUid":"Hi.Numerical.Acts.ActLineBegin","type":"Class"},{"name":"ActLineCsScript","href":"Hi.Numerical.Acts.ActLineCsScript.html","topicHref":"Hi.Numerical.Acts.ActLineCsScript.html","topicUid":"Hi.Numerical.Acts.ActLineCsScript","type":"Class"},{"name":"ActLineEnd","href":"Hi.Numerical.Acts.ActLineEnd.html","topicHref":"Hi.Numerical.Acts.ActLineEnd.html","topicUid":"Hi.Numerical.Acts.ActLineEnd","type":"Class"},{"name":"ActLinearClAndLinearMcAbcMcXyzabcContour","href":"Hi.Numerical.Acts.ActLinearClAndLinearMcAbcMcXyzabcContour.html","topicHref":"Hi.Numerical.Acts.ActLinearClAndLinearMcAbcMcXyzabcContour.html","topicUid":"Hi.Numerical.Acts.ActLinearClAndLinearMcAbcMcXyzabcContour","type":"Class"},{"name":"ActMcPolarLinearContour","href":"Hi.Numerical.Acts.ActMcPolarLinearContour.html","topicHref":"Hi.Numerical.Acts.ActMcPolarLinearContour.html","topicUid":"Hi.Numerical.Acts.ActMcPolarLinearContour","type":"Class"},{"name":"ActMcXyzLinearContour","href":"Hi.Numerical.Acts.ActMcXyzLinearContour.html","topicHref":"Hi.Numerical.Acts.ActMcXyzLinearContour.html","topicUid":"Hi.Numerical.Acts.ActMcXyzLinearContour","type":"Class"},{"name":"ActMcXyzStep","href":"Hi.Numerical.Acts.ActMcXyzStep.html","topicHref":"Hi.Numerical.Acts.ActMcXyzStep.html","topicUid":"Hi.Numerical.Acts.ActMcXyzStep","type":"Class"},{"name":"ActMcXyzabcOrientableLinearContour","href":"Hi.Numerical.Acts.ActMcXyzabcOrientableLinearContour.html","topicHref":"Hi.Numerical.Acts.ActMcXyzabcOrientableLinearContour.html","topicUid":"Hi.Numerical.Acts.ActMcXyzabcOrientableLinearContour","type":"Class"},{"name":"ActMcXyzabcStep","href":"Hi.Numerical.Acts.ActMcXyzabcStep.html","topicHref":"Hi.Numerical.Acts.ActMcXyzabcStep.html","topicUid":"Hi.Numerical.Acts.ActMcXyzabcStep","type":"Class"},{"name":"ActRapid","href":"Hi.Numerical.Acts.ActRapid.html","topicHref":"Hi.Numerical.Acts.ActRapid.html","topicUid":"Hi.Numerical.Acts.ActRapid","type":"Class"},{"name":"ActSpindleSpeed","href":"Hi.Numerical.Acts.ActSpindleSpeed.html","topicHref":"Hi.Numerical.Acts.ActSpindleSpeed.html","topicUid":"Hi.Numerical.Acts.ActSpindleSpeed","type":"Class"},{"name":"ActSpiralMcXyzContour","href":"Hi.Numerical.Acts.ActSpiralMcXyzContour.html","topicHref":"Hi.Numerical.Acts.ActSpiralMcXyzContour.html","topicUid":"Hi.Numerical.Acts.ActSpiralMcXyzContour","type":"Class"},{"name":"ActStateRunner","href":"Hi.Numerical.Acts.ActStateRunner.html","topicHref":"Hi.Numerical.Acts.ActStateRunner.html","topicUid":"Hi.Numerical.Acts.ActStateRunner","type":"Class"},{"name":"ActToolingStep","href":"Hi.Numerical.Acts.ActToolingStep.html","topicHref":"Hi.Numerical.Acts.ActToolingStep.html","topicUid":"Hi.Numerical.Acts.ActToolingStep","type":"Class"},{"name":"ActToolingTeleport","href":"Hi.Numerical.Acts.ActToolingTeleport.html","topicHref":"Hi.Numerical.Acts.ActToolingTeleport.html","topicUid":"Hi.Numerical.Acts.ActToolingTeleport","type":"Class"},{"name":"ActUnknownSkip","href":"Hi.Numerical.Acts.ActUnknownSkip.html","topicHref":"Hi.Numerical.Acts.ActUnknownSkip.html","topicUid":"Hi.Numerical.Acts.ActUnknownSkip","type":"Class"},{"name":"ActUtil","href":"Hi.Numerical.Acts.ActUtil.html","topicHref":"Hi.Numerical.Acts.ActUtil.html","topicUid":"Hi.Numerical.Acts.ActUtil","type":"Class"},{"name":"IAct","href":"Hi.Numerical.Acts.IAct.html","topicHref":"Hi.Numerical.Acts.IAct.html","topicUid":"Hi.Numerical.Acts.IAct","type":"Interface"},{"name":"IActClMove","href":"Hi.Numerical.Acts.IActClMove.html","topicHref":"Hi.Numerical.Acts.IActClMove.html","topicUid":"Hi.Numerical.Acts.IActClMove","type":"Interface"},{"name":"IActDuration","href":"Hi.Numerical.Acts.IActDuration.html","topicHref":"Hi.Numerical.Acts.IActDuration.html","topicUid":"Hi.Numerical.Acts.IActDuration","type":"Interface"},{"name":"IActMachineStep","href":"Hi.Numerical.Acts.IActMachineStep.html","topicHref":"Hi.Numerical.Acts.IActMachineStep.html","topicUid":"Hi.Numerical.Acts.IActMachineStep","type":"Interface"},{"name":"IActMcXyzContour","href":"Hi.Numerical.Acts.IActMcXyzContour.html","topicHref":"Hi.Numerical.Acts.IActMcXyzContour.html","topicUid":"Hi.Numerical.Acts.IActMcXyzContour","type":"Interface"},{"name":"IActMcXyzabcContour","href":"Hi.Numerical.Acts.IActMcXyzabcContour.html","topicHref":"Hi.Numerical.Acts.IActMcXyzabcContour.html","topicUid":"Hi.Numerical.Acts.IActMcXyzabcContour","type":"Interface"},{"name":"IActSkip","href":"Hi.Numerical.Acts.IActSkip.html","topicHref":"Hi.Numerical.Acts.IActSkip.html","topicUid":"Hi.Numerical.Acts.IActSkip","type":"Interface"},{"name":"IActTooling","href":"Hi.Numerical.Acts.IActTooling.html","topicHref":"Hi.Numerical.Acts.IActTooling.html","topicUid":"Hi.Numerical.Acts.IActTooling","type":"Interface"},{"name":"IWorkTimeAttrib","href":"Hi.Numerical.Acts.IWorkTimeAttrib.html","topicHref":"Hi.Numerical.Acts.IWorkTimeAttrib.html","topicUid":"Hi.Numerical.Acts.IWorkTimeAttrib","type":"Interface"},{"name":"IWorkTimeGetter","href":"Hi.Numerical.Acts.IWorkTimeGetter.html","topicHref":"Hi.Numerical.Acts.IWorkTimeGetter.html","topicUid":"Hi.Numerical.Acts.IWorkTimeGetter","type":"Interface"},{"name":"IWorkTimeSetter","href":"Hi.Numerical.Acts.IWorkTimeSetter.html","topicHref":"Hi.Numerical.Acts.IWorkTimeSetter.html","topicUid":"Hi.Numerical.Acts.IWorkTimeSetter","type":"Interface"}]},{"name":"Hi.Numerical.FilePlayers","href":"Hi.Numerical.FilePlayers.html","topicHref":"Hi.Numerical.FilePlayers.html","topicUid":"Hi.Numerical.FilePlayers","type":"Namespace","items":[{"name":"NcRunner","href":"Hi.Numerical.FilePlayers.NcRunner.html","topicHref":"Hi.Numerical.FilePlayers.NcRunner.html","topicUid":"Hi.Numerical.FilePlayers.NcRunner","type":"Class"}]},{"name":"Hi.Numerical.MachiningMotionResolutionUtils","href":"Hi.Numerical.MachiningMotionResolutionUtils.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils","type":"Namespace","items":[{"name":"FeedPerCycleMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution","type":"Class"},{"name":"FeedPerToothMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution","type":"Class"},{"name":"FeedPerToothNcResolution0","href":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0","type":"Class"},{"name":"FixedMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution","type":"Class"},{"name":"IMachiningMotionResolution","href":"Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html","topicHref":"Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html","topicUid":"Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution","type":"Interface"}]},{"name":"Hi.Numerical.NcArgs","href":"Hi.Numerical.NcArgs.html","topicHref":"Hi.Numerical.NcArgs.html","topicUid":"Hi.Numerical.NcArgs","type":"Namespace","items":[{"name":"ArcNcArg","href":"Hi.Numerical.NcArgs.ArcNcArg.html","topicHref":"Hi.Numerical.NcArgs.ArcNcArg.html","topicUid":"Hi.Numerical.NcArgs.ArcNcArg","type":"Class"},{"name":"G28Arg","href":"Hi.Numerical.NcArgs.G28Arg.html","topicHref":"Hi.Numerical.NcArgs.G28Arg.html","topicUid":"Hi.Numerical.NcArgs.G28Arg","type":"Class"},{"name":"Group07NcArg","href":"Hi.Numerical.NcArgs.Group07NcArg.html","topicHref":"Hi.Numerical.NcArgs.Group07NcArg.html","topicUid":"Hi.Numerical.NcArgs.Group07NcArg","type":"Class"},{"name":"Group09NcArg","href":"Hi.Numerical.NcArgs.Group09NcArg.html","topicHref":"Hi.Numerical.NcArgs.Group09NcArg.html","topicUid":"Hi.Numerical.NcArgs.Group09NcArg","type":"Class"},{"name":"HeidenhainCycleDef7Arg","href":"Hi.Numerical.NcArgs.HeidenhainCycleDef7Arg.html","topicHref":"Hi.Numerical.NcArgs.HeidenhainCycleDef7Arg.html","topicUid":"Hi.Numerical.NcArgs.HeidenhainCycleDef7Arg","type":"Class"},{"name":"HeidenhainPlaneSpatialArg","href":"Hi.Numerical.NcArgs.HeidenhainPlaneSpatialArg.html","topicHref":"Hi.Numerical.NcArgs.HeidenhainPlaneSpatialArg.html","topicUid":"Hi.Numerical.NcArgs.HeidenhainPlaneSpatialArg","type":"Class"},{"name":"IHeidenhainBlockCacheArg","href":"Hi.Numerical.NcArgs.IHeidenhainBlockCacheArg.html","topicHref":"Hi.Numerical.NcArgs.IHeidenhainBlockCacheArg.html","topicUid":"Hi.Numerical.NcArgs.IHeidenhainBlockCacheArg","type":"Interface"},{"name":"IHeidenhainPlaneArg","href":"Hi.Numerical.NcArgs.IHeidenhainPlaneArg.html","topicHref":"Hi.Numerical.NcArgs.IHeidenhainPlaneArg.html","topicUid":"Hi.Numerical.NcArgs.IHeidenhainPlaneArg","type":"Interface"},{"name":"ITiltPlaneNcArg","href":"Hi.Numerical.NcArgs.ITiltPlaneNcArg.html","topicHref":"Hi.Numerical.NcArgs.ITiltPlaneNcArg.html","topicUid":"Hi.Numerical.NcArgs.ITiltPlaneNcArg","type":"Interface"},{"name":"NcArgCycle800","href":"Hi.Numerical.NcArgs.NcArgCycle800.html","topicHref":"Hi.Numerical.NcArgs.NcArgCycle800.html","topicUid":"Hi.Numerical.NcArgs.NcArgCycle800","type":"Class"},{"name":"NcArgG68","href":"Hi.Numerical.NcArgs.NcArgG68.html","topicHref":"Hi.Numerical.NcArgs.NcArgG68.html","topicUid":"Hi.Numerical.NcArgs.NcArgG68","type":"Class"},{"name":"NcArgG68p2","href":"Hi.Numerical.NcArgs.NcArgG68p2.html","topicHref":"Hi.Numerical.NcArgs.NcArgG68p2.html","topicUid":"Hi.Numerical.NcArgs.NcArgG68p2","type":"Class"},{"name":"PausingNcArg","href":"Hi.Numerical.NcArgs.PausingNcArg.html","topicHref":"Hi.Numerical.NcArgs.PausingNcArg.html","topicUid":"Hi.Numerical.NcArgs.PausingNcArg","type":"Class"}]},{"name":"Hi.Numerical.StepSelectionUtils","href":"Hi.Numerical.StepSelectionUtils.html","topicHref":"Hi.Numerical.StepSelectionUtils.html","topicUid":"Hi.Numerical.StepSelectionUtils","type":"Namespace","items":[{"name":"AnchorMode","href":"Hi.Numerical.StepSelectionUtils.AnchorMode.html","topicHref":"Hi.Numerical.StepSelectionUtils.AnchorMode.html","topicUid":"Hi.Numerical.StepSelectionUtils.AnchorMode","type":"Enum"},{"name":"BoundSelector","href":"Hi.Numerical.StepSelectionUtils.BoundSelector.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelector.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelector","type":"Class"},{"name":"BoundSelectorHost","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorHost","type":"Class"},{"name":"BoundSelectorPair","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair","type":"Class"},{"name":"BoundSelectorPair.BoundLocale","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale","type":"Enum"},{"name":"BoundSelectorStepSectionBundle","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle","type":"Class"},{"name":"BoundSelectorUtil","href":"Hi.Numerical.StepSelectionUtils.BoundSelectorUtil.html","topicHref":"Hi.Numerical.StepSelectionUtils.BoundSelectorUtil.html","topicUid":"Hi.Numerical.StepSelectionUtils.BoundSelectorUtil","type":"Class"},{"name":"DistanceShift","href":"Hi.Numerical.StepSelectionUtils.DistanceShift.html","topicHref":"Hi.Numerical.StepSelectionUtils.DistanceShift.html","topicUid":"Hi.Numerical.StepSelectionUtils.DistanceShift","type":"Class"},{"name":"IStepShift","href":"Hi.Numerical.StepSelectionUtils.IStepShift.html","topicHref":"Hi.Numerical.StepSelectionUtils.IStepShift.html","topicUid":"Hi.Numerical.StepSelectionUtils.IStepShift","type":"Interface"},{"name":"TimeShift","href":"Hi.Numerical.StepSelectionUtils.TimeShift.html","topicHref":"Hi.Numerical.StepSelectionUtils.TimeShift.html","topicUid":"Hi.Numerical.StepSelectionUtils.TimeShift","type":"Class"}]},{"name":"Hi.Numerical.Xyzabc","href":"Hi.Numerical.Xyzabc.html","topicHref":"Hi.Numerical.Xyzabc.html","topicUid":"Hi.Numerical.Xyzabc","type":"Namespace","items":[{"name":"Abc","href":"Hi.Numerical.Xyzabc.Abc.html","topicHref":"Hi.Numerical.Xyzabc.Abc.html","topicUid":"Hi.Numerical.Xyzabc.Abc","type":"Struct"},{"name":"CodeXyzabcChain","href":"Hi.Numerical.Xyzabc.CodeXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.CodeXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.CodeXyzabcChain","type":"Class"},{"name":"GeneralXyzabcChain","href":"Hi.Numerical.Xyzabc.GeneralXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.GeneralXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.GeneralXyzabcChain","type":"Class"},{"name":"ICoordinateConverter","href":"Hi.Numerical.Xyzabc.ICoordinateConverter.html","topicHref":"Hi.Numerical.Xyzabc.ICoordinateConverter.html","topicUid":"Hi.Numerical.Xyzabc.ICoordinateConverter","type":"Interface"},{"name":"IGetMcXyzabc","href":"Hi.Numerical.Xyzabc.IGetMcXyzabc.html","topicHref":"Hi.Numerical.Xyzabc.IGetMcXyzabc.html","topicUid":"Hi.Numerical.Xyzabc.IGetMcXyzabc","type":"Interface"},{"name":"IGetXyzabcChain","href":"Hi.Numerical.Xyzabc.IGetXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.IGetXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.IGetXyzabcChain","type":"Interface"},{"name":"IXyzabcChain","href":"Hi.Numerical.Xyzabc.IXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.IXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.IXyzabcChain","type":"Interface"},{"name":"ReflectedXyzabcChain","href":"Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html","topicHref":"Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html","topicUid":"Hi.Numerical.Xyzabc.ReflectedXyzabcChain","type":"Class"},{"name":"SimpleChainCoordinateConverter","href":"Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html","topicHref":"Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html","topicUid":"Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter","type":"Class"},{"name":"XyzabcChainMillingCoordinateConverter","href":"Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html","topicHref":"Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html","topicUid":"Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter","type":"Class"},{"name":"XyzabcSolver","href":"Hi.Numerical.Xyzabc.XyzabcSolver.html","topicHref":"Hi.Numerical.Xyzabc.XyzabcSolver.html","topicUid":"Hi.Numerical.Xyzabc.XyzabcSolver","type":"Class"},{"name":"XyzabcUtil","href":"Hi.Numerical.Xyzabc.XyzabcUtil.html","topicHref":"Hi.Numerical.Xyzabc.XyzabcUtil.html","topicUid":"Hi.Numerical.Xyzabc.XyzabcUtil","type":"Class"}]},{"name":"Hi.PanelModels","href":"Hi.PanelModels.html","topicHref":"Hi.PanelModels.html","topicUid":"Hi.PanelModels","type":"Namespace","items":[{"name":"HiKey","href":"Hi.PanelModels.HiKey.html","topicHref":"Hi.PanelModels.HiKey.html","topicUid":"Hi.PanelModels.HiKey","type":"Enum"},{"name":"HiKeyEvent","href":"Hi.PanelModels.HiKeyEvent.html","topicHref":"Hi.PanelModels.HiKeyEvent.html","topicUid":"Hi.PanelModels.HiKeyEvent","type":"Class"},{"name":"HiModifierKeys","href":"Hi.PanelModels.HiModifierKeys.html","topicHref":"Hi.PanelModels.HiModifierKeys.html","topicUid":"Hi.PanelModels.HiModifierKeys","type":"Enum"},{"name":"HiMouseButton","href":"Hi.PanelModels.HiMouseButton.html","topicHref":"Hi.PanelModels.HiMouseButton.html","topicUid":"Hi.PanelModels.HiMouseButton","type":"Enum"},{"name":"HiMouseButtonEvent","href":"Hi.PanelModels.HiMouseButtonEvent.html","topicHref":"Hi.PanelModels.HiMouseButtonEvent.html","topicUid":"Hi.PanelModels.HiMouseButtonEvent","type":"Class"},{"name":"HiMouseButtonMask","href":"Hi.PanelModels.HiMouseButtonMask.html","topicHref":"Hi.PanelModels.HiMouseButtonMask.html","topicUid":"Hi.PanelModels.HiMouseButtonMask","type":"Enum"},{"name":"HiMouseButtonMaskUtil","href":"Hi.PanelModels.HiMouseButtonMaskUtil.html","topicHref":"Hi.PanelModels.HiMouseButtonMaskUtil.html","topicUid":"Hi.PanelModels.HiMouseButtonMaskUtil","type":"Class"},{"name":"HiMouseMoveEvent","href":"Hi.PanelModels.HiMouseMoveEvent.html","topicHref":"Hi.PanelModels.HiMouseMoveEvent.html","topicUid":"Hi.PanelModels.HiMouseMoveEvent","type":"Class"},{"name":"HiMouseWheelEvent","href":"Hi.PanelModels.HiMouseWheelEvent.html","topicHref":"Hi.PanelModels.HiMouseWheelEvent.html","topicUid":"Hi.PanelModels.HiMouseWheelEvent","type":"Class"},{"name":"PanelModel","href":"Hi.PanelModels.PanelModel.html","topicHref":"Hi.PanelModels.PanelModel.html","topicUid":"Hi.PanelModels.PanelModel","type":"Class"}]},{"name":"Hi.Parallels","href":"Hi.Parallels.html","topicHref":"Hi.Parallels.html","topicUid":"Hi.Parallels","type":"Namespace","items":[{"name":"CurrentThreadTaskScheduler","href":"Hi.Parallels.CurrentThreadTaskScheduler.html","topicHref":"Hi.Parallels.CurrentThreadTaskScheduler.html","topicUid":"Hi.Parallels.CurrentThreadTaskScheduler","type":"Class"},{"name":"DistributedQueueTaskScheduler","href":"Hi.Parallels.DistributedQueueTaskScheduler.html","topicHref":"Hi.Parallels.DistributedQueueTaskScheduler.html","topicUid":"Hi.Parallels.DistributedQueueTaskScheduler","type":"Class"},{"name":"DistributedQueueTaskStarter","href":"Hi.Parallels.DistributedQueueTaskStarter.html","topicHref":"Hi.Parallels.DistributedQueueTaskStarter.html","topicUid":"Hi.Parallels.DistributedQueueTaskStarter","type":"Class"},{"name":"LockUtil","href":"Hi.Parallels.LockUtil.html","topicHref":"Hi.Parallels.LockUtil.html","topicUid":"Hi.Parallels.LockUtil","type":"Class"},{"name":"QueueTaskScheduler","href":"Hi.Parallels.QueueTaskScheduler.html","topicHref":"Hi.Parallels.QueueTaskScheduler.html","topicUid":"Hi.Parallels.QueueTaskScheduler","type":"Class"},{"name":"ReaderWriterLockUtil","href":"Hi.Parallels.ReaderWriterLockUtil.html","topicHref":"Hi.Parallels.ReaderWriterLockUtil.html","topicUid":"Hi.Parallels.ReaderWriterLockUtil","type":"Class"},{"name":"SemaphoreUtil","href":"Hi.Parallels.SemaphoreUtil.html","topicHref":"Hi.Parallels.SemaphoreUtil.html","topicUid":"Hi.Parallels.SemaphoreUtil","type":"Class"},{"name":"ThreadSafeSet","href":"Hi.Parallels.ThreadSafeSet-1.html","topicHref":"Hi.Parallels.ThreadSafeSet-1.html","topicUid":"Hi.Parallels.ThreadSafeSet`1","type":"Class"}]},{"name":"Hi.Physics","href":"Hi.Physics.html","topicHref":"Hi.Physics.html","topicUid":"Hi.Physics","type":"Namespace","items":[{"name":"AmpPhase","href":"Hi.Physics.AmpPhase.html","topicHref":"Hi.Physics.AmpPhase.html","topicUid":"Hi.Physics.AmpPhase","type":"Class"},{"name":"CoatingMaterial","href":"Hi.Physics.CoatingMaterial.html","topicHref":"Hi.Physics.CoatingMaterial.html","topicUid":"Hi.Physics.CoatingMaterial","type":"Class"},{"name":"CoolantHeatCondition","href":"Hi.Physics.CoolantHeatCondition.html","topicHref":"Hi.Physics.CoolantHeatCondition.html","topicUid":"Hi.Physics.CoolantHeatCondition","type":"Class"},{"name":"CutterMaterial","href":"Hi.Physics.CutterMaterial.html","topicHref":"Hi.Physics.CutterMaterial.html","topicUid":"Hi.Physics.CutterMaterial","type":"Class"},{"name":"IGetThermalLayerList","href":"Hi.Physics.IGetThermalLayerList.html","topicHref":"Hi.Physics.IGetThermalLayerList.html","topicUid":"Hi.Physics.IGetThermalLayerList","type":"Interface"},{"name":"IStructureMaterial","href":"Hi.Physics.IStructureMaterial.html","topicHref":"Hi.Physics.IStructureMaterial.html","topicUid":"Hi.Physics.IStructureMaterial","type":"Interface"},{"name":"ISuccessivePhysicsBriefAccessor","href":"Hi.Physics.ISuccessivePhysicsBriefAccessor.html","topicHref":"Hi.Physics.ISuccessivePhysicsBriefAccessor.html","topicUid":"Hi.Physics.ISuccessivePhysicsBriefAccessor","type":"Interface"},{"name":"ISurfaceMaterial","href":"Hi.Physics.ISurfaceMaterial.html","topicHref":"Hi.Physics.ISurfaceMaterial.html","topicUid":"Hi.Physics.ISurfaceMaterial","type":"Interface"},{"name":"ITimeGetter","href":"Hi.Physics.ITimeGetter.html","topicHref":"Hi.Physics.ITimeGetter.html","topicUid":"Hi.Physics.ITimeGetter","type":"Interface"},{"name":"MillingTemperatureUtil","href":"Hi.Physics.MillingTemperatureUtil.html","topicHref":"Hi.Physics.MillingTemperatureUtil.html","topicUid":"Hi.Physics.MillingTemperatureUtil","type":"Class"},{"name":"SeqPhysicsBrief","href":"Hi.Physics.SeqPhysicsBrief.html","topicHref":"Hi.Physics.SeqPhysicsBrief.html","topicUid":"Hi.Physics.SeqPhysicsBrief","type":"Class"},{"name":"StructureMaterial","href":"Hi.Physics.StructureMaterial.html","topicHref":"Hi.Physics.StructureMaterial.html","topicUid":"Hi.Physics.StructureMaterial","type":"Class"},{"name":"TemperatureUtil","href":"Hi.Physics.TemperatureUtil.html","topicHref":"Hi.Physics.TemperatureUtil.html","topicUid":"Hi.Physics.TemperatureUtil","type":"Class"},{"name":"TemperatureVsHardness","href":"Hi.Physics.TemperatureVsHardness.html","topicHref":"Hi.Physics.TemperatureVsHardness.html","topicUid":"Hi.Physics.TemperatureVsHardness","type":"Class"},{"name":"ThermalLayer1D","href":"Hi.Physics.ThermalLayer1D.html","topicHref":"Hi.Physics.ThermalLayer1D.html","topicUid":"Hi.Physics.ThermalLayer1D","type":"Class"},{"name":"TimeSeriesUtil","href":"Hi.Physics.TimeSeriesUtil.html","topicHref":"Hi.Physics.TimeSeriesUtil.html","topicUid":"Hi.Physics.TimeSeriesUtil","type":"Class"},{"name":"TimeValue","href":"Hi.Physics.TimeValue.html","topicHref":"Hi.Physics.TimeValue.html","topicUid":"Hi.Physics.TimeValue","type":"Class"},{"name":"WorkpieceMaterial","href":"Hi.Physics.WorkpieceMaterial.html","topicHref":"Hi.Physics.WorkpieceMaterial.html","topicUid":"Hi.Physics.WorkpieceMaterial","type":"Class"}]},{"name":"Hi.ScriptApiUtils","href":"Hi.ScriptApiUtils.html","topicHref":"Hi.ScriptApiUtils.html","topicUid":"Hi.ScriptApiUtils","type":"Namespace","items":[{"name":"ICsScriptApi","href":"Hi.ScriptApiUtils.ICsScriptApi.html","topicHref":"Hi.ScriptApiUtils.ICsScriptApi.html","topicUid":"Hi.ScriptApiUtils.ICsScriptApi","type":"Interface"},{"name":"JsAceAttribute","href":"Hi.ScriptApiUtils.JsAceAttribute.html","topicHref":"Hi.ScriptApiUtils.JsAceAttribute.html","topicUid":"Hi.ScriptApiUtils.JsAceAttribute","type":"Class"}]},{"name":"Hi.ShellCommands","href":"Hi.ShellCommands.html","topicHref":"Hi.ShellCommands.html","topicUid":"Hi.ShellCommands","type":"Namespace","items":[{"name":"EnablingWrapper","href":"Hi.ShellCommands.EnablingWrapper.html","topicHref":"Hi.ShellCommands.EnablingWrapper.html","topicUid":"Hi.ShellCommands.EnablingWrapper","type":"Class"},{"name":"GeomDiffCommand","href":"Hi.ShellCommands.GeomDiffCommand.html","topicHref":"Hi.ShellCommands.GeomDiffCommand.html","topicUid":"Hi.ShellCommands.GeomDiffCommand","type":"Class"},{"name":"IShellCommand","href":"Hi.ShellCommands.IShellCommand.html","topicHref":"Hi.ShellCommands.IShellCommand.html","topicUid":"Hi.ShellCommands.IShellCommand","type":"Interface"},{"name":"ITitleCommand","href":"Hi.ShellCommands.ITitleCommand.html","topicHref":"Hi.ShellCommands.ITitleCommand.html","topicUid":"Hi.ShellCommands.ITitleCommand","type":"Interface"},{"name":"Lang","href":"Hi.ShellCommands.Lang.html","topicHref":"Hi.ShellCommands.Lang.html","topicUid":"Hi.ShellCommands.Lang","type":"Class"},{"name":"ListCommand","href":"Hi.ShellCommands.ListCommand.html","topicHref":"Hi.ShellCommands.ListCommand.html","topicUid":"Hi.ShellCommands.ListCommand","type":"Class"},{"name":"MachiningMotionResolutionCommand","href":"Hi.ShellCommands.MachiningMotionResolutionCommand.html","topicHref":"Hi.ShellCommands.MachiningMotionResolutionCommand.html","topicUid":"Hi.ShellCommands.MachiningMotionResolutionCommand","type":"Class"},{"name":"NcCodeCommand","href":"Hi.ShellCommands.NcCodeCommand.html","topicHref":"Hi.ShellCommands.NcCodeCommand.html","topicUid":"Hi.ShellCommands.NcCodeCommand","type":"Class"},{"name":"NcFileCommand","href":"Hi.ShellCommands.NcFileCommand.html","topicHref":"Hi.ShellCommands.NcFileCommand.html","topicUid":"Hi.ShellCommands.NcFileCommand","type":"Class"},{"name":"NcFileListCommand","href":"Hi.ShellCommands.NcFileListCommand.html","topicHref":"Hi.ShellCommands.NcFileListCommand.html","topicUid":"Hi.ShellCommands.NcFileListCommand","type":"Class"},{"name":"NcOptOptionCommand","href":"Hi.ShellCommands.NcOptOptionCommand.html","topicHref":"Hi.ShellCommands.NcOptOptionCommand.html","topicUid":"Hi.ShellCommands.NcOptOptionCommand","type":"Class"},{"name":"OptimizeToFilesCommand","href":"Hi.ShellCommands.OptimizeToFilesCommand.html","topicHref":"Hi.ShellCommands.OptimizeToFilesCommand.html","topicUid":"Hi.ShellCommands.OptimizeToFilesCommand","type":"Class"},{"name":"PostExecutionCommand","href":"Hi.ShellCommands.PostExecutionCommand.html","topicHref":"Hi.ShellCommands.PostExecutionCommand.html","topicUid":"Hi.ShellCommands.PostExecutionCommand","type":"Class"},{"name":"PreSettingCommand","href":"Hi.ShellCommands.PreSettingCommand.html","topicHref":"Hi.ShellCommands.PreSettingCommand.html","topicUid":"Hi.ShellCommands.PreSettingCommand","type":"Class"},{"name":"RecordRuntimeGeomActionEnum","href":"Hi.ShellCommands.RecordRuntimeGeomActionEnum.html","topicHref":"Hi.ShellCommands.RecordRuntimeGeomActionEnum.html","topicUid":"Hi.ShellCommands.RecordRuntimeGeomActionEnum","type":"Enum"},{"name":"RecordRuntimeGeomCommand","href":"Hi.ShellCommands.RecordRuntimeGeomCommand.html","topicHref":"Hi.ShellCommands.RecordRuntimeGeomCommand.html","topicUid":"Hi.ShellCommands.RecordRuntimeGeomCommand","type":"Class"},{"name":"ScriptCommand","href":"Hi.ShellCommands.ScriptCommand.html","topicHref":"Hi.ShellCommands.ScriptCommand.html","topicUid":"Hi.ShellCommands.ScriptCommand","type":"Class"},{"name":"SimpleSessionCommand","href":"Hi.ShellCommands.SimpleSessionCommand.html","topicHref":"Hi.ShellCommands.SimpleSessionCommand.html","topicUid":"Hi.ShellCommands.SimpleSessionCommand","type":"Class"},{"name":"WriteRuntimeGeomToStlCommand","href":"Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html","topicHref":"Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html","topicUid":"Hi.ShellCommands.WriteRuntimeGeomToStlCommand","type":"Class"},{"name":"WriteShotFilesCommand","href":"Hi.ShellCommands.WriteShotFilesCommand.html","topicHref":"Hi.ShellCommands.WriteShotFilesCommand.html","topicUid":"Hi.ShellCommands.WriteShotFilesCommand","type":"Class"},{"name":"WriteStepFilesCommand","href":"Hi.ShellCommands.WriteStepFilesCommand.html","topicHref":"Hi.ShellCommands.WriteStepFilesCommand.html","topicUid":"Hi.ShellCommands.WriteStepFilesCommand","type":"Class"}]},{"name":"Hi.Test","href":"Hi.Test.html","topicHref":"Hi.Test.html","topicUid":"Hi.Test","type":"Namespace","items":[{"name":"TestCollision","href":"Hi.Test.TestCollision.html","topicHref":"Hi.Test.TestCollision.html","topicUid":"Hi.Test.TestCollision","type":"Class"}]},{"name":"Hi.UiExtensions","href":"Hi.UiExtensions.html","topicHref":"Hi.UiExtensions.html","topicUid":"Hi.UiExtensions","type":"Namespace","items":[{"name":"ChartBoundary","href":"Hi.UiExtensions.ChartBoundary.html","topicHref":"Hi.UiExtensions.ChartBoundary.html","topicUid":"Hi.UiExtensions.ChartBoundary","type":"Class"},{"name":"ChartBoundaryEnum","href":"Hi.UiExtensions.ChartBoundaryEnum.html","topicHref":"Hi.UiExtensions.ChartBoundaryEnum.html","topicUid":"Hi.UiExtensions.ChartBoundaryEnum","type":"Enum"},{"name":"NativeVisibility","href":"Hi.UiExtensions.NativeVisibility.html","topicHref":"Hi.UiExtensions.NativeVisibility.html","topicUid":"Hi.UiExtensions.NativeVisibility","type":"Enum"},{"name":"UiUtil","href":"Hi.UiExtensions.UiUtil.html","topicHref":"Hi.UiExtensions.UiUtil.html","topicUid":"Hi.UiExtensions.UiUtil","type":"Class"},{"name":"UiUtil.InvokeFunc","href":"Hi.UiExtensions.UiUtil.InvokeFunc.html","topicHref":"Hi.UiExtensions.UiUtil.InvokeFunc.html","topicUid":"Hi.UiExtensions.UiUtil.InvokeFunc","type":"Delegate"}]},{"name":"Hi.UniversalNc","href":"Hi.UniversalNc.html","topicHref":"Hi.UniversalNc.html","topicUid":"Hi.UniversalNc","type":"Namespace","items":[{"name":"Lang","href":"Hi.UniversalNc.Lang.html","topicHref":"Hi.UniversalNc.Lang.html","topicUid":"Hi.UniversalNc.Lang","type":"Class"},{"name":"UniversalNcStep","href":"Hi.UniversalNc.UniversalNcStep.html","topicHref":"Hi.UniversalNc.UniversalNcStep.html","topicUid":"Hi.UniversalNc.UniversalNcStep","type":"Class"}]},{"name":"Hi.Vibrations","href":"Hi.Vibrations.html","topicHref":"Hi.Vibrations.html","topicUid":"Hi.Vibrations","type":"Namespace","items":[{"name":"AngularVelocityUtil","href":"Hi.Vibrations.AngularVelocityUtil.html","topicHref":"Hi.Vibrations.AngularVelocityUtil.html","topicUid":"Hi.Vibrations.AngularVelocityUtil","type":"Class"},{"name":"ForceAccelAmpPhase","href":"Hi.Vibrations.ForceAccelAmpPhase.html","topicHref":"Hi.Vibrations.ForceAccelAmpPhase.html","topicUid":"Hi.Vibrations.ForceAccelAmpPhase","type":"Class"},{"name":"ForceAccelFourierSeries","href":"Hi.Vibrations.ForceAccelFourierSeries.html","topicHref":"Hi.Vibrations.ForceAccelFourierSeries.html","topicUid":"Hi.Vibrations.ForceAccelFourierSeries","type":"Class"},{"name":"ForceAccelShot","href":"Hi.Vibrations.ForceAccelShot.html","topicHref":"Hi.Vibrations.ForceAccelShot.html","topicUid":"Hi.Vibrations.ForceAccelShot","type":"Class"},{"name":"ForceAccelUtil","href":"Hi.Vibrations.ForceAccelUtil.html","topicHref":"Hi.Vibrations.ForceAccelUtil.html","topicUid":"Hi.Vibrations.ForceAccelUtil","type":"Class"},{"name":"IAngularVelocityOwner","href":"Hi.Vibrations.IAngularVelocityOwner.html","topicHref":"Hi.Vibrations.IAngularVelocityOwner.html","topicUid":"Hi.Vibrations.IAngularVelocityOwner","type":"Interface"},{"name":"VibrationUtil","href":"Hi.Vibrations.VibrationUtil.html","topicHref":"Hi.Vibrations.VibrationUtil.html","topicUid":"Hi.Vibrations.VibrationUtil","type":"Class"},{"name":"WAmpPhase","href":"Hi.Vibrations.WAmpPhase.html","topicHref":"Hi.Vibrations.WAmpPhase.html","topicUid":"Hi.Vibrations.WAmpPhase","type":"Class"},{"name":"WAmpPhaseXyzTransformation","href":"Hi.Vibrations.WAmpPhaseXyzTransformation.html","topicHref":"Hi.Vibrations.WAmpPhaseXyzTransformation.html","topicUid":"Hi.Vibrations.WAmpPhaseXyzTransformation","type":"Class"}]},{"name":"Hi.Webapi.Hubs","href":"Hi.Webapi.Hubs.html","topicHref":"Hi.Webapi.Hubs.html","topicUid":"Hi.Webapi.Hubs","type":"Namespace","items":[{"name":"RenderingHub","href":"Hi.Webapi.Hubs.RenderingHub.html","topicHref":"Hi.Webapi.Hubs.RenderingHub.html","topicUid":"Hi.Webapi.Hubs.RenderingHub","type":"Class"}]},{"name":"Hi.Webapi.Services","href":"Hi.Webapi.Services.html","topicHref":"Hi.Webapi.Services.html","topicUid":"Hi.Webapi.Services","type":"Namespace","items":[{"name":"RenderingService","href":"Hi.Webapi.Services.RenderingService.html","topicHref":"Hi.Webapi.Services.RenderingService.html","topicUid":"Hi.Webapi.Services.RenderingService","type":"Class"}]},{"name":"Hi.WinForm.Disp","href":"Hi.WinForm.Disp.html","topicHref":"Hi.WinForm.Disp.html","topicUid":"Hi.WinForm.Disp","type":"Namespace","items":[{"name":"RenderingCanvas","href":"Hi.WinForm.Disp.RenderingCanvas.html","topicHref":"Hi.WinForm.Disp.RenderingCanvas.html","topicUid":"Hi.WinForm.Disp.RenderingCanvas","type":"Class"},{"name":"RenderingForm","href":"Hi.WinForm.Disp.RenderingForm.html","topicHref":"Hi.WinForm.Disp.RenderingForm.html","topicUid":"Hi.WinForm.Disp.RenderingForm","type":"Class"}]},{"name":"Hi.Wpf.Disp","href":"Hi.Wpf.Disp.html","topicHref":"Hi.Wpf.Disp.html","topicUid":"Hi.Wpf.Disp","type":"Namespace","items":[{"name":"RenderingCanvas","href":"Hi.Wpf.Disp.RenderingCanvas.html","topicHref":"Hi.Wpf.Disp.RenderingCanvas.html","topicUid":"Hi.Wpf.Disp.RenderingCanvas","type":"Class"},{"name":"RenderingWindow","href":"Hi.Wpf.Disp.RenderingWindow.html","topicHref":"Hi.Wpf.Disp.RenderingWindow.html","topicUid":"Hi.Wpf.Disp.RenderingWindow","type":"Class"}]},{"name":"HiMachining.Milling","href":"HiMachining.Milling.html","topicHref":"HiMachining.Milling.html","topicUid":"HiMachining.Milling","type":"Namespace","items":[{"name":"ClMillingDevice","href":"HiMachining.Milling.ClMillingDevice.html","topicHref":"HiMachining.Milling.ClMillingDevice.html","topicUid":"HiMachining.Milling.ClMillingDevice","type":"Class"}]},{"name":"HiNc.Grpcs","href":"HiNc.Grpcs.html","topicHref":"HiNc.Grpcs.html","topicUid":"HiNc.Grpcs","type":"Namespace","items":[{"name":"MachiningProjectGrpcServer","href":"HiNc.Grpcs.MachiningProjectGrpcServer.html","topicHref":"HiNc.Grpcs.MachiningProjectGrpcServer.html","topicUid":"HiNc.Grpcs.MachiningProjectGrpcServer","type":"Class"}]},{"name":"numerical","href":"numerical.html","topicHref":"numerical.html","topicUid":"numerical","type":"Namespace","items":[{"name":"Empty","href":"numerical.Empty.html","topicHref":"numerical.Empty.html","topicUid":"numerical.Empty","type":"Class"},{"name":"GrpcCsvRowDictionary","href":"numerical.GrpcCsvRowDictionary.html","topicHref":"numerical.GrpcCsvRowDictionary.html","topicUid":"numerical.GrpcCsvRowDictionary","type":"Class"},{"name":"GrpcNcStep","href":"numerical.GrpcNcStep.html","topicHref":"numerical.GrpcNcStep.html","topicUid":"numerical.GrpcNcStep","type":"Class"},{"name":"NumericalReflection","href":"numerical.NumericalReflection.html","topicHref":"numerical.NumericalReflection.html","topicUid":"numerical.NumericalReflection","type":"Class"},{"name":"NumericalService","href":"numerical.NumericalService.html","topicHref":"numerical.NumericalService.html","topicUid":"numerical.NumericalService","type":"Class"},{"name":"NumericalService.NumericalServiceBase","href":"numerical.NumericalService.NumericalServiceBase.html","topicHref":"numerical.NumericalService.NumericalServiceBase.html","topicUid":"numerical.NumericalService.NumericalServiceBase","type":"Class"},{"name":"NumericalService.NumericalServiceClient","href":"numerical.NumericalService.NumericalServiceClient.html","topicHref":"numerical.NumericalService.NumericalServiceClient.html","topicUid":"numerical.NumericalService.NumericalServiceClient","type":"Class"},{"name":"UniversalNcReflection","href":"numerical.UniversalNcReflection.html","topicHref":"numerical.UniversalNcReflection.html","topicUid":"numerical.UniversalNcReflection","type":"Class"},{"name":"UniversalNcService","href":"numerical.UniversalNcService.html","topicHref":"numerical.UniversalNcService.html","topicUid":"numerical.UniversalNcService","type":"Class"},{"name":"UniversalNcService.UniversalNcServiceBase","href":"numerical.UniversalNcService.UniversalNcServiceBase.html","topicHref":"numerical.UniversalNcService.UniversalNcServiceBase.html","topicUid":"numerical.UniversalNcService.UniversalNcServiceBase","type":"Class"},{"name":"UniversalNcService.UniversalNcServiceClient","href":"numerical.UniversalNcService.UniversalNcServiceClient.html","topicHref":"numerical.UniversalNcService.UniversalNcServiceClient.html","topicUid":"numerical.UniversalNcService.UniversalNcServiceClient","type":"Class"}]}],"memberLayout":"SamePage"} diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/common/xml-io.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/common/xml-io.html new file mode 100644 index 00000000..4179ab15 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/common/xml-io.html @@ -0,0 +1,334 @@ + + + + + About XML IO | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    +

    About XML IO

    + +

    The XML IO design pattern in Hi Framework is based on IMakeXmlSource interface and XFactory class. This pattern provides a standardized way to serialize and deserialize objects to and from XML format.

    +

    Don't serialize the runtime member object like Func<TResult> or Action 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.

    +

    Core Components

    +

    IMakeXmlSource Interface

    +

    The IMakeXmlSource interface defines the contract for objects that can be serialized to XML format. It contains a single method MakeXmlSource.

    +

    XFactory Registration

    +

    Every class implementing IMakeXmlSource must:

    +
      +
    1. Define a static XName property matching the class name
      2. +
    2. Register itself in the static constructor using XFactory.Regs.Add
      3. +
    3. Implement XML serialization and deserialization logic
      4. +
    +

    For example, see BallApt:

    +
    static BallApt()
+{
+    // Register to the <see cref="XFactory.Default"/>.
+    XFactory.Regs.Add(XName, (xml,baseDirectory,relFile, res) => new BallApt(xml));
+}
+

    Implementation Patterns

    +

    Simple Value Objects

    +

    See BallApt implementation:

    +
    /// <summary>
+/// Name for XML IO.
+/// </summary>
+public static string XName => nameof(BallApt);
+/// <summary>
+/// Ctor.
+/// </summary>
+/// <param name="src">XML</param>
+public BallApt(XElement src)
+{
+    Diameter_mm = double.Parse(src.Element("D").Value);
+    FluteHeight_mm = double.Parse(src.Element("FluteH").Value);
+}
+/// <inheritdoc/>
+public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly) => ToXElement();
+
+/// <inheritdoc/>
+public XElement ToXElement()
+{
+    return new XElement(XName,
+        new XElement("D", Diameter_mm),
+        new XElement("FluteH", FluteHeight_mm)
+        );
+}
+

    Complex Data Structures

    +

    See SpindleCapability implementation:

    +
    /// <summary>
+/// Name for XML IO.
+/// </summary>
+public static string XName => nameof(SpindleCapability);
+/// <summary>
+/// Initializes a new instance of the <see cref="SpindleCapability"/> class.
+/// </summary>
+/// <param name="src">The XML element containing spindle data.</param>
+/// <param name="baseDirectory">The base directory for resolving relative paths.</param>
+/// <param name="res">Additional resolution parameters.</param>
+public SpindleCapability(XElement src, string baseDirectory, params object[] res)
+{
+    this.SetNameNote(src);
+    if (src.Element(nameof(EnergyEfficiency)) != null)
+        EnergyEfficiency = XmlConvert.ToDouble(
+            src.Element(nameof(EnergyEfficiency)).Value);
+    src.Element(nameof(WorkingTemperatureUpperBoundary_C))?.SelfInvoke(
+        e => WorkingTemperatureUpperBoundary_C = XmlConvert.ToDouble(e.Value));
+    src.Element(nameof(GearShiftSpindleSpeed_rpm))?.Value?.SelfInvoke(
+        s => GearShiftSpindleSpeed_rpm = string.IsNullOrEmpty(s)
+            ? null : XmlConvert.ToDouble(s));
+    if (src.Element(nameof(DryRunFrictionPowerCoefficient_mWdrpm)) != null)
+        DryRunFrictionPowerCoefficient_mWdrpm = XmlConvert.ToDouble(
+            src.Element(nameof(DryRunFrictionPowerCoefficient_mWdrpm)).Value);
+    if (src.Element(nameof(DryRunWindagePowerCoefficient_pWdrpm3)) != null)
+        DryRunWindagePowerCoefficient_pWdrpm3 = XmlConvert.ToDouble(
+            src.Element(nameof(DryRunWindagePowerCoefficient_pWdrpm3)).Value);
+
+    if (src.Element("SpindleSpeedToPowerContours") != null) //for legacy
+        WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW =
+            src.Element("SpindleSpeedToPowerContours").Elements("Contour")
+            .ToDictionary(
+                contourElem =>
+                {
+                    double r = XmlConvert.ToDouble(contourElem.Attribute("InsistentRatio")?.Value);
+                    //600s=10mins
+                    return r ==1?double.PositiveInfinity:(r * 600);
+                },
+                contourElem => contourElem.Elements("SpindleSpeedToPower").Select(
+                    elem => new Vec2d(
+                        XmlConvert.ToDouble(elem.Element("SpindleSpeed-RPM").Value) / 60,
+                        XmlConvert.ToDouble(elem.Element("Power-kW").Value)))
+                .ToList());
+    src.Element("WorkableDurationToSpindleSpeedPowerContoursDictionary")
+        ?.SelfInvoke(dicElem =>
+        {
+            WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW
+            = dicElem.Elements("Contour")
+            .ToDictionary(
+                contourElem => XmlConvert.ToDouble(
+                    contourElem.Attribute("WorkableDuration-min")?.Value),
+                contourElem => contourElem.Elements("SpindleSpeedToPower").Select(
+                    elem => new Vec2d(
+                        XmlConvert.ToDouble(elem.Element("SpindleSpeed-RPM").Value) / 60,
+                        XmlConvert.ToDouble(elem.Element("Power-kW").Value)))
+                .ToList());
+        });
+
+    if (src.Element("SpindleSpeedToTorqueContours") != null) //for legacy
+        WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm =
+            src.Element("SpindleSpeedToTorqueContours").Elements("Contour")
+            .ToDictionary(
+                contourElem =>
+                {
+                    double r = XmlConvert.ToDouble(contourElem.Attribute("InsistentRatio")?.Value);
+                    //600s=10mins
+                    return r == 1 ? double.PositiveInfinity : (r * 600);
+                },
+                contourElem => contourElem.Elements("SpindleSpeedToTorque").Select(
+                    elem => new Vec2d(
+                        XmlConvert.ToDouble(elem.Element("SpindleSpeed-RPM").Value) / 60,
+                        XmlConvert.ToDouble(elem.Element("Torque-Nm").Value)))
+                .ToList());
+    src.Element("WorkableDurationToSpindleSpeedTorqueContoursDictionary")
+        ?.SelfInvoke(dicElem =>
+        {
+            //MessageUtil.WriteLine($"dicElem: {dicElem}");
+            WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm =
+            dicElem.Elements("Contour").ToDictionary(
+                contourElem => XmlConvert.ToDouble(
+                    contourElem.Attribute("WorkableDuration-min")?.Value),
+                contourElem => contourElem.Elements("SpindleSpeedToTorque").Select(
+                    elem => new Vec2d(
+                        XmlConvert.ToDouble(elem.Element("SpindleSpeed-RPM").Value) / 60,
+                        XmlConvert.ToDouble(elem.Element("Torque-Nm").Value)))
+                .ToList());
+            //MessageUtil.WriteLine($"keys: {string.Join(',',WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm.Select(e=>e.Key))}");
+        });
+
+    //for legacy compatible.
+    if (src.Element("SpindleSpeedToPower--RPM-to-kW") != null)
+        InfInsistentSpindleSpeedToPower_cycleDs_kW =
+            src.Element("SpindleSpeedToPower--RPM-to-kW").Elements()
+            .Select(elem => new Vec2d(XmlConvert.ToDouble(elem.Attribute(
+                "SpindleSpeed-RPM").Value) / 60,
+                XmlConvert.ToDouble(elem.Value))).ToList();
+    //for legacy compatible.
+    if (src.Element("SpindleSpeedToTorque--RPM-to-Nm") != null)
+        InfInsistentSpindleSpeedToTorque_cycleDs_Nm =
+            src.Element("SpindleSpeedToTorque--RPM-to-Nm").Elements()
+            .Select(elem => new Vec2d(XmlConvert.ToDouble(elem.Attribute(
+                "SpindleSpeed-RPM").Value) / 60,
+                XmlConvert.ToDouble(elem.Value))).ToList();
+}
+/// <inheritdoc/>
+public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)
+{
+    return new XElement(XName,
+        this.GetNameNoteXElementList(),
+        new XElement(nameof(EnergyEfficiency), EnergyEfficiency),
+        new XElement(nameof(GearShiftSpindleSpeed_rpm), GearShiftSpindleSpeed_rpm),
+        new XElement(nameof(DryRunFrictionPowerCoefficient_mWdrpm),
+            DryRunFrictionPowerCoefficient_mWdrpm),
+        new XElement(nameof(DryRunWindagePowerCoefficient_pWdrpm3),
+            DryRunWindagePowerCoefficient_pWdrpm3),
+        new XElement("WorkableDurationToSpindleSpeedPowerContoursDictionary",
+            WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW.OrderBy(entry => entry.Key)
+            .Select(entry => new XElement("Contour",
+                new XAttribute("WorkableDuration-min", entry.Key),
+                entry.Value.Select(entry
+                => new XElement("SpindleSpeedToPower",
+                new XElement("SpindleSpeed-RPM", entry.X * 60),
+                new XElement("Power-kW", entry.Y)))))
+            ),
+        new XElement("WorkableDurationToSpindleSpeedTorqueContoursDictionary",
+            WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm.OrderBy(entry => entry.Key)
+            .Select(entry => new XElement("Contour",
+                new XAttribute("WorkableDuration-min", entry.Key),
+                entry.Value.Select(entry
+                => new XElement("SpindleSpeedToTorque",
+                new XElement("SpindleSpeed-RPM", entry.X * 60),
+                new XElement("Torque-Nm", entry.Y)))))
+            )
+        );
+}
+

    Best Practices

    +
      +
    1. XName: Always define static XName property matching the class name
      2. +
    2. Registration: Register in static constructor using XFactory.Regs.Add
      3. +
    3. Error Handling: Use appropriate GenMode
      4. +
    4. Legacy Support: Maintain backward compatibility when needed
      5. +
    5. Documentation: Include XML comments for properties and methods
      6. +
    +

    Generation Modes

    +

    The GenMode enumeration provides:

    + +

    Common Usage Patterns

    +
      +
    1. Simple Object Generation:
      2. +
    +
    var obj = XFactory.Gen<MyType>(xmlElement, baseDir, null, GenMode.Default);
+
    +
      +
    1. File-Based Generation:
      2. +
    +
    var obj = XFactory.GenByFile<MyType>(baseDir, relativeFile, GenMode.Default);
+
    +
      +
    1. XML Source and File Generation:
      2. +
    +
    var xmlSourceAndFile = XFactory.GenXmlSourceAndFile<MyType>(xmlElement, baseDir, null, GenMode.Default);
+
    +
      +
    1. Hierarchical Object Generation:
      2. +
    +
    var childObj = XFactory.GenByChild<IStructureMaterial>(parentElement, baseDir, null, GenMode.Default);
+
    + +
    + +
    +
    + + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/geom/basic-geometry.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/geom/basic-geometry.html new file mode 100644 index 00000000..d523a9e1 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/geom/basic-geometry.html @@ -0,0 +1,186 @@ + + + + + Geometry Objects | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    +
    +
    Table of Contents
    + +
    +
    + +
    +
    +
    + +
    +
    + + + +
    + +
    +

    Geometry Objects

    + +

    IGetStl is the base interface for all geometry objects in HiAPI, providing unified STL support.

    +

    Several common geometry types are available:

    + +

    See Transformations for TransformationGeom.

    + +
    +
    Note
    +

    All coordinate values use standard units (millimeters, radians)

    +
    +

    Example Usage

    +
    using System;
+using System.Collections.Generic;
+using Hi.Geom;
+using Hi.Mech.Topo;
+
+namespace Sample.Geom
+{
+    /// <summary>
+    /// Demonstrates the creation and manipulation of geometric objects in HiAPI.
+    /// Shows how to create and transform various geometry types including boxes, cylindroids, and STL files.
+    /// </summary>
+    /// <remarks>
+    /// ### Source Code
+    /// [!code-csharp[SampleCode](~/../Hi.Sample/Geom/DemoBuildGeom.cs)]
+    /// </remarks>
+    public static class DemoBuildGeom
+    {
+        /// <summary>
+        /// Generates a collection of geometric objects for demonstration purposes.
+        /// Creates various geometry types including boxes, cylindroids, STL files, and transformed geometries.
+        /// </summary>
+        /// <returns>A list of geometries implementing the IGetStl interface</returns>
+        public static List<IGetStl> GenGeoms()
+        {
+            Box3d box = new Box3d(0, 0, -50, 70, 50, 0);
+            Cylindroid cylindroid = new Cylindroid([ new PairZr(0,12),new PairZr(20,12),
+                                new PairZr(20,16),new PairZr(30,16)]);
+            Stl stl = new Stl("geom.stl");
+            StlFile stlFile = new StlFile("geom.stl");
+            TransformationGeom transformationGeom = new TransformationGeom()
+            {
+                Transformer = new GeneralTransform(1,
+                    new StaticRotation(new Vec3d(0, 0, 1), MathUtil.ToRad(15), new Vec3d(0, 0, 0)),
+                    new StaticTranslation(new Vec3d(0, 0, 0))),
+                Geom = stl
+            };
+            GeomCombination geomCombination = new GeomCombination(stlFile, transformationGeom);
+            return new List<IGetStl>([box, cylindroid, stl, stlFile, transformationGeom]);
+        }
+    }
+
+}
+
    +
    + +
    +
    + + + +
    + +
    + +
    +
    + +
    + + + + diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/chain.png b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/chain.png similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/chain.png rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/chain.png diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/chainLink.png b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/chainLink.png similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/chainLink.png rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/chainLink.png diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/index.html similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/index.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/index.html diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/vmt.png b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/vmt.png similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/Topo/vmt.png rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/Topo/vmt.png diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/index.html similarity index 98% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/index.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/index.html index 175779a5..cbdbdd7f 100644 --- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/index.html +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/index.html @@ -101,6 +101,7 @@
    • Topology - Kinematic topology structure, including assembly management and chain definition
    • Transformers - Coordinate transformation and motion transformation
      • +
    • Render Topology - Rendering with topology structure and anchored display

    API References

      diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/render-topology/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/render-topology/index.html new file mode 100644 index 00000000..533d7bf8 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/render-topology/index.html @@ -0,0 +1,207 @@ + + + + + Render Topology | HiAPI-C# 2025 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + +
      +
      +
      +
      +
      Table of Contents
      + +
      +
      + +
      +
      +
      + +
      +
      + + + +
      + +
      +

      Render Topology

      + +

      Read Kinematic Topology Rendering for the prerequisite.

      +

      A Asmb is a group to render its descendent Anchors.

      +

      Several ways to render with the topology:

      +
        +
      • Render by Anchoring Matrix Map
        • +
      • Render by Anchored Displayee
        • +
      +

      Render by Anchoring Matrix Map

      +

      Render by Anchored Displayee

      +

      Inherit IAnchoredDisplayee or apply AnchoredDisplayee to Asmb.Display().

      +

      Inherit ITopoDisplayee to manage the object with Asmb and plural anchors .

      +

      The base logic is also by the anchoring matrix. Here is some class and function wrapping the logic.

      +

      The sample code shows the topology rendering for a MillingTool editing helper:

      +
      using Hi.Common;
+using Hi.Common.Messages;
+using Hi.Disp;
+using Hi.Disp.Flag;
+using Hi.Geom;
+using Hi.Mech.Topo;
+using Hi.Milling.Cutters;
+using Hi.NcMech.Holders;
+using System;
+using System.Collections.Generic;
+
+namespace Hi.Milling.MillingTools
+{
+    public class MillingToolEditorDisplayee : ITopoDisplayee, IClearCache
+    {
+        public Func<MillingTool> MillingToolGetter { get; set; }
+        public MillingTool MillingTool => MillingToolGetter?.Invoke();
+
+        public bool ShowCutter { get; set; } = true;
+        public bool ShowHolder { get; set; } = true;
+
+        public MillingCutterEditorDisplayee MillingCutterEditorDisplayee { get; }
+            = new MillingCutterEditorDisplayee();
+        public HolderEditorDisplayee HolderEditorDisplayee { get; }
+            = new HolderEditorDisplayee();
+        /// <inheritdoc/>
+        public List<IAnchoredDisplayee> GetAnchoredDisplayeeList()
+        {
+            var dst = new List<IAnchoredDisplayee>();
+
+            var millingTool = MillingTool;
+            if (millingTool == null)
+                return dst;
+
+            if (ShowCutter)
+            {
+                var cutter = millingTool.Cutter;
+                if (cutter is MillingCutter millingCutter)
+                {
+                    //MessageKit.AddMessage($"MillingTool.Cutter: {MillingTool?.Cutter?.GetHashCode()}");
+                    MillingCutterEditorDisplayee.MillingCutterSourceFunc
+                        = () => MillingTool?.Cutter as MillingCutter;
+                    dst.Add(MillingCutterEditorDisplayee);
+                }
+                else if(cutter!=null)
+                    dst.Add(cutter);
+            }
+            if (ShowHolder)
+            {
+                HolderEditorDisplayee.Holder = millingTool.Holder;
+                dst.Add(HolderEditorDisplayee);
+            }
+            return dst;
+        }
+        /// <inheritdoc/>
+        public void Display(Bind bind)
+        {
+            bind.PushCoveringPixelMode();
+            DimensionBar.Display(bind, "mm");
+            bind.ModelMatStack.Pop();
+
+            TopoDisplayeeUtil.Display(this, bind);
+        }
+        /// <inheritdoc/>
+        public void ExpandToBox3d(Box3d dst)
+        {
+            TopoDisplayeeUtil.ExpandToBox3d(this, dst);
+        }
+        /// <inheritdoc/>
+        public Asmb GetAsmb() => MillingTool?.Asmb;
+        /// <inheritdoc/>
+        public Anchor GetAnchor() => MillingTool?.GetAnchor();
+        /// <inheritdoc/>
+        public void ClearCache()
+        {
+            MillingCutterEditorDisplayee?.ClearCache();
+        }
+    }
+}
+
      +
      + +
      +
      + + + +
      + +
      + +
      +
      + +
      + + + + diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/transformers/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/transformers/index.html similarity index 98% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/transformers/index.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/transformers/index.html index 5d96ca39..cf33de13 100644 --- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/mechanism/transformers/index.html +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/mechanism/transformers/index.html @@ -96,6 +96,7 @@
    • StaticTranslation
    • StaticRotation
    • StaticFreeform
      • +
    • GeneralTransform
  • IDynamicTransformer diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/drawing/easydraw_lines.png b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/drawing/easydraw_lines.png similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/drawing/easydraw_lines.png rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/drawing/easydraw_lines.png diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/drawing/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/drawing/index.html similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/drawing/index.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/drawing/index.html diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/index.html similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/index.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/index.html diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/rendering-canvas/custom-implementation.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/custom-implementation.html similarity index 96% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/rendering-canvas/custom-implementation.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/custom-implementation.html index d6c90f8b..90ef1ca3 100644 --- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/rendering-canvas/custom-implementation.html +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/custom-implementation.html @@ -90,41 +90,12 @@

    This guide provides detailed implementation information for creating your own RenderingCanvas using the DispEngine. By understanding these implementation details, you can customize the rendering component for specific application needs or create implementations for other UI frameworks.

    Note
    -

    For Windows Applications: If you are developing for Windows systems, it is recommended to directly use the existing RenderingCanvas implementations in the Hi.WinForm or Hi.Wpf packages, rather than creating your own. These implementations are fully tested, optimized, and maintained.

    +

    For Windows Applications: If you are developing for Windows systems, it is recommended to directly use the existing RenderingCanvas implementations in the Hi.WinForm or Hi.Wpf packages, rather than creating your own. These implementations are fully tested, optimized, and maintained. +For Webapi Applications: Using Hi.Webapi.

    The implementation details provided in this document are primarily for educational purposes or for developers who need to port RenderingCanvas to other platforms/frameworks.

    Basic DispEngine Usage

    -

    The DispEngine is designed to display objects that implement the IDisplayee interface. This is the fundamental purpose of DispEngine - to render displayable objects.

    -

    IDisplayee Implementation

    -

    To create renderable content, implement the IDisplayee interface:

    -
    public class MyCustomDisplayee : IDisplayee
-{
-    public void Display(Bind bind)
-    {
-        // Drawing code using the bind object
-    }
-
-    public void ExpandToBox3d(Box3d box)
-    {
-        // Update bounding box for view calculations
-    }
-}
-
    -

    Using Displayees with DispEngine

    -

    There are multiple ways to provide displayees to a DispEngine:

    -
    // Create DispEngine with a single displayee
-var engine = new DispEngine(myDisplayee);
-
-// Create DispEngine with multiple displayees
-var engine = new DispEngine(displayee1, displayee2, displayee3);
-
-// Change the displayee after creation
-engine.Displayee = newDisplayee;
-
-// Use DispList to group multiple displayees
-var displayList = new DispList(displayee1, displayee2);
-engine.Displayee = displayList;
-
    +

    The DispEngine is designed to display objects that implement the IDisplayee interface. This is the fundamental purpose of DispEngine - to render displayable objects. Assign IDisplayee to DispEngine.Displayee.

    Core Implementation Pattern

    When implementing a custom RenderingCanvas for a UI platform, follow these key steps:

      @@ -480,24 +451,35 @@ public RenderingCanvas() // Enable touch support this.IsManipulationEnabled = true; + // Initialize power management + InitializePowerManagement(); + // Add the display pane to this control's content Content = DisplayerPane; }

      Rendering Pipeline

      -
      /// <summary>
+
      private byte[] PreImageBgra { get; set; }
+/// <summary>
 /// Handles the buffer swapped event from DispEngine
 /// </summary>
 private unsafe void RenderingCanvas_BufferSwapped(byte* data, int w, int h)
 {
     if (data == null)
         return;
-        
+
+    //since the treatment is different from Razor version, 
+    //the image checking mechanism cannot be set in DispEngine.
+    Span<byte> bgra = new Span<byte>(data, w * h * 4);
+    if (PreImageBgra != null && bgra.SequenceEqual(PreImageBgra))
+        return;
+    PreImageBgra = bgra.ToArray();
+
     // Copy pixel data from DispEngine
     int n = w * h * 4;
     byte[] arr = new byte[n];
     for (int i = 0; i < n; i++)
         arr[i] = data[i];
-        
+    
     // Update UI on the UI thread
     DisplayerPane.Dispatcher.InvokeAsync(() =>
     {
@@ -722,6 +704,9 @@ protected virtual void Dispose(bool disposing)
     {
         if (disposing)
         {
+            // Unsubscribe from power events
+            SystemEvents.PowerModeChanged -= SystemEvents_PowerModeChanged;
+            
             // Dispose the DispEngine to free resources
             DispEngine.Dispose();
         }
diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/rendering-canvas/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/index.html
similarity index 85%
rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/rendering-canvas/index.html
rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/index.html
index 3eb51a41..fb1d7ffa 100644
--- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/basic/rendering/rendering-canvas/index.html
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/index.html
@@ -93,21 +93,19 @@
 
        
 
      • Hi.WinForm for Windows Forms applications
        • 
 
      • Hi.Wpf for WPF applications
        • 
+
      • Hi.Webapi for Webapi applications
        • 
 
      
 
      All implementations share a common architecture centered around the DispEngine class, enabling consistent rendering and interaction across platforms.
      
 
      Core Concept: DispEngine and IDisplayee
      
 
      At the heart of the rendering system is the relationship between DispEngine and IDisplayee:
      
 
        
-
      • DispEngine: The rendering engine that manages the OpenGL context and handles user interaction
        • 
-
      • IDisplayee: The interface that defines objects that can be rendered by the DispEngine
        • 
+
      • DispEngine: The rendering engine that manages the OpenGL context and handles user interaction
        • 
+
      • IDisplayee: The interface that defines objects that can be rendered by the DispEngine
        • 
 
      
-
      This relationship is fundamental - the primary purpose of DispEngine is to render IDisplayee objects.
      
+
      This relationship is fundamental - the purpose of DispEngine is to render IDisplayee objects.
      
 
      graph TD
-    A[RenderingCanvas UI Component] --> B[DispEngine]
-    B --> C[Rendering Pipeline]
-    B --> D[Input Handling]
-    B --> E[View Manipulation]
-    F[IDisplayee Objects] -->|Rendered by| B
+    A[IDisplayee Objects] -->|Rendered by| B
+    B[DispEngine] <--> C[RenderingCanvas UI Component]
 
      
 
      Working with IDisplayee
      
 
      Objects implementing IDisplayee define what gets rendered. Typically, you'll use Drawing objects or compose multiple IDisplayee objects together:
      
@@ -142,19 +140,9 @@ public class MyCompositeDisplayee : IDisplayee
     }
 }
 
      
-
      Multiple displayees can be combined using DispList:
      
-
      // Combine multiple displayees
-var displayList = new DispList();
-displayList.Add(myModel);
-displayList.Add(myAnnotations);
-displayList.Add(myCoordinateSystem);
-
-// Pass to DispEngine
-engine.Displayee = displayList;
-
      
 
      For more detailed information on creating displayees with Drawing, see the Drawing section.
      
 
      Basic Usage
      
-
      WinForm Implementation
      
+
      Apply Hi.WinForm
      
 
      // Create a new instance with displayee objects
 using Hi.WinForm.Disp;
 
@@ -170,7 +158,7 @@ DispEngine engine = canvas.DispEngine;
 // Add to a form
 myForm.Controls.Add(canvas);
 
      
-
      WPF Implementation
      
+
      Apply Hi.WPF
      
 
      // Create a new instance
 using Hi.Wpf.Disp;
 
@@ -186,6 +174,8 @@ canvas.DispEngine.Displayee = displayee;
 // Add to a container
 myGrid.Children.Add(canvas);
 
      
+
      Apply Hi.Webapi
      
+
      See Using Rendering Canvas By Hi.Webapi.
      
 
      Switching Displayees at Runtime
      
 
      You can dynamically change what's being displayed:
      
 
      // Switch to a different displayee
@@ -199,34 +189,17 @@ renderingCanvas.DispEngine.Displayee = displayList;
 
      
 
      Key Features of DispEngine
      
 
      The DispEngine provides cross-platform support for:
      
-
        
-
      1. Rendering Pipeline Management
        
 
          
 
        • Handles buffer swapping and image generation
          • 
-
        • Manages GPU resources efficiently
          • 
-
        
-
        2. 
-
      2. Input Handling
        
-
          
-
        • Mouse/pointer events (move, click, drag)
          • 
+
        • Mouse/pointer events
          • 
 
        • Keyboard navigation
          • 
-
        • Touch gestures (pinch, rotate, pan)
          • 
-
        
-
        3. 
-
      3. View Manipulation
        
-
          
+
        • Touch gestures
          • 
+
        • Zoom, pan, and rotate operations
          • 
+
        • Resize and Visibility changed.
          • 
 
        • Camera positioning and orientation
          • 
 
        • Standard views (front, top, isometric, etc.)
          • 
-
        • Zoom, pan, and rotate operations
          • 
-
        
-
        4. 
-
      4. DisplayeeObjects Management
        
-
          
 
        • Renders IDisplayee implementations
          • 
-
        • Manages visibility and drawing state
          • 
 
        
-
        5. 
-
      
 
      Touch and Gesture Support
      
 
      The DispEngine centralizes touch handling across all platforms with a unified API that supports:
      
 
        
@@ -235,16 +208,6 @@ renderingCanvas.DispEngine.Displayee = displayList;
 
      • Multi-finger specialized operations
        • 
 
      
 
      The touch API is designed to be simple for UI implementations to use. Platform-specific UI components only need to capture touch events and forward them to the DispEngine.
      
-
      Basic Touch API Example
      
-
      // When a touch point is detected
-DispEngine.TouchDown(touchId, x, y);
-
-// When a touch point moves
-DispEngine.TouchMove(touchId, x, y);
-
-// When a touch point is released
-DispEngine.TouchUp(touchId);
-
      
 
      Common Operations
      
 
      // Accessing DispEngine (works on all platforms)
 var engine = renderingCanvas.DispEngine;
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/webapi-rendering-canvas.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/webapi-rendering-canvas.html
new file mode 100644
index 00000000..c48781d4
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/basic/rendering/rendering-canvas/webapi-rendering-canvas.html
@@ -0,0 +1,164 @@
+
+
+  
+    
+      Using Rendering Canvas By Hi.Webapi | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Using Rendering Canvas By Hi.Webapi
      
+
+
      Hi.Webapi git repo:
      
+
      The Rendering Canvas implementation is located on the Hi.Webapi project (SeeHiAPI Overview to get git repository):
      
+
        
+
      • wwwroot/disp/rendering-canvas.js
+
          
+
        • Pure js implementation.
          • 
+
        
+
        • 
+
      • wwwroot/disp/rendering-canvas-vue.js
+
          
+
        • vue implementation.
          • 
+
        
+
        • 
+
      • wwwroot/disp/rendering-canvas.css
        • 
+
      
+
      Usage Demonstration by Hi.Sample.Webapi Project
      
+
      The usage is illustrated by the sample code in Hi.Sample.Webapi project (SeeHiAPI Overview to get git repository).
      
+
      The project applies Hi.Webapi nuget package (SeeHiAPI Overview to get git repository).
      
+
      Following pathes are based on the Hi.Sample.Webapi project.
      
+
        
+
      • A sample GUI to controll the rendering view
+
          
+
        • wwwroot/disp/rendering-canvas-view-dropdown.js
          • 
+
        
+
        • 
+
      • Set Rendering Content (IDisplayee) to the Rendering Canvas
+
          
+
        • Controllers/RenderingController.cs
          • 
+
        
+
        • 
+
      
+
      Component Usage
      
+
        
+
      • wwwroot/demo.html
+
          
+
        • apply rendering-canvas.js from Hi.Webapi package.
          • 
+
        
+
        • 
+
      • wwwroot/demo-vue.html
+
          
+
        • apply rendering-canvas-vue.js from Hi.Webapi package.
          • 
+
        
+
        • 
+
      • wwwroot/demo-plain-inline.html
+
          
+
        • Hard code implementation without re-using js file.
          • 
+
        
+
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/controller/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/controller/index.html
new file mode 100644
index 00000000..dcbe6b25
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/controller/index.html
@@ -0,0 +1,310 @@
+
+
+  
+    
+      Controller Page | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Controller Page
      
+
+
      The Controller Page is responsible for configuring and managing the CNC controller settings for the machine tool.
      
+
      Key Models
      
+
      The key models used by the Controller Page are:
      
+
+
      The MachiningProjectDisplayee contains IsoCoordinateEntryDisplayee and HeidenhainCoordinateEntryDisplayee. They are used in this GUI.
      
+
      Connection with Main Panel
      
+
      The Controller Page is activated through the Main Panel's Environment menu. It retrieves the MachiningProject from the Main Panel and updates the model.
      
+
      Layout
      
+
+
      
+
      Tip
      
+
      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.
      
+
      Apply SetViewToIsometricView() on initialization if Viewer Panel has enabled.
      
+
      
+
      
+
      Tip
      
+
      Add a resizable splitter between the Manage Panel and Viewer Panel to allow users to customize the interface layout according to their needs.
      
+
      
+
      Behavior
      
+
      ISO Coordinate Table
      
+
      The ISO coordinate table allows users to edit and manage coordinates for the IsoCoordinateTable. Each entry consists of:
      
+
        
+
      • An index identifier
        • 
+
      • X, Y, Z coordinate values
        • 
+
      • Action buttons to set the entry to program zero or machine zero
        • 
+
      
+
      Datum Preset and Shift Tables (Heidenhain)
      
+
      These tables are specific to Heidenhain controllers and provide interfaces for:
      
+
+
      Offset Table
      
+
      Manages tool offsets with the following capabilities:
      
+
        
+
      • Display and edit ideal radius and height values in MillingToolOffsetTable
        • 
+
      • Configure radial and axial wear values
        • 
+
      • Option to automatically set ideal offset based on the MachiningToolHouse configuration
        • 
+
      • Add new tool offset entries (when not using tool house dependency)
        • 
+
      
+
      Machine Configuration
      
+
      Controls machine-specific settings:
      
+
+
      Brand Selection
      
+
      Allows switching between different CNC controller brands via CncBrand:
      
+
+
      Each brand may have specialized settings that appear when selected.
      
+
      Config Options
      
+
      General configuration options including:
      
+
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Numerical/Controller/ControllerWindow
        • 
+
      • Numerical/Controller/IsoCoordinateTablePanel
        • 
+
      • Numerical/Controller/DatumPresetTablePanel
        • 
+
      • Numerical/Controller/DatumShiftTablePanel
        • 
+
      • Numerical/Controller/ControllerExtendedRenderingCanvasToolBar
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/controller/controller-panel.js
        • 
+
      • wwwroot/controller/controller-extended-toolbar.js
        • 
+
      • Controller/Controller/ControllerController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/general-rules.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/general-rules.html
new file mode 100644
index 00000000..03c5bb9a
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/general-rules.html
@@ -0,0 +1,159 @@
+
+
+  
+    
+      General Rules | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      General Rules
      
+
+
      
+
      Tip
      
+
      You MUST read the cited hyperlink before you do the job. ASK if you think the hyperlink is not work.
      
+
      
+
      Handle Message and Exception
      
+
      If message is well-managed, apply MessageKit to show the message; if the message is Exception, apply ExceptionUtil.ShowException(Exception, object) to show the exception for detail treatment. The messages are shown in Message Section on Main Panel.
      
+
      For examples of message and exception handling patterns:
      
+
        
+
      1. Normal message handling:
        2. 
+
      
+
      MessageKit.AddMessage("Operation completed successfully.");
+MessageKit.AddWarning("Please check your input.");
+
      
+
        
+
      1. Exception handling in synchronous code:
        2. 
+
      
+
      try
+{
+    // Your code here
+    throw new NotImplementedException("Demo exception");
+}
+catch (Exception ex)
+{
+    ExceptionUtil.ShowException(ex, null);
+}
+
      
+
        
+
      1. Exception handling in asynchronous code:
        2. 
+
      
+
      await Task.Run(() =>
+{
+    // Your async operation here
+    throw new NotImplementedException("Demo async exception");
+}).ShowIfCatched(null);
+
      
+
      The examples are in project Hi.Sample. See this page for git repository.
      
+
      Loose Manner
      
+
      Run Skippable Rapid Calling Synchronous Action in Loose Manner.
      
+
      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 LooseRunner and apply LooseRunner.TryRun(Action<CancellationToken>) to run the action.
      
+
      Dispose the LooseRunner on owner disposing to ensure the tryrun action is well-managed.
      
+
      GUI File Path Assignment
      
+
      See GUI File Path Assignment.
      
+
      Translation Remarks
      
+
      See Translation Remarks.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/box3d-control.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/box3d-control.html
new file mode 100644
index 00000000..fbe36afb
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/box3d-control.html
@@ -0,0 +1,150 @@
+
+
+  
+    
+      Box3dControl | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Box3dControl
      
+
+
      The Box3dControl provides a user interface for editing a 3D box defined by its minimum and maximum coordinates.
      
+
      Features
      
+
        
+
      • Edit the minimum and maximum coordinates of the box
        • 
+
      • View the calculated dimensions and center of the box
        • 
+
      • Read-Only Mode and Edit Mode
        • 
+
      • There are three sub-edit modes that can be selected in Edit Mode:
+
          
+
        • Min and Max
          • 
+
        • Min and Dimension
          • 
+
        • Center and Dimension
          • 
+
        
+
        • 
+
      
+
      UI Layout
      
+
      The Box3dControl includes the following UI elements:
      
+
        
+
      1. Min Vec3dControl
        2. 
+
      2. Max Vec3dControl
        3. 
+
      3. Dimension Vec3dControl
        4. 
+
      4. Center Vec3dControl
        5. 
+
      
+
      The sub-edit mode rules the controls to readonly or editable.
      
+
      Since the native of Box3d is that only Min and Max Properties are editable, the other mode requires little additional logic to take effect.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/Box3dControl
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/box3d-control.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/cylindroid-control.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/cylindroid-control.html
new file mode 100644
index 00000000..19356ec1
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/cylindroid-control.html
@@ -0,0 +1,141 @@
+
+
+  
+    
+      CylindroidControl | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      CylindroidControl
      
+
+
      The CylindroidControl provides a user interface for editing a cylindroid, which is a generalized cylinder defined by a series of radius values along the Z-axis.
      
+
      Features
      
+
        
+
      • Edit the Z-radius pairs that define the cylindroid's profile
        • 
+
      • Set the longitude number (resolution) for the cylindroid
        • 
+
      • Add and remove Z-radius pairs
        • 
+
      
+
      UI Layout
      
+
      The CylindroidControl includes the following UI elements:
      
+
        
+
      1. Longitude Number - A numeric input for setting the resolution of the cylindroid
        2. 
+
      2. Z-Radius Pairs - A DataGrid showing the Z-coordinate and radius pairs
        3. 
+
      3. Add Button - Adds a new Z-radius pair
        4. 
+
      4. Remove Button - Removes the selected Z-radius pair
        5. 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/CylindroidControl
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/cylindroid-control.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/extended-cylinder-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/extended-cylinder-panel.html
new file mode 100644
index 00000000..f3967f5c
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/extended-cylinder-panel.html
@@ -0,0 +1,135 @@
+
+
+  
+    
+      Extended Cylinder Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Extended Cylinder Panel
      
+
+
      The model is ExtendedCylinder.
      
+
      Layout
      
+
        
+
      • Extended Cylinder Panel
+
          
+
        • FullLength Input Field
          • 
+
        
+
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/ExtendedCylinderControl
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/extended-cylinder-panel.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-combination-control.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-combination-control.html
new file mode 100644
index 00000000..f66a52ae
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-combination-control.html
@@ -0,0 +1,155 @@
+
+
+  
+    
+      GeomCombinationControl | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      GeomCombinationControl
      
+
+
      The GeomCombinationControl provides a user interface for combining multiple geometric objects into a single composite geometry. This is useful for creating complex shapes from simpler primitives.
      
+
      Features
      
+
        
+
      • Add multiple geometric objects to the combination
        • 
+
      • Remove selected objects from the combination
        • 
+
      • Edit the properties of each included geometry
        • 
+
      • Support for various geometry types
        • 
+
      
+
      UI Layout
      
+
      The GeomCombinationControl includes the following UI elements:
      
+
        
+
      1. Geometry List - A ListView showing all the geometries in the combination
        2. 
+
      2. Add Geometry - A section for adding new geometries:
+
          
+
        • Geometry Type - A combo box for selecting the type of geometry to add
          • 
+
        • Add Button - Adds a new geometry of the selected type to the combination
          • 
+
        
+
        3. 
+
      3. Remove Button - Removes the selected geometry from the combination
        4. 
+
      4. Geometry Properties - A container that shows the appropriate control for editing the selected geometry
        5. 
+
      
+
      Supported Geometry Types
      
+
      The control supports adding the following geometry types to the combination:
      
+
        
+
      • Box3d
        • 
+
      • Cylindroid
        • 
+
      • StlFile
        • 
+
      • TransformationGeom
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/GeomCombinationControl
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/geom-combination-control.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-manage-control.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-manage-control.html
new file mode 100644
index 00000000..8c268e68
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/geom-manage-control.html
@@ -0,0 +1,161 @@
+
+
+  
+    
+      Geometry Management Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Geometry Management Panel
      
+
+
      Geometry Management Panel get and set a TargetGeometry IStlSource.
      
+
      null is acceptable for TargetGeometry.
      
+
      The TargetGeometry can be convert to TransformationGeom or get out of the TransformationGeom. The conversion button can be hide by the code-behind property.
      
+
      The TargetGeometry can be convert to GeomCombination or get out of the GeomCombination if there is only one geometry in StlSources. The conversion button can be hide by the code-behind property.
      
+
      The geometry type in the
      
+
      Layout
      
+
        
+
      • Geometry Management Panel
+
          
+
        • Geometry Selection and Conversion Bar
+
+
          • 
+
        • Content Panel (varied by the TargetGeometry)
          • 
+
        
+
        • 
+
      
+
      Geometry Type Selection Bar Setting
      
+
      See Geometry Panels for the various geometry type.
      
+
      The geometries are availible by default:
      
+
+
      The geometries are default hiding but they can be code-behind optionally enabled:
      
+
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/GeometryManagementPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/geom-manage-control.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/index.html
new file mode 100644
index 00000000..fcc0c066
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/index.html
@@ -0,0 +1,145 @@
+
+
+  
+    
+      Geometry Panels | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Geometry Panels
      
+
+
      Geometry Panels are GUIs of Geometry Objects.
      
+
      Use Geometry Management Control to get, set and manage the geometry.
      
+
      Basic Geometry Control
      
+
        
+
      • Box3dControl - A control for editing a 3D box defined by its minimum and maximum coordinates.
        • 
+
      • CylindroidControl - A control for editing a cylindroid defined by a series of radius values along the Z-axis.
        • 
+
      • StlFileControl - A control for loading and manipulating STL files.
        • 
+
      
+
      Management Geometry Control
      
+
+
      Special Geometry Control
      
+
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/runtime-geom-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/runtime-geom-panel.html
new file mode 100644
index 00000000..e47d5e8a
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/runtime-geom-panel.html
@@ -0,0 +1,139 @@
+
+
+  
+    
+      Runtime Geometry Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Runtime Geometry Panel
      
+
+
      Key model is CubeTreeFile.
      
+
      
+
      Note
      
+
      The term Runtime Geometry is CubeTree.
      
+
      
+
      Layout
      
+
        
+
      • Runtime Geom Panel
+
          
+
        • File Selector
          • 
+
        
+
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/RuntimeGeomPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/runtime-geom-panel.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/stlfile-control.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/stlfile-control.html
new file mode 100644
index 00000000..105e02bc
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/stlfile-control.html
@@ -0,0 +1,140 @@
+
+
+  
+    
+      StlFileControl | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      StlFileControl
      
+
+
      The StlFileControl provides a user interface for loading and manipulating STL (STereoLithography) files, which are commonly used for representing 3D surface geometry.
      
+
      Features
      
+
        
+
      • Load STL files from the file system
        • 
+
      • Display the path of the loaded STL file
        • 
+
      • View basic information about the loaded STL (when available)
        • 
+
      
+
      UI Layout
      
+
      The StlFileControl includes the following UI elements:
      
+
        
+
      1. File Path - A text box showing the path of the loaded STL file
        2. 
+
      2. Browse Button - Opens a file dialog to select an STL file
        3. 
+
      3. Information Panel - Displays information about the loaded STL file (when available)
        4. 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/StlFileControl
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/stlfile-control.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/transformation-geom-control.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/transformation-geom-control.html
new file mode 100644
index 00000000..6644eed4
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/geom/transformation-geom-control.html
@@ -0,0 +1,156 @@
+
+
+  
+    
+      TransformationGeomControl | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      TransformationGeomControl
      
+
+
      The TransformationGeomControl provides a user interface for applying transformations to geometric objects. It allows you to wrap any geometry with transformation parameters like scaling, rotation, and translation.
      
+
      Features
      
+
        
+
      • Select and edit the base geometry object
        • 
+
      • Apply transformations including scaling, rotation, and translation
        • 
+
      • Preview the transformed geometry
        • 
+
      
+
      UI Layout
      
+
      The TransformationGeomControl includes the following UI elements:
      
+
        
+
      • Base Geometry - A combo box for selecting the type of base geometry
        • 
+
      • Geometry Properties - A container that shows the appropriate control for the selected geometry type
        • 
+
      • Transformation Selection Bar
+
          
+
        • Available options (The dynamic transformer is not avaible):
+
            
+
          • Null Transform Option (Show if originally existed or code-behind optionally assinged)
            • 
+
          • Identity Transform Option (Show if originally existed or code-behind optionally assinged)
            • 
+
          • Static Translate Option
            • 
+
          • General Transform Option
            • 
+
          • Freeform Transform Option
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      See Also
      
+
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Source Code Path
      
+
        
+
      • Geom/TransformationGeomControl
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/geom/transformation-geom-control.js
        • 
+
      • Controller/Geom/GeomController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/index.html
new file mode 100644
index 00000000..39c8e63a
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/index.html
@@ -0,0 +1,171 @@
+
+
+  
+    
+      Sketch to Build HiNC GUI | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Sketch to Build HiNC GUI
      
+
+
      Apply General Rules to build the HiNC GUI.
      
+
      WPF Application Source Code
      
+
      The source code of HiNC-2025-win-desktop project is at the git repository:
      
+
      https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-win-desktop.git
      
+
      Web Page Application Source Code
      
+
      The source code of HiNC-2025-webapi project is at the git repository:
      
+
      https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-webapi.git
      
+
      Step by Step Program Construction Check List
      
+
      
+
      Tip
      
+
      If you are using AI agent to build the application:
      
+
        
+
      • Ask AI to do only one job at one time to ensure the quality.
        • 
+
      
+
      
+
        
+
      1. Create and config a application project.
+
          
+
        1. Set the project platform to x64.
          2. 
+
        2. Create a application project.
          3. 
+
        3. Add HiNc packages to the project. See Getting Started to config the packages.
          4. 
+
        
+
        
+
        Note
        
+
        Add Hi.Wpf packages to the project if the building WPF project.
        
+
        
+
        2. 
+
      2. Create Main Window, set the layout according to Main Panel Layout.
        3. 
+
      3. Build Message Section according to Message Section on Main Panel.
        4. 
+
      4. Initialize HiAPI at application entry point according to Initialize HiAPI.
        5. 
+
      5. Set behavior of Navigation Menu/Project according to Behavior of Navigation Menu/Project.
        6. 
+
      6. Create RenderingCanvas Tool Bar for later usage.
        7. 
+
      7. Create by Player Panel the Player Panel Step by Step Program Construction Check List.
        8. 
+
      8. Build behavior of Graphic-Cache Dropdown.
        9. 
+
      9. Build basic GUI widget component:
+
+
        10. 
+
      10. Build Transformers
        11. 
+
      11. Build Geometry Panels.
        12. 
+
      12. Build Fixture Page.
        13. 
+
      13. Build Workpiece Page.
        14. 
+
      14. Build Controller Page.
        15. 
+
      15. Build ToolHouse Page.
        16. 
+
      16. Add application icon, splash screen and etc..
        17. 
+
      17. (The content is consturcting..)
        18. 
+
      
+
      
+
      Tip
      
+
        
+
      • Complete the check list step by step.
        • 
+
      • Compile to ensure the code work on each step completed.
        • 
+
      • You MUST read the cited hyperlink before you do the job. ASK if you think the hyperlink is not work.
        • 
+
      
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/initialize-hiapi.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/initialize-hiapi.html
new file mode 100644
index 00000000..cb0058bb
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/initialize-hiapi.html
@@ -0,0 +1,120 @@
+
+
+  
+    
+      Initialize HiAPI at Application Entry Point | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Initialize HiAPI at Application Entry Point
      
+
+
      At the application entry point, you need to initialize HiAPI and set the exiting event.
      
+
        
+
      • <xref:Hi.HiNcKits.LocalApp.AppBegin()>
        • 
+
      • <xref:Hi.HiNcKits.LocalApp.AppEnd()>
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/main-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/main-panel.html
new file mode 100644
index 00000000..44bc39eb
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/main-panel.html
@@ -0,0 +1,208 @@
+
+
+  
+    
+      Main Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Main Panel
      
+
+
+
      Main Panel Layout
      
+
+
      Behavior of Navigation Menu/Project
      
+
      Project Path Text Field Shows the Project Path if the project is assinged.
      
+
      
+
      Tip
      
+
      Project Path Text Field should not be button style. It should be a pure text field that can be selected and copied.
      
+
      
+
      The Project Menu Managing MachiningProject.
      
+
      To New (create), Save and Save As the MachiningProject, See DemoBuildGeomOnlyMachiningProject for the example.
      
+
      To Load MachiningProject, See DemoUseMachiningProject for the example.
      
+
      Show message for the actions result (successed or has exception) by MessageKit.
      
+
      
+
      Tip
      
+
      Recommmand using static function of MessageKit to do the job.
+Read document of MessageKit to ensure the proper usage.
      
+
      
+
      On project loaded (Navigation Menu/Project/Load MenuItem)
+, set the Player.Panel.RenderingCanvas.DispEngine to SetViewToIsometricView().
      
+
      
+
      Tip
      
+
      Using async to comfort the process
      
+
      
+
      WPF Application Specification
      
+
      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.
      
+
      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.
      
+
      Web-Page Application Specification
      
+
      Apply Player Panel as the default panel.
      
+
      Application Specification and Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • MainWindow
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • Controllers/PreferenceController.cs
        • 
+
      • wwwroot/main.js
        • 
+
      • wwwroot/index.html
        • 
+
      
+
      Web Page Application Specification
      
+
      The page and URL are bi-directional.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/apt-profile-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/apt-profile-panel.html
new file mode 100644
index 00000000..f7cd7276
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/apt-profile-panel.html
@@ -0,0 +1,151 @@
+
+
+  
+    
+      APT Profile Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      APT Profile Panel
      
+
+
      The main model is AptProfile and its property AptProfile.Apt.
      
+
      See APT Cutter Definition. GeneralApt is the generalization of other IAptBased types.
      
+
      Layout
      
+
        
+
      • APT Profile Panel
+
          
+
        • Diameter Input Field (mm)
          • 
+
        • Round Radius Input Field (mm)
+Visibly if Apt is IAptRc
          • 
+
        • Round Ring Radius Input Field(mm)
+Visibly if Apt is IAptRr
          • 
+
        • Round Ring Height Input Field(mm)
+Visibly if Apt is IAptRz
          • 
+
        • Bottom Cone Angle Input Field (deg)
+Visibly if Apt is IAptAlpha
          • 
+
        • Top Cone Angle Input Field (deg)
+Visibly if Apt is IAptBeta
          • 
+
        • Length of Cut Input Field (mm)
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
      Keep field format “G4”
      
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/AptProfilePanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/cutter/apt-profile-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/freeform-remover-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/freeform-remover-panel.html
new file mode 100644
index 00000000..7b619286
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/freeform-remover-panel.html
@@ -0,0 +1,200 @@
+
+
+  
+    
+      Freeform Remover Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Freeform Remover Panel
      
+
+
      The key model is FreeformRemover.
      
+
      Layout
      
+
+
      Geometry Definitions
      
+
        
+
      • Strut Geometry - The non-cutting portion (holder/shank)
+
          
+
        • Used for collision detection
          • 
+
        
+
        • 
+
      • Shaper Geometry - The cutting portion
+
          
+
        • Defines cutting surfaces
          • 
+
        • Used for material removal simulation
          • 
+
        
+
        • 
+
      
+
      Implementation Note
      
+
      Remember to call ClearCache() after geometry changes.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/FreeformRemoverPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/cutter/freeform-remover-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/index.html
new file mode 100644
index 00000000..58a535ee
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/index.html
@@ -0,0 +1,161 @@
+
+
+  
+    
+      Cutter Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Cutter Panel
      
+
+
      Overview
      
+
      The key component is ICutter.
      
+
      The Cutter Panel is used to manage cutting tool definitions in HiNC. It supports two main types of cutting tools: MillingCutter and FreeformRemover.
      
+
      Layout
      
+
        
+
      • Cutter Panel
+
          
+
        • Head Line
+
            
+
          • Object Management Menu Button
+
              
+
            • File extension is .Cutter
              • 
+
            • The pointed Editor Panel is Cutter Management Panel
              • 
+
            
+
            • 
+
          • Title Label
            • 
+
          • Cutter Type Selection Dropdown
+
              
+
            • Options: Milling Cutter, Freeform Remover, Unset
              • 
+
            
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Cutter Management Panel
+Varies by the Cutter Type. It can be:
+
+
        • 
+
      
+
      Features
      
+
      Since ICutter implements IClearCache, remember to call the ClearCache method when the cutter geometry or properties change to ensure proper updates in simulation.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/CutterManagementPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/cutter/cutter-management-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/milling-cutter-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/milling-cutter-panel.html
new file mode 100644
index 00000000..ed7be567
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/cutter/milling-cutter-panel.html
@@ -0,0 +1,451 @@
+
+
+  
+    
+      Milling Cutter Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Milling Cutter Panel
      
+
+
      The key model is MillingCutter.
      
+
      Layout
      
+
+
      Flute-Profile Tab
      
+
+
      See DemoBuildMachiningProject for creating the apt profile and setting to the cutter.
      
+
      See APT Panel for APT-based Profile Configuration Panel. The APT series option is all wrap by AptProfile but with different property AptProfile.Apt assigned.
      
+
+
      Property Tab
      
+
      Visible if UserEnv.EnablePhysics is true.
      
+
        
+
      • Integral Mode Selection Dropdown
+
          
+
        • Solid End
          • 
+
        • Insert End
          • 
+
        
+
        • 
+
      • Cutter/Shank Mass Input Field (g)
+
          
+
        • Show the label ‘Cutter Mass’ if the Cutter is Solid End Integral Mode; Show the label ‘Shank Mass’ if the Cutter is Insert End Integral Mode.
          • 
+
        • Value format “G4”
          • 
+
        • Auto Update CheckBox
+The model is ShankMassAssignmentMode.
+
            
+
          • When enabled: field becomes readonly and shows calculated value.
            • 
+
          • When disabled: field is editable
            • 
+
          • Functionality Note: The value is calculate by the volume and density. The volume is the inner beam volume and the upper beam volume.
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Hone Radius (μm) Input Field
        • 
+
      • Relief Angle (deg) Input Field
        • 
+
      • Minimum Available Cutting Thickness (μm)
+
+
        • 
+
      
+
      Insert-Cutter Tab
      
+
      Visible if UserEnv.EnablePhysics is true and Integral Mode is Insert End.
      
+
        
+
      • Insert Number Input field
        • 
+
      • Insert Mass Input field (g)
+
          
+
        • Format “G4”
          • 
+
        
+
        • 
+
      • Insert Thickness Input field (mm)
+
          
+
        • Format “G4”
          • 
+
        • The Insert Thickness is for computing heat transfer.
          • 
+
        
+
        • 
+
      
+
      Material Tab
      
+
      Visible if UserEnv.EnablePhysics is true.
      
+
        
+
      • Shank Material (visible only for Integral Mode is Insert End mode)
+
          
+
        • Material File Selector
+Apply IStructureMaterial
+
            
+
          • Menu Dropdown
+
              
+
            • Browse Button
              • 
+
            • Browse Resource Button
              • 
+
            
+
            • 
+
          • Readonly Name TextBox (Name)
+
              
+
            • ToolTip by Note from the material
              • 
+
            
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Flute Material
+
          
+
        • Material File Selector
+Apply CutterMaterial
+
            
+
          • Menu Dropdown
+
              
+
            • Browse Button
              • 
+
            • Browse Resource Button
              • 
+
            
+
            • 
+
          • Readonly Name TextBox (Name)
+
              
+
            • ToolTip by Note from the material
              • 
+
            
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Coating Panel
+
          
+
        • Show note that the sequence starts from surface, i.e. from outer to inner.
          • 
+
        • Manages CoatingLayerList
+
            
+
          • Exists sequence management.
            • 
+
          • The first layer has the remark: Air-Exposing Coating.
            • 
+
          • ThermalLayer1D Component
+
            
+
            Tip
            
+
              
+
            • Keep the child components to one line.
              • 
+
            • After Coating Material is manual loaded, set the PreferedThickness_um to the Length_um and update the corresponding field.
              • 
+
            
+
            
+
              
+
            • Coating Material
+
                
+
              • Material File Selector
+Apply CoatingMaterial
+
                  
+
                • Menu Dropdown
+
                    
+
                  • Browse Button
                    • 
+
                  • Browse Resource Button
                    • 
+
                  
+
                  • 
+
                • Readonly Name TextBox (Name)
+
                    
+
                  • ToolTip by Note from the material
                    • 
+
                  
+
                  • 
+
                
+
                • 
+
              
+
              • 
+
            • Thickness Input Field (um) (editable)
+
+
              • 
+
            
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      If the cutter is Solid End, the Shank Material should keep the same with Flute Material. i.e. Set the Shank Material when Flute Material set.
      
+
      Default Resource
      
+
      The default resources of Material exist in Resource folder under application folder (Not project folder). Set the corresponding default folder of the File Selector to the Resource sub folder:
      
+
        
+
      • “Resource/StructureMaterial”
        • 
+
      • “Resource/CutterMaterial”
        • 
+
      • “Resource/CoatingMaterial”
        • 
+
      
+
      Flute-Contours Tab
      
+
      Visible if UserEnv.EnablePhysics is true.
      
+
      This part manages FluteContourTray.
      
+
        
+
      • Contour Tray Selection Dropdown
+
+
        • 
+
      • Contour Tray Configuration Panel
+
          
+
        • Dynamic component based on selected contour tray type
          • 
+
        • For Uniform Contour Tray:
+
            
+
          • Track Number Input Field
            • 
+
          • Baseline Contour Configuration
+//building
            • 
+
          
+
          • 
+
        • For Free Contour Tray:
+
            
+
          • Individual contour configuration for each flute
+//building
            • 
+
          • Add/Remove contour controls
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      Flute-Inner-Beam Tab
      
+
      Visible if UserEnv.EnablePhysics is true.
      
+
      This part manages InnerBeamProfile.
      
+
        
+
      • Profile Type Selection Dropdown
+
+
        • 
+
      • Profile Configuration Panel
+
          
+
        • Dynamic component based on selected profile type
          • 
+
        • For Flute Dependent Ratio Profile:
+
            
+
          • Radius Ratio Number Field (readonly)
+
              
+
            • Label also shows the additional information: ‘Dependent on flute num xxx’, the ‘xxx’ is the flute number that pass by MillingCutter.FluteContourTray. Series pass the model by the GUI if needed.
              • 
+
            
+
            • 
+
          
+
          • 
+
        • For Const Ratio Profile:
+
            
+
          • Radius Ratio Number Field (editable)
            • 
+
          
+
          • 
+
        • For Custom Spinning Profile:
+
+
          • 
+
        
+
        • 
+
      
+
      Optimization Tab
      
+
      Visible if UserEnv.EnablePhysics is true.
      
+
      This part manages MillingCutterOptLimit.
      
+
        
+
      • Enable Optimization Checkbox
+
          
+
        • Controls whether optimization limits are active
          • 
+
        
+
        • 
+
      • When optimization is enabled:
+
          
+
        • Limit by Theoretical Minimum Feed Per Tooth Checkbox
+
+
          • 
+
        • Min Feed Per Tooth (mm) Number Field
+
            
+
          • Step (If UI supported): 0.01
            • 
+
          
+
          • 
+
        • Max Feed Per Tooth (mm) Number Field
+
            
+
          • Step (If UI supported): 0.01
            • 
+
          
+
          • 
+
        • Safety Factor for Yielding Number Field
+
            
+
          • Step (If UI supported): 0.1
            • 
+
          • Default value typically around 2.0
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/MillingCutterPanel
        • 
+
      • Mech/ToolHouse/AptProfilePanel
        • 
+
      • Mech/ToolHouse/MaterialTabPanel
        • 
+
      • Mech/ToolHouse/PropertyTabPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/cutter/milling-cutter-panel.js
        • 
+
      • wwwroot/mech/cutter/apt-profile-panel.js
        • 
+
      • wwwroot/mech/cutter/material-tab-panel.js
        • 
+
      • wwwroot/mech/cutter/property-tab-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/fixture-page.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/fixture-page.html
new file mode 100644
index 00000000..236dc7cb
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/fixture-page.html
@@ -0,0 +1,196 @@
+
+
+  
+    
+      Fixture Page | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Fixture Page
      
+
+
      The page triggers by Main Panel.
      
+
      The key model is Fixture and FixtureEditorDisplayeeConfig.
+Fixture is assigned from the Main Panel's MachiningProject.MachiningEquipment.Fixture.
      
+
      FixtureEditorDisplayeeConfig is from UserEnv.UserConfig which assigned from the parent component.
      
+
      Layout
      
+
+
      
+
      Tip
      
+
        
+
      • Add a resizable splition bar between Manage Panel and Viewer Panel.
        • 
+
      
+
      
+
      Behavior
      
+
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/Fixtures/FixturePage
        • 
+
      • Mech/Fixtures/FixtureWindow
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/fixture-page.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/cylindroid-holder-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/cylindroid-holder-panel.html
new file mode 100644
index 00000000..642a07b0
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/cylindroid-holder-panel.html
@@ -0,0 +1,159 @@
+
+
+  
+    
+      Cylindroid Holder Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Cylindroid Holder Panel
      
+
+
      The key model is CylindroidHolder.
      
+
      Layout
      
+
        
+
      • Cylindroid Holder Panel
+
+
        • 
+
      
+
      Remember to call UpdateByCylindroid() after geometry reference or content changed.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/CylindroidHolderPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/holder/cylindroid-holder-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/freeform-holder-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/freeform-holder-panel.html
new file mode 100644
index 00000000..301841cb
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/freeform-holder-panel.html
@@ -0,0 +1,166 @@
+
+
+  
+    
+      Freeform Holder Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Freeform Holder Panel
      
+
+
      The key model is FreeformHolder.
      
+
      Layout
      
+
+
      Remember to call UpdateByGeom() after geometry reference or content changed.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/FreeformHolderPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/holder/freeform-holder-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/index.html
new file mode 100644
index 00000000..3cfbe182
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/holder/index.html
@@ -0,0 +1,162 @@
+
+
+  
+    
+      Holder Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Holder Panel
      
+
+
      This section describes the user interface and behavior for managing different types of tool holders in the application. Tool holders are crucial components in defining a complete tool assembly.
      
+
      
+
      Note
      
+
      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.
      
+
      
+
      The primary models involved are subclasses of IHolder. Two common types are:
      
+
+
      Each holder type will have its own specific user interface elements for defining its geometry and properties.
      
+
      Layout
      
+
        
+
      • Holder Panel
+
          
+
        • Head Line
+
+
          • 
+
        • Holder Management Panel
+
            
+
          • Holder Type Selection Bar
            • 
+
          • Holder Sub Management Panel
+The content varied by the Holder Type.
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/HolderPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/holder/holder-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/machining-chain-page.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/machining-chain-page.html
new file mode 100644
index 00000000..254fb190
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/machining-chain-page.html
@@ -0,0 +1,174 @@
+
+
+  
+    
+      Machine Tool Page | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Machine Tool Page
      
+
+
+
      Layout
      
+
        
+
      • Head Line
+
+
        • 
+
      • Management Panel
+
          
+
        • If the key model inherits INameNote:
+
            
+
          • Name Setting Line
+
              
+
            • Name Label
              • 
+
            • Name TextField
              • 
+
            
+
            • 
+
          • Note Setting Line
+
              
+
            • Note Label
              • 
+
            • Note TextField
              • 
+
            
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/MachiningChains/MachiningChainPage
        • 
+
      • Mech/MachiningChains/MachiningChainWindow
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/machining-chain-page.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/stick-tool-panel/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/stick-tool-panel/index.html
new file mode 100644
index 00000000..6eb73b4e
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/stick-tool-panel/index.html
@@ -0,0 +1,188 @@
+
+
+  
+    
+      Stick Tool Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Stick Tool Panel
      
+
+
      The term stick is for not only milling, but other remover like electric discharge machining tool.
      
+
      The key model is MillingTool.
+Other model: UserEnv.
      
+
      Layout
      
+
        
+
      • Head Line
+
+
        • 
+
      • Stick Tool Management Panel
+
          
+
        • Cutter Tab
+
+
          • 
+
        • Holder Tab
+
+
          • 
+
        • Clamping Tab
+
            
+
          • Exposed-Cutter-Height TextField
            • 
+
          • Preserved-Distance-Between-Flute-and-Spindle-Nose TextField
            • 
+
          
+
          • 
+
        • Intelligent Holder Tab
+Visible if UserEnv.EnablePhysics is true.
          • 
+
        • Info Tab
+
            
+
          • Abstract Note TextField (readonly)
            • 
+
          • Note TextField (editable)
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      
+
      Note
      
+
      The Exposed-Cutter-Height and Preserved-Distance-Between-Flute-and-Spindle-Nose are directly related. Each value changed if each other value is changed.
      
+
      
+
      Step by Step Build Guide
      
+
        
+
      1. Build the Stick Tool Panel Layout framework. Since the framework helps to check of the child componenet.
        2. 
+
      2. Build accessory part of the framework.
+
          
+
        1. Object Management Menu Button
          2. 
+
        2. Info Tab
          3. 
+
        3. Clamping Tab
          4. 
+
        
+
        3. 
+
      3. Build Holder Panel and the related holder type panel.
        4. 
+
      4. Build Cutter Panel and the related cutter type panel.
        5. 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/StickToolPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/stick-tool-panel.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/tool-house-page.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/tool-house-page.html
new file mode 100644
index 00000000..90b24e8d
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/tool-house-page.html
@@ -0,0 +1,244 @@
+
+
+  
+    
+      Tool House Page | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Tool House Page
      
+
+
      The page triggers by Main Panel.
      
+
      The key model is MachiningToolHouse.
+The model UserEnv is delivered by the host GUI.
      
+
      Layout
      
+
        
+
      • Tool House Page
+
          
+
        • Tool List Panel
+The panel has CRUD (and Duplicate) of the tools. Read and Update the selected tool by the Selected Tool Editor Panel.
+
            
+
          • Head Line
+
+
            • 
+
          • Batch Action Menu
+
              
+
            • Select All Button
              • 
+
            • De-Select All Button
              • 
+
            • (splition bar)
              • 
+
            • Duplication Button
              • 
+
            • Remove Button
              • 
+
            
+
            • 
+
          • Create Tool Button
            • 
+
          • Tool List
+
              
+
            • Selection Checkbox (for batch action)
              • 
+
            • Editable Tool ID TextField
              • 
+
            • Editable Note/Abstract TextField
              • 
+
            
+
            • 
+
          
+
          • 
+
        • Selected Tool Editor Panel
+
+
          • 
+
        • Viewer Panel
+
+
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
        
+
      • 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.
        • 
+
      • Add a resizable splition bar between Tool List Panel, Selected Tool Editor Panel and Viewer Panel.
        • 
+
      • The options of MillingCutterEditorDisplayee and HolderEditorDisplayee is enabled only if the upper level options are enabled, i.e. ShowCutter and ShowHolder.
        • 
+
      • Use less layer of EditorDisplayee Options ToolBar for user convenient. Flatten the options of the children displayee except the ratio button group.
        • 
+
      
+
      
+
      The Tool ID can not be repeated. When create new tool, assign a new tool ID (maybe the largest ID plus 1).
      
+
      When a tool is entered, call the renderingCanvas.DispEngine.SetViewToHomeView().
      
+
      Duplication Button
      
+
      Use Duplicate(params object[]) to duplicate the tool.
      
+
      Note/Abstract TextField
      
+
      The Note/Abstract TextField shows note if note existed and is not empty string; otherwise it shows the AbstractNote. The tooltip is the abstract note.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/ToolHouse/ToolHousePage
        • 
+
      • Mech/ToolHouse/ToolHouseWindow
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/tool-house-page.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/topo/transformers.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/topo/transformers.html
new file mode 100644
index 00000000..78f4b1ea
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/topo/transformers.html
@@ -0,0 +1,155 @@
+
+
+  
+    
+      Transformers GUI | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Transformers GUI
      
+
+
      Each Transformers has GUI component.
      
+
      Transformer Manage Panel
      
+
      Use Transformer Manage Panel to setup the ITransformer.
      
+
      Layout
      
+
        
+
      • Transformer Manage Panel
+
          
+
        • Transformer Type Selection Bar
          • 
+
        • Transformer Content Panel (vary by the selected Transformer)
          • 
+
        
+
        • 
+
      
+
      Transformer Type Selection Bar
      
+
      Transformer Type Selection Bar get or set ITransformer.
      
+
      The Transformer Type Selection Bar has code-behind option to choose what the transformer options to show.
      
+
      If the original model (i.e. source model) transformer conflicts with the restricted transformers, show the model.
      
+
      
+
      Tip
      
+
      Consider one line layout to save the space for the selection bar.
      
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/Topo/TransformerSelectPanel
        • 
+
      • Mech/Topo/StaticTranslationPanel
        • 
+
      • Mech/Topo/StaticFreeformPanel
        • 
+
      • Mech/Topo/DynamicTranslationPanel
        • 
+
      • Mech/Topo/DynamicRotationPanel
        • 
+
      • Mech/Topo/GeneralTransformPanel
        • 
+
      • Mech/Topo/TransformerDemoWindow
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • Mech/Topo/TransformerSelectDiv
        • 
+
      • Mech/Topo/StaticTranslationDiv
        • 
+
      • Mech/Topo/DynamicTranslationDiv
        • 
+
      • Mech/Topo/DynamicRotationDiv
        • 
+
      • Mech/Topo/GeneralTransformDiv
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/workpiece-page.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/workpiece-page.html
new file mode 100644
index 00000000..35ef65bc
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mech/workpiece-page.html
@@ -0,0 +1,284 @@
+
+
+  
+    
+      Workpiece Page | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Workpiece Page
      
+
+
      The page triggers by Main Panel.
      
+
      The key model is Workpiece and WorkpieceEditorDisplayeeConfig.
+Which is assigned from the Main Panel's MachiningProject.Workpiece.
      
+
      FixtureEditorDisplayeeConfig is from UserEnv.UserConfig which assigned from the parent component.
      
+
      Layout
      
+
        
+
      • Workpiece Page
+
          
+
        • Management Panel
+
            
+
          • Head Line
+
+
            • 
+
          • Management Tabs Panel
+
              
+
            • Raw Shape Tab
+
+
              • 
+
            • Target Shape Tab
+
                
+
              • Geometry Management Control
                • 
+
              
+
              • 
+
            • Anchor Tab
+
+
              • 
+
            • Runtime Tab
+
                
+
              • Initial Resolution Dropdown (powers of 2)
+
                  
+
                • 0.0009765625
                  • 
+
                • 0.001953125
                  • 
+
                • 0.00390625
                  • 
+
                • 0.0078125
                  • 
+
                • 0.015625
                  • 
+
                • 0.03125
                  • 
+
                • 0.0625
                  • 
+
                • 0.125
                  • 
+
                • 0.25
                  • 
+
                • 0.5
                  • 
+
                • 1
                  • 
+
                • 2
                  • 
+
                • 4
                  • 
+
                • 8
                  • 
+
                • 16
                  • 
+
                
+
                • 
+
              
+
              • 
+
            • Material Tab
+Visible if UserEnv.EnablePhysics is true.
+
                
+
              • Workpiece Material File Selector
+
                  
+
                • Browse Button
+The initial directory is the project directory.
                  • 
+
                • Browse Resource Button
+The directory is the Default Resource directory.
                  • 
+
                • Readonly File Path TextBox
                  • 
+
                • Readonly Name TextBox (Name)
+
+
                  • 
+
                
+
                • 
+
              • Cutting Parameter File Selector
+
                  
+
                • Browse Button
+The initial directory is the project directory.
                  • 
+
                • Browse Resource Button
+The directory is the Default Resource directory.
                  • 
+
                • Readonly File Path TextBox
                  • 
+
                • Readonly Name TextBox (Name)
+
+
                  • 
+
                
+
                • 
+
              
+
              • 
+
            
+
            • 
+
          
+
          • 
+
        • Viewer Panel
+
+
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
      Add a resizable splition bar between Manage Panel and Viewer Panel.
      
+
      
+
      Default Resource
      
+
      The default resources of Workpiece Material and Cutting Parameter exist in Resource folder under application folder (Not project folder). Set the default folder of the File Selector to the Resource sub folder:
      
+
        
+
      • “Resource/WorkpieceMaterial”
        • 
+
      • “Resource/CuttingParameter”
        • 
+
      
+
      Behavior
      
+
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mech/Workpieces/WorkpiecePage
        • 
+
      • Mech/Workpieces/WorkpieceWindow
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/mech/workpiece-page.js
        • 
+
      • Controller/Mech/MechController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/message-section-on-main-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/message-section-on-main-panel.html
new file mode 100644
index 00000000..09506214
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/message-section-on-main-panel.html
@@ -0,0 +1,173 @@
+
+
+  
+    
+      Message Section on Main Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Message Section on Main Panel
      
+
+
      Initialize MessageKit.Default with Message Section
      
+
      To show and save the message on Brief Message Text Field, add event to Default.OnAdding.
      
+
      The event contains:
      
+
        
+
      • update the text content of Brief Message Text Field
        • 
+
      • Append the message to log file (create if not existed) $"logs/log-{DateTime.Now:yyyy-MM-dd}.txt"
        • 
+
      
+
      
+
      Tip
      
+
        
+
      • Handle the situation that logs over one day.
        • 
+
      • Check if passing argument of OnAdding is Exception. If the it is Exception, update text content by Exception.Message but log to file with the full Exception information.
        • 
+
      • Consider MessageFlag to set the behavior of Message Section. For example, apply alert style if passing argument is exception. The Info (and the other flags that the priority lower than it) should only record in the logs but not shows in the Message Section.
        • 
+
      
+
      
+
      WPF Application Layout
      
+
        
+
      • Message Section Bottom Bar
+
          
+
        • Brief Message Text Field
          • 
+
        • Show Log Button
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
      The text field should be selectable to let user easy to copy the message.
      
+
      
+
      Web Page Application Layout
      
+
        
+
      • Message Section Stacking Toast
+
          
+
        • Brief Message Text Field
          • 
+
        
+
        • 
+
      
+
      Enable toast Auto-Hide only if the message level is low.
      
+
      
+
      Note
      
+
      The convention of web page is not like WPF panel. Use Boostrap or Bootstrap-like toast. They are much appropriate than the fixed bottom bar on WPF.
      
+
      
+
      Log Page Layout
      
+
        
+
      • Head Line
+
          
+
        • Log Label
          • 
+
        • Show Log Button
          • 
+
        • Download Log Button
          • 
+
        
+
        • 
+
      • Log TextArea
        • 
+
      
+
      Behavior of Show Log Button
      
+
      Call an editor (or reader, bootstrap modal like poping block) to show the current log.
      
+
      
+
      Tip
      
+
      Handle the situation that the current log file does not exist. It may occurs if no message has added.
      
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/ListCommand-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/ListCommand-panel.html
new file mode 100644
index 00000000..27d2693f
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/ListCommand-panel.html
@@ -0,0 +1,242 @@
+
+
+  
+    
+      List Command Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      List Command Panel
      
+
+
      The key model is ListCommand.
      
+
+
      Layout
      
+
        
+
      • Columns Layout (Two column with one splition bar)
+
          
+
        • Command Entry List Panel
+Provide entrys for selection
+The model is CommandEntryList.
+
            
+
          • Head Line
+
+
            • 
+
          • Command Entrys Selection Panel
+
              
+
            • (Each) Command Entry Box:
+The boxes are multi-selectable for re-order, remove and etc..
+The boxes are draggable for re-order.
+
                
+
              • Enable CheckBox
+
+
                
+
                Tip
                
+
                Show the label text.
                
+
                
+
                • 
+
              • Title Label
+
                  
+
                • Apply <xref:Hi.ShellCommands.ITitleCommand.GetCommandTitle()> if the command is inherited from ITitleCommand; otherwise, show the class name.
                  • 
+
                
+
                • 
+
              
+
              
+
              Tip
              
+
              Apply style changed if the entry is selected.
              
+
              
+
                
+
              • If there is only one PreSettingCommand in the list and at the begining, Keep it at begining when items adding, shows a “pin at begining” label with a pin icon.
                • 
+
              • If there is only one PostExecutionCommand in the list and at the end, Keep it at end when items adding, shows a “pin at end” label a pin icon.
                • 
+
              
+
              • 
+
            
+
            • 
+
          • Support file drag from the external application (such as file explorer), files drag into the Command Entrys List Panel is equivalent to create NcFileCommands (with the EnablingWrapper) and set the file into the NC File Command.
            • 
+
          
+
          • 
+
        • Vertical Splition Bar
+
            
+
          • The bar can be drag to tune the width.
            • 
+
          
+
          • 
+
        • Selected Command Content Panel
+
            
+
          • The model is Command.
            • 
+
          • The panel is based on command type
            • 
+
          
+
          
+
          Tip
          
+
          The width of the entry block should expand to fulfill the content block.
          
+
          
+
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
      Use Disabled Style for command panels if the Enable checkbox is not checked.
      
+
      
+
      
+
      Note
      
+
      Each command entry can be individually enabled or disabled without removing it from the list.
      
+
      
+
      Features
      
+
      Update the Title Label if the Command is updated by the Command Content Panel.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mission/ListCommandPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/NcFileCommand-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/NcFileCommand-panel.html
new file mode 100644
index 00000000..dba7f4d2
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/NcFileCommand-panel.html
@@ -0,0 +1,172 @@
+
+
+  
+    
+      NcFileCommand Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      NcFileCommand Panel
      
+
+
      The key model is NcFileCommand.
      
+
        
+
      • Other Model: string BaseDirectory.
        • 
+
      
+
      Layout
      
+
        
+
      • NcFileCommand Panel
+
          
+
        • Head Line
+
            
+
          • NC File Setting
+
              
+
            • The model is <xref:Hi.ShellCommands.ClassicNcFileCommand.NcFile>.
              • 
+
            • NC File Label
              • 
+
            • NC File Text Field
+
                
+
              • About 20 charactor width
                • 
+
              
+
              • 
+
            • Load File Browser Button
+
                
+
              • Apply universal file filter for the NC files.
+Since NC File has too many extensions, such as but not limits to: nc, h, mpf, ptp.
                • 
+
              • Follow the Load Pattern.
                • 
+
              
+
              • 
+
            
+
            • 
+
          
+
          • 
+
        • NC File Editor
+The editor only available for text file.
+If the file lines within 20000 line, enable the NC File Editor;
+Otherwise, just preview the first 20000 line of the file and show the message to the Head Message Place.
+Auto-Save the file if the content changed.
+
            
+
          • Head Message Place
+
              
+
            • Show the error or exception of the File.
              • 
+
            
+
            • 
+
          • NC Code TextArea
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
      Fix the height of NC Code TextArea to the panel bottom.
+Set NC Code TextArea height resizable.
      
+
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mission/NcFileCommandPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/NcOptOption-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/NcOptOption-panel.html
new file mode 100644
index 00000000..a581dbf2
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/NcOptOption-panel.html
@@ -0,0 +1,237 @@
+
+
+  
+    
+      NC Optimization Option Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      NC Optimization Option Panel
      
+
+
      Key model is NcOptOption.
      
+
      Layout
      
+
        
+
      • General Optimization Section
        
+
+
        • 
+
      • Distance Settings Section
        
+
+
        • 
+
      • Feedrate Limits Section
        
+
          
+
        • Minimum Feedrate Floating Number Field (with Unit)
+
+
          • 
+
        • Maximum Feedrate Floating Number Field (with Unit)
+
+
          • 
+
        • Rapid Feed Floating Number Field (with Unit)
+
+
          • 
+
        
+
        • 
+
      • Motion Dynamics Section
        
+
          
+
        • Maximum Acceleration Floating Number Field (with Unit)
+
+
          • 
+
        • Maximum Jerk Floating Number Field (with Unit)
+
+
          • 
+
        
+
        • 
+
      • Force and Safety Section
        
+
+
        • 
+
      • Compensation Section
        
+
+
        • 
+
      
+
      
+
      Tip
      
+
      Use XmlConvert.ToDouble and FromDouble to parse the double value for dealing with the inf value.
      
+
      
+
      WPF Application Source Code Path
      
+
        
+
      • NcOpt/NcOptOptionPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/PostExecutionCommand-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/PostExecutionCommand-panel.html
new file mode 100644
index 00000000..c87b2af1
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/PostExecutionCommand-panel.html
@@ -0,0 +1,207 @@
+
+
+  
+    
+      PostExecutionCommand Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      PostExecutionCommand Panel
      
+
+
+
      Layout
      
+
        
+
      • Output Step Files Section
+
          
+
        • Enable Write Step Files CheckBox
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.EnableWriteStepFiles>.
            • 
+
          
+
          • 
+
        • Step File Template Label
          • 
+
        • Step File Template Text Field
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.StepFileTemplate>.
            • 
+
          • Default value: “Output/[NcName].step.csv”
            • 
+
          
+
          • 
+
        • Apply one line layout to the label and the text field.
          • 
+
        
+
        • 
+
      • Output Shot Files Section
+Visible if UserEnv.EnablePhysics is true.
+
          
+
        • Enable Write Shot Files CheckBox
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.EnableWriteShotFiles>.
            • 
+
          
+
          • 
+
        • Shot File Template Text Field
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.ShotFileTemplate>.
            • 
+
          • Default value: Output/[NcName].shot.csv
            • 
+
          
+
          • 
+
        • Shot File Time Resolution (ms) Number Field
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.ShotFileTimeResolution_ms>.
            • 
+
          • Default value: 1
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Optimization Files Section
+Visible if UserEnv.EnablePhysics is true.
+
          
+
        • Enable Optimize To Files CheckBox
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.EnableOptimizeToFiles>.
            • 
+
          
+
          • 
+
        • Optimization File Template Text Field
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.OptimizationFileTemplate>.
            • 
+
          • Default value: “Output/Opt-[NcName]”
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Geometry Difference Section
+
          
+
        • Enable Geom Diff CheckBox
+
            
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.EnableGeomDiff>.
            • 
+
          
+
          • 
+
        • Geom Diff Detect Radius Number Field (with Unit)
+
            
+
          • One Line layout
            • 
+
          • The model is <xref:Hi.ShellCommands.ClassicSessionCommand.GeomDiffDetectRadius_mm>.
            • 
+
          • Default value: 1
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mission/PostExecutionCommandPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/PreSettingCommand-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/PreSettingCommand-panel.html
new file mode 100644
index 00000000..59658713
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/PreSettingCommand-panel.html
@@ -0,0 +1,205 @@
+
+
+  
+    
+      PreSettingCommand Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      PreSettingCommand Panel
      
+
+
+
      Layout
      
+
        
+
      • Machining Resolution Label (with Unit)
        • 
+
      • Machining Resolution ComboBox
+
          
+
        • The model is MachiningResolution_mm.
          • 
+
        • Default value: 0.125
          • 
+
        • Options (powers of 2)
+
            
+
          • 0.0009765625
            • 
+
          • 0.001953125
            • 
+
          • 0.00390625
            • 
+
          • 0.0078125
            • 
+
          • 0.015625
            • 
+
          • 0.03125
            • 
+
          • 0.0625
            • 
+
          • 0.125
            • 
+
          • 0.25
            • 
+
          • 0.5
            • 
+
          • 1
            • 
+
          • 2
            • 
+
          • 4
            • 
+
          • 8
            • 
+
          • 16
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      
+
      Note
      
+
      The Machining Resolution is initialized from workpiece's InitResolution if available.
      
+
      
+
        
+
      • Machining Motion Resolution Setting
        
+
+
        • 
+
      • FixedMachiningMotionResolution Section
+If MachiningMotionResolution is FixedMachiningMotionResolution, show the panel.
        
+
          
+
        • Linear Resolution Label (with Unit)
          • 
+
        • Linear Resolution Number Input Field
          • 
+
        • Angle Resolution Label (with Unit)
          • 
+
        • Angle Resolution Number Input Field
          • 
+
        
+
        • 
+
      • Detection Settings Setting
        
+
+
        • 
+
      • Enable Physics CheckBox
        
+
+
        • 
+
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mission/PreSettingCommandPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/SimpleSessionCommand-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/SimpleSessionCommand-panel.html
new file mode 100644
index 00000000..fb85d7e9
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/SimpleSessionCommand-panel.html
@@ -0,0 +1,246 @@
+
+
+  
+    
+      Classic Session Command Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Classic Session Command Panel
      
+
+
      The key model is SimpleSessionCommand.
      
+
      Layout
      
+
        
+
      • Head Line
+
+
        • 
+
      • Title Label
        • 
+
      • Session Management Panel
+
          
+
        • NC/Command List Tab
+
            
+
          • Shell Commands ListBox
+
              
+
            • The model is NcCommandList.
              • 
+
            • Support add, remove, reorder commands.
              • 
+
            • The items are multi-selectable.
              • 
+
            • Support file drag from the external application (such as file explorer), files drag into the Shell Commands List is equivalent to create NcFileCommands.
              • 
+
            
+
            
+
            Tip
            
+
            don't use file filter to the drag behavior
            
+
            
+
              
+
            • On each Classic NC File Command:
+
+
              • 
+
            • The horizontal auto scroll bar is required.
              • 
+
            
+
            • 
+
          
+
          • 
+
        • Output Tab
+
            
+
          • Output Shot Files Tab
+
+
            • 
+
          • Output Step Files Tab
+
              
+
            • Enable Write Step Files CheckBox
+
+
              • 
+
            • Step File Template Label
              • 
+
            • Step File Template Text Field
+
                
+
              • The model is StepFileTemplate.
                • 
+
              • Default value: “Output/[NcName].step.csv”
                • 
+
              
+
              • 
+
            • Apply one line layout to the label and the text field.
              • 
+
            
+
            • 
+
          • Optimization Files Tab
+
+
            • 
+
          
+
          • 
+
        • Geometry Difference Tab
+
            
+
          • Enable Geom Diff CheckBox
+
+
            • 
+
          • Geom Diff Detect Radius (mm) Number Field
+
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
      Use Disabled Style if the section key checkbox is not checked.
      
+
      
+
      
+
      Tip
      
+
      The file templates support placeholder [NcName] which will be replaced with actual NC program name.
      
+
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mission/SimpleSessionCommandPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/index.html
new file mode 100644
index 00000000..d01447a8
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/index.html
@@ -0,0 +1,174 @@
+
+
+  
+    
+      Mission Page | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Mission Page
      
+
+
+
      Layout
      
+
        
+
      • Mission Page
+
          
+
        • Head Line
+
            
+
          • Object Management Menu Button
+
              
+
            • file extension is ShellCommand
              • 
+
            • The pointed Editor Panel is Mission Edit Panel
              • 
+
            
+
            • 
+
          • Mission Type Selection Section
+
              
+
            • Mission Type Label
              • 
+
            • Mission Type ComboBox
              • 
+
            
+
            • 
+
          
+
          • 
+
        • Mission Edit Panel
+
            
+
          • Content depends on the Mission Type Selection.
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      Mission Type Selection ComboBox
      
+
      The options:
      
+
+
      Step by Step Building Guide
      
+
        
+
      1. create the Mission Page window and Mission Page panel.
        2. 
+
      2. build the options panel and set into the Mission Page panel.
+
          
+
        1. Build List Command Panel.
          2. 
+
        2. Build Script Command Panel.
          3. 
+
        
+
        3. 
+
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mission/MissionWindow
        • 
+
      • Mission/MissionPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/script-command-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/script-command-panel.html
new file mode 100644
index 00000000..9ff18f23
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/mission/script-command-panel.html
@@ -0,0 +1,135 @@
+
+
+  
+    
+      Script Command Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Script Command Panel
      
+
+
      The key model is ScriptCommand.
      
+
      Layout
      
+
        
+
      • Head Line
+
          
+
        • Script Title Label
          • 
+
        • Script Title Text Field
          • 
+
        
+
        • 
+
      • C# Rich Text Editor Area
+
+
        • 
+
      
+
      WPF Application Source Code Path
      
+
        
+
      • Mission/ScriptCommandPanel
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/index.html
new file mode 100644
index 00000000..a909e20b
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/index.html
@@ -0,0 +1,167 @@
+
+
+  
+    
+      Player Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Player Panel
      
+
+
      The model of the player panel is MachiningProject and UserEnv.
      
+
      Step by Step Program Construction Check List
      
+
        
+
      1. Create the Player Panel Layout and set Player Panel/RenderingCanvas.
        2. 
+
      2. Set behavior of RenderingCanvas.
        3. 
+
      3. Create Player Tool Bar.
        4. 
+
      4. Create layout of Player extended RenderingCanvas Tool Bar.
        5. 
+
      5. Complete Behavior of Navigation Menu/Player on the Main Panel.
        6. 
+
      6. Build behavior of Player extended RenderingCanvas Tool Bar
+
          
+
        1. Set behavior of Behavior of CL Strip Buttons and Fit View Button.
          2. 
+
        2. Set behavior of Behavior of Project Rendering Items DropDown.
          3. 
+
        3. Set notification to Player extended RenderingCanvas Tool Bar if project changed by Main Panel.
          4. 
+
        
+
        7. 
+
      7. Set Player Panel as default panel on Page Panel when open the main window. The related toolbar has to be set, too.
        8. 
+
      8. Build Session Message Panel.
        9. 
+
      9. Build Step Present Preference Page
        10. 
+
      10. Build Selected-Step Info Panel
        11. 
+
      
+
      Belonged Tool Bars
      
+
+
      Layout of Player Panel
      
+
+
      Behavior of Player Panel/RenderingCanvas
      
+
      On initializing, create MachiningProjectDisplayee and set it to RenderingCanvas.DispEngine.Displayee. The MachiningProjectDisplayee constructor argument is from the model MachiningProject from Player Panel.
      
+
      Dispose RenderingCanvas on Player Panel disposing.
      
+
      Source Code Path and Specification
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Play/PlayerPanel
        • 
+
      
+
      Webapi Application Source Code Path
      
+
        
+
      • wwwroot/player/player-panel.js
        • 
+
      • Controller/Player/PlayerController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html
new file mode 100644
index 00000000..a0cb3238
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html
@@ -0,0 +1,157 @@
+
+
+  
+    
+      Player extended RenderingCanvas Tool Bar | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Player extended RenderingCanvas Tool Bar
      
+
+
      The model of the tool bar is DispEngine which is assigned from the RenderingCanvas of Player Panel.
      
+
      The content of DispEngine.Displayee here is MachiningProjectDisplayee. the key content of the MachiningProjectDisplayee is MachiningProject.
      
+
      The sub-model is MachiningProjectDisplayee and MachiningProject.
      
+
      Layout
      
+
        
+
      • Player extended RenderingCanvas Tool Bar
+
          
+
        • Show CL Strip Button
          • 
+
        • Show CL Strip Dots Button
+Only editable if the ClStrip in RenderingFlagBitArray is true.
          • 
+
        • Fit View Button
          • 
+
        • Rendering Items SubMenu
+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.
+Create the submenu component class since the other GUI component also use it. See controller page
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
      checkboxs in Project Rendering Items SubMenu can be classified by the category of RenderingFlag (see the hyperlink for the categories).
      
+
      
+
      Behavior of CL Strip Buttons and Fit View Button
      
+
      Apply RenderingFlagBitArray to set the Project Rendering Items.
      
+
      
+
      Tip
      
+
      Extract the MachiningProject From the MachiningProjectDisplayee and use it to set the behaviors.
      
+
      
+
      Behavior of Project Rendering Items DropDown
      
+
      See DemoRenderingMachiningProcessAndStripPosSelection for the sample code to complete the behavior of the buttons.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Play/PlayerExtendedRenderingCanvasToolBar
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/player-extended-toolbar.js
        • 
+
      • Controller/Player/PlayerController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/player-tool-bar.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/player-tool-bar.html
new file mode 100644
index 00000000..995b2a59
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/player-tool-bar.html
@@ -0,0 +1,387 @@
+
+
+  
+    
+      Player Tool Bar | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Player Tool Bar
      
+
+
      Layout
      
+
        
+
      • Player Tool Bar
+
          
+
        • Status Text Field
          • 
+
        • Start Button
          • 
+
        • Pause Button
          • 
+
        • Run-One-Line Button
          • 
+
        • Run-One-Step Button
          • 
+
        • Stop Button
          • 
+
        • Reset Button
          • 
+
        
+
        • 
+
      
+
      Behavior of Player Tool Bar
      
+
      See the example code to:
      
+
        
+
      • complete the behavior of the buttons and Status Text Field.
        • 
+
      • The rapidly used buttons should has hotkey. At least the following buttons:
+
          
+
        • Run One Line Button
          • 
+
        • Run One Step Button
          • 
+
        • Start/Continue
          • 
+
        • Pause
          • 
+
        
+
        • 
+
      • Add and remove the event to the PacePlayer on Player Tool Bar initialization and finalization. The events update the Status Text Field.
        • 
+
      • Alter the background color of the Status Text Field if the status changed.
+
          
+
        • Warning style color
+
            
+
          • Running
            • 
+
          
+
          • 
+
        • Secondary style color
+
            
+
          • Paused
            • 
+
          • No Project
            • 
+
          
+
          • 
+
        • Success style color
+
            
+
          • Finished
            • 
+
          • Ready
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      The action of Reset Button should be async for user experience.
      
+
      
+
      Tip
      
+
      Use icon instead of text to the tool bar button. Run One Line Button and Run One Step Button use the same icon, use the different color to resolve them.
      
+
        
+
      • Run One Line Button > default color with green seasoned
        • 
+
      • Run One Step Button > default color with blue seasoned
        • 
+
      
+
      The other button use the default color is enough.
      
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Play/PlayerToolBar
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/player/player-tool-bar.js
        • 
+
      • Controller/Player/PlayerController.cs
        • 
+
      
+
      Razor Page Source Code
      
+
      @using Hi.Common.PathUtils;
+@using Hi.HiNcKits;
+@using Hi.MachiningProcs
+@using Hi.MillingProcs;
+@using Hi.Numerical.FilePlayers;
+@inject HiNcHost hiNcHost
+
+@{
+    MachiningProject machiningProject = hiNcHost.MachiningProject;
+    bool disabledByMachiningProject = machiningProject == null;
+}
+
+<div class="btn-group" role="group">
+    <div class=" btn-group"
+         data-bs-toggle="collapse" data-bs-target="#player-@Tid">
+        <button class="btn btn-outline-info text-nowrap "
+                disabled="@disabledByMachiningProject"
+                data-bs-toggle="button">
+            <span class="me-1">@Loc["Player"]</span>
+            <div class="d-inline-block" style="width: 4rem">
+                @{
+                    if (machiningProject == null) { }
+                    else if (machiningProject.PacePlayer.IsRunning)
+                    {
+                        <span class="badge text-bg-warning">@Loc["Running"]</span>
+                    }
+                    else if (machiningProject.PacePlayer.IsLocked)
+                    {
+                        <span class="badge text-bg-secondary">@Loc["Pause"]</span>
+                    }
+                    else if (machiningProject.PacePlayer.IsFinished)
+                    {
+                        <span class="badge text-bg-success">@Loc["Finish"]</span>
+                    }
+                    else
+                    {
+                        <span class="badge text-bg-primary">@Loc["Unlocked"]</span>
+                    }
+                }
+            </div>
+        </button>
+    </div>
+
+    <div id="player-@Tid" class="btn-group collapse collapse-horizontal show" role="group">
+
+        @if (machiningProject == null) { }
+        else if (!machiningProject.PacePlayer.IsLocked)
+        {
+            <button class="btn btn-primary text-nowrap" title="@Loc["Start"] (S)"
+                    accesskey="s"
+                    disabled="@(disabledByMachiningProject||machiningProject.PacePlayer.IsFinished)"
+                    @onclick="StartOrContinue">
+                <span class="oi oi-media-play me-1"></span>
+            </button>
+        }
+        else
+        {
+            <button class="btn btn-primary text-nowrap" title="@Loc["Continue"] (S)"
+                    accesskey="s"
+                    @onclick="StartOrContinue"
+                    disabled="@(disabledByMachiningProject||machiningProject.PacePlayer.IsFinished||machiningProject.PacePlayer.IsRunning)">
+                <span class="oi oi-media-play me-1"></span>
+            </button>
+        }
+        <button class="btn btn-primary text-nowrap" title="@Loc["Pause"] (P)"
+                accesskey="p"
+                @onclick="Pause"
+                disabled="@(disabledByMachiningProject||!machiningProject.PacePlayer.IsRunning)">
+            <span class="oi oi-media-pause me-1"></span>
+        </button>
+        <button class="btn btn-primary text-nowrap" title="@Loc["Run One Line"] (L)"
+                accesskey="l"
+                @onclick="RunToLineEnd"
+                disabled="@(disabledByMachiningProject||machiningProject.PacePlayer.IsFinished)">
+            <span class="oi oi-media-step-forward me-1"></span>
+        </button>
+
+        <button class="btn btn-primary text-nowrap" title="@Loc["Run One Step"] (K)"
+                accesskey="k"
+                @onclick="RunToNextPace"
+                disabled="@(disabledByMachiningProject||machiningProject.PacePlayer.IsFinished)">
+            <CommonRcl.Shared.CombinedIcon>
+                <IconA>
+                    <span class="oi oi-media-step-forward me-1"></span>
+                </IconA>
+                <IconB>
+                    <span class="badge rounded-pill bg-primary-subtle text-primary-emphasis">
+                        step
+                    </span>
+                </IconB>
+            </CommonRcl.Shared.CombinedIcon>
+        </button>
+
+        <button class="btn btn-primary text-nowrap" title="@Loc["Break"]"
+                @onclick="@Break"
+                disabled="@(disabledByMachiningProject||!(machiningProject.PacePlayer.IsLocked||machiningProject.PacePlayer.IsFinished))">
+            <span class="oi oi-media-stop me-1"></span>
+        </button>
+
+        <button class="btn btn-primary text-nowrap" title="@Loc["Reset"]"
+                disabled="@disabledByMachiningProject"
+                @onclick="Reset">
+            <span class="bi bi-backspace"></span>
+        </button>
+    </div>
+</div>
+
+
      using Hi.Common;
+using Hi.MachiningProcs;
+using Hi.Parallels;
+using Microsoft.AspNetCore.Components;
+
+namespace HiNcRcl.Areas.Player
+{
+    public partial class PlayerButtonGroup : IAsyncDisposable
+    {
+        [Parameter]
+        public string Tid { set; get; } = System.Guid.NewGuid().ToString();
+        StringLocalizer Loc { get; } = new StringLocalizer(typeof(PlayerDiv));
+        SemaphoreSlim DisposeSemaphore { get; } = new SemaphoreSlim(1);
+        MachiningProject MachiningProject => hiNcHost.MachiningProject;
+        bool disposedValue = false;
+        /// <inheritdoc/>
+        protected override async Task OnAfterRenderAsync(bool firstRender)
+        {
+            base.OnAfterRender(firstRender);
+            if (firstRender)
+            {
+                using var _ = await DisposeSemaphore.EmbraceAsync();
+                if (disposedValue) return;
+                var machiningProject = MachiningProject;
+                if (machiningProject != null)
+                {
+                    machiningProject.PacePlayer.IsLockedChangedEvent
+                        += EnumerablePlayer_IsLockedEventHandler;
+                    machiningProject.PacePlayer.IsRunningChangedEvent
+                        += EnumerablePlayer_IsLockedEventHandler;
+                    machiningProject.PacePlayer.IsFinishedChangedEvent
+                        += EnumerablePlayer_IsLockedEventHandler;
+                }
+            }
+        }
+
+        /// <inheritdoc/>
+        public async ValueTask DisposeAsync()
+        {
+            using var _ = await DisposeSemaphore.EmbraceAsync();
+            var machiningProject = MachiningProject;
+            if (machiningProject != null)
+            {
+                machiningProject.PacePlayer.IsLockedChangedEvent
+                    -= EnumerablePlayer_IsLockedEventHandler;
+                machiningProject.PacePlayer.IsRunningChangedEvent
+                    -= EnumerablePlayer_IsLockedEventHandler;
+                machiningProject.PacePlayer.IsFinishedChangedEvent
+                    -= EnumerablePlayer_IsLockedEventHandler;
+            }
+            disposedValue = true;
+            await ValueTask.CompletedTask;
+        }
+
+        private void EnumerablePlayer_IsLockedEventHandler(bool obj)
+        {
+            InvokeAsync(StateHasChanged).ConfigureAwait(false);
+        }
+        public void StartOrContinue()
+        {
+            if (!MachiningProject.PacePlayer.IsLocked)
+            {
+                MachiningProject.PacePlayer.Start();
+            }
+            else if (!MachiningProject.PacePlayer.IsRunning
+            && !MachiningProject.PacePlayer.IsFinished)
+            {
+                MachiningProject.PacePlayer.Resume();
+            }
+        }
+        public void Pause()
+        {
+            MachiningProject?.PacePlayer.Pause();
+        }
+        public void RunToLineEnd()
+        {
+            MachiningProject?.NcRunner.RunToLineEnd();
+        }
+        public void RunToNextPace()
+        {
+            MachiningProject?.PacePlayer.RunToNextPace();
+        }
+        public void Break()
+        {
+            MachiningProject?.PacePlayer.Terminate();
+        }
+        public async Task Reset()
+        {
+            await Task.Run(() => {
+                MachiningProject?.PacePlayer.Reset();
+            }).ShowIfCatched(this);
+        }
+    }
+}
+
      
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/selected-step-info-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/selected-step-info-panel.html
new file mode 100644
index 00000000..166bbcd1
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/player/selected-step-info-panel.html
@@ -0,0 +1,146 @@
+
+
+  
+    
+      Selected-Step Info Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Selected-Step Info Panel
      
+
+
      The panel locates on the Player Panel.
      
+
      The model is MachiningStep and UserEnv.
      
+
      The MachiningStep is assigned by ClStrip.PosSelected.
      
+
      Show step infomation from UserEnv.DisplayedStepPresentAccessList.
      
+
      The resx of MachiningStep contains the translation of PresentAttribute.Name, apply the translation to the GUI. If the translation not existed, use the original value.
      
+
      See Also Step Present Preference Page.
      
+
      Sample Code
      
+
      Refer the code to show step infomation.
      
+
      internal static void ShowStepPresent(
+    UserEnv userEnv, MachiningStep machiningStep)
+{
+    foreach (var entry in userEnv.DisplayedStepPresentAccessList)
+    {
+        var present = entry.Value.Present;
+        var valueText = string.Format("{0:" + present.DataFormatString + "}", entry.Value.GetValueFunc.Invoke(machiningStep));
+        Console.WriteLine($"{present.ShortName}: {valueText} {present.TailUnitString} ({present.Name} [{entry.Key}])");
+    }
+}
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Play/SelectedStepInfoPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/selected-step-info-panel.js (Vue component)
        • 
+
      • wwwroot/selected-step-info-panel.css (Styles)
        • 
+
      • Controllers/PlayerController.cs (REST API)
        • 
+
      • Hubs/PlayerHub.cs (SignalR Hub for real-time updates)
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/graphic-cache-dropdown.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/graphic-cache-dropdown.html
new file mode 100644
index 00000000..d3db7b30
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/graphic-cache-dropdown.html
@@ -0,0 +1,141 @@
+
+
+  
+    
+      Graphic-Cache SubMenu | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Graphic-Cache SubMenu
      
+
+
      The submenu locates on the Preference Menu Dropdown.
      
+
      The model UserEnv is from its parent component.
      
+
      Layout
      
+
        
+
      • Graphic-Cache SubMenu
+
          
+
        • Graphic-Cache Lower Limit Input Text Field
          • 
+
        • Graphic-Cache Upper Limit Input Text Field
          • 
+
        • Graphic-Cache Input Text Field
          • 
+
        • Graphic-Cache Slider
          • 
+
        
+
        • 
+
      
+
      Behavior
      
+
      Graphic-Cache Input Text Field and Graphic-Cache Slider bind the UserConfig.GraphicCacheMb. The limit text fields also bind to the properties of UserConfig.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • MainWindow (be included in preference menu)
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/preference/preference-menu.js
        • 
+
      • Controller/Preference/PreferenceController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/index.html
new file mode 100644
index 00000000..12992e79
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/index.html
@@ -0,0 +1,151 @@
+
+
+  
+    
+      Preference Menu Dropdown | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Preference Menu Dropdown
      
+
+
      The model of the UI is UserEnv.
+UserEnv contains UserConfig, which is rapidly used in the GUI.
      
+
      The dropdown is on the Main Panel.
      
+
      Layout
      
+
+
      Single User Application
      
+
      In single user application, access global UserEnv and UserConfig by the LocalApp.
      
+
      Apply LocalApp.SaveUserConfig() or LocalApp.LooseSaveUserConfig() (save config in Loose Manner) if config changed.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • MainWindow (include preference menu)
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/preference/preference-menu.js
        • 
+
      • Controller/Preference/PreferenceController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/language-selection-submenu.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/language-selection-submenu.html
new file mode 100644
index 00000000..f4249165
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/language-selection-submenu.html
@@ -0,0 +1,143 @@
+
+
+  
+    
+      Language Selection SubMenu | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Language Selection SubMenu
      
+
+
      The submenu locates on the Preference Menu Dropdown.
      
+
      The model UserEnv is from its parent component.
      
+
      Load the language preference on application start.
      
+
      
+
      Note
      
+
      Keep language resource on each UI componenets.
      
+
      
+
      Layout
      
+
        
+
      • Language Selection SubMenu
+
          
+
        • English Radio CheckBox
          • 
+
        • Simlified Chinese Radio CheckBox
          • 
+
        • Traditional Chinese Radio CheckBox
          • 
+
        
+
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • MainWindow (In the preference menu)
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/preference/preference-menu.js
        • 
+
      • Controller/Preference/PreferenceController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/step-present-preference-page.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/step-present-preference-page.html
new file mode 100644
index 00000000..42d7722e
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/preference/step-present-preference-page.html
@@ -0,0 +1,489 @@
+
+
+  
+    
+      Step Present Preference Page | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Step Present Preference Page
      
+
+
      The model UserEnv is from its parent component. The UserEnv.UserConfig is rapidly used.
      
+
      The model of Candidate Keys Panel is CandidateStepPresentKeyList.
+The model of Displayed Keys Panel is DisplayedStepPresentKeyList.
      
+
      Layout
      
+
        
+
      • Step Present Preference Page (or window)
+
          
+
        • Candidate Keys Panel
+
            
+
          • Category A Panel
+
              
+
            • Key a ToggleButton
              • 
+
            • Key b ToggleButton
              • 
+
            • ...
              • 
+
            
+
            • 
+
          • Category B Panel
+
              
+
            • ...
              • 
+
            
+
            • 
+
          • ...
            • 
+
          • Category Other Panel
            • 
+
          
+
          • 
+
        • Displayed Keys Panel
+
            
+
          • Key 1
            • 
+
          • Key 2
            • 
+
          • ...
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      The categories are not defined for programming logic but only for user experience. So decide and define the categories in the GUI here only.
      
+
      Since the Keys are not all come from the properties of MachiningStep, a category panel (Category Other Panel) for the uncategoried keys is required.
      
+
      The keys in the Displayed Keys Panel is in sequence of DisplayedStepPresentKeyList. User tune the sequence and remove key by the Displayed Keys Panel. User add and remove the key from the ToggleButtons in Candidate Keys Panel. Those UI control items are required.
      
+
      To both Candidate Keys Panel and Displayed Keys Panel:
+Apply PresentAttribute.Name as Key label by StepPresentAccessDictionary. Apply the key to the button tooltip.
      
+
      The resx of MachiningStep contains the translation of PresentAttribute.Name, apply the translation to the GUI. If the translation not existed, use the original value.
      
+
      Categories
      
+
      Refer the code to design Categories:
      
+
      @using Hi.Common
+@using Hi.Geom
+@using Hi.Mech.Topo
+@{
+    string pCalss = "d-flex flex-wrap gap-2";
+    string cardTextClass = $"card-text {pCalss}";
+}
+
+<div class="card" style="overflow-y: hidden; height:100%; ">
+    <div style="overflow-y: scroll; ">
+        <div style="height: auto">
+            <div class="card-header py-0" data-bs-toggle="collapse" data-bs-target="#fileLineFlagTime-@Tid">@Loc["File"] / @Loc["Command"] / @Loc["Flag"] / @Loc["Time"] / @Loc["System"]</div>
+            <div class="collapse show " id="fileLineFlagTime-@Tid">
+                <div class="card-body ">
+                    <div class="@cardTextClass">
+                        <div class="w-auto" title="@Loc["File No."] : @Loc["Line No."]">
+                            <span class="form-label">@Loc["F.L.No."]</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.FileNo : @MillingStep?.LineNo</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["File"]</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.FilePath</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Accumulated Time"]</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.AccumulatedTime.ToString("G"))</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Line Text"]</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.LineText</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Flags"]</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.FlagsText</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Step Index"]</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.StepIndex</span>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="card-header py-0" data-bs-toggle="collapse" data-bs-target="#toolFeedrateSpindleSpeed-@Tid">@Loc["Tool"] / @Loc["Feedrate"] / @Loc["Spindle Speed"]</div>
+            <div class="collapse show " id="toolFeedrateSpindleSpeed-@Tid">
+                <div class="card-body ">
+                    <div class="@cardTextClass">
+                        <div class="w-auto" title="@Loc["Tool ID"]">
+                            <span class="form-label">@Loc["T"]</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.ToolId</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["S"] (rpm)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.SpindleSpeed_rpm.ToString("G5"))</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["F"] (mm/min)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.Feedrate_mmdmin.ToString("G5"))</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Feed per Tooth"] (mm)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.FeedPerTooth_mm.ToString("G5"))</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Feed per Cycle"] (mm)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.FeedPerCycle_mm.ToString("G5"))</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Tooth Arc Duration"] (s)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.ToothArcDuration_s.ToString("G4"))</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Spindle Cycle Period"] (s)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.SpindleCyclePeriod_s.ToString("G4"))</span>
+                        </div>
+                        <div class="w-auto">
+                            <span class="form-label">@Loc["Cutting Speed"] (mm/s)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.CuttingSpeed_mmds?.ToString("G4"))</span>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="card-header py-0" data-bs-toggle="collapse" data-bs-target="#coordinateAndMove-@Tid">@Loc["Coordinate"] / @Loc["Move"]</div>
+            <div class="collapse show " id="coordinateAndMove-@Tid">
+                <div class="card-body ">
+                    <div class="@cardTextClass">
+                        <p class="@pCalss">
+                            @{
+                                var mcCodes = HostMachiningProject?.MachiningEquipment?.GetMachiningChain()?.McCodes;
+                                if (mcCodes != null)
+                                {
+                                    var mcTransformers = HostMachiningProject
+                                    ?.MachiningEquipment?.GetMachiningChain()?.McTransformers;
+                                    for (int i = 0; i < mcCodes.Length; i++)
+                                    {
+                                        if (mcTransformers[i] == null)
+                                            continue;
+                                        if (mcTransformers[i] is DynamicRotation)
+                                        {
+                                            <div class="w-auto" title="@Loc["Machine Coordinate"] @mcCodes[i] (deg)">
+                                                <span class="form-label">MC.@mcCodes[i] (deg)</span>
+                                                <span class="form-control readonly w-auto">
+                                                    @MillingStep?.GetMcValue(i)?.SelfInvoke(v => MathUtil.ToDeg(v)).ToString("F5")
+                                                </span>
+                                            </div>
+                                        }
+                                        else
+                                        {
+                                            <div class="w-auto" title="@Loc["Machine Coordinate"] @mcCodes[i] (mm)">
+                                                <span class="form-label">MC.@mcCodes[i] (mm)</span>
+                                                <span class="form-control readonly w-auto">
+                                                    @MillingStep?.GetMcValue(i)?.ToString("F5")
+                                                </span>
+                                            </div>
+                                        }
+                                    }
+                                }
+                            }
+                        </p>
+                        <div class="w-auto" title="@Loc["Cutter Location Point"]">
+                            <span class="form-label">CL.XYZ (mm)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.Cl?.Point?.ToString("F5"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Cutter Location Normal"]">
+                            <span class="form-label">CL.IJK</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.Cl?.Normal?.ToString("F5"))</span>
+                        </div>
+                        @{
+                            var moveDirection = MillingStep?.MoveOnProgramCoordinate.GetNormalized();
+                            <div class="w-auto" title="@Loc["Move Direction"] (@Loc["Workpiece Coordinate"])">
+                                <span class="form-label">@Loc["Move Direction"] [W]</span>
+                                <span class="form-control readonly w-auto">@(moveDirection?.ToString("F4"))</span>
+                            </div>
+                        }
+                    </div>
+                </div>
+            </div>
+            <div class="card-header py-0" data-bs-toggle="collapse" data-bs-target="#gcgr-@Tid">@Loc["Cutting Geometry"] / @Loc["Chip"] / @Loc["Bias"] / @Loc["Roughness"]</div>
+            <div class="collapse show " id="gcgr-@Tid">
+                <div class="card-body ">
+                    <div class="@cardTextClass">
+                        <div class="w-auto" title="@Loc["Is Touched"]">
+                            <span class="form-label">@Loc["Is Touched"]</span>
+                            <span class="form-control readonly w-auto">@Loc[(MillingStep?.IsTouched)?.ToString()]</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Cutting Width"]">
+                            <span class="form-label">ae (mm)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.CuttingWidth_mm.ToString("G3"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Cutting Depth"]">
+                            <span class="form-label">ap (mm)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.CuttingDepth_mm.ToString("G3"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Material Removal Rate"]">
+                            <span class="form-label">MRR (mm<sup>3</sup>/s)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.Mrr_mm3ds.ToString("G3"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Chip Thickness"]">
+                            <span class="form-label">@Loc["Chip Thickness"] (um)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.ChipThickness_um?.ToString("G3"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Chip Volume"]">
+                            <span class="form-label">@Loc["Chip Volume"] (mm<sup>3</sup>)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.ChipVolume_mm3?.ToString("G3"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Chip Mass"]">
+                            <span class="form-label">@Loc["Chip Mass"] (mg)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.ChipMass_mg?.ToString("G3"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Program Side Cusp"]">
+                            <span class="form-label">@Loc["Program Side Cusp"] (um)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.ProgramSideCusp_um.ToString("G4"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Re-Cut Depth"]">
+                            <span class="form-label">@Loc["Re-Cut Depth"] (um)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.ReCutDepth_um.ToString("G4"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Delta Tip Deflection"] (@Loc["Tool Running Coordinate"])">
+                            <span class="form-label">@Loc["Delta Tip Deflection"] [TR] (um)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.DeltaTipDeflectionOnToolRunningCoordinate_um?.ToString("G3"))</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Max Tip Deflection"] (@Loc["Tool Running Coordinate"])">
+                            <span class="form-label">@Loc["Max Tip Deflection"] [TR] (um)</span>
+                            <span class="form-control readonly w-auto">@(MillingStep?.MaxTipDeflectionOnToolRunningCoordinate_um?.ToString("G3"))</span>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="card-header py-0" data-bs-toggle="collapse" data-bs-target="#phe-@Tid">
+                @Loc["Mechanics"] / @Loc["Power"] / @Loc["Energy"]
+            </div>
+            <div class="collapse show " id="phe-@Tid">
+                <div class="card-body ">
+                    <div class="@cardTextClass">
+                        <div class="w-auto" title="@Loc["Max Force"]">
+                            <span class="form-label">@Loc["Max Force"] (N)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.MaxAbsForce_N?.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Max Force"] (@Loc["Tool Running Coordinate"])">
+                            <span class="form-label">@Loc["Max Force"] [TR] (N)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.MaxForceOnToolRunningCoordinate_N?.ToString("G4")</span>
+                        </div>
+
+                        <div class="w-auto" title="@Loc["Average Moment about Sensor"] (@Loc["Spindle Rotation Coordinate"])">
+                            <span class="form-label">@Loc["Avg Moment about Sensor"] [SR] (Nm)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.AvgMomentAboutSensor_Nm?.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Average Absolute Moment about Sensor"] (@Loc["Spindle Rotation Coordinate"])">
+                            <span class="form-label">@Loc["Avg Abs Moment about Sensor"] [SR] (Nm)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.AvgAbsMomentAboutSensorVec3d_Nm?.ToString("G4")</span>
+                        </div>
+
+                        <div class="w-auto" title="@Loc["Thermal Stress"]">
+                            <span class="form-label">@Loc["Thermal Stress"] (MPa)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.ThermalStress_MPa?.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Workpiece Plastic Depth"]">
+                            <span class="form-label">@Loc["Workpiece Plastic Depth"] (um)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.WorkpiecePlasticDepth_um.ToString("G4")</span>
+                        </div>
+
+                        <div class="w-auto" title="@Loc["Spindle Input Power"]">
+                            <span class="form-label">@Loc["Spindle Input Power"] (W)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.SpindleInputPower_W.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Spindle Output Power"]">
+                            <span class="form-label">@Loc["Spindle Output Power"] (W)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.SpindleOutputPower_W.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Accumulated Spindle Energy Consumption From Spindle Input Power"]">
+                            <span class="form-label">@Loc["Accumulated Spindle Energy Consumption"] (kWh)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.AccumulatedSpindleEnergyConsumption_kWh.ToString("G6")</span>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="card-header py-0" data-bs-toggle="collapse" data-bs-target="#tw-@Tid">@Loc["Temperature"] / @Loc["Wear"]</div>
+            <div class="collapse show " id="tw-@Tid">
+                <div class="card-body ">
+                    <div class="@cardTextClass">
+                        <div class="w-auto" title="@Loc["Chip Temperature"]">
+                            <span class="form-label">@Loc["Chip Temperature"] (<sup>o</sup>C)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.ChipTemperature_C?.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Cutter Dermis Temperature"]">
+                            <span class="form-label">@Loc["Cutter Dermis Temperature"] (<sup>o</sup>C)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.CutterDermisTemperature_C?.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Cutter Body Temperature"]">
+                            <span class="form-label">@Loc["Cutter Body Temperature"] (<sup>o</sup>C)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.CutterBodyTemperature_C?.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Workpiece Dermis Temperature"]">
+                            <span class="form-label">@Loc["Workpiece Dermis Temperature"] (<sup>o</sup>C)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.WorkpieceDermisTemperature_C?.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Instant Crater Wear"]">
+                            <span class="form-label">@Loc["Instant Crater Wear"] (um)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.InstantCraterWear_um?.ToString("G3")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Accumulated Crater Wear"]">
+                            <span class="form-label">@Loc["Accumulated Crater Wear"] (um)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.AccumulatedCraterWear_um.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Accumulated Flank Wear Depth"]">
+                            <span class="form-label">@Loc["Accumulated Flank Wear Depth"] (um)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.AccumulatedFlankWearDepth_um.ToString("G4")</span>
+                        </div>
+                        <div class="w-auto" title="@Loc["Accumulated Flank Wear Width"]">
+                            <span class="form-label">VB (um)</span>
+                            <span class="form-control readonly w-auto">@MillingStep?.AccumulatedFlankWearWidth_um.ToString("G4")</span>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="card-header py-0" data-bs-toggle="collapse" data-bs-target="#custom-@Tid">@Loc["Custom"]</div>
+            <div class="collapse show " id="custom-@Tid">
+                <div class="card-body ">
+                    <div class="@cardTextClass">
+                        @{
+                            var flexDictionary=MillingStep?.FlexDictionary;
+                            if (flexDictionary != null)
+                            {
+                                foreach(var entry in flexDictionary)
+                                {
+                                    if(HostMachiningProject?.StepPropertyAccessDictionary.TryGetValue(
+                                        entry.Key, out var stepPropertyAccess)==true)
+                                    {
+                                        <div class="w-auto" title="@(stepPropertyAccess.PresentAttribute?.Name)">
+                                            <span class="form-label">@(stepPropertyAccess.PresentAttribute?.ShortName)</span>
+                                            <span class="form-control readonly w-auto">@(stepPropertyAccess.GetValueText(MillingStep))</span>
+                                        </div>
+                                    }
+                                    else
+                                    {
+                                        <div class="w-auto" title="@(entry.Key) (@Loc["Not Registered"])">
+                                            <span class="form-label">@(entry.Key)</span>
+                                            <span class="form-control readonly w-auto">@(entry.Value)</span>
+                                        </div>
+                                    }
+                                }
+                            }
+                        }
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+
      
+
      Refer the code to apply PresentAttribute.
      
+
      internal static void ShowStepPresent(
+    UserEnv userEnv, MachiningStep machiningStep)
+{
+    foreach (var entry in userEnv.DisplayedStepPresentAccessList)
+    {
+        var present = entry.Value.Present;
+        var valueText = string.Format("{0:" + present.DataFormatString + "}", entry.Value.GetValueFunc.Invoke(machiningStep));
+        Console.WriteLine($"{present.ShortName}: {valueText} {present.TailUnitString} ({present.Name} [{entry.Key}])");
+    }
+}
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Preference/StepPresentPreferenceWindow
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/preference/step-present-preference.js
        • 
+
      • Controller/Preference/PreferenceController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/renderingcanvas-tool-bar.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/renderingcanvas-tool-bar.html
new file mode 100644
index 00000000..3a1dd431
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/renderingcanvas-tool-bar.html
@@ -0,0 +1,152 @@
+
+
+  
+    
+      RenderingCanvas Tool Bar | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      RenderingCanvas Tool Bar
      
+
+
      The model of the RenderingCanvas Tool Bar is DispEngine.
      
+
      Layout and Behavior
      
+
        
+
      • View Buttons SubMenu
+
          
+
        • Front View Button
+Call DispEngine.SetViewToFrontView().
          • 
+
        • Back View Button
+Call DispEngine.SetViewToFrontView() and turn back the view by the code:
          DispEngine.SetViewToFrontView();
+DispEngine.TurnBackView();
+
          • 
+
        • Right View Button
+...(refer the instruction above)
          • 
+
        • Left View Button
+...
          • 
+
        • Top View Button
+...
          • 
+
        • Bottom View Button
+...
          • 
+
        • Isometric View Button
+...
          • 
+
        
+
        • 
+
      • (other RenderingCanvas tool bar item may be appended here)
        • 
+
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Disp/RenderingCanvasToolBar
        • 
+
      
+
      Webapi Application Source Code Path
      
+
        
+
      • wwwroot/disp/rendering-canvas-tool-bar.js
        • 
+
      • wwwroot/disp/rendering-canvas-tool-bar.css
        • 
+
      
+
      To build it, you can refer Hi.Sample.Webapi/wwwroot/disp/rendering-canvas-view-dropdown.js.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/session-message-panel/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/session-message-panel/index.html
new file mode 100644
index 00000000..00c757f5
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/session-message-panel/index.html
@@ -0,0 +1,200 @@
+
+
+  
+    
+      Session Message Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Session Message Panel
      
+
+
      The model is MachiningProject.SessionMessageHost.
      
+
      MachiningProject is assigned from the Player Panel.
      
+
      Layout
      
+
        
+
      • Top Message Filter ToolBar
+
          
+
        • Message Type Filter SubMenu
+
            
+
          • NC CheckBox
            • 
+
          • Progress CheckBox
            • 
+
          • Error CheckBox
            • 
+
          
+
          • 
+
        • Message Text Filter Input
+
            
+
          • Message Text Filter Input Text Area
            • 
+
          • Message Text Filter Reset Button
            • 
+
          
+
          • 
+
        • Export Button
          • 
+
        
+
        • 
+
      • Central Message Table
        • 
+
      
+
      Central Message Table
      
+
      The model of Central Message Table is SessionMessageHost.MessageCollection.
      
+
      Only take last 1000 filtered elements in the MessageCollection by GetFliteredList(FilterFlag, string) to show for user experience. Find the usage example in the code:
      
+
      internal static void DemoUseSessionMessageHost(MachiningProject project)
+{
+    SessionMessageHost sessionMessageHost = project.SessionMessageHost;
+
+    SessionMessageHost.FilterFlag filterFlags =
+        SessionMessageHost.FilterFlag.NC |
+        SessionMessageHost.FilterFlag.Progress |
+        SessionMessageHost.FilterFlag.Error;
+    string filterText = null;
+    var filteredSessionMessageList = sessionMessageHost
+        .GetFliteredList(filterFlags, filterText);
+
+    foreach (var sessionMessage in filteredSessionMessageList)
+    {
+        //M.I.: Message Index.
+        Console.Write($"M.I.: {sessionMessage.Index}; Role: {sessionMessage.MessageRoleText}");
+
+        // For SessionMessageHost.FilterFlag.NC
+        var nc = sessionMessage.DirectInstantSourceCommand;
+        if (nc != null)
+            Console.Write($"Message/NC: {nc.Line}; File: {nc.FilePath}; LineNo: {nc.GetLineNo()}; ");
+
+        // For SessionMessageHost.FilterFlag.Progress or Error.
+        var multiTagMessage = sessionMessage.MultiTagMessage;
+        if (multiTagMessage != null)
+            Console.WriteLine($"Message/NC: {multiTagMessage.Message}");
+        var exception = sessionMessage.Exception;
+        if (exception != null)
+            Console.WriteLine($"Message/NC: {exception.Message}");
+    }
+    File.WriteAllLines("output-session-messages.txt",
+        filteredSessionMessageList.Select(m =>
+        $"Msg[{m.Index}][{m.MessageRoleText}]: {m}"));
+}
+
      
+
      In the table, show the columns: Role, NC/Message.
      
+
      Add update table event to CollectionItemChanged. The updating process has to be called by Loose Manner for user experience.
      
+
      
+
      Tip
      
+
      On window desktop application (WPF), consider use textarea instead of datagrid to MessageTable for better performance. Use padding to show the different columns. And use the font in the textarea that with consistent width.
      
+
      
+
      
+
      Note
      
+
      The message display should be real-time.
      
+
      
+
      Behavior of Export Button
      
+
      Export ALL filtered elements in the MessageCollection by GetFliteredList(FilterFlag, string).
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Play/SessionMessagePanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/player-panel.js (include in Player Panel)
        • 
+
      • Controller/Player/PlayerController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/translation-remarks.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/translation-remarks.html
new file mode 100644
index 00000000..f10321fb
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/translation-remarks.html
@@ -0,0 +1,164 @@
+
+
+  
+    
+      Translation Remarks | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Translation Remarks
      
+
+
      The translation terminology and convention has to keep consistency.
      
+
        
+
      • Anchor 定位
        
+
        • 
+
      • Cutter 刀具
        
+
          
+
        • Insert Cutter 刀片式刀具
+
            
+
          • Insert 刀片
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Holder 刀把
        
+
          
+
        • Cylindroid Holder 柱狀刀把
          • 
+
        • Freeform Holder 任意形刀把
          • 
+
        
+
        • 
+
      • Shank 刀柄
        
+
        • 
+
      • Fixture 夾具
        
+
        • 
+
      • Milling Cutter 銑刀
        
+
        • 
+
      • Freeform Remover 任意移除工具
        
+
        • 
+
      • Flute 刀刃
        
+
          
+
        • Flute-Profile 刃包絡型
          • 
+
        • Flute-Contours 刃型
          • 
+
        • Flute-Inner-Beam 刃中芯
          • 
+
        
+
        • 
+
      • Upper-Beam 夾持柱
        
+
        • 
+
      • Integral Mode 組裝形式
        
+
          
+
        • Solid End 一體式
          • 
+
        • Insert End 刀片式
          • 
+
        
+
        • 
+
      • Preset 前設置
        
+
        • 
+
      • Runtime Geometry 運行時幾何
        
+
        • 
+
      • Machining Resolution 加工解析度
        
+
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/unused/machine-tool-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/unused/machine-tool-panel.html
new file mode 100644
index 00000000..1d811000
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/unused/machine-tool-panel.html
@@ -0,0 +1,123 @@
+
+
+  
+    
+      Machine Tool Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Machine Tool Panel
      
+
+
      Layout of Machine Tool Panel
      
+
        
+
      • Top Item: Load button and the Loaded Machine Tool File Name readonly textarea.
        • 
+
      • Central Panel: RenderingCanvas
        • 
+
      
+
      Behavior of Machine Tool Panel
      
+
      RenderingCanvas.Displayee is the machine tool (MachiningProject.MachiningEquipment.MachiningChain)
      
+
      Load button load the machine tool to MachiningProject.MachiningEquipment.MachiningChain and MachiningProject.MachiningEquipment.MachiningChainFile by XFactory.Default.GenByFile.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/unused/mission-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/unused/mission-panel.html
new file mode 100644
index 00000000..2833c0c5
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/unused/mission-panel.html
@@ -0,0 +1,400 @@
+
+
+  
+    
+      Mission Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Mission Panel
      
+
+
      The Mission Panel manages NC program loading, editing, and preparation for simulation in the geometry-only HiNC application.
      
+
      Panel Layout
      
+
        
+
      • Left side: NC Program Management Panel
        
+
          
+
        • Program Files Section
+
            
+
          • Load NC File button
            • 
+
          • New NC File button
            • 
+
          • List view of loaded NC programs
            • 
+
          • Remove button (to remove selected program)
            • 
+
          
+
          • 
+
        • Program Properties Section
+
            
+
          • File name and path display
            • 
+
          • Program description input field
            • 
+
          • Program size and line count display
            • 
+
          
+
          • 
+
        • Program Association Section
+
            
+
          • Tool mapping controls:
+
              
+
            • Dropdown to select T-code
              • 
+
            • Dropdown to select corresponding tool from Tool House
              • 
+
            • Apply Mapping button
              • 
+
            
+
            • 
+
          • Work offset mapping controls:
+
              
+
            • Dropdown to select work offset code (G54, G55, etc.)
              • 
+
            • X, Y, Z offset value inputs
              • 
+
            • Apply Offset button
              • 
+
            
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      • Right side: NC Program Editor/Viewer
        
+
          
+
        • Syntax-highlighted G-code editor
          • 
+
        • Line numbers
          • 
+
        • Save button
          • 
+
        • Validate button
          • 
+
        • Validation results display area
          • 
+
        • Show Toolpath Preview toggle button
          • 
+
        
+
        • 
+
      • Bottom: Toolpath Preview Panel (shown when preview is toggled on)
        
+
          
+
        • 3D view of the toolpath
          • 
+
        • Color-coded display based on operation type or feed rate
          • 
+
        • Basic camera controls
          • 
+
        
+
        • 
+
      
+
      Behavior
      
+
      Loading NC Program Files
      
+
      When the user clicks the Load NC File button:
      
+
        
+
      1. Open a file selection dialog showing NC files (*.nc, *.cnc, *.ngc, etc.)
        2. 
+
      2. After selection, validate the file format
        3. 
+
      3. Add the file to the list of NC programs
        4. 
+
      4. Display the file in the editor/viewer
        5. 
+
      5. Update program properties display
        6. 
+
      
+
      // Example code
+public void LoadNCFile(string filePath)
+{
+    if (File.Exists(filePath))
+    {
+        // Read and validate NC file
+        string programContent = File.ReadAllText(filePath);
+        
+        // Create a new program object
+        NCProgram program = new NCProgram
+        {
+            FilePath = filePath,
+            FileName = Path.GetFileName(filePath),
+            Content = programContent,
+            LineCount = programContent.Split('\n').Length,
+            FileSize = new FileInfo(filePath).Length
+        };
+        
+        // Add to the project's mission
+        machiningProject.MachiningMission.Programs.Add(program);
+        
+        // Update the NC program list view
+        UpdateProgramListView();
+        
+        // Select the newly added program
+        SelectProgram(program);
+        
+        // Display the program in the editor
+        LoadProgramIntoEditor(program);
+    }
+}
+
      
+
      Creating a New NC Program
      
+
      When the user clicks the New NC File button:
      
+
        
+
      1. Create a new empty NC program object
        2. 
+
      2. Add it to the list of programs
        3. 
+
      3. Load it into the editor with minimal template content
        4. 
+
      4. Allow the user to start editing
        5. 
+
      
+
      public void CreateNewNCProgram()
+{
+    // Create a basic template for a new NC program
+    string templateContent = "%\nO0001\n(NEW PROGRAM)\n\nG90 G40 G17\nG21 (MM)\n\n(PROGRAM BODY)\n\nM30\n%";
+    
+    // Create a new program object
+    NCProgram program = new NCProgram
+    {
+        FileName = "NewProgram.nc",
+        Content = templateContent,
+        LineCount = templateContent.Split('\n').Length,
+        IsNew = true
+    };
+    
+    // Add to the project's mission
+    machiningProject.MachiningMission.Programs.Add(program);
+    
+    // Update the NC program list view
+    UpdateProgramListView();
+    
+    // Select the newly added program
+    SelectProgram(program);
+    
+    // Display the program in the editor
+    LoadProgramIntoEditor(program);
+}
+
      
+
      Tool Mapping
      
+
      When the user sets up a tool mapping and clicks Apply Mapping:
      
+
        
+
      1. Extract the T-code from the selected dropdown
        2. 
+
      2. Get the corresponding tool from the Tool House based on the selection
        3. 
+
      3. Add or update the mapping in the mission's tool map
        4. 
+
      4. Update the display to show the active mapping
        5. 
+
      
+
      public void ApplyToolMapping(string tCodeStr, int toolHousePosition)
+{
+    if (int.TryParse(tCodeStr.Substring(1), out int tCode))
+    {
+        // Get the tool from the tool house
+        var tool = machiningProject.MachiningToolHouse[toolHousePosition];
+        if (tool != null)
+        {
+            // Update or add the mapping
+            machiningProject.MachiningMission.ToolMap[tCode] = toolHousePosition;
+            
+            // Update the display
+            UpdateToolMappingDisplay();
+        }
+    }
+}
+
      
+
      Work Offset Mapping
      
+
      When the user sets up a work offset and clicks Apply Offset:
      
+
        
+
      1. Extract the offset code (G54, G55, etc.)
        2. 
+
      2. Create a vector from the X, Y, Z input values
        3. 
+
      3. Add or update the offset in the mission's work offset map
        4. 
+
      4. Update the display to show the active offset
        5. 
+
      
+
      public void ApplyWorkOffset(string offsetCode, double x, double y, double z)
+{
+    // Create the offset vector
+    Vec3d offset = new Vec3d(x, y, z);
+    
+    // Update or add the mapping
+    machiningProject.MachiningMission.WorkOffsetMap[offsetCode] = offset;
+    
+    // Update the display
+    UpdateWorkOffsetDisplay();
+}
+
      
+
      Validating NC Program
      
+
      When the user clicks the Validate button:
      
+
        
+
      1. Parse the current program content in the editor
        2. 
+
      2. Check for syntax errors
        3. 
+
      3. Verify tool references against the tool map
        4. 
+
      4. Check for unsupported G/M codes
        5. 
+
      5. Display validation results in the results area
        6. 
+
      
+
      public void ValidateProgram()
+{
+    // Get the current content from the editor
+    string programContent = GetEditorContent();
+    
+    // Create a validator
+    NCProgramValidator validator = new NCProgramValidator(machiningProject);
+    
+    // Perform validation
+    ValidationResult result = validator.Validate(programContent);
+    
+    // Display results
+    ClearValidationResultsDisplay();
+    if (result.IsValid)
+    {
+        DisplayValidationSuccess("Program validation successful.");
+    }
+    else
+    {
+        foreach (var error in result.Errors)
+        {
+            DisplayValidationError(error);
+        }
+    }
+}
+
      
+
      Displaying Toolpath Preview
      
+
      When the user toggles the Show Toolpath Preview:
      
+
        
+
      1. If toggled on:
+a. Parse the NC program
+b. Generate a toolpath using the geometry-only simulation engine
+c. Render the toolpath in the preview panel
+d. Show the preview panel
        2. 
+
      2. If toggled off:
+a. Hide the preview panel
        3. 
+
      
+
      public void ToggleToolpathPreview(bool showPreview)
+{
+    if (showPreview)
+    {
+        // Get the current program
+        NCProgram program = GetSelectedProgram();
+        
+        // Generate toolpath (simplified for geometry-only)
+        Toolpath toolpath = ToolpathGenerator.GenerateFromNCProgram(
+            program.Content, 
+            machiningProject.MachiningMission.ToolMap,
+            machiningProject.MachiningMission.WorkOffsetMap,
+            machiningProject.MachiningEquipment);
+        
+        // Render the toolpath
+        RenderToolpathPreview(toolpath);
+        
+        // Show the preview panel
+        toolpathPreviewPanel.Visibility = Visibility.Visible;
+    }
+    else
+    {
+        // Hide the preview panel
+        toolpathPreviewPanel.Visibility = Visibility.Collapsed;
+    }
+}
+
      
+
      Data Structure
      
+
      The panel operates primarily on the MachiningMission of the MachiningProject:
      
+
      public class MachiningMission
+{
+    public List<NCProgram> Programs { get; set; } = new List<NCProgram>();
+    public Dictionary<int, int> ToolMap { get; set; } = new Dictionary<int, int>();
+    public Dictionary<string, Vec3d> WorkOffsetMap { get; set; } = new Dictionary<string, Vec3d>();
+    // Other mission-related properties
+}
+
+public class NCProgram
+{
+    public string FilePath { get; set; }
+    public string FileName { get; set; }
+    public string Content { get; set; }
+    public long FileSize { get; set; }
+    public int LineCount { get; set; }
+    public bool IsNew { get; set; }
+    public string Description { get; set; }
+    // Other program-related properties
+}
+
      
+
      Integration with Main Application
      
+
      The Mission Panel is activated when the user selects the Mission item in the Navigation Menu. It accesses and modifies the MachiningMission component of the current MachiningProject instance.
      
+
      When changes are made in this panel, the following notifications should be sent:
      
+
        
+
      1. ProgramListChanged - When programs are added or removed
        2. 
+
      2. ProgramContentChanged - When program content is edited
        3. 
+
      3. ToolMapChanged - When tool mappings are updated
        4. 
+
      4. WorkOffsetMapChanged - When work offsets are updated
        5. 
+
      
+
      These notifications allow other components (particularly the Player panel) to update their behavior accordingly when preparing for or executing the simulation.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/gui-file-path-assignment.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/gui-file-path-assignment.html
new file mode 100644
index 00000000..b2145f3e
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/gui-file-path-assignment.html
@@ -0,0 +1,158 @@
+
+
+  
+    
+      GUI File Path Assignment | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      GUI File Path Assignment
      
+
+
      See the remarks of MakeXmlSource(string, string, bool) to know the design pattern of file path treatment.
      
+
      if the assigned file path is descendent of the configuration directory, it is straight forward that set the baseDirectory to the configuration directory and apply relative path to relFile; if not, set baseDirectory to null and set relFile to absolute path.
      
+
      GUI that needs to assign file generally requires a code-behind BaseDirectory property as assistent model. The property is assigned by the parent model from the parent GUI.
      
+
      In most cases, the first BaseDirectory is the project directory if the project has assigned (created or loaded).
      
+
      Portability
      
+
      To maintain For the portability of project or the other folder-based unit, if the sub-item is loaded by absolute path outside the folder-based unit directory, redirect the saving path to the folder-based unit directory, i.e. the SubItemFile below.
      
+
      
+
      Note
      
+
      You have no need to do an additional action to create a duplicate in the folder-based unit directory. Since the file-writing pattern of MakeXmlSource(string, string, bool) create files when user call to save. In other perspective, if user does not call to save, the local duplicate should be created.
      
+
      
+
      The design pattern is usually saw in the HiAPI program, a object contains the properties:
      
+
        
+
      • object SubItem;
        • 
+
      • string SubItemFile;
        • 
+
      
+
      Then you should keep the Protability.
      
+
      File Path of Load Button and Save Button
      
+
      The genneral convention of the File Path of Load and Save is different by the single-user desktop application and web page application.
      
+
      
+
      Tip
      
+
      Always preserve an empty filter ( * . * ) for the browser.
      
+
      
+
      Single-User Desktop Application
      
+
      The default directory of the Save/Load button are generally:
      
+
        
+
      • System Default Directory or Project Directory (default, if not explicitly indicated)
+The initial directory is the project directory.
        • 
+
      • Resource Directory
+The path always point to <application path>/Resource/<classification> directory.
+The button label has to explicitly show ‘Load Resource’.
        • 
+
      
+
      The kinds of buttons are not exclusive, they can be existed on the same tool bar.
      
+
      If the selected file path is under the project directory, apply the relative path from the project, i.e. baseDirectory is project directory and relFile is the relative path.
      
+
      Web Page Application
      
+
      The default directory of the Save/Load button are generally:
      
+
        
+
      • Admin Directory
        • 
+
      • Project Directory
        • 
+
      • Resource Directory
        • 
+
      
+
      The Resource Directory and Project Directory are generally under the Admin Directory. And the admin directory is generally set in the appsettings.json file.
      
+
      Typical Action if exhibitionOnly false
      
+
      On IMakeXmlSource.MakeXmlSource(string, string, bool) with exhibitionOnly false, the argument (baseDirectory and relFile) should be the same from object's host (if exist) XML output function.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/object-management-menu-button.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/object-management-menu-button.html
new file mode 100644
index 00000000..3340abbd
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/object-management-menu-button.html
@@ -0,0 +1,211 @@
+
+
+  
+    
+      Object Management Menu Button | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Object Management Menu Button
      
+
+
      The menu button represent the target object with getter function and setter function. The target object generally is IMakeXmlSource.
      
+
      the target object with getter function and setter function is such like:
      
+
      object TargetObject{get=>TargetObjectGetter?.Invoke();set=>TargetObjectSetter?.Invoke(value);}
+Func<TargetObject> TargetObjectGetter{get;set;}
+Action<TargetObject> TargetObjectSetter{get;set;}
+
      
+
      The target object has the following functions:
      
+
+
      If the target object is not IMakeXmlSource, then the XML Editor Panel Mode should not appear. The other functions are still buildable.
      
+
      Don't use GenMode.Default on XFactory functions. Use GenMode.Rebase. Since GenMode.Default pass the inner exception silently.
      
+
      Layout
      
+
        
+
      • Object Management Menu Button
+
          
+
        • Load Button
          • 
+
        • Load Resource Button
          • 
+
        • Save As Button
          • 
+
        • (splitter)
          • 
+
        • Copy Button (with hotkey support if the Object Management Menu Button is focused)
          • 
+
        • Paste Button (with hotkey support if the Object Management Menu Button is focused)
          • 
+
        • (splitter)
          • 
+
        • GUI Ratio Button
          • 
+
        • XML Ratio Button
          • 
+
        
+
        • 
+
      
+
      
+
      Tip
      
+
        
+
      • Since the Object Management Menu Button has special meaning, use icon instead of text label.
        • 
+
      • Do not use icon on the other child buttons. The icons gains nothing but hard to keep style to the full application.
        • 
+
      • If the model is selected, show a different style (may be color) on the menu button.
        • 
+
      • The model should contain a ResourceDirectory property.
        • 
+
      • Do not show Load Resource Button if Resource directory not explicitly gave.
        • 
+
      
+
      
+
      Copy & Paste
      
+
        
+
      • Object Copy/Paste (i.e. Select/Set or Duplicated-Set)
+
          
+
        • Copy (i.e. Select)
+Set the model to UserEnv.SelectedItem.
          • 
+
        • Paste
+Set UserEnv.SelectedItem to the model.
+Set by reference is default. Apply Duplicated-Set if explicitly required.
          • 
+
        
+
        • 
+
      
+
      While a object is copied (selected) here, it can also be paste (drag) to:
      
+
+
      Show message when paste action success or failed. See Handle Message and Exception.
      
+
      If the data type is not matched, show the un-matched message.
      
+
      Editor Panel Mode Ratio Button
      
+
      The Editor Panel switched by the Editor Panel Mode Ratio Button.
      
+
      The BaseDirectory and RelFile properties should exist. Use the RelFile property if the object's host has the corresponding property like XXXFile.
      
+
      The Apply action should be well-set. Include SetFileDelegate from XFactory.Gen<T>(XElement, string, SetFileDelegate, GenMode, params object[]) function.
+The last argument should also be delivered by the host. So there must exist an property to pass the argument.
      
+
      XML Editor Panel Layout
      
+
        
+
      • XML Editor Panel
+
          
+
        • Cancel Button
          • 
+
        • Apply Button
          • 
+
        • XML TextArea
          • 
+
        
+
        • 
+
      
+
      Shows error message if the xml-parsing or object creation failed on XML Editor Panel Apply Button applied.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Common/ObjectManagementMenuButton
        • 
+
      
+
      see this page for git repository.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/polar-resolution-2d-panel.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/polar-resolution-2d-panel.html
new file mode 100644
index 00000000..af386be4
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/polar-resolution-2d-panel.html
@@ -0,0 +1,153 @@
+
+
+  
+    
+      Polar Resolution 2D Panel | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Polar Resolution 2D Panel
      
+
+
      The model is PolarResolution2d.
      
+
      Layout
      
+
        
+
      • Polar Resolution 2D Panel
+
          
+
        • Enable Custom Resolution CheckBox
+
            
+
          • enabled if host.model is not null.
            • 
+
          • set host.model to null if not enabled.
            • 
+
          
+
          • 
+
        • Linear Resolution (mm) Input Field
+
            
+
          • enabled if model not null
            • 
+
          
+
          • 
+
        • Angle Resolution (deg) Input Field
+
            
+
          • enabled if model not null
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      Feature
      
+
      There is a code-behind property to set visibility of Enable CheckBox.
      
+
      If the host.model is null, it may mean the resolution applied the default value.
      
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/PolarResolution2dPanel
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/widget/polar-resolution-2d-panel.js
        • 
+
      • Controller/Widget/WidgetController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/vec3d/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/vec3d/index.html
new file mode 100644
index 00000000..9d29c410
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/build-hinc/widget/vec3d/index.html
@@ -0,0 +1,601 @@
+
+
+  
+    
+      Vec3dControl Component | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      Vec3dControl Component
      
+
+
      Vec3dControl is a user control for Vec3d and display.
      
+
      Main Features
      
+
        
+
      1. Dual Input Modes
        
+
          
+
        • Standard Mode: Input X, Y, Z components separately
          • 
+
        • Text Mode: Input complete vector in text format
          • 
+
        
+
        2. 
+
      2. Vector Normalization
        
+
          
+
        • Normalization button (optional)
          • 
+
        • Button visibility controlled by ShowNormalizeButton property
          • 
+
        
+
        3. 
+
      
+
      Refer Sample Code
      
+
      <UserControl x:Class="HiNC_2025_win_desktop.Geom.Vec3dControl"
+             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
+             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
+             mc:Ignorable="d" 
+             d:DesignHeight="30" d:DesignWidth="200">
+    <Grid>
+        <Grid.ColumnDefinitions>
+            <ColumnDefinition Width="*"/>
+            <ColumnDefinition Width="*"/>
+            <ColumnDefinition Width="*"/>
+            <ColumnDefinition Width="Auto"/>
+            <ColumnDefinition Width="Auto"/>
+        </Grid.ColumnDefinitions>
+
+        <!-- Standard Mode Panel -->
+        <StackPanel x:Name="StandardModePanel" Orientation="Horizontal" Grid.ColumnSpan="5">
+            <TextBox x:Name="XTextBox" Width="60" Margin="0,0,2,0" TextChanged="XTextBox_TextChanged" IsReadOnly="{Binding IsReadOnly}"/>
+            <TextBox x:Name="YTextBox" Width="60" Margin="0,0,2,0" TextChanged="YTextBox_TextChanged" IsReadOnly="{Binding IsReadOnly}"/>
+            <TextBox x:Name="ZTextBox" Width="60" Margin="0,0,2,0" TextChanged="ZTextBox_TextChanged" IsReadOnly="{Binding IsReadOnly}"/>
+            <Button Content="{DynamicResource Vec3d_TextMode_Toggle}" Width="20" Click="TextModeToggle_Click" Margin="0,0,2,0" ToolTip="{DynamicResource Vec3d_TextMode_Tooltip}"/>
+            <Button Content="{DynamicResource Vec3d_Normalize}" Width="20" Click="NormalizeButton_Click" Visibility="{Binding ShowNormalizeButton, Converter={StaticResource BooleanToVisibilityConverter}}" ToolTip="{DynamicResource Vec3d_Normalize_Tooltip}"/>
+        </StackPanel>
+
+        <!-- Text Mode Panel -->
+        <StackPanel x:Name="TextModePanel" Orientation="Horizontal" Grid.ColumnSpan="5" Visibility="Collapsed">
+            <TextBox x:Name="VectorTextBox" Width="180" Margin="0,0,2,0" TextChanged="VectorTextBox_TextChanged" IsReadOnly="{Binding IsReadOnly}"
+                     ToolTip="{DynamicResource Vec3d_TextMode_Format_Tooltip}"/>
+            <Button Content="{DynamicResource Vec3d_StandardMode_Toggle}" Width="20" Click="StandardModeToggle_Click" Margin="0,0,2,0" ToolTip="{DynamicResource Vec3d_StandardMode_Tooltip}"/>
+            <Button Content="{DynamicResource Vec3d_Normalize}" Width="20" Click="NormalizeButton_Click" Visibility="{Binding ShowNormalizeButton, Converter={StaticResource BooleanToVisibilityConverter}}" ToolTip="{DynamicResource Vec3d_Normalize_Tooltip}"/>
+        </StackPanel>
+    </Grid>
+</UserControl> 
+
      using System;
+using System.Threading.Tasks;
+using System.Windows.Controls;
+using System.Windows;
+using Hi.Geom;
+using System.Text.RegularExpressions;
+using System.ComponentModel;
+using Hi.Common;
+using Hi.Common.Messages;
+
+namespace HiNC_2025_win_desktop.Geom
+{
+    /// <summary>
+    /// Vec3dControl.xaml 的交互逻辑
+    /// </summary>
+    public partial class Vec3dControl : UserControl, INotifyPropertyChanged
+    {
+        private bool _isUpdating = false;
+        private Func<Vec3d> _getterFunc;
+        private Func<Task> _updateByContentFunc;
+        private bool _showNormalizeButton = false;
+        private bool _isTextMode = false;
+        private bool _isReadOnly = false;
+
+        // 用于匹配各种格式的正则表达式
+        private static readonly Regex VectorRegex = new Regex(@"^\s*[\(\[\{]?\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*[\)\]\}]?\s*$", RegexOptions.Compiled);
+        
+        // 用于匹配变换矩阵格式的正则表达式（包括带有花括号的嵌套格式）
+        private static readonly Regex MatrixRegex = new Regex(@"\{(?:\s*\{?\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*\}?\s*,){3}\s*\{?\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*,\s*(-?\d*\.?\d+)\s*\}?\s*\}", RegexOptions.Compiled);
+
+        public event PropertyChangedEventHandler PropertyChanged;
+
+        public string ControlId { get; set; } = Guid.NewGuid().ToString();
+
+        public Func<Vec3d> GetterFunc
+        {
+            get => _getterFunc;
+            set
+            {
+                _getterFunc = value;
+                UpdateUI();
+            }
+        }
+
+        public Func<Task> UpdateByContentFunc
+        {
+            get => _updateByContentFunc;
+            set => _updateByContentFunc = value;
+        }
+
+        public bool ShowNormalizeButton
+        {
+            get => _showNormalizeButton;
+            set
+            {
+                if (_showNormalizeButton != value)
+                {
+                    _showNormalizeButton = value;
+                    OnPropertyChanged(nameof(ShowNormalizeButton));
+                }
+            }
+        }
+
+        public bool IsTextMode
+        {
+            get => _isTextMode;
+            set
+            {
+                if (_isTextMode != value)
+                {
+                    _isTextMode = value;
+                    UpdateModeVisibility();
+                    OnPropertyChanged(nameof(IsTextMode));
+                }
+            }
+        }
+
+        public bool IsReadOnly
+        {
+            get => _isReadOnly;
+            set
+            {
+                if (_isReadOnly != value)
+                {
+                    _isReadOnly = value;
+                    OnPropertyChanged(nameof(IsReadOnly));
+                }
+            }
+        }
+
+        protected void OnPropertyChanged(string propertyName)
+        {
+            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
+        }
+
+        public Vec3dControl()
+        {
+            InitializeComponent();
+            DataContext = this;
+        }
+
+        private void UpdateModeVisibility()
+        {
+            if (IsTextMode)
+            {
+                StandardModePanel.Visibility = Visibility.Collapsed;
+                TextModePanel.Visibility = Visibility.Visible;
+                UpdateVectorTextFromXYZ();
+            }
+            else
+            {
+                StandardModePanel.Visibility = Visibility.Visible;
+                TextModePanel.Visibility = Visibility.Collapsed;
+            }
+        }
+
+        private void UpdateVectorTextFromXYZ()
+        {
+            if (_isUpdating) return;
+
+            if (double.TryParse(XTextBox.Text, out double x) &&
+                double.TryParse(YTextBox.Text, out double y) &&
+                double.TryParse(ZTextBox.Text, out double z))
+            {
+                VectorTextBox.Text = $"{x},{y},{z}";
+            }
+        }
+
+        private void TextModeToggle_Click(object sender, RoutedEventArgs e)
+        {
+            IsTextMode = true;
+        }
+
+        private void StandardModeToggle_Click(object sender, RoutedEventArgs e)
+        {
+            IsTextMode = false;
+        }
+
+        private async void NormalizeButton_Click(object sender, RoutedEventArgs e)
+        {
+            if (_isUpdating || _getterFunc == null ||  IsReadOnly)
+                return;
+
+            try
+            {
+                _isUpdating = true;
+
+                var vec = _getterFunc();
+                if (vec != null)
+                {
+                    vec.Normalize();
+                    
+                    XTextBox.Text = vec.X.ToString("F3");
+                    YTextBox.Text = vec.Y.ToString("F3");
+                    ZTextBox.Text = vec.Z.ToString("F3");
+                    
+                    if (IsTextMode)
+                    {
+                        VectorTextBox.Text = $"{vec.X:F3},{vec.Y:F3},{vec.Z:F3}";
+                    }
+                    if(_updateByContentFunc != null)
+                        await _updateByContentFunc();
+                }
+            }
+            catch (Exception ex)
+            {
+                MessageKit.AddError(string.Format(Application.Current.FindResource("Vec3d_Update_Error").ToString(), ex.Message));
+                ex.ShowException(this);
+            }
+            finally
+            {
+                _isUpdating = false;
+            }
+        }
+
+        public void UpdateUI()
+        {
+            if (_isUpdating || _getterFunc == null)
+                return;
+
+            try
+            {
+                _isUpdating = true;
+                var vec = _getterFunc();
+                if (vec != null)
+                {
+                    XTextBox.Text = vec.X.ToString("F3");
+                    YTextBox.Text = vec.Y.ToString("F3");
+                    ZTextBox.Text = vec.Z.ToString("F3");
+
+                    if (IsTextMode)
+                    {
+                        VectorTextBox.Text = $"{vec.X},{vec.Y},{vec.Z}";
+                    }
+                }
+                else
+                {
+                    XTextBox.Text = "";
+                    YTextBox.Text = "";
+                    ZTextBox.Text = "";
+                    VectorTextBox.Text = "";
+                }
+            }
+            finally
+            {
+                _isUpdating = false;
+            }
+        }
+
+        private async void XTextBox_TextChanged(object sender, TextChangedEventArgs e)
+        {
+            await HandleTextChanged();
+        }
+
+        private async void YTextBox_TextChanged(object sender, TextChangedEventArgs e)
+        {
+            await HandleTextChanged();
+        }
+
+        private async void ZTextBox_TextChanged(object sender, TextChangedEventArgs e)
+        {
+            await HandleTextChanged();
+        }
+
+        private async void VectorTextBox_TextChanged(object sender, TextChangedEventArgs e)
+        {
+            if (_isUpdating || _getterFunc == null || IsReadOnly)
+                return;
+
+            try
+            {
+                string text = VectorTextBox.Text.Trim();
+
+                // 如果文本为空或太短，不做处理
+                if (string.IsNullOrWhiteSpace(text) || text.Length < 3)
+                    return;
+
+                _isUpdating = true;
+
+                // 尝试解析为向量格式
+                if (TryParseVector(text, out double x, out double y, out double z))
+                {
+                    await UpdateVectorValues(x, y, z);
+                }
+                // 尝试解析为变换矩阵格式（仅提取位移分量）
+                else if (TryParseTransformMatrix(text, out double tx, out double ty, out double tz))
+                {
+                    await UpdateVectorValues(tx, ty, tz);
+                }
+                // 尝试作为单值解析每个字段（宽松模式）
+                else if (TryParseLooseVector(text, out double lx, out double ly, out double lz))
+                {
+                    await UpdateVectorValues(lx, ly, lz);
+                }
+            }
+            catch (Exception ex)
+            {
+                MessageKit.AddError(string.Format(Application.Current.FindResource("Vec3d_Update_Error").ToString(), ex.Message));
+                ex.ShowException(this);
+            }
+            finally
+            {
+                _isUpdating = false;
+            }
+        }
+
+        private bool TryParseVector(string text, out double x, out double y, out double z)
+        {
+            x = y = z = 0;
+            
+            // 使用正则表达式匹配向量格式
+            Match match = VectorRegex.Match(text);
+            if (match.Success && match.Groups.Count >= 4)
+            {
+                if (double.TryParse(match.Groups[1].Value, out x) &&
+                    double.TryParse(match.Groups[2].Value, out y) &&
+                    double.TryParse(match.Groups[3].Value, out z))
+                {
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        private bool TryParseTransformMatrix(string text, out double tx, out double ty, out double tz)
+        {
+            tx = ty = tz = 0;
+            
+            // 移除所有换行和多余空格，便于匹配
+            text = Regex.Replace(text, @"\s+", " ");
+            
+            // 尝试匹配变换矩阵格式
+            Match match = MatrixRegex.Match(text);
+            if (match.Success && match.Groups.Count >= 8)
+            {
+                // 变换矩阵的第4列通常是位移分量
+                if (double.TryParse(match.Groups[4].Value, out tx) &&
+                    double.TryParse(match.Groups[8].Value, out ty) &&
+                    double.TryParse(match.Groups[12].Value, out tz))
+                {
+                    return true;
+                }
+            }
+            
+            // 尝试匹配更宽松的变换矩阵表示（例如从界面复制的数据）
+            var numbers = Regex.Matches(text, @"(-?\d*\.?\d+)");
+            if (numbers.Count >= 16)
+            {
+                // 假设这是一个4x4矩阵，提取位移分量（第4、8、12个数字）
+                if (double.TryParse(numbers[3].Value, out tx) &&
+                    double.TryParse(numbers[7].Value, out ty) &&
+                    double.TryParse(numbers[11].Value, out tz))
+                {
+                    return true;
+                }
+            }
+            
+            return false;
+        }
+
+        private bool TryParseLooseVector(string text, out double x, out double y, out double z)
+        {
+            x = y = z = 0;
+            
+            // 移除所有非数字和小数点以外的字符，然后按空白分割
+            string cleanText = Regex.Replace(text, @"[^\d\.\-\s,;]+", " ");
+            string[] parts = Regex.Split(cleanText, @"[\s,;]+");
+            
+            // 尝试从分割后的部分获取三个数字
+            var numbers = new System.Collections.Generic.List<double>();
+            foreach (var part in parts)
+            {
+                if (!string.IsNullOrWhiteSpace(part) && double.TryParse(part, out double value))
+                {
+                    numbers.Add(value);
+                    if (numbers.Count >= 3) break; // 最多取3个数字
+                }
+            }
+            
+            // 如果获取到了三个数字，就认为解析成功
+            if (numbers.Count >= 3)
+            {
+                x = numbers[0];
+                y = numbers[1];
+                z = numbers[2];
+                return true;
+            }
+            
+            return false;
+        }
+
+        private async Task UpdateVectorValues(double x, double y, double z)
+        {
+            XTextBox.Text = x.ToString("F3");
+            YTextBox.Text = y.ToString("F3");
+            ZTextBox.Text = z.ToString("F3");
+
+            var vec = _getterFunc?.Invoke();
+            if (vec != null)
+            {
+                vec.X = x;
+                vec.Y = y;
+                vec.Z = z;
+
+                if (_updateByContentFunc != null)
+                {
+                    await _updateByContentFunc();
+                }
+            }
+        }
+
+        private async Task HandleTextChanged()
+        {
+            if (_isUpdating || _getterFunc == null ||  IsReadOnly)
+                return;
+
+            try
+            {
+                _isUpdating = true;
+
+                // 尝试解析每个文本框的值
+                bool allValid = true;
+                
+                allValid &= double.TryParse(XTextBox.Text, out double x);
+                allValid &= double.TryParse(YTextBox.Text, out double y);
+                allValid &= double.TryParse(ZTextBox.Text, out double z);
+
+                if (allValid)
+                {
+                    if (IsTextMode)
+                    {
+                        VectorTextBox.Text = $"{x},{y},{z}";
+                    }
+
+                    var vec = _getterFunc();
+                    if (vec != null)
+                    {
+                        vec.X = x;
+                        vec.Y = y;
+                        vec.Z = z;
+
+                        if(_updateByContentFunc != null)
+                            await _updateByContentFunc();
+                    }
+                }
+                else
+                {
+                    // 如果有无效输入，不进行更新但也不显示错误
+                    // 这允许用户在输入过程中有不完整的状态
+                }
+            }
+            catch (Exception ex)
+            {
+                // 记录异常但不中断用户操作
+                MessageKit.AddError(string.Format(Application.Current.FindResource("Vec3d_Update_Error").ToString(), ex.Message));
+                ex.ShowException(this);
+            }
+            finally
+            {
+                _isUpdating = false;
+            }
+        }
+    }
+} 
+
      Source Code Path
      
+
      See this page for git repository.
      
+
      WPF Application Source Code Path
      
+
        
+
      • Geom/Vec3dControl
        • 
+
      
+
      Web Page Application Source Code Path
      
+
        
+
      • wwwroot/widget/vec3d-control.js
        • 
+
      • Controller/Widget/WidgetController.cs
        • 
+
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/general-hinc-workflow/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/general-hinc-workflow/index.html
new file mode 100644
index 00000000..0c1873dc
--- /dev/null
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/general-hinc-workflow/index.html
@@ -0,0 +1,195 @@
+
+
+  
+    
+      General HiNC Workflow | HiAPI-C# 2025 
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+
+      
+
+      
+
+  
+
+  
+    
      
+      
+    
      
+
+    
      
+      
      
+        
      
+          
      
+            
      Table of Contents
      
+            
+          
      
+          
      
+            
+          
      
+        
      
+      
      
+
+      
      
+        
      
+          
+
+          
+        
      
+
+        
      
+          
      General HiNC Workflow
      
+
+
      The following diagram illustrates the overall HiNC workflow:
      
+
      graph TD
+    A["Create MachiningProject"] --> B["Setting Environment"]
+    B --> C["Setting Project Tasks"]
+    C --> D["Run Tasks"]
+    D --> E["View Analysis Results"]
+
      
+
      For a complete implementation example, see: DemoBuildMachiningProject
      
+
      1. Create MachiningProject
      
+
      Creating a machining project is the first step in the HiNC workflow, accomplished by initializing a MachiningProject object.
      
+
      2. Setting Environment In MachiningProject
      
+
+
      3. Setting Project Tasks
      
+
      Set sequential tasks using PlayerCommand:
      
+
        
+
      • Set NC Files - Set the file path and customize simulation and optimization settings for each NC file
        • 
+
      • Configure NC optimization - Configure NC code optimization parameters
        • 
+
      • Set <xref:Hi.ShellCommandUtils.GeomDiffCommand> - Configure geometry comparison functionality to compare target workpiece shape with simulated shape
        • 
+
      • Set MillingTraining - Configure milling parameter training to calibrate simulation parameters based on actual machining data
        • 
+
      • Other task configurations…
        • 
+
      
+
      The PlayerCommand is typically a <xref:Hi.ShellCommandUtils.ListCommand> that contains a sequence of command entries to be executed during the simulation.
      
+
      4. Run the Tasks (Simulation and Optimization)
      
+
      Run PlayerCommand through PacePlayer.
      
+
      At this stage, the simulation process is similar to video playback, which can be:
      
+
        
+
      • Started
        • 
+
      • Stopped
        • 
+
      • Paused
        • 
+
      • Run one line
        • 
+
      • Run one step
        • 
+
      • Reset
        • 
+
      
+
      The PacePlayer controls the execution pace of the simulation, allowing you to observe the machining process in detail or run it at full speed.
      
+
      View the Analysis During Process or Result
      
+
      SessionMessageHost contains a sequence of simulation messages and step data, which can be used to monitor and analyze the simulation process and results.
      
+
      UI Pattern
      
+
      The user interface navigation bar matches the workflow. Top-level navigation items include:
      
+
        
+
      • MachiningProject
+
          
+
        • New
          • 
+
        • Save
          • 
+
        • Load
          • 
+
        
+
        • 
+
      • Environment
+
          
+
        • ...
          • 
+
        
+
        • 
+
      • Task
+
          
+
        • ...
          • 
+
        
+
        • 
+
      • Sim (Simulation)
        • 
+
      
+
      This UI structure makes it intuitive to follow the HiNC workflow from project creation to simulation execution.
      
+
+
      
+
+        
      
+        
      
+
+        
+
+      
      
+
+      
      
+        
+      
      
+    
      
+
+    
      
+
+    
+  
+
diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/getting-started/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/getting-started/index.html
similarity index 92%
rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/getting-started/index.html
rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/getting-started/index.html
index e8ed0ad8..dc070054 100644
--- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/getting-started/index.html
+++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/getting-started/index.html
@@ -112,14 +112,15 @@
 
 
    1. In the dotnet project file, add the package reference.
      
 
      <ItemGroup>
-  <PackageReference Include="HiNc" Version="1.4.*" />
+  <PackageReference Include="HiNc" Version="3.1.*" />
   <!--optional-->
   <PackageReference Include="Hi.Wpf" Version="*" /> 
 </ItemGroup>
 
      
 
      2. 
-
    2. In the program file, setting the environment initialization and finalization.
      
+
    3. In the program file, setting the HiNC application initialization and finalization.
      
 
      using Hi.Disp;
+using Hi.HiNcKits;
 using Hi.Licenses;
 using Hi.MongoUtils;
 using System;
@@ -141,27 +142,18 @@ namespace Sample
         static int Main(string[] args)
         {
             Console.WriteLine("HiAPI starting.");
-            License.LogInAll();
-            DispEngine.Init();
-            MongoServer.Default = MongoServer.Run(new MongoRunnerOptions()
-            {
-                MongoPort = 28100
-            });
+            LocalApp.AppBegin();
 
             Console.WriteLine("Hello World! HiAPI.");
 
-            MongoServer.Default.Dispose();
-            DispEngine.FinishDisp();
-            License.LogOutAll();
+            LocalApp.AppEnd();
             Console.WriteLine("HiAPI exited.");
 
             return 0;
         }
     }
 }
-
      
-
      If 3D rendering is not required, the setting of DispEngine can be eliminated.
      
-
      4. 
+

    Sample Code to Start a MachiningProject

    See the following sample code to start a HiAPI application.

    diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/index.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/index.html similarity index 79% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/index.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/index.html index b0aad539..6a947979 100644 --- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/index.html +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/index.html @@ -110,24 +110,60 @@ HiDisp --> Hi.WinForm HiDisp --> Hi.Wpf + HiDisp --> Hi.Webapi style HiNc fill:#d3d,stroke:#333,stroke-width:2px

    UI Framework Support

    If you need to develop Windows desktop applications:

      -
    • For Windows Forms applications, use the Hi.WinForm package
      • -
    • For WPF applications, use the Hi.Wpf package
      • +
    • For Windows Forms applications, use the Hi.WinForm package.
      • +
    • For WPF applications, use the Hi.Wpf package.
      • +
    • For Webapi applications, use Hi.Webapi package.
    Note

    See Building Your Own Rendering Canvas to build the rendering canvas cross-platform.

    +

    Rendering Canvas Source Code Repositories

    +

    HiAPI Sample Code

    See Sample Code or download the repositories to get more samples. The following sample repository demonstrate various aspects of using HiAPI for machining simulation:

    • diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/system-requirements.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/system-requirements.html similarity index 100% rename from App/wwwroot/HiAPI-docsite/brief/developer-doc/system-requirements.html rename to App/wwwroot/HiAPI-docsite/brief/dev-doc/system-requirements.html diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/toc.html b/App/wwwroot/HiAPI-docsite/brief/dev-doc/toc.html new file mode 100644 index 00000000..a9d1e841 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/toc.html @@ -0,0 +1,186 @@ + + diff --git a/App/wwwroot/HiAPI-docsite/brief/dev-doc/toc.json b/App/wwwroot/HiAPI-docsite/brief/dev-doc/toc.json new file mode 100644 index 00000000..c2675387 --- /dev/null +++ b/App/wwwroot/HiAPI-docsite/brief/dev-doc/toc.json @@ -0,0 +1,2 @@ + +{"items":[{"name":"Overview","href":"index.html","topicHref":"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":"Sketch to Build HiNC GUI","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":"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":"Vec3d Control","href":"build-hinc/widget/vec3d/index.html","topicHref":"build-hinc/widget/vec3d/index.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":"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"}]}]} diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/toc.html b/App/wwwroot/HiAPI-docsite/brief/developer-doc/toc.html deleted file mode 100644 index 5d51e12b..00000000 --- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/toc.html +++ /dev/null @@ -1,67 +0,0 @@ - -
    -
    -
    -
    - - - -
    -
    -
    - -
    -
    -
    diff --git a/App/wwwroot/HiAPI-docsite/brief/developer-doc/toc.json b/App/wwwroot/HiAPI-docsite/brief/developer-doc/toc.json deleted file mode 100644 index 231e7f34..00000000 --- a/App/wwwroot/HiAPI-docsite/brief/developer-doc/toc.json +++ /dev/null @@ -1,2 +0,0 @@ - -{"items":[{"name":"Overview","href":"index.html","topicHref":"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":"Logic Basic","items":[{"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"}]}]}]} diff --git a/App/wwwroot/HiAPI-docsite/brief/index.html b/App/wwwroot/HiAPI-docsite/brief/index.html index c9e63830..599763c3 100644 --- a/App/wwwroot/HiAPI-docsite/brief/index.html +++ b/App/wwwroot/HiAPI-docsite/brief/index.html @@ -83,7 +83,7 @@

    2. Developer Documentation

    Technical documentation for the HiNC API, including reference, requirements, and integration guides.

    The sample code using HiNC API:

    +
  • + + Sample.Common + + +
    • +
  • + + Sample.Controllers + + +
  • Sample.Disp @@ -87,9 +113,15 @@ Sample.Machining
      +
    • + DemoBuildGeomOnlyMachiningProject +
    • DemoBuildMachiningProject
      • +
    • + DemoMillingByCutterLocation +
    • DemoRenderingMachiningProcessAndStripPosSelection
      • diff --git a/App/wwwroot/HiAPI-docsite/brief/sample/toc.json b/App/wwwroot/HiAPI-docsite/brief/sample/toc.json index 1c8c7c4e..d193a889 100644 --- a/App/wwwroot/HiAPI-docsite/brief/sample/toc.json +++ b/App/wwwroot/HiAPI-docsite/brief/sample/toc.json @@ -1,2 +1,2 @@ -{"items":[{"name":"Sample","href":"Sample.html","topicHref":"Sample.html","topicUid":"Sample","type":"Namespace","items":[{"name":"HelloHiAPI","href":"Sample.HelloHiAPI.html","topicHref":"Sample.HelloHiAPI.html","topicUid":"Sample.HelloHiAPI","type":"Class"}]},{"name":"Sample.Disp","href":"Sample.Disp.html","topicHref":"Sample.Disp.html","topicUid":"Sample.Disp","type":"Namespace","items":[{"name":"DemoCylindroid","href":"Sample.Disp.DemoCylindroid.html","topicHref":"Sample.Disp.DemoCylindroid.html","topicUid":"Sample.Disp.DemoCylindroid","type":"Class"},{"name":"DemoDiscreteRgb","href":"Sample.Disp.DemoDiscreteRgb.html","topicHref":"Sample.Disp.DemoDiscreteRgb.html","topicUid":"Sample.Disp.DemoDiscreteRgb","type":"Class"},{"name":"DemoDrawing","href":"Sample.Disp.DemoDrawing.html","topicHref":"Sample.Disp.DemoDrawing.html","topicUid":"Sample.Disp.DemoDrawing","type":"Class"},{"name":"DemoPick1","href":"Sample.Disp.DemoPick1.html","topicHref":"Sample.Disp.DemoPick1.html","topicUid":"Sample.Disp.DemoPick1","type":"Class"},{"name":"DemoPick2","href":"Sample.Disp.DemoPick2.html","topicHref":"Sample.Disp.DemoPick2.html","topicUid":"Sample.Disp.DemoPick2","type":"Class"},{"name":"DemoPickable","href":"Sample.Disp.DemoPickable.html","topicHref":"Sample.Disp.DemoPickable.html","topicUid":"Sample.Disp.DemoPickable","type":"Class"},{"name":"DemoSatellite","href":"Sample.Disp.DemoSatellite.html","topicHref":"Sample.Disp.DemoSatellite.html","topicUid":"Sample.Disp.DemoSatellite","type":"Class"},{"name":"DemoStl","href":"Sample.Disp.DemoStl.html","topicHref":"Sample.Disp.DemoStl.html","topicUid":"Sample.Disp.DemoStl","type":"Class"},{"name":"DemoUtil","href":"Sample.Disp.DemoUtil.html","topicHref":"Sample.Disp.DemoUtil.html","topicUid":"Sample.Disp.DemoUtil","type":"Class"}]},{"name":"Sample.Geom","href":"Sample.Geom.html","topicHref":"Sample.Geom.html","topicUid":"Sample.Geom","type":"Namespace","items":[{"name":"DemoBuildGeom","href":"Sample.Geom.DemoBuildGeom.html","topicHref":"Sample.Geom.DemoBuildGeom.html","topicUid":"Sample.Geom.DemoBuildGeom","type":"Class"},{"name":"DemoIExpandToBox3d","href":"Sample.Geom.DemoIExpandToBox3d.html","topicHref":"Sample.Geom.DemoIExpandToBox3d.html","topicUid":"Sample.Geom.DemoIExpandToBox3d","type":"Class"}]},{"name":"Sample.MachineTool","href":"Sample.MachineTool.html","topicHref":"Sample.MachineTool.html","topicUid":"Sample.MachineTool","type":"Namespace","items":[{"name":"DemoBuildMachineTool","href":"Sample.MachineTool.DemoBuildMachineTool.html","topicHref":"Sample.MachineTool.DemoBuildMachineTool.html","topicUid":"Sample.MachineTool.DemoBuildMachineTool","type":"Class"},{"name":"DemoBuildMachineToolWithoutGeometrys","href":"Sample.MachineTool.DemoBuildMachineToolWithoutGeometrys.html","topicHref":"Sample.MachineTool.DemoBuildMachineToolWithoutGeometrys.html","topicUid":"Sample.MachineTool.DemoBuildMachineToolWithoutGeometrys","type":"Class"}]},{"name":"Sample.Machining","href":"Sample.Machining.html","topicHref":"Sample.Machining.html","topicUid":"Sample.Machining","type":"Namespace","items":[{"name":"DemoBuildMachiningProject","href":"Sample.Machining.DemoBuildMachiningProject.html","topicHref":"Sample.Machining.DemoBuildMachiningProject.html","topicUid":"Sample.Machining.DemoBuildMachiningProject","type":"Class"},{"name":"DemoRenderingMachiningProcessAndStripPosSelection","href":"Sample.Machining.DemoRenderingMachiningProcessAndStripPosSelection.html","topicHref":"Sample.Machining.DemoRenderingMachiningProcessAndStripPosSelection.html","topicUid":"Sample.Machining.DemoRenderingMachiningProcessAndStripPosSelection","type":"Class"},{"name":"DemoUseMachiningProject","href":"Sample.Machining.DemoUseMachiningProject.html","topicHref":"Sample.Machining.DemoUseMachiningProject.html","topicUid":"Sample.Machining.DemoUseMachiningProject","type":"Class"}]},{"name":"Sample.Mech","href":"Sample.Mech.html","topicHref":"Sample.Mech.html","topicUid":"Sample.Mech","type":"Namespace","items":[{"name":"DemoTopo1","href":"Sample.Mech.DemoTopo1.html","topicHref":"Sample.Mech.DemoTopo1.html","topicUid":"Sample.Mech.DemoTopo1","type":"Class"}]}],"memberLayout":"SamePage"} +{"items":[{"name":"Sample","href":"Sample.html","topicHref":"Sample.html","topicUid":"Sample","type":"Namespace","items":[{"name":"HelloHiAPI","href":"Sample.HelloHiAPI.html","topicHref":"Sample.HelloHiAPI.html","topicUid":"Sample.HelloHiAPI","type":"Class"}]},{"name":"Sample.Common","href":"Sample.Common.html","topicHref":"Sample.Common.html","topicUid":"Sample.Common","type":"Namespace","items":[{"name":"DemoMessageAndExceptionHandling","href":"Sample.Common.DemoMessageAndExceptionHandling.html","topicHref":"Sample.Common.DemoMessageAndExceptionHandling.html","topicUid":"Sample.Common.DemoMessageAndExceptionHandling","type":"Class"},{"name":"DemoSessionMessage","href":"Sample.Common.DemoSessionMessage.html","topicHref":"Sample.Common.DemoSessionMessage.html","topicUid":"Sample.Common.DemoSessionMessage","type":"Class"}]},{"name":"Sample.Controllers","href":"Sample.Controllers.html","topicHref":"Sample.Controllers.html","topicUid":"Sample.Controllers","type":"Namespace","items":[{"name":"RenderingController","href":"Sample.Controllers.RenderingController.html","topicHref":"Sample.Controllers.RenderingController.html","topicUid":"Sample.Controllers.RenderingController","type":"Class"},{"name":"TestDisplayee","href":"Sample.Controllers.TestDisplayee.html","topicHref":"Sample.Controllers.TestDisplayee.html","topicUid":"Sample.Controllers.TestDisplayee","type":"Class"}]},{"name":"Sample.Disp","href":"Sample.Disp.html","topicHref":"Sample.Disp.html","topicUid":"Sample.Disp","type":"Namespace","items":[{"name":"DemoCylindroid","href":"Sample.Disp.DemoCylindroid.html","topicHref":"Sample.Disp.DemoCylindroid.html","topicUid":"Sample.Disp.DemoCylindroid","type":"Class"},{"name":"DemoDiscreteRgb","href":"Sample.Disp.DemoDiscreteRgb.html","topicHref":"Sample.Disp.DemoDiscreteRgb.html","topicUid":"Sample.Disp.DemoDiscreteRgb","type":"Class"},{"name":"DemoDrawing","href":"Sample.Disp.DemoDrawing.html","topicHref":"Sample.Disp.DemoDrawing.html","topicUid":"Sample.Disp.DemoDrawing","type":"Class"},{"name":"DemoPick1","href":"Sample.Disp.DemoPick1.html","topicHref":"Sample.Disp.DemoPick1.html","topicUid":"Sample.Disp.DemoPick1","type":"Class"},{"name":"DemoPick2","href":"Sample.Disp.DemoPick2.html","topicHref":"Sample.Disp.DemoPick2.html","topicUid":"Sample.Disp.DemoPick2","type":"Class"},{"name":"DemoPickable","href":"Sample.Disp.DemoPickable.html","topicHref":"Sample.Disp.DemoPickable.html","topicUid":"Sample.Disp.DemoPickable","type":"Class"},{"name":"DemoSatellite","href":"Sample.Disp.DemoSatellite.html","topicHref":"Sample.Disp.DemoSatellite.html","topicUid":"Sample.Disp.DemoSatellite","type":"Class"},{"name":"DemoStl","href":"Sample.Disp.DemoStl.html","topicHref":"Sample.Disp.DemoStl.html","topicUid":"Sample.Disp.DemoStl","type":"Class"},{"name":"DemoUtil","href":"Sample.Disp.DemoUtil.html","topicHref":"Sample.Disp.DemoUtil.html","topicUid":"Sample.Disp.DemoUtil","type":"Class"}]},{"name":"Sample.Geom","href":"Sample.Geom.html","topicHref":"Sample.Geom.html","topicUid":"Sample.Geom","type":"Namespace","items":[{"name":"DemoBuildGeom","href":"Sample.Geom.DemoBuildGeom.html","topicHref":"Sample.Geom.DemoBuildGeom.html","topicUid":"Sample.Geom.DemoBuildGeom","type":"Class"},{"name":"DemoIExpandToBox3d","href":"Sample.Geom.DemoIExpandToBox3d.html","topicHref":"Sample.Geom.DemoIExpandToBox3d.html","topicUid":"Sample.Geom.DemoIExpandToBox3d","type":"Class"}]},{"name":"Sample.MachineTool","href":"Sample.MachineTool.html","topicHref":"Sample.MachineTool.html","topicUid":"Sample.MachineTool","type":"Namespace","items":[{"name":"DemoBuildMachineTool","href":"Sample.MachineTool.DemoBuildMachineTool.html","topicHref":"Sample.MachineTool.DemoBuildMachineTool.html","topicUid":"Sample.MachineTool.DemoBuildMachineTool","type":"Class"},{"name":"DemoBuildMachineToolWithoutGeometrys","href":"Sample.MachineTool.DemoBuildMachineToolWithoutGeometrys.html","topicHref":"Sample.MachineTool.DemoBuildMachineToolWithoutGeometrys.html","topicUid":"Sample.MachineTool.DemoBuildMachineToolWithoutGeometrys","type":"Class"}]},{"name":"Sample.Machining","href":"Sample.Machining.html","topicHref":"Sample.Machining.html","topicUid":"Sample.Machining","type":"Namespace","items":[{"name":"DemoBuildGeomOnlyMachiningProject","href":"Sample.Machining.DemoBuildGeomOnlyMachiningProject.html","topicHref":"Sample.Machining.DemoBuildGeomOnlyMachiningProject.html","topicUid":"Sample.Machining.DemoBuildGeomOnlyMachiningProject","type":"Class"},{"name":"DemoBuildMachiningProject","href":"Sample.Machining.DemoBuildMachiningProject.html","topicHref":"Sample.Machining.DemoBuildMachiningProject.html","topicUid":"Sample.Machining.DemoBuildMachiningProject","type":"Class"},{"name":"DemoMillingByCutterLocation","href":"Sample.Machining.DemoMillingByCutterLocation.html","topicHref":"Sample.Machining.DemoMillingByCutterLocation.html","topicUid":"Sample.Machining.DemoMillingByCutterLocation","type":"Class"},{"name":"DemoRenderingMachiningProcessAndStripPosSelection","href":"Sample.Machining.DemoRenderingMachiningProcessAndStripPosSelection.html","topicHref":"Sample.Machining.DemoRenderingMachiningProcessAndStripPosSelection.html","topicUid":"Sample.Machining.DemoRenderingMachiningProcessAndStripPosSelection","type":"Class"},{"name":"DemoUseMachiningProject","href":"Sample.Machining.DemoUseMachiningProject.html","topicHref":"Sample.Machining.DemoUseMachiningProject.html","topicUid":"Sample.Machining.DemoUseMachiningProject","type":"Class"}]},{"name":"Sample.Mech","href":"Sample.Mech.html","topicHref":"Sample.Mech.html","topicUid":"Sample.Mech","type":"Namespace","items":[{"name":"DemoTopo1","href":"Sample.Mech.DemoTopo1.html","topicHref":"Sample.Mech.DemoTopo1.html","topicUid":"Sample.Mech.DemoTopo1","type":"Class"}]}],"memberLayout":"SamePage"} diff --git a/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.html b/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.html index 5150c293..c0a1cbf0 100644 --- a/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.html +++ b/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.html @@ -98,10 +98,10 @@
      • - 碰撞檢測 + 文件任務
      • - 文件任務 + 碰撞檢測
      • 離料 diff --git a/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.json b/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.json index 69b78b00..132c1c22 100644 --- a/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.json +++ b/App/wwwroot/HiAPI-docsite/brief/user-guide/zh-Hant/toc.json @@ -1,2 +1,2 @@ -{"items":[{"name":"HiNC 使用說明","href":"index.html","topicHref":"index.html"},{"name":"使用者條款","href":"license/index.html","topicHref":"license/index.html"},{"name":"HiNC啟用","items":[{"name":"Windows系統啟用","href":"startup/windows.html","topicHref":"startup/windows.html"},{"name":"單機多站配置","href":"startup/multi-station.html","topicHref":"startup/multi-station.html"},{"name":"多主機授權設置","href":"startup/delegate-auth.html","topicHref":"startup/delegate-auth.html"},{"name":"教學視頻","href":"startup/tutorial.html","topicHref":"startup/tutorial.html"}]},{"name":"系統","items":[{"name":"檔案總管","href":"system/file-explorer.html","topicHref":"system/file-explorer.html"}]},{"name":"設備","items":[{"name":"錨點","href":"mech/anchor.html","topicHref":"mech/anchor.html"},{"name":"工具機建置","href":"equipment/build-machine-tool.html","topicHref":"equipment/build-machine-tool.html"},{"name":"冷卻液","href":"equipment/coolant.html","topicHref":"equipment/coolant.html"}]},{"name":"控制器","items":[{"name":"海德漢支援","href":"controllers/heidenhain-support.html","topicHref":"controllers/heidenhain-support.html"},{"name":"通用NC碼支援","href":"controllers/iso-nc-support.html","topicHref":"controllers/iso-nc-support.html"}]},{"name":"加工工具","items":[{"name":"銑刀","href":"milling-tool/cutter.html","topicHref":"milling-tool/cutter.html"},{"name":"APT工具","href":"milling-tool/apt.html","topicHref":"milling-tool/apt.html"},{"name":"智慧刀把","href":"milling-tool/smart-tool-holder.html","topicHref":"milling-tool/smart-tool-holder.html"}]},{"name":"腳本命令","items":[{"name":"碰撞檢測","href":"script/Collision/index.html","topicHref":"script/Collision/index.html"},{"name":"文件任務","href":"script/Doc-Task/index.html","topicHref":"script/Doc-Task/index.html"},{"name":"離料","href":"script/FlyPiece/index.html","topicHref":"script/FlyPiece/index.html"},{"name":"幾何差異","href":"script/GeomDiff/index.html","topicHref":"script/GeomDiff/index.html"},{"name":"映射","href":"script/Mapping/index.html","topicHref":"script/Mapping/index.html"},{"name":"銑削訓練","href":"script/MillingTraining/index.html","topicHref":"script/MillingTraining/index.html"},{"name":"NC優化","href":"script/NcOptimization/index.html","topicHref":"script/NcOptimization/index.html"},{"name":"解析度","href":"script/Resolution/index.html","topicHref":"script/Resolution/index.html"},{"name":"運行NC檔案","href":"script/RunNcFile/index.html","topicHref":"script/RunNcFile/index.html"},{"name":"運行時幾何","href":"script/RuntimeGeom/index.html","topicHref":"script/RuntimeGeom/index.html"},{"name":"輸出Shot檔案","href":"script/WriteShotFiles/index.html","topicHref":"script/WriteShotFiles/index.html"},{"name":"輸出Step檔案","href":"script/WriteStepFiles/index.html","topicHref":"script/WriteStepFiles/index.html"}]},{"name":"理論與技術","items":[{"name":"銑削物理座標系","href":"theory-and-technique/milling-physics-coordinates.html","topicHref":"theory-and-technique/milling-physics-coordinates.html"},{"name":"評估製程可加工性","href":"availability/index.html","topicHref":"availability/index.html"},{"name":"刀具壽命與磨耗","href":"technique/wear.html","topicHref":"technique/wear.html"}]},{"name":"優化","items":[{"name":"NC優化","href":"optimization/index.html","topicHref":"optimization/index.html"}]}]} +{"items":[{"name":"HiNC 使用說明","href":"index.html","topicHref":"index.html"},{"name":"使用者條款","href":"license/index.html","topicHref":"license/index.html"},{"name":"HiNC啟用","items":[{"name":"Windows系統啟用","href":"startup/windows.html","topicHref":"startup/windows.html"},{"name":"單機多站配置","href":"startup/multi-station.html","topicHref":"startup/multi-station.html"},{"name":"多主機授權設置","href":"startup/delegate-auth.html","topicHref":"startup/delegate-auth.html"},{"name":"教學視頻","href":"startup/tutorial.html","topicHref":"startup/tutorial.html"}]},{"name":"系統","items":[{"name":"檔案總管","href":"system/file-explorer.html","topicHref":"system/file-explorer.html"}]},{"name":"設備","items":[{"name":"錨點","href":"mech/anchor.html","topicHref":"mech/anchor.html"},{"name":"工具機建置","href":"equipment/build-machine-tool.html","topicHref":"equipment/build-machine-tool.html"},{"name":"冷卻液","href":"equipment/coolant.html","topicHref":"equipment/coolant.html"}]},{"name":"控制器","items":[{"name":"海德漢支援","href":"controllers/heidenhain-support.html","topicHref":"controllers/heidenhain-support.html"},{"name":"通用NC碼支援","href":"controllers/iso-nc-support.html","topicHref":"controllers/iso-nc-support.html"}]},{"name":"加工工具","items":[{"name":"銑刀","href":"milling-tool/cutter.html","topicHref":"milling-tool/cutter.html"},{"name":"APT工具","href":"milling-tool/apt.html","topicHref":"milling-tool/apt.html"},{"name":"智慧刀把","href":"milling-tool/smart-tool-holder.html","topicHref":"milling-tool/smart-tool-holder.html"}]},{"name":"腳本命令","items":[{"name":"文件任務","href":"script/Doc-Task/index.html","topicHref":"script/Doc-Task/index.html"},{"name":"碰撞檢測","href":"script/Collision/index.html","topicHref":"script/Collision/index.html"},{"name":"離料","href":"script/FlyPiece/index.html","topicHref":"script/FlyPiece/index.html"},{"name":"幾何差異","href":"script/GeomDiff/index.html","topicHref":"script/GeomDiff/index.html"},{"name":"映射","href":"script/Mapping/index.html","topicHref":"script/Mapping/index.html"},{"name":"銑削訓練","href":"script/MillingTraining/index.html","topicHref":"script/MillingTraining/index.html"},{"name":"NC優化","href":"script/NcOptimization/index.html","topicHref":"script/NcOptimization/index.html"},{"name":"解析度","href":"script/Resolution/index.html","topicHref":"script/Resolution/index.html"},{"name":"運行NC檔案","href":"script/RunNcFile/index.html","topicHref":"script/RunNcFile/index.html"},{"name":"運行時幾何","href":"script/RuntimeGeom/index.html","topicHref":"script/RuntimeGeom/index.html"},{"name":"輸出Shot檔案","href":"script/WriteShotFiles/index.html","topicHref":"script/WriteShotFiles/index.html"},{"name":"輸出Step檔案","href":"script/WriteStepFiles/index.html","topicHref":"script/WriteStepFiles/index.html"}]},{"name":"理論與技術","items":[{"name":"銑削物理座標系","href":"theory-and-technique/milling-physics-coordinates.html","topicHref":"theory-and-technique/milling-physics-coordinates.html"},{"name":"評估製程可加工性","href":"availability/index.html","topicHref":"availability/index.html"},{"name":"刀具壽命與磨耗","href":"technique/wear.html","topicHref":"technique/wear.html"}]},{"name":"優化","items":[{"name":"NC優化","href":"optimization/index.html","topicHref":"optimization/index.html"}]}]} diff --git a/App/wwwroot/HiAPI-docsite/docfx.json b/App/wwwroot/HiAPI-docsite/docfx.json index de449625..45bed4de 100644 --- a/App/wwwroot/HiAPI-docsite/docfx.json +++ b/App/wwwroot/HiAPI-docsite/docfx.json @@ -12,7 +12,8 @@ "HiUniNc/HiUniNc.csproj", "HiNc/HiNc.csproj", "Hi.Wpf/Hi.Wpf.csproj", - "Hi.WinForm/Hi.WinForm.csproj" + "Hi.WinForm/Hi.WinForm.csproj", + "Hi.Webapi/Hi.Webapi.csproj" ] } ], @@ -33,7 +34,8 @@ "src": "../", "files": [ "Hi.Sample/Hi.Sample.csproj", - "Hi.Sample.Wpf/Hi.Sample.Wpf.csproj" + "Hi.Sample.Wpf/Hi.Sample.Wpf.csproj", + "Hi.Sample.Webapi/Hi.Sample.Webapi.csproj" ] } ], @@ -75,7 +77,7 @@ "img/**", "acc/**", "brief/**.png", - "developer-doc/**.png", + "dev-doc/**.png", "user-guide/**.png", "**.svg", "**.jpg", diff --git a/App/wwwroot/HiAPI-docsite/index.html b/App/wwwroot/HiAPI-docsite/index.html index ff9dc533..85f7f64b 100644 --- a/App/wwwroot/HiAPI-docsite/index.html +++ b/App/wwwroot/HiAPI-docsite/index.html @@ -83,7 +83,7 @@

        2. Developer Documentation

        Technical documentation for the HiNC API, including reference, requirements, and integration guides.

        The sample code using HiNC API:

          diff --git a/App/wwwroot/HiAPI-docsite/index.json b/App/wwwroot/HiAPI-docsite/index.json index 6fa7c562..dadcd9fb 100644 --- a/App/wwwroot/HiAPI-docsite/index.json +++ b/App/wwwroot/HiAPI-docsite/index.json @@ -7,12 +7,12 @@ "api/Hi.Cbtr.CachedTris.html": { "href": "api/Hi.Cbtr.CachedTris.html", "title": "Class CachedTris | HiAPI-C# 2025", - "summary": "Class CachedTris Namespace Hi.Cbtr Assembly HiCbtr.dll Feature-cached triangle for CubeTree computation. public class CachedTris : IDisposable, IDisplayee, IExpandToBox3d Inheritance object CachedTris Implements IDisposable IDisplayee IExpandToBox3d 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) Constructors CachedTris(NativeTopoStld, Mat4d, double) Ctor by the transformed stl. only available for geometry that does not contains near point or points on the same line on the same plane. public CachedTris(NativeTopoStld stl, Mat4d mat, double fractionTolerance) Parameters stl NativeTopoStld stl mat Mat4d transformation matrix fractionTolerance double fraction tolerance for the operation CachedTris(NativeTopoStld, NativeTopoStlfr, Mat4d, Mat4d, double, SweepingMode) Ctor by the swept stl. The sweeping is from the transformation of pre to cur. public CachedTris(NativeTopoStld tstl, NativeTopoStlfr tstlfr, Mat4d pre, Mat4d cur, double fractionTolerance, CachedTris.SweepingMode sweepingMode = SweepingMode.Auto) Parameters tstl NativeTopoStld Topo Stl tstlfr NativeTopoStlfr Topo Stl with fraction tolerance pre Mat4d previous transformation matrix cur Mat4d current transformation matrix fractionTolerance double fraction tolerance for the operation sweepingMode CachedTris.SweepingMode mode for the sweeping operation Properties CachedTrisPtr Native pointer of the object. public nint CachedTrisPtr { get; } Property Value nint Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~CachedTris() protected ~CachedTris()" + "summary": "Class CachedTris Namespace Hi.Cbtr Assembly HiCbtr.dll Feature-cached triangle for CubeTree computation. public class CachedTris : IDisposable, IDisplayee, IExpandToBox3d Inheritance object CachedTris Implements IDisposable IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CachedTris(NativeTopoStld, Mat4d, double) Ctor by the transformed stl. only available for geometry that does not contains near point or points on the same line on the same plane. public CachedTris(NativeTopoStld stl, Mat4d mat, double fractionTolerance) Parameters stl NativeTopoStld stl mat Mat4d transformation matrix fractionTolerance double fraction tolerance for the operation CachedTris(NativeTopoStld, NativeTopoStlfr, Mat4d, Mat4d, double, SweepingMode) Ctor by the swept stl. The sweeping is from the transformation of pre to cur. public CachedTris(NativeTopoStld tstl, NativeTopoStlfr tstlfr, Mat4d pre, Mat4d cur, double fractionTolerance, CachedTris.SweepingMode sweepingMode = SweepingMode.Auto) Parameters tstl NativeTopoStld Topo Stl tstlfr NativeTopoStlfr Topo Stl with fraction tolerance pre Mat4d previous transformation matrix cur Mat4d current transformation matrix fractionTolerance double fraction tolerance for the operation sweepingMode CachedTris.SweepingMode mode for the sweeping operation Properties CachedTrisPtr Native pointer of the object. public nint CachedTrisPtr { get; } Property Value nint Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~CachedTris() protected ~CachedTris()" }, "api/Hi.Cbtr.CbtrPickable.html": { "href": "api/Hi.Cbtr.CbtrPickable.html", "title": "Class CbtrPickable | HiAPI-C# 2025", - "summary": "Class CbtrPickable Namespace Hi.Cbtr Assembly HiCbtr.dll Pickable of CubeTree grids. public class CbtrPickable : Pickable, IPickableGetter, IDisposable Inheritance object Pickable CbtrPickable Implements IPickableGetter IDisposable Derived DiffAttachment UnhighlightablePickable ClStripPos Inherited Members Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.OnKeyDown(key_event_t, panel_state_t) Pickable.OnKeyUp(key_event_t, panel_state_t) Pickable.OnMouseDown(mouse_button_event_t, panel_state_t) Pickable.OnMouseUp(mouse_button_event_t, panel_state_t) Pickable.OnMouseMove(mouse_move_event_t, panel_state_t) Pickable.OnMouseWheel(mouse_wheel_event_t, panel_state_t) Pickable.Dispose() 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) Constructors CbtrPickable() Initializes a new instance of the CbtrPickable class with default white color. public CbtrPickable() CbtrPickable(vec3f) Initializes a new instance of the CbtrPickable class with specified color. public CbtrPickable(vec3f rgb) Parameters rgb vec3f The RGB color for the pickable object. Properties AttachmentPriority The color and Pickable priority if several attachments occupied at the same pixel. NAN is the lowest priority. the smaller number is the lower priority. public virtual double AttachmentPriority { get; set; } Property Value double Rgb Color RGB. public virtual Vec3d Rgb { get; set; } Property Value Vec3d Methods CleanLinkedCbtrNodesDrawingCache() CleanLinkedNodesDrawingCache. Not thread safe with substraction process. public void CleanLinkedCbtrNodesDrawingCache() Dispose(bool) protected override void Dispose(bool disposing) Parameters disposing bool Highlight(bool) Highlight the CbtrPickable by triangles line. Only one CbtrPickable can be highlighted on a CubeTree. public void Highlight(bool b) Parameters b bool highligt or not OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state ShrinkToFitNodeMap() ShrinkToFitNodeMap. Not thread safe with substraction process. public void ShrinkToFitNodeMap()" + "summary": "Class CbtrPickable Namespace Hi.Cbtr Assembly HiCbtr.dll Pickable of CubeTree grids. public class CbtrPickable : Pickable, IGetPickable, IDisposable Inheritance object Pickable CbtrPickable Implements IGetPickable IDisposable Derived DiffAttachment UnhighlightablePickable ClStripPos Inherited Members Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.OnKeyDown(key_event_t, panel_state_t) Pickable.OnKeyUp(key_event_t, panel_state_t) Pickable.OnMouseDown(mouse_button_event_t, panel_state_t) Pickable.OnMouseUp(mouse_button_event_t, panel_state_t) Pickable.OnMouseMove(mouse_move_event_t, panel_state_t) Pickable.OnMouseWheel(mouse_wheel_event_t, panel_state_t) Pickable.Dispose() 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) Constructors CbtrPickable() Initializes a new instance of the CbtrPickable class with default white color. public CbtrPickable() CbtrPickable(vec3f) Initializes a new instance of the CbtrPickable class with specified color. public CbtrPickable(vec3f rgb) Parameters rgb vec3f The RGB color for the pickable object. Properties AttachmentPriority The color and Pickable priority if several attachments occupied at the same pixel. NAN is the lowest priority. the smaller number is the lower priority. public virtual double AttachmentPriority { get; set; } Property Value double Rgb Color RGB. public virtual Vec3d Rgb { get; set; } Property Value Vec3d Methods CleanLinkedCbtrNodesDrawingCache() CleanLinkedNodesDrawingCache. Not thread safe with substraction process. public void CleanLinkedCbtrNodesDrawingCache() Dispose(bool) protected override void Dispose(bool disposing) Parameters disposing bool Highlight(bool) Highlight the CbtrPickable by triangles line. Only one CbtrPickable can be highlighted on a CubeTree. public void Highlight(bool b) Parameters b bool highligt or not OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state ShrinkToFitNodeMap() ShrinkToFitNodeMap. Not thread safe with substraction process. public void ShrinkToFitNodeMap()" }, "api/Hi.Cbtr.CubeTree.diff_response_func_t.html": { "href": "api/Hi.Cbtr.CubeTree.diff_response_func_t.html", @@ -22,17 +22,17 @@ "api/Hi.Cbtr.CubeTree.html": { "href": "api/Hi.Cbtr.CubeTree.html", "title": "Class CubeTree | HiAPI-C# 2025", - "summary": "Class CubeTree Namespace Hi.Cbtr Assembly HiCbtr.dll Cube-based data structure. CubeTree has high performance for free-form geometry manipulation include volume removal and addition. public class CubeTree : IDisposable, IDisplayee, ICollidee, ICollidable, IExpandToBox3d, IGetCollidable Inheritance object CubeTree Implements IDisposable IDisplayee ICollidee ICollidable IExpandToBox3d IGetCollidable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(CubeTree, TriTree, Mat4d, double, int) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) SweptableUtil.RemoveBySweepingVolume(CubeTree, IGetSweptable, Mat4d, Mat4d, double, double, bool, bool) CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CubeTree(NativeStl, double, CancellationToken, IProgress) Ctor. This ctor is faster than CubeTree(NativeStl, double, CancellationToken, IProgress). public CubeTree(NativeStl stl, double preferredGridWidth, CancellationToken token, IProgress progress) Parameters stl NativeStl Triangle Grid. The triangles must be manifold geometry. preferredGridWidth double The expected resolution. token CancellationToken Cancellation token for the operation progress IProgress Progress reporter for the operation Remarks The applied resolution is equal or smaller than the expected resolution. The applied resolution is c*(2^i). Where c is a constant; i is a integer to make the closest value of the formula. 與輸入幾何的誤差分布在菱角及曲面處。 CubeTree(Stl, double, CancellationToken, IProgress) 可使用Stl或NativeStl物件初始化，使用NativeStl的速度較快。輸入的三角網格必須是流形幾何(manifold geometry)，即三角形的頂點對齊其他三角形的頂點，且為封閉幾何。 public CubeTree(Stl stl, double expectedResolution, CancellationToken token, IProgress progress) Parameters stl Stl expectedResolution double 設定裕度，實際裕度會小於等於設定裕度，大約以2的指數作為級距。 與輸入幾何的誤差分布在菱角及曲面處。 token CancellationToken Cancellation token for the operation progress IProgress Progress reporter for the operation CubeTree(string) Initializes a new instance of the CubeTree class from a file. public CubeTree(string file) Parameters file string The path to the cube tree file. Fields defaultPreferredGridWidth The default grid_width for the constructor. public const double defaultPreferredGridWidth = 0.0625 Field Value double Properties CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag CubetreePtr Private element. public nint CubetreePtr { get; } Property Value nint DispCacheMb Display cache size in Mb. The cahce cost from graphic card and RAM. public static long DispCacheMb { get; set; } Property Value long Resolution Get initialized resolution. public double Resolution { get; } Property Value double TotalCacheMb Cache size used by CubeTree. Sum of TrisCacheMb and DispCacheMb. TotalCacheMb Setter distributes (2/5 of the setting value) for DispCacheMb. public static long TotalCacheMb { get; set; } Property Value long TrisCacheMb Triangles cache size in Mb. The cache costs from RAM. public static long TrisCacheMb { get; set; } Property Value long Methods CleanCache() Call Hi.Cbtr.CubeTree.CleanTrisCache() and Hi.Cbtr.CubeTree.CleanDispCache_(). public static void CleanCache() CleanDispCachee() Clean display cache of this. public void CleanDispCachee() Diff(NativeStl, double, RangeColorRule, IProgress) Compares the cube tree with an ideal geometry and returns difference attachments. public ConcurrentBag Diff(NativeStl idealGeom, double diffRadius, RangeColorRule diffRangeColorRule, IProgress progress = null) Parameters idealGeom NativeStl The ideal geometry to compare with. diffRadius double The radius for difference detection. diffRangeColorRule RangeColorRule The color rule for visualizing differences. progress IProgress Progress reporter for the operation. Returns ConcurrentBag A collection of difference attachments. Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~CubeTree() dtor protected ~CubeTree() GetCollidable() Gets the collidable object. public ICollidable GetCollidable() Returns ICollidable The collidable object (this instance). GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetRgbTrisNativeArray(double) Get triangles in type of double array. The returned triangles is non-manifold. It may not be closed model and the apexes of triangle grid may not be overlapped. public double[] GetRgbTrisNativeArray(double resolution = 0) Parameters resolution double The preferred resolution. The real resolution may be smaller or equal the prefered resolution. The real resolution is discrete. The resolution value is at 2^i. The geometric error mainly locate at corner. Returns double[] rgb traingle grid. In sequence of r,g,b,n.x,n.y,n.z,p0.x,p0.y,p0.z,p1.x,p1.y,p1.z,p2.x,p2.y,p2.z, repetitively. A triangle take 15 double. GetTris(double) Get triangles. The returned triangles is non-manifold. It may not be closed model and the apexes of triangle grid may not be overlapped. public List GetTris(double resolution = 0) Parameters resolution double 設定裕度，實際裕度會小於等於設定裕度，大約以2的指數作為級距。與輸入幾何的誤差分布在菱角及曲面處。裕度越大，三角網格數量越少，運算也較迅速。 Returns List 三角網格 RebuildAttach(CbtrPickable) Every node in CubeTree can contain one CbtrPickable object. This function put or replace the contained data of all nodes to src. 使用UpdateAttach(CbtrPickable)會將尚未儲存資料(CbtrPickable為null)的節點放入src。 public void RebuildAttach(CbtrPickable src) Parameters src CbtrPickable RemoveFlyPiece() Removes disconnected pieces (fly pieces) from the cube tree. public void RemoveFlyPiece() Substract(CachedTris, double, bool, bool) 使用BufferedTris效率比NativeStl好。 若差集區域的裕度與本體的裕度不同，則該部位採用較低的裕度。 public UnmanagedSubstraction Substract(CachedTris cutterBufferedTris, double preferredCubeWidth, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters cutterBufferedTris CachedTris 差集幾何 preferredCubeWidth double The preferred cube width for the operation. isBuildContactContours bool 為真，則回傳的Substraction中含有差集幾何與工件幾何相交處的圍線群，該圍線群可做後續分析使用。 isAggressiveCut bool If true, uses aggressive cutting mode. Returns UnmanagedSubstraction Substract(GeomBoolCache, bool, bool) Subtracts a geometry from the cube tree using a geometry boolean cache. public UnmanagedSubstraction Substract(GeomBoolCache geomBoolCache, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters geomBoolCache GeomBoolCache The geometry boolean cache containing the geometry to subtract. isBuildContactContours bool If true, the returned Substraction will contain contact contours. isAggressiveCut bool If true, uses aggressive cutting mode. Returns UnmanagedSubstraction The result of the subtraction operation. Substract(InitStickConvex, Mat4d, double, bool, bool) Subtracts a stick convex geometry from the cube tree. public UnmanagedSubstraction Substract(InitStickConvex initStickConvex, Mat4d mat, double preferredCubeWidth, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters initStickConvex InitStickConvex The stick convex geometry to subtract. mat Mat4d The transformation matrix to apply to the stick convex. preferredCubeWidth double The preferred cube width for the operation. isBuildContactContours bool If true, the returned Substraction will contain contact contours. isAggressiveCut bool If true, uses aggressive cutting mode. Returns UnmanagedSubstraction The result of the subtraction operation. Substract(NativeStl, double, bool, bool) 與Substract(BufferedTris,...)同功能。效率較差，多了一個轉換CachedTris的步驟。 public UnmanagedSubstraction Substract(NativeStl cutterStl, double preferredCubeWidth = 0, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters cutterStl NativeStl preferredCubeWidth double isBuildContactContours bool isAggressiveCut bool Returns UnmanagedSubstraction TestDiff(out CubeTree, out NativeStl) Tests the difference calculation between a cube tree and an ideal geometry. public static void TestDiff(out CubeTree cubeTree_, out NativeStl idealGeom_) Parameters cubeTree_ CubeTree The resulting cube tree. idealGeom_ NativeStl The ideal geometry used for comparison. TestIO() Tests the input/output operations for a cube tree. public static CubeTree TestIO() Returns CubeTree The cube tree created or loaded during the test. TestSimpleRemove(out CubeTree) Tests the simple removal operation on a cube tree. public static void TestSimpleRemove(out CubeTree cubeTree_) Parameters cubeTree_ CubeTree The resulting cube tree after the removal operation. UpdateAttach(CbtrPickable) Every node in CubeTree can contain one CbtrPickable object. This function put src to the nodes that contain null. public void UpdateAttach(CbtrPickable src) Parameters src CbtrPickable WriteFile(string) Writes the cube tree to a file. public void WriteFile(string file) Parameters file string The path where the cube tree will be written." + "summary": "Class CubeTree Namespace Hi.Cbtr Assembly HiCbtr.dll Cube-based data structure. CubeTree has high performance for free-form geometry manipulation include volume removal and addition. public class CubeTree : IDisposable, IDisplayee, ICollidee, ICollidable, IExpandToBox3d, IGetCollidable Inheritance object CubeTree Implements IDisposable IDisplayee ICollidee ICollidable IExpandToBox3d IGetCollidable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(CubeTree, TriTree, Mat4d, double, int) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) SweptableUtil.RemoveBySweepingVolume(CubeTree, IGetSweptable, Mat4d, Mat4d, double, double, bool, bool) CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CubeTree(NativeStl, double, CancellationToken, IProgress) Ctor. This ctor is faster than CubeTree(NativeStl, double, CancellationToken, IProgress). public CubeTree(NativeStl stl, double preferredGridWidth, CancellationToken token, IProgress progress) Parameters stl NativeStl Triangle Grid. The triangles must be manifold geometry. preferredGridWidth double The expected resolution. token CancellationToken Cancellation token for the operation progress IProgress Progress reporter for the operation Remarks The applied resolution is equal or smaller than the expected resolution. The applied resolution is c*(2^i). Where c is a constant; i is a integer to make the closest value of the formula. 與輸入幾何的誤差分布在菱角及曲面處。 CubeTree(Stl, double, CancellationToken, IProgress) 可使用Stl或NativeStl物件初始化，使用NativeStl的速度較快。輸入的三角網格必須是流形幾何(manifold geometry)，即三角形的頂點對齊其他三角形的頂點，且為封閉幾何。 public CubeTree(Stl stl, double expectedResolution, CancellationToken token, IProgress progress) Parameters stl Stl expectedResolution double 設定裕度，實際裕度會小於等於設定裕度，大約以2的指數作為級距。 與輸入幾何的誤差分布在菱角及曲面處。 token CancellationToken Cancellation token for the operation progress IProgress Progress reporter for the operation CubeTree(string) Initializes a new instance of the CubeTree class from a file. public CubeTree(string file) Parameters file string The path to the cube tree file. Fields defaultPreferredGridWidth The default grid_width for the constructor. public const double defaultPreferredGridWidth = 0.0625 Field Value double Properties CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag CubetreePtr Private element. public nint CubetreePtr { get; } Property Value nint DispCacheMb Display cache size in Mb. The cahce cost from graphic card and RAM. public static long DispCacheMb { get; set; } Property Value long Resolution Get initialized resolution. public double Resolution { get; } Property Value double TotalCacheMb Cache size used by CubeTree. Sum of TrisCacheMb and DispCacheMb. TotalCacheMb Setter distributes (2/5 of the setting value) for DispCacheMb. public static long TotalCacheMb { get; set; } Property Value long TrisCacheMb Triangles cache size in Mb. The cache costs from RAM. public static long TrisCacheMb { get; set; } Property Value long Methods CleanCache() Call Hi.Cbtr.CubeTree.CleanTrisCache() and Hi.Cbtr.CubeTree.CleanDispCache_(). public static void CleanCache() CleanDispCachee() Clean display cache of this. public void CleanDispCachee() Diff(NativeStl, double, RangeColorRule, IProgress) Compares the cube tree with an ideal geometry and returns difference attachments. public ConcurrentBag Diff(NativeStl idealGeom, double diffRadius, RangeColorRule diffRangeColorRule, IProgress progress = null) Parameters idealGeom NativeStl The ideal geometry to compare with. diffRadius double The radius for difference detection. diffRangeColorRule RangeColorRule The color rule for visualizing differences. progress IProgress Progress reporter for the operation. Returns ConcurrentBag A collection of difference attachments. Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~CubeTree() dtor protected ~CubeTree() GetCollidable() Gets the collidable object. public ICollidable GetCollidable() Returns ICollidable The collidable object (this instance). GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetRgbTrisNativeArray(double) Get triangles in type of double array. The returned triangles is non-manifold. It may not be closed model and the apexes of triangle grid may not be overlapped. public double[] GetRgbTrisNativeArray(double resolution = 0) Parameters resolution double The preferred resolution. The real resolution may be smaller or equal the prefered resolution. The real resolution is discrete. The resolution value is at 2^i. The geometric error mainly locate at corner. Returns double[] rgb traingle grid. In sequence of r,g,b,n.x,n.y,n.z,p0.x,p0.y,p0.z,p1.x,p1.y,p1.z,p2.x,p2.y,p2.z, repetitively. A triangle take 15 double. GetTris(double) Get triangles. The returned triangles is non-manifold. It may not be closed model and the apexes of triangle grid may not be overlapped. public List GetTris(double resolution = 0) Parameters resolution double 設定裕度，實際裕度會小於等於設定裕度，大約以2的指數作為級距。與輸入幾何的誤差分布在菱角及曲面處。裕度越大，三角網格數量越少，運算也較迅速。 Returns List 三角網格 RebuildAttach(CbtrPickable) Every node in CubeTree can contain one CbtrPickable object. This function put or replace the contained data of all nodes to src. 使用UpdateAttach(CbtrPickable)會將尚未儲存資料(CbtrPickable為null)的節點放入src。 public void RebuildAttach(CbtrPickable src) Parameters src CbtrPickable RemoveFlyPiece() Removes disconnected pieces (fly pieces) from the cube tree. public void RemoveFlyPiece() Substract(CachedTris, double, bool, bool) 使用BufferedTris效率比NativeStl好。 若差集區域的裕度與本體的裕度不同，則該部位採用較低的裕度。 public UnmanagedSubstraction Substract(CachedTris cutterBufferedTris, double preferredCubeWidth, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters cutterBufferedTris CachedTris 差集幾何 preferredCubeWidth double The preferred cube width for the operation. isBuildContactContours bool 為真，則回傳的Substraction中含有差集幾何與工件幾何相交處的圍線群，該圍線群可做後續分析使用。 isAggressiveCut bool If true, uses aggressive cutting mode. Returns UnmanagedSubstraction Substract(GeomBoolCache, bool, bool) Subtracts a geometry from the cube tree using a geometry boolean cache. public UnmanagedSubstraction Substract(GeomBoolCache geomBoolCache, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters geomBoolCache GeomBoolCache The geometry boolean cache containing the geometry to subtract. isBuildContactContours bool If true, the returned Substraction will contain contact contours. isAggressiveCut bool If true, uses aggressive cutting mode. Returns UnmanagedSubstraction The result of the subtraction operation. Substract(InitStickConvex, Mat4d, double, bool, bool) Subtracts a stick convex geometry from the cube tree. public UnmanagedSubstraction Substract(InitStickConvex initStickConvex, Mat4d mat, double preferredCubeWidth, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters initStickConvex InitStickConvex The stick convex geometry to subtract. mat Mat4d The transformation matrix to apply to the stick convex. preferredCubeWidth double The preferred cube width for the operation. isBuildContactContours bool If true, the returned Substraction will contain contact contours. isAggressiveCut bool If true, uses aggressive cutting mode. Returns UnmanagedSubstraction The result of the subtraction operation. Substract(NativeStl, double, bool, bool) 與Substract(BufferedTris,...)同功能。效率較差，多了一個轉換CachedTris的步驟。 public UnmanagedSubstraction Substract(NativeStl cutterStl, double preferredCubeWidth = 0, bool isBuildContactContours = false, bool isAggressiveCut = false) Parameters cutterStl NativeStl preferredCubeWidth double isBuildContactContours bool isAggressiveCut bool Returns UnmanagedSubstraction TestDiff(out CubeTree, out NativeStl) Tests the difference calculation between a cube tree and an ideal geometry. public static void TestDiff(out CubeTree cubeTree_, out NativeStl idealGeom_) Parameters cubeTree_ CubeTree The resulting cube tree. idealGeom_ NativeStl The ideal geometry used for comparison. TestIO() Tests the input/output operations for a cube tree. public static CubeTree TestIO() Returns CubeTree The cube tree created or loaded during the test. TestSimpleRemove(out CubeTree) Tests the simple removal operation on a cube tree. public static void TestSimpleRemove(out CubeTree cubeTree_) Parameters cubeTree_ CubeTree The resulting cube tree after the removal operation. UpdateAttach(CbtrPickable) Every node in CubeTree can contain one CbtrPickable object. This function put src to the nodes that contain null. public void UpdateAttach(CbtrPickable src) Parameters src CbtrPickable WriteFile(string) Writes the cube tree to a file. public void WriteFile(string file) Parameters file string The path where the cube tree will be written." }, "api/Hi.Cbtr.CubeTreeFile.html": { "href": "api/Hi.Cbtr.CubeTreeFile.html", "title": "Class CubeTreeFile | HiAPI-C# 2025", - "summary": "Class CubeTreeFile Namespace Hi.Cbtr Assembly HiCbtr.dll Represents a file containing cube tree data. public class CubeTreeFile : IMakeXmlSource, ISourceFile Inheritance object CubeTreeFile Implements IMakeXmlSource ISourceFile 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) Constructors CubeTreeFile() Ctor. public CubeTreeFile() CubeTreeFile(string, string) Ctor. public CubeTreeFile(string relFile, string baseDirectory) Parameters relFile string baseDirectory string CubeTreeFile(XElement, string) Ctor. public CubeTreeFile(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for relative paths. Properties BaseDirectory Gets or sets the base directory for file operations. public string BaseDirectory { get; set; } Property Value string SourceFile file path. public string SourceFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods LoadByFile() Loads a cube tree from the specified file. public CubeTree LoadByFile() Returns CubeTree The loaded cube tree, or null if the file path is empty or null. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CubeTreeFile Namespace Hi.Cbtr Assembly HiCbtr.dll Represents a file containing cube tree data. public class CubeTreeFile : IMakeXmlSource, ISourceFile Inheritance object CubeTreeFile Implements IMakeXmlSource ISourceFile 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) Constructors CubeTreeFile() Ctor. public CubeTreeFile() CubeTreeFile(string, string) Ctor. public CubeTreeFile(string relFile, string baseDirectory) Parameters relFile string baseDirectory string CubeTreeFile(XElement, string) Ctor. public CubeTreeFile(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for relative paths. Properties BaseDirectory Gets or sets the base directory for file operations. public string BaseDirectory { get; set; } Property Value string SourceFile file path. public string SourceFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods LoadByFile() Loads a cube tree from the specified file. public CubeTree LoadByFile() Returns CubeTree The loaded cube tree, or null if the file path is empty or null. 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." }, "api/Hi.Cbtr.DiffAttachment.html": { "href": "api/Hi.Cbtr.DiffAttachment.html", "title": "Class DiffAttachment | HiAPI-C# 2025", - "summary": "Class DiffAttachment Namespace Hi.Cbtr Assembly HiCbtr.dll Represents an attachment with a difference value for cube tree. public class DiffAttachment : CbtrPickable, IPickableGetter, IDisposable Inheritance object Pickable CbtrPickable DiffAttachment Implements IPickableGetter IDisposable Inherited Members CbtrPickable.Rgb CbtrPickable.AttachmentPriority CbtrPickable.Highlight(bool) CbtrPickable.CleanLinkedCbtrNodesDrawingCache() CbtrPickable.ShrinkToFitNodeMap() CbtrPickable.OnMouseEnter(ui_event_type, panel_state_t) CbtrPickable.OnMouseLeave(ui_event_type, panel_state_t) Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.OnKeyDown(key_event_t, panel_state_t) Pickable.OnKeyUp(key_event_t, panel_state_t) Pickable.OnMouseDown(mouse_button_event_t, panel_state_t) Pickable.OnMouseUp(mouse_button_event_t, panel_state_t) Pickable.OnMouseMove(mouse_move_event_t, panel_state_t) Pickable.OnMouseWheel(mouse_wheel_event_t, panel_state_t) Pickable.Dispose() 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) Constructors DiffAttachment(double) Initializes a new instance of the DiffAttachment class. public DiffAttachment(double diff) Parameters diff double The difference value. Properties Diff Gets or sets the difference value. public double Diff { get; set; } Property Value double Methods Dispose(bool) protected override void Dispose(bool disposing) Parameters disposing bool" + "summary": "Class DiffAttachment Namespace Hi.Cbtr Assembly HiCbtr.dll Represents an attachment with a difference value for cube tree. public class DiffAttachment : CbtrPickable, IGetPickable, IDisposable Inheritance object Pickable CbtrPickable DiffAttachment Implements IGetPickable IDisposable Inherited Members CbtrPickable.Rgb CbtrPickable.AttachmentPriority CbtrPickable.Highlight(bool) CbtrPickable.CleanLinkedCbtrNodesDrawingCache() CbtrPickable.ShrinkToFitNodeMap() CbtrPickable.OnMouseEnter(ui_event_type, panel_state_t) CbtrPickable.OnMouseLeave(ui_event_type, panel_state_t) Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.OnKeyDown(key_event_t, panel_state_t) Pickable.OnKeyUp(key_event_t, panel_state_t) Pickable.OnMouseDown(mouse_button_event_t, panel_state_t) Pickable.OnMouseUp(mouse_button_event_t, panel_state_t) Pickable.OnMouseMove(mouse_move_event_t, panel_state_t) Pickable.OnMouseWheel(mouse_wheel_event_t, panel_state_t) Pickable.Dispose() 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) Constructors DiffAttachment(double) Initializes a new instance of the DiffAttachment class. public DiffAttachment(double diff) Parameters diff double The difference value. Properties Diff Gets or sets the difference value. public double Diff { get; set; } Property Value double Methods Dispose(bool) protected override void Dispose(bool disposing) Parameters disposing bool" }, "api/Hi.Cbtr.GeomBoolCache.html": { "href": "api/Hi.Cbtr.GeomBoolCache.html", @@ -67,12 +67,12 @@ "api/Hi.Cbtr.UnhighlightablePickable.html": { "href": "api/Hi.Cbtr.UnhighlightablePickable.html", "title": "Class UnhighlightablePickable | HiAPI-C# 2025", - "summary": "Class UnhighlightablePickable Namespace Hi.Cbtr Assembly HiCbtr.dll Cbtr un-highlightable pickable. For initailizing purpose by RebuildAttach(CbtrPickable). public class UnhighlightablePickable : CbtrPickable, IPickableGetter, IDisposable Inheritance object Pickable CbtrPickable UnhighlightablePickable Implements IPickableGetter IDisposable Inherited Members CbtrPickable.Rgb CbtrPickable.AttachmentPriority CbtrPickable.Highlight(bool) CbtrPickable.CleanLinkedCbtrNodesDrawingCache() CbtrPickable.ShrinkToFitNodeMap() CbtrPickable.Dispose(bool) Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.OnKeyDown(key_event_t, panel_state_t) Pickable.OnKeyUp(key_event_t, panel_state_t) Pickable.OnMouseDown(mouse_button_event_t, panel_state_t) Pickable.OnMouseUp(mouse_button_event_t, panel_state_t) Pickable.OnMouseMove(mouse_move_event_t, panel_state_t) Pickable.OnMouseWheel(mouse_wheel_event_t, panel_state_t) Pickable.Dispose() 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) Constructors UnhighlightablePickable() Ctor. public UnhighlightablePickable() Methods OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state" + "summary": "Class UnhighlightablePickable Namespace Hi.Cbtr Assembly HiCbtr.dll Cbtr un-highlightable pickable. For initailizing purpose by RebuildAttach(CbtrPickable). public class UnhighlightablePickable : CbtrPickable, IGetPickable, IDisposable Inheritance object Pickable CbtrPickable UnhighlightablePickable Implements IGetPickable IDisposable Inherited Members CbtrPickable.Rgb CbtrPickable.AttachmentPriority CbtrPickable.Highlight(bool) CbtrPickable.CleanLinkedCbtrNodesDrawingCache() CbtrPickable.ShrinkToFitNodeMap() CbtrPickable.Dispose(bool) Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.OnKeyDown(key_event_t, panel_state_t) Pickable.OnKeyUp(key_event_t, panel_state_t) Pickable.OnMouseDown(mouse_button_event_t, panel_state_t) Pickable.OnMouseUp(mouse_button_event_t, panel_state_t) Pickable.OnMouseMove(mouse_move_event_t, panel_state_t) Pickable.OnMouseWheel(mouse_wheel_event_t, panel_state_t) Pickable.Dispose() 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) Constructors UnhighlightablePickable() Ctor. public UnhighlightablePickable() Methods OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state" }, "api/Hi.Cbtr.UnmanagedSubstraction.html": { "href": "api/Hi.Cbtr.UnmanagedSubstraction.html", "title": "Class UnmanagedSubstraction | HiAPI-C# 2025", - "summary": "Class UnmanagedSubstraction Namespace Hi.Cbtr Assembly HiCbtr.dll Data about the removing behavior of CubeTree. public class UnmanagedSubstraction : IDisplayee, IExpandToBox3d, IDisposable Inheritance object UnmanagedSubstraction Implements IDisplayee IExpandToBox3d 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) Fields preserveCount The count of preservations to prevent disposal. public int preserveCount Field Value int Properties ContactContours Contact contours. Each contour is composed by 3~12 points. public List> ContactContours { get; } Property Value List> ContactContoursArea Gets the area of the contact contours. public double ContactContoursArea { get; } Property Value double IsTouched Is the cutter and workpiece touched. public bool IsTouched { get; } Property Value bool Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. DisplayContours(Bind) Display ContactContours by lines. public void DisplayContours(Bind bind) Parameters bind Bind bind DisplayContours(List>, Bind) Displays contours in a visualization binding. public static void DisplayContours(List> contours, Bind bind) Parameters contours List> The list of contours to display, where each contour is a list of 3D points. bind Bind The binding to display the contours in. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~UnmanagedSubstraction() protected ~UnmanagedSubstraction() PreserveBegin() Preserve the object from arising Dispose(). Add preserve count for 1. public void PreserveBegin() See Also PreserveEnd() PreserveEnd() Minus preserve count for 1. If preserve count is eqaul or lower than 0, call Dispose(). public void PreserveEnd() See Also PreserveBegin()" + "summary": "Class UnmanagedSubstraction Namespace Hi.Cbtr Assembly HiCbtr.dll Data about the removing behavior of CubeTree. public class UnmanagedSubstraction : IDisplayee, IExpandToBox3d, IDisposable Inheritance object UnmanagedSubstraction Implements IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields preserveCount The count of preservations to prevent disposal. public int preserveCount Field Value int Properties ContactContours Contact contours. Each contour is composed by 3~12 points. public List> ContactContours { get; } Property Value List> ContactContoursArea Gets the area of the contact contours. public double ContactContoursArea { get; } Property Value double IsTouched Is the cutter and workpiece touched. public bool IsTouched { get; } Property Value bool Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. DisplayContours(Bind) Display ContactContours by lines. public void DisplayContours(Bind bind) Parameters bind Bind bind DisplayContours(List>, Bind) Displays contours in a visualization binding. public static void DisplayContours(List> contours, Bind bind) Parameters contours List> The list of contours to display, where each contour is a list of 3D points. bind Bind The binding to display the contours in. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~UnmanagedSubstraction() protected ~UnmanagedSubstraction() PreserveBegin() Preserve the object from arising Dispose(). Add preserve count for 1. public void PreserveBegin() See Also PreserveEnd() PreserveEnd() Minus preserve count for 1. If preserve count is eqaul or lower than 0, call Dispose(). public void PreserveEnd() See Also PreserveBegin()" }, "api/Hi.Cbtr.html": { "href": "api/Hi.Cbtr.html", @@ -92,7 +92,7 @@ "api/Hi.Collision.AnchoredCollidablePair.html": { "href": "api/Hi.Collision.AnchoredCollidablePair.html", "title": "Class AnchoredCollidablePair | HiAPI-C# 2025", - "summary": "Class AnchoredCollidablePair Namespace Hi.Collision Assembly HiMech.dll Represents a pair of anchored collidable objects for collision detection. public class AnchoredCollidablePair : IMakeXmlSource Inheritance object AnchoredCollidablePair Implements IMakeXmlSource Inherited Members object.Equals(object, object) 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) Constructors AnchoredCollidablePair(IAnchoredCollidableBased, IAnchoredCollidableBased) Initializes a new instance of the AnchoredCollidablePair class with two collidable objects. public AnchoredCollidablePair(IAnchoredCollidableBased indexA, IAnchoredCollidableBased indexB) Parameters indexA IAnchoredCollidableBased The first collidable object. indexB IAnchoredCollidableBased The second collidable object. AnchoredCollidablePair(string, IAnchoredCollidableBased, IAnchoredCollidableBased) Initializes a new instance of the AnchoredCollidablePair class with a name and two collidable objects. public AnchoredCollidablePair(string name, IAnchoredCollidableBased indexA, IAnchoredCollidableBased indexB) Parameters name string The name of the pair. indexA IAnchoredCollidableBased The first collidable object. indexB IAnchoredCollidableBased The second collidable object. AnchoredCollidablePair(XElement, string, params object[]) Initializes a new instance of the AnchoredCollidablePair class from XML. public AnchoredCollidablePair(XElement src, string baseDirectory, params object[] res) Parameters src XElement The XML element containing the pair data. baseDirectory string The base directory for resolving relative paths. res object[] Additional resources for initialization. Fields XName The XML element name for serialization. public static string XName Field Value string Properties CollisionFlag Gets or sets the collision flag indicating the collision status between the two objects. public CollisionFlag CollisionFlag { get; } Property Value CollisionFlag IndexA Gets the first collidable object in the pair. public IAnchoredCollidableBased IndexA { get; } Property Value IAnchoredCollidableBased IndexB Gets the second collidable object in the pair. public IAnchoredCollidableBased IndexB { get; } Property Value IAnchoredCollidableBased MatAB Gets or sets the transformation matrix from object A to object B. public Mat4d MatAB { get; set; } Property Value Mat4d Name Gets or sets the pair name for UI manipulation. public string Name { get; set; } Property Value string SafeDistance Gets or sets the safe distance between the two collidable objects. public double SafeDistance { get; set; } Property Value double Methods 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. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class AnchoredCollidablePair Namespace Hi.Collision Assembly HiMech.dll Represents a pair of anchored collidable objects for collision detection. public class AnchoredCollidablePair : IMakeXmlSource Inheritance object AnchoredCollidablePair Implements IMakeXmlSource Inherited Members object.Equals(object, object) 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) Constructors AnchoredCollidablePair(IAnchoredCollidableBased, IAnchoredCollidableBased) Initializes a new instance of the AnchoredCollidablePair class with two collidable objects. public AnchoredCollidablePair(IAnchoredCollidableBased indexA, IAnchoredCollidableBased indexB) Parameters indexA IAnchoredCollidableBased The first collidable object. indexB IAnchoredCollidableBased The second collidable object. AnchoredCollidablePair(string, IAnchoredCollidableBased, IAnchoredCollidableBased) Initializes a new instance of the AnchoredCollidablePair class with a name and two collidable objects. public AnchoredCollidablePair(string name, IAnchoredCollidableBased indexA, IAnchoredCollidableBased indexB) Parameters name string The name of the pair. indexA IAnchoredCollidableBased The first collidable object. indexB IAnchoredCollidableBased The second collidable object. AnchoredCollidablePair(XElement, string, params object[]) Initializes a new instance of the AnchoredCollidablePair class from XML. public AnchoredCollidablePair(XElement src, string baseDirectory, params object[] res) Parameters src XElement The XML element containing the pair data. baseDirectory string The base directory for resolving relative paths. res object[] Additional resources for initialization. Fields XName The XML element name for serialization. public static string XName Field Value string Properties CollisionFlag Gets or sets the collision flag indicating the collision status between the two objects. public CollisionFlag CollisionFlag { get; } Property Value CollisionFlag IndexA Gets the first collidable object in the pair. public IAnchoredCollidableBased IndexA { get; } Property Value IAnchoredCollidableBased IndexB Gets the second collidable object in the pair. public IAnchoredCollidableBased IndexB { get; } Property Value IAnchoredCollidableBased MatAB Gets or sets the transformation matrix from object A to object B. public Mat4d MatAB { get; set; } Property Value Mat4d Name Gets or sets the pair name for UI manipulation. public string Name { get; set; } Property Value string SafeDistance Gets or sets the safe distance between the two collidable objects. public double SafeDistance { get; set; } Property Value double Methods 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. 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." }, "api/Hi.Collision.CollidableStl.html": { "href": "api/Hi.Collision.CollidableStl.html", @@ -102,12 +102,12 @@ "api/Hi.Collision.CollisionFlag.html": { "href": "api/Hi.Collision.CollisionFlag.html", "title": "Enum CollisionFlag | HiAPI-C# 2025", - "summary": "Enum CollisionFlag Namespace Hi.Collision Assembly HiCbtr.dll Collision flag. The definition is the same as native collision_flag. public enum CollisionFlag Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields COLLISION = 0 Collision. MAY_INSIDE_SAFE_DISTANCE = 1 May or may not be inside the safe distance. OUTSIDE_SAFE_DISTANCE = 2 Outside the safe distance. UNDEFINED = 3 Not defined behavior. _IGNORED = 4 Internal Use Only Remarks The int value is according to severity. The larger is severer." + "summary": "Enum CollisionFlag Namespace Hi.Collision Assembly HiCbtr.dll Collision flag. The definition is the same as native collision_flag. public enum CollisionFlag Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields Collision = 0 Collision. MAY_INSIDE_SAFE_DISTANCE = 1 May or may not be inside the safe distance. OUTSIDE_SAFE_DISTANCE = 2 Outside the safe distance. UNDEFINED = 3 Not defined behavior. _IGNORED = 4 Internal Use Only Remarks The int value is according to severity. The larger is severer." }, "api/Hi.Collision.CollisionIndexPair.html": { "href": "api/Hi.Collision.CollisionIndexPair.html", "title": "Class CollisionIndexPair | HiAPI-C# 2025", - "summary": "Class CollisionIndexPair Namespace Hi.Collision Assembly HiMech.dll Represents a pair of collision indices for collision detection. public class CollisionIndexPair : IMakeXmlSource Inheritance object CollisionIndexPair Implements IMakeXmlSource Inherited Members object.Equals(object, object) 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) Constructors CollisionIndexPair(ICollisionIndex, ICollisionIndex) Initializes a new instance of the CollisionIndexPair class with two collision indices. public CollisionIndexPair(ICollisionIndex indexA, ICollisionIndex indexB) Parameters indexA ICollisionIndex The first collision index. indexB ICollisionIndex The second collision index. CollisionIndexPair(XElement, string, params object[]) Initializes a new instance of the CollisionIndexPair class from XML. public CollisionIndexPair(XElement src, string baseDirectory, params object[] res) Parameters src XElement The XML element containing the pair data. baseDirectory string The base directory for resolving relative paths. res object[] Additional resources for initialization. Fields XName The XML element name for serialization. public static string XName Field Value string Properties CollisionFlag Gets or sets the collision flag indicating the collision status between the two objects. public CollisionFlag CollisionFlag { get; } Property Value CollisionFlag IndexA Gets the first collision index in the pair. public ICollisionIndex IndexA { get; } Property Value ICollisionIndex IndexB Gets the second collision index in the pair. public ICollisionIndex IndexB { get; } Property Value ICollisionIndex MatAB Gets or sets the transformation matrix from object A to object B. public Mat4d MatAB { get; set; } Property Value Mat4d SafeDistance Gets or sets the safe distance between the two collision indices. public double SafeDistance { get; set; } Property Value double Methods 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. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CollisionIndexPair Namespace Hi.Collision Assembly HiMech.dll Represents a pair of collision indices for collision detection. public class CollisionIndexPair : IMakeXmlSource Inheritance object CollisionIndexPair Implements IMakeXmlSource Inherited Members object.Equals(object, object) 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) Constructors CollisionIndexPair(ICollisionIndex, ICollisionIndex) Initializes a new instance of the CollisionIndexPair class with two collision indices. public CollisionIndexPair(ICollisionIndex indexA, ICollisionIndex indexB) Parameters indexA ICollisionIndex The first collision index. indexB ICollisionIndex The second collision index. CollisionIndexPair(XElement, string, params object[]) Initializes a new instance of the CollisionIndexPair class from XML. public CollisionIndexPair(XElement src, string baseDirectory, params object[] res) Parameters src XElement The XML element containing the pair data. baseDirectory string The base directory for resolving relative paths. res object[] Additional resources for initialization. Fields XName The XML element name for serialization. public static string XName Field Value string Properties CollisionFlag Gets or sets the collision flag indicating the collision status between the two objects. public CollisionFlag CollisionFlag { get; } Property Value CollisionFlag IndexA Gets the first collision index in the pair. public ICollisionIndex IndexA { get; } Property Value ICollisionIndex IndexB Gets the second collision index in the pair. public ICollisionIndex IndexB { get; } Property Value ICollisionIndex MatAB Gets or sets the transformation matrix from object A to object B. public Mat4d MatAB { get; set; } Property Value Mat4d SafeDistance Gets or sets the safe distance between the two collision indices. public double SafeDistance { get; set; } Property Value double Methods 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. 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." }, "api/Hi.Collision.CollisionUtil.html": { "href": "api/Hi.Collision.CollisionUtil.html", @@ -152,12 +152,12 @@ "api/Hi.Collision.ICollisionArena.html": { "href": "api/Hi.Collision.ICollisionArena.html", "title": "Interface ICollisionArena | HiAPI-C# 2025", - "summary": "Interface ICollisionArena Namespace Hi.Collision Assembly HiMech.dll Interface for a topological collision arena that manages collision detection between objects. public interface ICollisionArena : IGetCollisionIndexPairs, IGetAsmb, IGetTopoIndex, IGetRootAnchor Inherited Members IGetCollisionIndexPairs.GetCollisionIndexPairs() IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() 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)" + "summary": "Interface ICollisionArena Namespace Hi.Collision Assembly HiMech.dll Interface for a topological collision arena that manages collision detection between objects. public interface ICollisionArena : IGetCollisionIndexPairs, IGetAsmb, IGetAnchor, IGetTopoIndex Inherited Members IGetCollisionIndexPairs.GetCollisionIndexPairs() IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object)" }, "api/Hi.Collision.ICollisionIndex.html": { "href": "api/Hi.Collision.ICollisionIndex.html", "title": "Interface ICollisionIndex | HiAPI-C# 2025", - "summary": "Interface ICollisionIndex Namespace Hi.Collision Assembly HiMech.dll Interface for collision index objects that provide identification and anchoring for collidable objects. public interface ICollisionIndex : IGetCollidable, IMakeXmlSource Inherited Members IGetCollidable.GetCollidable() IMakeXmlSource.MakeXmlSource(string, string) 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) Properties Anchor Gets the anchor point for this collision index. Anchor Anchor { get; } Property Value Anchor Key Gets the unique identifier for this collision index. string Key { get; } Property Value string" + "summary": "Interface ICollisionIndex Namespace Hi.Collision Assembly HiMech.dll Interface for collision index objects that provide identification and anchoring for collidable objects. public interface ICollisionIndex : IGetCollidable, IMakeXmlSource Inherited Members IGetCollidable.GetCollidable() IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Properties Anchor Gets the anchor point for this collision index. Anchor Anchor { get; } Property Value Anchor Key Gets the unique identifier for this collision index. string Key { get; } Property Value string" }, "api/Hi.Collision.IGetAnchoredCollidablePairs.html": { "href": "api/Hi.Collision.IGetAnchoredCollidablePairs.html", @@ -204,6 +204,21 @@ "title": "Namespace Hi.Collision | HiAPI-C# 2025", "summary": "Namespace Hi.Collision Classes AnchoredCollidableLeaf Represents a leaf node in the anchored collidable hierarchy. AnchoredCollidablePair Represents a pair of anchored collidable objects for collision detection. CollidableStl Collidable Stl. CollisionIndexPair Represents a pair of collision indices for collision detection. CollisionUtil Utility of tree grid related structure. FuncAnchoredCollidable Represents a function-based implementation of an anchored collidable object. MechCollisionResult Represents the result of a mechanical collision detection operation. MechCollisionUtil Utility class providing methods for mechanical collision detection and management. TriTree A wrapper provides native tree-grid-based structure. It wraps NativeStl. Interfaces IAnchoredCollidableBased Interface for objects that are based on anchored collidable nodes. IAnchoredCollidableLeaf Interface for leaf nodes in the anchored collidable hierarchy. A leaf node represents a collidable object that doesn't contain other collidable objects. IAnchoredCollidableNode Base interface for anchored collidable nodes in the collision hierarchy. Do not inherit this interface directly. Only inherit directly from IAnchoredCollidableLeaf and IAnchoredCollidableStem. It is acceptable to inherit from IAnchoredCollidableLeaf and IAnchoredCollidableStem. IAnchoredCollidableStem Interface for stem nodes in the anchored collidable hierarchy. A stem node represents a collidable object that contains other collidable objects. ICollidable Collidable geometry. ICollidee Dont inherit the interface. Only TriTree and CubeTree inherit the interface. ICollisionArena Interface for a topological collision arena that manages collision detection between objects. ICollisionIndex Interface for collision index objects that provide identification and anchoring for collidable objects. IGetAnchoredCollidablePairs Interface for objects that can provide pairs of anchored collidable objects for collision detection. IGetCollidable Interface for objects that can provide a collidable object. IGetCollisionIndexPairs Interface for objects that can provide pairs of collision indices for collision detection. IGetDefaultCollidablePairs Interface for objects that can provide default pairs of anchored collidable objects. IGetTriTree Interface of TriTree Getter. Enums CollisionFlag Collision flag. The definition is the same as native collision_flag." }, + "api/Hi.Collisions.AnchoredCollidabled.html": { + "href": "api/Hi.Collisions.AnchoredCollidabled.html", + "title": "Class AnchoredCollidabled | HiAPI-C# 2025", + "summary": "Class AnchoredCollidabled Namespace Hi.Collisions Assembly HiMech.dll public class AnchoredCollidabled : IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex Inheritance object AnchoredCollidabled Implements IAnchoredCollidabled IGetCollidable IGetAnchor IGetTopoIndex 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) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors AnchoredCollidabled() public AnchoredCollidabled() AnchoredCollidabled(Anchor, ICollidable) public AnchoredCollidabled(Anchor anchor, ICollidable collidable) Parameters anchor Anchor collidable ICollidable Properties Anchor public Anchor Anchor { get; set; } Property Value Anchor Collidable public ICollidable Collidable { get; set; } Property Value ICollidable Methods GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetCollidable() Get ICollidable. public ICollidable GetCollidable() Returns ICollidable The collidable object. GetCollidableAnchor() public Anchor GetCollidableAnchor() Returns Anchor" + }, + "api/Hi.Collisions.IAnchoredCollidabled.html": { + "href": "api/Hi.Collisions.IAnchoredCollidabled.html", + "title": "Interface IAnchoredCollidabled | HiAPI-C# 2025", + "summary": "Interface IAnchoredCollidabled Namespace Hi.Collisions Assembly HiMech.dll public interface IAnchoredCollidabled : IGetCollidable, IGetAnchor, IGetTopoIndex Inherited Members IGetCollidable.GetCollidable() IGetAnchor.GetAnchor() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods GetCollidableAnchor() Anchor GetCollidableAnchor() Returns Anchor" + }, + "api/Hi.Collisions.html": { + "href": "api/Hi.Collisions.html", + "title": "Namespace Hi.Collisions | HiAPI-C# 2025", + "summary": "Namespace Hi.Collisions Classes AnchoredCollidabled Interfaces IAnchoredCollidabled" + }, "api/Hi.Coloring.ColorUtil.html": { "href": "api/Hi.Coloring.ColorUtil.html", "title": "Class ColorUtil | HiAPI-C# 2025", @@ -212,27 +227,27 @@ "api/Hi.Coloring.DictionaryColorGuide.html": { "href": "api/Hi.Coloring.DictionaryColorGuide.html", "title": "Class DictionaryColorGuide | HiAPI-C# 2025", - "summary": "Class DictionaryColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that manages a dictionary of color guides and allows selection of one active guide. public class DictionaryColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object DictionaryColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors DictionaryColorGuide() Initializes a new instance of the DictionaryColorGuide class. public DictionaryColorGuide() DictionaryColorGuide(DictionaryColorGuide) Initializes a new instance of the DictionaryColorGuide class by copying from another instance. public DictionaryColorGuide(DictionaryColorGuide src) Parameters src DictionaryColorGuide The source color guide to copy from. DictionaryColorGuide(XElement, string, Dictionary) Initializes a new instance of the DictionaryColorGuide class from XML. public DictionaryColorGuide(XElement src, string baseDirectory, Dictionary colorGuideCtorArgDictionary) Parameters src XElement The XML element containing the color guide data. baseDirectory string The base directory for resolving relative paths. colorGuideCtorArgDictionary Dictionary Dictionary containing constructor arguments for color guides. Properties KeyToColorGuide Gets or sets the dictionary mapping keys to color guides. public Dictionary KeyToColorGuide { get; set; } Property Value Dictionary SelectedColorGuide Gets the currently selected color guide. public IColorGuide SelectedColorGuide { get; } Property Value IColorGuide SelectedKey Gets or sets the key of the currently selected color guide. public string SelectedKey { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state RefreshSelectedColorGuide() Refreshes the selected color guide based on the current SelectedKey. public void RefreshSelectedColorGuide()" + "summary": "Class DictionaryColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that manages a dictionary of color guides and allows selection of one active guide. public class DictionaryColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object DictionaryColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors DictionaryColorGuide() Initializes a new instance of the DictionaryColorGuide class. public DictionaryColorGuide() DictionaryColorGuide(DictionaryColorGuide) Initializes a new instance of the DictionaryColorGuide class by copying from another instance. public DictionaryColorGuide(DictionaryColorGuide src) Parameters src DictionaryColorGuide The source color guide to copy from. DictionaryColorGuide(XElement, string, Dictionary) Initializes a new instance of the DictionaryColorGuide class from XML. public DictionaryColorGuide(XElement src, string baseDirectory, Dictionary colorGuideCtorArgDictionary) Parameters src XElement The XML element containing the color guide data. baseDirectory string The base directory for resolving relative paths. colorGuideCtorArgDictionary Dictionary Dictionary containing constructor arguments for color guides. Properties KeyToColorGuide Gets or sets the dictionary mapping keys to color guides. public Dictionary KeyToColorGuide { get; set; } Property Value Dictionary SelectedColorGuide Gets the currently selected color guide. public IColorGuide SelectedColorGuide { get; } Property Value IColorGuide SelectedKey Gets or sets the key of the currently selected color guide. public string SelectedKey { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority 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. RefreshSelectedColorGuide() Refreshes the selected color guide based on the current SelectedKey. public void RefreshSelectedColorGuide()" }, "api/Hi.Coloring.DiscreteQuantityColorGuide.html": { "href": "api/Hi.Coloring.DiscreteQuantityColorGuide.html", "title": "Class DiscreteQuantityColorGuide | HiAPI-C# 2025", - "summary": "Class DiscreteQuantityColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that assigns colors based on discrete quantity values. public class DiscreteQuantityColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object DiscreteQuantityColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors DiscreteQuantityColorGuide() Initializes a new instance of the DiscreteQuantityColorGuide class. public DiscreteQuantityColorGuide() DiscreteQuantityColorGuide(string) Initializes a new instance of the DiscreteQuantityColorGuide class with a specified quantity key. public DiscreteQuantityColorGuide(string quantityKey) Parameters quantityKey string The key used to retrieve quantity values. DiscreteQuantityColorGuide(XElement) Initializes a new instance of the DiscreteQuantityColorGuide class from XML. public DiscreteQuantityColorGuide(XElement src) Parameters src XElement The XML element containing the color guide data. Properties QuantityKey Gets or sets the key used to retrieve the quantity value. public string QuantityKey { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class DiscreteQuantityColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that assigns colors based on discrete quantity values. public class DiscreteQuantityColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object DiscreteQuantityColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors DiscreteQuantityColorGuide() Initializes a new instance of the DiscreteQuantityColorGuide class. public DiscreteQuantityColorGuide() DiscreteQuantityColorGuide(string) Initializes a new instance of the DiscreteQuantityColorGuide class with a specified quantity key. public DiscreteQuantityColorGuide(string quantityKey) Parameters quantityKey string The key used to retrieve quantity values. DiscreteQuantityColorGuide(XElement) Initializes a new instance of the DiscreteQuantityColorGuide class from XML. public DiscreteQuantityColorGuide(XElement src) Parameters src XElement The XML element containing the color guide data. Properties QuantityKey Gets or sets the key used to retrieve the quantity value. public string QuantityKey { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority 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." }, "api/Hi.Coloring.FilteredColorGuide.html": { "href": "api/Hi.Coloring.FilteredColorGuide.html", "title": "Class FilteredColorGuide | HiAPI-C# 2025", - "summary": "Class FilteredColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that combines a filter color guide with a dictionary color guide. public class FilteredColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object FilteredColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors FilteredColorGuide() Initializes a new instance of the FilteredColorGuide class. public FilteredColorGuide() FilteredColorGuide(XElement, string, Dictionary) Initializes a new instance of the FilteredColorGuide class from XML. public FilteredColorGuide(XElement src, string baseDirectory, Dictionary colorGuideCtorArgDictionary) Parameters src XElement The XML element containing the color guide data. baseDirectory string The base directory for resolving relative paths. colorGuideCtorArgDictionary Dictionary Dictionary containing constructor arguments for color guides. Properties DictionaryColorGuide Gets or sets the dictionary color guide that is used when the filter color guide returns null. public DictionaryColorGuide DictionaryColorGuide { get; set; } Property Value DictionaryColorGuide FilterColorGuide Gets or sets the filter color guide that is applied first. public IColorGuide FilterColorGuide { get; set; } Property Value IColorGuide XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FilteredColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that combines a filter color guide with a dictionary color guide. public class FilteredColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object FilteredColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors FilteredColorGuide() Initializes a new instance of the FilteredColorGuide class. public FilteredColorGuide() FilteredColorGuide(XElement, string, Dictionary) Initializes a new instance of the FilteredColorGuide class from XML. public FilteredColorGuide(XElement src, string baseDirectory, Dictionary colorGuideCtorArgDictionary) Parameters src XElement The XML element containing the color guide data. baseDirectory string The base directory for resolving relative paths. colorGuideCtorArgDictionary Dictionary Dictionary containing constructor arguments for color guides. Properties DictionaryColorGuide Gets or sets the dictionary color guide that is used when the filter color guide returns null. public DictionaryColorGuide DictionaryColorGuide { get; set; } Property Value DictionaryColorGuide FilterColorGuide Gets or sets the filter color guide that is applied first. public IColorGuide FilterColorGuide { get; set; } Property Value IColorGuide XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority 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." }, "api/Hi.Coloring.FuncRangeColorGuide.html": { "href": "api/Hi.Coloring.FuncRangeColorGuide.html", "title": "Class FuncRangeColorGuide | HiAPI-C# 2025", - "summary": "Class FuncRangeColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that uses a function to get a numeric value and maps it to a color using a range color rule. public class FuncRangeColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide, IGetRangeColorRule Inheritance object FuncRangeColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide IGetRangeColorRule 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) Constructors FuncRangeColorGuide(Func, RangeColorRule) Initializes a new instance of the FuncRangeColorGuide class. public FuncRangeColorGuide(Func colorIndexFunc, RangeColorRule rangeColorRule) Parameters colorIndexFunc Func The function to get the numeric value for coloring. rangeColorRule RangeColorRule The rule that maps numeric values to colors. FuncRangeColorGuide(XElement, Func) Initializes a new instance of the FuncRangeColorGuide class from XML. public FuncRangeColorGuide(XElement src, Func colorIndexFunc) Parameters src XElement The XML element containing the color guide data. colorIndexFunc Func The function to get the numeric value for coloring. Properties ColorIndexFunc Gets or sets the function that extracts a numeric value from the input object for coloring. public Func ColorIndexFunc { get; set; } Property Value Func RangeColorRule Gets or sets the rule that maps numeric values to colors. public RangeColorRule RangeColorRule { get; set; } Property Value RangeColorRule XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRangeColorRule() Gets the range color rule. public RangeColorRule GetRangeColorRule() Returns RangeColorRule The range color rule. GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FuncRangeColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that uses a function to get a numeric value and maps it to a color using a range color rule. public class FuncRangeColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide, IGetRangeColorRule Inheritance object FuncRangeColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide IGetRangeColorRule 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) Constructors FuncRangeColorGuide(Func, RangeColorRule) Initializes a new instance of the FuncRangeColorGuide class. public FuncRangeColorGuide(Func colorIndexFunc, RangeColorRule rangeColorRule) Parameters colorIndexFunc Func The function to get the numeric value for coloring. rangeColorRule RangeColorRule The rule that maps numeric values to colors. FuncRangeColorGuide(XElement, Func) Initializes a new instance of the FuncRangeColorGuide class from XML. public FuncRangeColorGuide(XElement src, Func colorIndexFunc) Parameters src XElement The XML element containing the color guide data. colorIndexFunc Func The function to get the numeric value for coloring. Properties ColorIndexFunc Gets or sets the function that extracts a numeric value from the input object for coloring. public Func ColorIndexFunc { get; set; } Property Value Func RangeColorRule Gets or sets the rule that maps numeric values to colors. public RangeColorRule RangeColorRule { get; set; } Property Value RangeColorRule XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRangeColorRule() Gets the range color rule. public RangeColorRule GetRangeColorRule() Returns RangeColorRule The range color rule. GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority 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." }, "api/Hi.Coloring.IColorGuide.html": { "href": "api/Hi.Coloring.IColorGuide.html", "title": "Interface IColorGuide | HiAPI-C# 2025", - "summary": "Interface IColorGuide Namespace Hi.Coloring Assembly HiMech.dll Interface of setting color and the rendering priority. public interface IColorGuide : IMakeXmlSource, IGetColorGuide Inherited Members IMakeXmlSource.MakeXmlSource(string, string) IGetColorGuide.GetColorGuide() 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) Methods GetRgb(object) Get rgb bystep. Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority" + "summary": "Interface IColorGuide Namespace Hi.Coloring Assembly HiMech.dll Interface of setting color and the rendering priority. public interface IColorGuide : IMakeXmlSource, IGetColorGuide Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) IGetColorGuide.GetColorGuide() 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) Methods GetRgb(object) Get rgb bystep. Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority" }, "api/Hi.Coloring.IColorGuideProperty.html": { "href": "api/Hi.Coloring.IColorGuideProperty.html", @@ -262,17 +277,17 @@ "api/Hi.Coloring.PlainColorGuide.html": { "href": "api/Hi.Coloring.PlainColorGuide.html", "title": "Class PlainColorGuide | HiAPI-C# 2025", - "summary": "Class PlainColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that provides a constant color value. public class PlainColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object PlainColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors PlainColorGuide() Initializes a new instance of the PlainColorGuide class. public PlainColorGuide() PlainColorGuide(XElement) Initializes a new instance of the PlainColorGuide class from XML. public PlainColorGuide(XElement src) Parameters src XElement The XML element containing the color guide data. Properties Rgb Gets or sets the RGB color value. public Vec3d Rgb { get; set; } Property Value Vec3d XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class PlainColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that provides a constant color value. public class PlainColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide Inheritance object PlainColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide 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) Constructors PlainColorGuide() Initializes a new instance of the PlainColorGuide class. public PlainColorGuide() PlainColorGuide(XElement) Initializes a new instance of the PlainColorGuide class from XML. public PlainColorGuide(XElement src) Parameters src XElement The XML element containing the color guide data. Properties Rgb Gets or sets the RGB color value. public Vec3d Rgb { get; set; } Property Value Vec3d XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority 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." }, "api/Hi.Coloring.QuantityColorGuide.html": { "href": "api/Hi.Coloring.QuantityColorGuide.html", "title": "Class QuantityColorGuide | HiAPI-C# 2025", - "summary": "Class QuantityColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that maps numeric quantities to colors using a range color rule. public class QuantityColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide, IGetRangeColorRule Inheritance object QuantityColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide IGetRangeColorRule 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) Constructors QuantityColorGuide() Initializes a new instance of the QuantityColorGuide class. public QuantityColorGuide() QuantityColorGuide(string, RangeColorRule) Initializes a new instance of the QuantityColorGuide class with specified quantity key and range color rule. public QuantityColorGuide(string quantityKey, RangeColorRule rangeColorRule) Parameters quantityKey string The key used to retrieve quantity values. rangeColorRule RangeColorRule The rule that maps numeric values to colors. QuantityColorGuide(XElement) Initializes a new instance of the QuantityColorGuide class from XML. public QuantityColorGuide(XElement src) Parameters src XElement The XML element containing the color guide data. Properties QuantityKey Gets or sets the key used to retrieve the quantity value. public string QuantityKey { get; set; } Property Value string RangeColorRule Gets or sets the rule that maps numeric values to colors. public RangeColorRule RangeColorRule { get; set; } Property Value RangeColorRule XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRangeColorRule() Gets the range color rule. public RangeColorRule GetRangeColorRule() Returns RangeColorRule The range color rule. GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class QuantityColorGuide Namespace Hi.Coloring Assembly HiMech.dll A color guide that maps numeric quantities to colors using a range color rule. public class QuantityColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide, IGetRangeColorRule Inheritance object QuantityColorGuide Implements IColorGuide IMakeXmlSource IGetColorGuide IGetRangeColorRule 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) Constructors QuantityColorGuide() Initializes a new instance of the QuantityColorGuide class. public QuantityColorGuide() QuantityColorGuide(string, RangeColorRule) Initializes a new instance of the QuantityColorGuide class with specified quantity key and range color rule. public QuantityColorGuide(string quantityKey, RangeColorRule rangeColorRule) Parameters quantityKey string The key used to retrieve quantity values. rangeColorRule RangeColorRule The rule that maps numeric values to colors. QuantityColorGuide(XElement) Initializes a new instance of the QuantityColorGuide class from XML. public QuantityColorGuide(XElement src) Parameters src XElement The XML element containing the color guide data. Properties QuantityKey Gets or sets the key used to retrieve the quantity value. public string QuantityKey { get; set; } Property Value string RangeColorRule Gets or sets the rule that maps numeric values to colors. public RangeColorRule RangeColorRule { get; set; } Property Value RangeColorRule XName Name for XML IO. public static string XName { get; } Property Value string Methods GetColorGuide() Get IColorGuide. public IColorGuide GetColorGuide() Returns IColorGuide IColorGuide GetRangeColorRule() Gets the range color rule. public RangeColorRule GetRangeColorRule() Returns RangeColorRule The range color rule. GetRgb(object) Get rgb bystep. public Vec3d GetRgb(object step) Parameters step object step Returns Vec3d rgb GetRgbWithPriority(object, out Vec3d, out double) Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree. public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority) Parameters step object step rgb Vec3d rgb attachmentPriority double priority 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." }, "api/Hi.Coloring.RangeColorRule.html": { "href": "api/Hi.Coloring.RangeColorRule.html", "title": "Class RangeColorRule | HiAPI-C# 2025", - "summary": "Class RangeColorRule Namespace Hi.Coloring Assembly HiGeom.dll Defines a rule for mapping numeric values to colors based on a range. public class RangeColorRule : IMakeXmlSource, IGetRangeColorRule Inheritance object RangeColorRule Implements IMakeXmlSource IGetRangeColorRule 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors RangeColorRule() Ctor. public RangeColorRule() RangeColorRule(double, double, RatioRgbFuncEnum) Constructor with range and color function specification. public RangeColorRule(double floor, double ceiling, RatioRgbFuncEnum ratioRgbFuncEnum = RatioRgbFuncEnum.NormalizedPositiveErf) Parameters floor double The lower bound of the range. ceiling double The upper bound of the range. ratioRgbFuncEnum RatioRgbFuncEnum The function to map ratio values to RGB colors. RangeColorRule(XElement) Ctor. public RangeColorRule(XElement src) Parameters src XElement XML Fields RatioRgbFuncEnum The function used to map ratio values to RGB colors. public RatioRgbFuncEnum RatioRgbFuncEnum Field Value RatioRgbFuncEnum Properties Ceiling Gets or sets the upper bound of the range. public double Ceiling { get; set; } Property Value double Floor Gets or sets the lower bound of the range. public double Floor { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods GetRangeColorRule() Gets the range color rule. public RangeColorRule GetRangeColorRule() Returns RangeColorRule The range color rule. GetRgb(double) Gets the RGB color for a given value based on the range and color function. public Vec3d GetRgb(double v) Parameters v double The value to convert to a color. Returns Vec3d RGB color vector. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class RangeColorRule Namespace Hi.Coloring Assembly HiGeom.dll Defines a rule for mapping numeric values to colors based on a range. public class RangeColorRule : IMakeXmlSource, IGetRangeColorRule Inheritance object RangeColorRule Implements IMakeXmlSource IGetRangeColorRule 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) 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 RangeColorRule() Ctor. public RangeColorRule() RangeColorRule(double, double, RatioRgbFuncEnum) Constructor with range and color function specification. public RangeColorRule(double floor, double ceiling, RatioRgbFuncEnum ratioRgbFuncEnum = RatioRgbFuncEnum.NormalizedPositiveErf) Parameters floor double The lower bound of the range. ceiling double The upper bound of the range. ratioRgbFuncEnum RatioRgbFuncEnum The function to map ratio values to RGB colors. RangeColorRule(XElement) Ctor. public RangeColorRule(XElement src) Parameters src XElement XML Fields RatioRgbFuncEnum The function used to map ratio values to RGB colors. public RatioRgbFuncEnum RatioRgbFuncEnum Field Value RatioRgbFuncEnum Properties Ceiling Gets or sets the upper bound of the range. public double Ceiling { get; set; } Property Value double Floor Gets or sets the lower bound of the range. public double Floor { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods GetRangeColorRule() Gets the range color rule. public RangeColorRule GetRangeColorRule() Returns RangeColorRule The range color rule. GetRgb(double) Gets the RGB color for a given value based on the range and color function. public Vec3d GetRgb(double v) Parameters v double The value to convert to a color. Returns Vec3d RGB color vector. 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." }, "api/Hi.Coloring.RatioRgbFuncEnum.html": { "href": "api/Hi.Coloring.RatioRgbFuncEnum.html", @@ -282,7 +297,7 @@ "api/Hi.Coloring.RgbSeed.html": { "href": "api/Hi.Coloring.RgbSeed.html", "title": "Class RgbSeed | HiAPI-C# 2025", - "summary": "Class RgbSeed Namespace Hi.Coloring Assembly HiGeom.dll A simple object contains RGB value. public class RgbSeed : IGetRgb, IMakeXmlSource Inheritance object RgbSeed Implements IGetRgb IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors RgbSeed() Ctor. public RgbSeed() RgbSeed(Vec3d) Ctor. public RgbSeed(Vec3d rgb) Parameters rgb Vec3d RGB RgbSeed(XElement) Ctor. public RgbSeed(XElement src) Parameters src XElement XML Properties Rgb RGB. public Vec3d Rgb { get; set; } Property Value Vec3d XName Name for XML IO. public static string XName { get; } Property Value string Methods GetRgb() Get RGB. public Vec3d GetRgb() Returns Vec3d RGB MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class RgbSeed Namespace Hi.Coloring Assembly HiGeom.dll A simple object contains RGB value. public class RgbSeed : IGetRgb, IMakeXmlSource Inheritance object RgbSeed Implements IGetRgb IMakeXmlSource 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) 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 RgbSeed() Ctor. public RgbSeed() RgbSeed(Vec3d) Ctor. public RgbSeed(Vec3d rgb) Parameters rgb Vec3d RGB RgbSeed(XElement) Ctor. public RgbSeed(XElement src) Parameters src XElement XML Properties Rgb RGB. public Vec3d Rgb { get; set; } Property Value Vec3d XName Name for XML IO. public static string XName { get; } Property Value string Methods GetRgb() Get RGB. public Vec3d GetRgb() Returns Vec3d RGB 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." }, "api/Hi.Coloring.html": { "href": "api/Hi.Coloring.html", @@ -307,7 +322,7 @@ "api/Hi.Common.BlockingTimer.html": { "href": "api/Hi.Common.BlockingTimer.html", "title": "Class BlockingTimer | HiAPI-C# 2025", - "summary": "Class BlockingTimer Namespace Hi.Common Assembly HiGeom.dll Timer use one task and delay each event call. The delay time is Period, counted from the previous trigger to the nest trigger. The first function call does no intending delay. If the execution time is over the Period, no delay between the triggers. public class BlockingTimer : IMakeXmlSource, IDisposable Inheritance object BlockingTimer Implements IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors BlockingTimer() Ctor. public BlockingTimer() BlockingTimer(TimeSpan) Initializes a new instance of the BlockingTimer class with the specified period. public BlockingTimer(TimeSpan period) Parameters period TimeSpan The time interval between timer events BlockingTimer(XElement) Constructor that initializes the timer from XML data. public BlockingTimer(XElement src) Parameters src XElement XML element containing timer configuration Fields XName XML element name for serialization. public static string XName Field Value string Properties Period The time period between timer events. public TimeSpan Period { get; set; } Property Value TimeSpan WorkingTask Gets the task that represents the timer's working process. public Task WorkingTask { get; } Property Value Task Methods 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 EnsureRunOnce() Ensures the timer runs at least once. public Task EnsureRunOnce() Returns Task The task representing the timer's working process MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Start() Starts the timer in long-term mode. public Task Start() Returns Task The task representing the timer's working process Stop() Stops the timer and cancels any ongoing operations. public Task Stop() Returns Task The task representing the timer's working process Events Elapsed Event that is triggered when the timer elapses. public event Action Elapsed Event Type Action" + "summary": "Class BlockingTimer Namespace Hi.Common Assembly HiGeom.dll Timer use one task and delay each event call. The delay time is Period, counted from the previous trigger to the nest trigger. The first function call does no intending delay. If the execution time is over the Period, no delay between the triggers. public class BlockingTimer : IMakeXmlSource, IDisposable Inheritance object BlockingTimer Implements IMakeXmlSource 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) 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 BlockingTimer() Ctor. public BlockingTimer() BlockingTimer(TimeSpan) Initializes a new instance of the BlockingTimer class with the specified period. public BlockingTimer(TimeSpan period) Parameters period TimeSpan The time interval between timer events BlockingTimer(XElement) Constructor that initializes the timer from XML data. public BlockingTimer(XElement src) Parameters src XElement XML element containing timer configuration Fields XName XML element name for serialization. public static string XName Field Value string Properties Period The time period between timer events. public TimeSpan Period { get; set; } Property Value TimeSpan WorkingTask Gets the task that represents the timer's working process. public Task WorkingTask { get; } Property Value Task Methods 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 EnsureRunOnce() Ensures the timer runs at least once. public Task EnsureRunOnce() Returns Task The task representing the timer's working process 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. Start() Starts the timer in long-term mode. public Task Start() Returns Task The task representing the timer's working process Stop() Stops the timer and cancels any ongoing operations. public Task Stop() Returns Task The task representing the timer's working process Events Elapsed Event that is triggered when the timer elapses. public event Action Elapsed Event Type Action" }, "api/Hi.Common.BytesUtil.html": { "href": "api/Hi.Common.BytesUtil.html", @@ -447,7 +462,7 @@ "api/Hi.Common.ExceptionUtil.html": { "href": "api/Hi.Common.ExceptionUtil.html", "title": "Class ExceptionUtil | HiAPI-C# 2025", - "summary": "Class ExceptionUtil Namespace Hi.Common Assembly HiGeom.dll Provides utility methods for handling exceptions. public static class ExceptionUtil Inheritance object ExceptionUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods CatchWithSilentPass(Task, object, params Type[]) Continues the task and silently passes specified exception types. public static Task CatchWithSilentPass(this Task task, object sender, params Type[] silentPassTypes) Parameters task Task The task to continue. sender object The sender object. silentPassTypes Type[] The exception types to silently pass. Returns Task A task that represents the continuation. ShowException(Exception, object) Shows the exception by invoking the OnShown event. public static void ShowException(this Exception exception, object sender) Parameters exception Exception The exception to show. sender object The sender object. ShowIfCatched(Task, object) Continues the task and shows any exception that occurs. public static Task ShowIfCatched(this Task task, object sender) Parameters task Task The task to continue. sender object The sender object. Returns Task A task that represents the continuation. ShowIfCatched(Action, object) Executes the specified action and shows any exception that occurs. public static void ShowIfCatched(this Action action, object sender = null) Parameters action Action The action to execute. sender object The sender object. Type Parameters T The type of the action. ShowIfCatched(Func, object) Executes the specified function and shows any exception that occurs. public static T ShowIfCatched(this Func func, object sender = null) Parameters func Func The function to execute. sender object The sender object. Returns T The result of the function, or default(T) if an exception occurs. Type Parameters T The return type of the function. Events OnShown On Catched or handled. public static event EventHandler OnShown Event Type EventHandler" + "summary": "Class ExceptionUtil Namespace Hi.Common Assembly HiGeom.dll Provides utility methods for handling exceptions. public static class ExceptionUtil Inheritance object ExceptionUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods CatchWithSilentPass(Task, object, params Type[]) Continues the task and silently passes specified exception types. public static Task CatchWithSilentPass(this Task task, object sender, params Type[] silentPassTypes) Parameters task Task The task to continue. sender object The sender object. silentPassTypes Type[] The exception types to silently pass. Returns Task A task that represents the continuation. Default_OnShown(object, Exception) public static void Default_OnShown(object sender, Exception e) Parameters sender object e Exception ShowException(Exception, object) Shows the exception by invoking the OnShown event. public static void ShowException(this Exception exception, object sender) Parameters exception Exception The exception to show. sender object The sender object. ShowIfCatched(Task, object) Continues the task and shows any exception that occurs. public static Task ShowIfCatched(this Task task, object sender) Parameters task Task The task to continue. sender object The sender object. Returns Task A task that represents the continuation. ShowIfCatched(Action, object) Executes the specified action and shows any exception that occurs. public static void ShowIfCatched(this Action action, object sender = null) Parameters action Action The action to execute. sender object The sender object. Type Parameters T The type of the action. ShowIfCatched(Func, object) Executes the specified function and shows any exception that occurs. public static T ShowIfCatched(this Func func, object sender = null) Parameters func Func The function to execute. sender object The sender object. Returns T The result of the function, or default(T) if an exception occurs. Type Parameters T The return type of the function. Events OnShown On Catched or handled. public static event EventHandler OnShown Event Type EventHandler" }, "api/Hi.Common.FileLines.FileBeginEventArgs.html": { "href": "api/Hi.Common.FileLines.FileBeginEventArgs.html", @@ -462,7 +477,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 Inheritance object FileLineIndex Implements IFileLineIndex IGetFileLineIndex IComparable IMakeXmlSource 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) FileLineUtil.GetFileNo(IFileLineIndex) FileLineUtil.GetLineNo(IFileLineIndex) FileLineUtil.MixedIndex(IFileLineIndex) FileLineUtil.MixedIndex(IGetFileLineIndex) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) 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) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state 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)”" + "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) 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() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Common.FileLines.FileLinePipingKit.html": { "href": "api/Hi.Common.FileLines.FileLinePipingKit.html", @@ -534,11 +549,6 @@ "title": "Namespace Hi.Common.FileLines | HiAPI-C# 2025", "summary": "Namespace Hi.Common.FileLines Classes FileBeginEventArgs Event arguments for when a file processing begins. FileEndEventArgs Event arguments for when a file processing ends. FileLineIndex Represents a location in a file by its file index and line number. FileLinePipingKit Perform lines piping to a file by another thread. FileLineUtil Utility of IFileLineIndex. FileUtil Utility to manage files. IndexedFile Represents a file with an associated index. IndexedFileLine Represents a line of text from a file with associated file and line information. LineBeginEventArgs Event arguments for when line processing begins. LineEndEventArgs Event arguments for when line processing ends. Interfaces IFileChangedEventSupport Interface for supporting file change events. IFileLine Interface of file line. IFileLineIndex Interface of file number and line number. IGetFileLineIndex Interface of GetFileLineIndex(). IGetIndexedFileLine Interface for objects that can provide a file line. ILineChangedEventSupport Interface for objects that support line change events." }, - "api/Hi.Common.HiLog.html": { - "href": "api/Hi.Common.HiLog.html", - "title": "Class HiLog | HiAPI-C# 2025", - "summary": "Class HiLog Namespace Hi.Common Assembly HiGeom.dll Logging utility class that provides logging functionality with timestamp. public class HiLog Inheritance object HiLog 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 Internal Use Only Constructors HiLog() Initializes a new instance of the HiLog class with no writer. public HiLog() HiLog(StreamWriter) Initializes a new instance of the HiLog class with the specified writer. public HiLog(StreamWriter writer) Parameters writer StreamWriter The stream writer to use for logging Properties Default Gets or sets the default logger instance. The default log file name is formatted as “logYYYYMM.txt” based on the current date. public static HiLog Default { get; set; } Property Value HiLog WriteToConsole Gets or sets a value indicating whether log messages should also be written to the console. public bool WriteToConsole { get; set; } Property Value bool Writer Gets or sets the stream writer used for logging. public StreamWriter Writer { get; set; } Property Value StreamWriter Methods Append(string) Synchronously appends the specified information to the log with a timestamp. This is a blocking wrapper around AppendAsync(string). public void Append(string info) Parameters info string The information to log AppendAsync(string) Asynchronously appends the specified information to the log with a timestamp. If WriteToConsole is true, the information is also output to the console. public Task AppendAsync(string info) Parameters info string The information to log Returns Task A task representing the asynchronous operation" - }, "api/Hi.Common.IAbstractNote.html": { "href": "api/Hi.Common.IAbstractNote.html", "title": "Interface IAbstractNote | HiAPI-C# 2025", @@ -569,6 +579,11 @@ "title": "Interface IGetSelectionName | HiAPI-C# 2025", "summary": "Interface IGetSelectionName Namespace Hi.Common Assembly HiGeom.dll Interface for objects that can provide a name for selection purposes. public interface IGetSelectionName 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) Methods GetSelectionName() Gets a name that can be used for selection in UI or other contexts. string GetSelectionName() Returns string The selection name for this object" }, + "api/Hi.Common.INameNote.html": { + "href": "api/Hi.Common.INameNote.html", + "title": "Interface INameNote | HiAPI-C# 2025", + "summary": "Interface INameNote Namespace Hi.Common Assembly HiGeom.dll Interface for objects that have a name and note property. public interface INameNote Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XmlUtil.GetNameNoteXElementList(INameNote) XmlUtil.SetNameNote(INameNote, XElement) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties Name Gets or sets the name of the object. string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. string Note { get; set; } Property Value string" + }, "api/Hi.Common.IPreferredFileName.html": { "href": "api/Hi.Common.IPreferredFileName.html", "title": "Interface IPreferredFileName | HiAPI-C# 2025", @@ -597,17 +612,17 @@ "api/Hi.Common.IndexSegment.html": { "href": "api/Hi.Common.IndexSegment.html", "title": "Class IndexSegment | HiAPI-C# 2025", - "summary": "Class IndexSegment Namespace Hi.Common Assembly HiGeom.dll Represents a segment of indices with a beginning and ending point. Used for defining ranges of data in collections or arrays. public class IndexSegment : IEquatable, IMakeXmlSource Inheritance object IndexSegment Implements IEquatable IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors IndexSegment() Initializes a new instance of the IndexSegment class. public IndexSegment() IndexSegment(IndexSegment) Initializes a new instance of the IndexSegment class by copying another instance. public IndexSegment(IndexSegment src) Parameters src IndexSegment The source index segment to copy from. IndexSegment(int, int) Initializes a new instance of the IndexSegment class with the specified begin and end indices. public IndexSegment(int begin, int end) Parameters begin int The beginning index (inclusive). end int The ending index (exclusive). IndexSegment(XElement) Initializes a new instance of the IndexSegment class from an XML element. public IndexSegment(XElement src) Parameters src XElement The XML element containing the index segment data. Fields XName The XML element name used for serialization. public static string XName Field Value string begin Begin index. Inclusive. public int begin Field Value int end End index. Exclusive. public int end Field Value int Properties Begin Gets or sets the beginning index of the segment (inclusive). public int Begin { get; set; } Property Value int End Gets or sets the ending index of the segment (exclusive). public int End { get; set; } Property Value int Length Gets the length of the segment (End - Begin). public int Length { get; } Property Value int Methods Any() Determines whether this index segment contains any indices. public bool Any() Returns bool true if the segment contains any indices; otherwise, false. Contains(int) Determines whether this index segment contains the specified index. public bool Contains(int index) Parameters index int The index to check. Returns bool true if the index is within the segment; otherwise, false. Enumerate() Enumerates all indices within this segment. public IEnumerable Enumerate() Returns IEnumerable An enumerable collection of all indices within the segment. Equals(IndexSegment) Determines whether the specified index segment is equal to the current index segment. public bool Equals(IndexSegment other) Parameters other IndexSegment The index segment to compare with the current index segment. Returns bool true if the specified index segment is equal to the current index segment; otherwise, false. Equals(object) Determines whether the specified object is equal to the current index segment. public override bool Equals(object obj) Parameters obj object The object to compare with the current index segment. Returns bool true if the specified object is equal to the current index segment; otherwise, false. Expand(int) Expands this index segment to include the specified value if needed. public void Expand(int v) Parameters v int The value to include in the segment. GetHashCode() Returns a hash code for this index segment. public override int GetHashCode() Returns int A hash code for the current index segment. GetIndexSegment(IList, int, int, Func) Gets an index segment from a list of data items based on the specified indices. public static IndexSegment GetIndexSegment(IList steps, int cacheStepIndex, int keyStepIndex, Func dataToKeyIndexFunc) Parameters steps IList The list of data items. cacheStepIndex int The cache step index. keyStepIndex int The key step index. dataToKeyIndexFunc Func A function that extracts an index from a data item. Returns IndexSegment An index segment representing the range of indices. Type Parameters TData The type of data items. MakeXmlSource(string, string) Creates an XML element representing this index segment. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for relative paths. relFile string The relative file path. Returns XElement An XML element representing this index segment. ToString() Returns a string representation of this index segment. public override string ToString() Returns string A string representation of the current index segment." + "summary": "Class IndexSegment Namespace Hi.Common Assembly HiGeom.dll Represents a segment of indices with a beginning and ending point. Used for defining ranges of data in collections or arrays. public class IndexSegment : IEquatable, IMakeXmlSource Inheritance object IndexSegment Implements IEquatable IMakeXmlSource 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) 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 IndexSegment() Initializes a new instance of the IndexSegment class. public IndexSegment() IndexSegment(IndexSegment) Initializes a new instance of the IndexSegment class by copying another instance. public IndexSegment(IndexSegment src) Parameters src IndexSegment The source index segment to copy from. IndexSegment(int, int) Initializes a new instance of the IndexSegment class with the specified begin and end indices. public IndexSegment(int begin, int end) Parameters begin int The beginning index (inclusive). end int The ending index (exclusive). IndexSegment(XElement) Initializes a new instance of the IndexSegment class from an XML element. public IndexSegment(XElement src) Parameters src XElement The XML element containing the index segment data. Fields XName The XML element name used for serialization. public static string XName Field Value string begin Begin index. Inclusive. public int begin Field Value int end End index. Exclusive. public int end Field Value int Properties Begin Gets or sets the beginning index of the segment (inclusive). public int Begin { get; set; } Property Value int End Gets or sets the ending index of the segment (exclusive). public int End { get; set; } Property Value int Length Gets the length of the segment (End - Begin). public int Length { get; } Property Value int Methods Any() Determines whether this index segment contains any indices. public bool Any() Returns bool true if the segment contains any indices; otherwise, false. Contains(int) Determines whether this index segment contains the specified index. public bool Contains(int index) Parameters index int The index to check. Returns bool true if the index is within the segment; otherwise, false. Enumerate() Enumerates all indices within this segment. public IEnumerable Enumerate() Returns IEnumerable An enumerable collection of all indices within the segment. Equals(IndexSegment) Determines whether the specified index segment is equal to the current index segment. public bool Equals(IndexSegment other) Parameters other IndexSegment The index segment to compare with the current index segment. Returns bool true if the specified index segment is equal to the current index segment; otherwise, false. Equals(object) Determines whether the specified object is equal to the current index segment. public override bool Equals(object obj) Parameters obj object The object to compare with the current index segment. Returns bool true if the specified object is equal to the current index segment; otherwise, false. Expand(int) Expands this index segment to include the specified value if needed. public void Expand(int v) Parameters v int The value to include in the segment. GetHashCode() Returns a hash code for this index segment. public override int GetHashCode() Returns int A hash code for the current index segment. GetIndexSegment(IList, int, int, Func) Gets an index segment from a list of data items based on the specified indices. public static IndexSegment GetIndexSegment(IList steps, int cacheStepIndex, int keyStepIndex, Func dataToKeyIndexFunc) Parameters steps IList The list of data items. cacheStepIndex int The cache step index. keyStepIndex int The key step index. dataToKeyIndexFunc Func A function that extracts an index from a data item. Returns IndexSegment An index segment representing the range of indices. Type Parameters TData The type of data items. 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 representation of this index segment. public override string ToString() Returns string A string representation of the current index segment." }, "api/Hi.Common.IntegerKeyDictionaryConverter-1.html": { "href": "api/Hi.Common.IntegerKeyDictionaryConverter-1.html", "title": "Class IntegerKeyDictionaryConverter | HiAPI-C# 2025", - "summary": "Class IntegerKeyDictionaryConverter Namespace Hi.Common Assembly HiGeom.dll Generic version of IntegerKeyDictionaryConverter that works with a specific value type. public class IntegerKeyDictionaryConverter : IMakeXmlSource Type Parameters TValue The type of values in the dictionary. Inheritance object IntegerKeyDictionaryConverter Implements IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors IntegerKeyDictionaryConverter() Ctor. public IntegerKeyDictionaryConverter() IntegerKeyDictionaryConverter(XElement) Ctor. public IntegerKeyDictionaryConverter(XElement src) Parameters src XElement XML Properties RawKeyList Dont modify. public List RawKeyList { get; } Property Value List RawKeyToIndex Dont modify. public Dictionary RawKeyToIndex { get; } Property Value Dictionary XName Name for XML IO. public static string XName { get; } Property Value string Methods GetIntegerKeyDictionary(Dictionary) Converts a dictionary with string keys to a dictionary with integer keys. public Dictionary GetIntegerKeyDictionary(Dictionary rawKeyDictionary) Parameters rawKeyDictionary Dictionary The dictionary with string keys to convert. Returns Dictionary A dictionary with integer keys. GetRestoredDictionary(Dictionary) Converts a dictionary with integer keys back to a dictionary with string keys. public Dictionary GetRestoredDictionary(Dictionary integerKeyDictionary) Parameters integerKeyDictionary Dictionary The dictionary with integer keys to convert. Returns Dictionary A dictionary with string keys. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class IntegerKeyDictionaryConverter Namespace Hi.Common Assembly HiGeom.dll Generic version of IntegerKeyDictionaryConverter that works with a specific value type. public class IntegerKeyDictionaryConverter : IMakeXmlSource Type Parameters TValue The type of values in the dictionary. Inheritance object IntegerKeyDictionaryConverter Implements IMakeXmlSource 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) 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 IntegerKeyDictionaryConverter() Ctor. public IntegerKeyDictionaryConverter() IntegerKeyDictionaryConverter(XElement) Ctor. public IntegerKeyDictionaryConverter(XElement src) Parameters src XElement XML Properties RawKeyList Dont modify. public List RawKeyList { get; } Property Value List RawKeyToIndex Dont modify. public Dictionary RawKeyToIndex { get; } Property Value Dictionary XName Name for XML IO. public static string XName { get; } Property Value string Methods GetIntegerKeyDictionary(Dictionary) Converts a dictionary with string keys to a dictionary with integer keys. public Dictionary GetIntegerKeyDictionary(Dictionary rawKeyDictionary) Parameters rawKeyDictionary Dictionary The dictionary with string keys to convert. Returns Dictionary A dictionary with integer keys. GetRestoredDictionary(Dictionary) Converts a dictionary with integer keys back to a dictionary with string keys. public Dictionary GetRestoredDictionary(Dictionary integerKeyDictionary) Parameters integerKeyDictionary Dictionary The dictionary with integer keys to convert. Returns Dictionary A dictionary with string keys. 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." }, "api/Hi.Common.IntegerKeyDictionaryConverter.html": { "href": "api/Hi.Common.IntegerKeyDictionaryConverter.html", "title": "Class IntegerKeyDictionaryConverter | HiAPI-C# 2025", - "summary": "Class IntegerKeyDictionaryConverter Namespace Hi.Common Assembly HiGeom.dll Converts dictionaries with string keys to dictionaries with integer keys for more efficient storage and lookup. public class IntegerKeyDictionaryConverter : IMakeXmlSource Inheritance object IntegerKeyDictionaryConverter Implements IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors IntegerKeyDictionaryConverter() Initializes a new instance of the IntegerKeyDictionaryConverter class. public IntegerKeyDictionaryConverter() IntegerKeyDictionaryConverter(XElement) Initializes a new instance of the IntegerKeyDictionaryConverter class from XML. public IntegerKeyDictionaryConverter(XElement src) Parameters src XElement XML element containing the converter data. Properties RawKeyList Dont modify. public List RawKeyList { get; } Property Value List RawKeyToIndex Dont modify. public Dictionary RawKeyToIndex { get; } Property Value Dictionary XName Name for XML IO. public static string XName { get; } Property Value string Methods GetIntegerKeyDictionary(Dictionary) Converts a dictionary with string keys to a dictionary with integer keys. public Dictionary GetIntegerKeyDictionary(Dictionary rawKeyDictionary) Parameters rawKeyDictionary Dictionary The dictionary with string keys to convert. Returns Dictionary A dictionary with integer keys. GetRestoredDictionary(Dictionary) Converts a dictionary with integer keys back to a dictionary with string keys. public Dictionary GetRestoredDictionary(Dictionary integerKeyDictionary) Parameters integerKeyDictionary Dictionary The dictionary with integer keys to convert. Returns Dictionary A dictionary with string keys. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class IntegerKeyDictionaryConverter Namespace Hi.Common Assembly HiGeom.dll Converts dictionaries with string keys to dictionaries with integer keys for more efficient storage and lookup. public class IntegerKeyDictionaryConverter : IMakeXmlSource Inheritance object IntegerKeyDictionaryConverter Implements IMakeXmlSource 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) 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 IntegerKeyDictionaryConverter() Initializes a new instance of the IntegerKeyDictionaryConverter class. public IntegerKeyDictionaryConverter() IntegerKeyDictionaryConverter(XElement) Initializes a new instance of the IntegerKeyDictionaryConverter class from XML. public IntegerKeyDictionaryConverter(XElement src) Parameters src XElement XML element containing the converter data. Properties RawKeyList Dont modify. public List RawKeyList { get; } Property Value List RawKeyToIndex Dont modify. public Dictionary RawKeyToIndex { get; } Property Value Dictionary XName Name for XML IO. public static string XName { get; } Property Value string Methods GetIntegerKeyDictionary(Dictionary) Converts a dictionary with string keys to a dictionary with integer keys. public Dictionary GetIntegerKeyDictionary(Dictionary rawKeyDictionary) Parameters rawKeyDictionary Dictionary The dictionary with string keys to convert. Returns Dictionary A dictionary with integer keys. GetRestoredDictionary(Dictionary) Converts a dictionary with integer keys back to a dictionary with string keys. public Dictionary GetRestoredDictionary(Dictionary integerKeyDictionary) Parameters integerKeyDictionary Dictionary The dictionary with integer keys to convert. Returns Dictionary A dictionary with string keys. 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." }, "api/Hi.Common.InternalException.html": { "href": "api/Hi.Common.InternalException.html", @@ -619,10 +634,15 @@ "title": "Class InvokeUtil | HiAPI-C# 2025", "summary": "Class InvokeUtil Namespace Hi.Common Assembly HiGeom.dll Utility class for method invocation operations. public static class InvokeUtil Inheritance object InvokeUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods SelfInvoke(TSrc, Action) Invokes the specified action on the source object itself. public static void SelfInvoke(this TSrc src, Action func) Parameters src TSrc The source object func Action The action to invoke on the source object Type Parameters TSrc The type of the source object SelfInvoke(TSrc, Func) Invokes the specified function on the source object itself and returns the result. This function is usually used to apply a temporary variable, so that the property call is not computed twice. public static TDst SelfInvoke(this TSrc src, Func func) Parameters src TSrc The source object func Func The function to invoke on the source object Returns TDst The result of the function invocation Type Parameters TSrc The type of the source object TDst The type of the result" }, + "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 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) public static void WritePartialJson(string filePath, string configName, TConfig config) Parameters filePath string configName string config TConfig Type Parameters TConfig" + }, "api/Hi.Common.LooseRunner.html": { "href": "api/Hi.Common.LooseRunner.html", "title": "Class LooseRunner | HiAPI-C# 2025", - "summary": "Class LooseRunner Namespace Hi.Common Assembly HiGeom.dll Provides a mechanism for running actions asynchronously in a loose manner, where only the most recent action is executed and previous pending actions are discarded. public class LooseRunner : IDisposable Inheritance object LooseRunner Implements 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) Constructors LooseRunner(CancellationToken?) Initializes a new instance of the LooseRunner class. public LooseRunner(CancellationToken? cancellationToken = null) Parameters cancellationToken CancellationToken? Optional cancellation token to control the lifetime of the runner. If not provided, a new token will be created. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources used by the LooseRunner and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. GetLastWaiting() Asynchronously waits for the last action to complete execution. public Task GetLastWaiting() Returns Task A task representing the asynchronous wait operation. TryRun(Action) Tries to run the specified action asynchronously. If an action is already pending, it will be replaced with the new action. public void TryRun(Action action) Parameters action Action The action to run. WaitLastActionDone() Waits for the last action to complete execution. public void WaitLastActionDone()" + "summary": "Class LooseRunner Namespace Hi.Common Assembly HiGeom.dll Provides a mechanism for running actions asynchronously in a loose manner. Only the most recent action is executed and previous pending actions are discarded. public class LooseRunner : IDisposable Inheritance object LooseRunner Implements 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) Constructors LooseRunner(CancellationToken?) Initializes a new instance of the LooseRunner class. public LooseRunner(CancellationToken? cancellationToken = null) Parameters cancellationToken CancellationToken? Optional cancellation token to control the lifetime of the runner. If not provided, a new token will be created. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources used by the LooseRunner and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. GetLastWaiting() Asynchronously waits for the last action to complete execution. public Task GetLastWaiting() Returns Task A task representing the asynchronous wait operation. TryRun(Action) Tries to run the specified action asynchronously. If an action is already pending, it will be replaced with the new action. public void TryRun(Action action) Parameters action Action The action to run. WaitLastActionDone() Waits for the last action to complete execution. public void WaitLastActionDone()" }, "api/Hi.Common.ManualUtil.html": { "href": "api/Hi.Common.ManualUtil.html", @@ -639,30 +659,10 @@ "title": "Enum BootstrapTheme | HiAPI-C# 2025", "summary": "Enum BootstrapTheme Namespace Hi.Common.Messages Assembly HiGeom.dll Bootstrap theme colors for UI styling. public enum BootstrapTheme Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields danger = 5 Danger theme color (typically red). dark = 7 Dark theme color (typically black or very dark gray). info = 3 Information theme color (typically light blue). light = 6 Light theme color (typically white or very light gray). primary = 0 Primary theme color (typically blue). secondary = 1 Secondary theme color (typically gray). success = 2 Success theme color (typically green). warning = 4 Warning theme color (typically yellow)." }, - "api/Hi.Common.Messages.FilteringMultiTagMessageQueue.html": { - "href": "api/Hi.Common.Messages.FilteringMultiTagMessageQueue.html", - "title": "Class FilteringMultiTagMessageQueue | HiAPI-C# 2025", - "summary": "Class FilteringMultiTagMessageQueue Namespace Hi.Common.Messages Assembly HiGeom.dll Implementation of IMultiTagMessageQueue that supports filtering messages by tags. public class FilteringMultiTagMessageQueue : IMultiTagMessageQueue Inheritance object FilteringMultiTagMessageQueue Implements IMultiTagMessageQueue 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) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params MessageFlag[]) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueError(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueuePrograss(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueWarning(IMultiTagMessageQueue, string, params string[]) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors FilteringMultiTagMessageQueue() Initializes a new instance of the FilteringMultiTagMessageQueue class. public FilteringMultiTagMessageQueue() FilteringMultiTagMessageQueue(int) Initializes a new instance of the FilteringMultiTagMessageQueue class with the specified buffer capacity. public FilteringMultiTagMessageQueue(int bufferCapacity) Parameters bufferCapacity int The maximum capacity of the message buffer Properties BufferCapacity Gets or sets the maximum capacity of the message buffer. public int BufferCapacity { get; set; } Property Value int HiddenTagSet Gets or sets the set of tags that should be hidden when filtering messages. public HashSet HiddenTagSet { get; set; } Property Value HashSet MessageLinkedList Gets the linked list that stores the messages. public LinkedList MessageLinkedList { get; } Property Value LinkedList Methods Enqueue(MultiTagMessage) Thread-safe method to enqueue a message with multiple tags. public MultiTagMessage Enqueue(MultiTagMessage multiTagMessage) Parameters multiTagMessage MultiTagMessage The message to enqueue Returns MultiTagMessage The enqueued message GetFilteredMessagesByHiddenTagSet() Gets messages filtered by the hidden tag set. public IEnumerable GetFilteredMessagesByHiddenTagSet() Returns IEnumerable An enumerable collection of filtered messages GetFilteredMessagesByPreservedTag(IEnumerable) Gets messages that contain any of the specified preserved tags. public IEnumerable GetFilteredMessagesByPreservedTag(IEnumerable preservedTags) Parameters preservedTags IEnumerable The collection of tags that messages may contain Returns IEnumerable An enumerable collection of filtered messages GetFilteredMessagesByPreservedTag(string) Gets messages that contain a specific preserved tag. public IEnumerable GetFilteredMessagesByPreservedTag(string preservedTag) Parameters preservedTag string The tag that messages must contain Returns IEnumerable An enumerable collection of filtered messages" - }, - "api/Hi.Common.Messages.IMessageHost.html": { - "href": "api/Hi.Common.Messages.IMessageHost.html", - "title": "Interface IMessageHost | HiAPI-C# 2025", - "summary": "Interface IMessageHost Namespace Hi.Common.Messages Assembly HiGeom.dll Interface for objects that can host and manage messages. public interface IMessageHost Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MessageHostUtil.AddError(IMessageHost, string, params string[]) MessageHostUtil.AddMessage(IMessageHost, string, params string[]) MessageHostUtil.AddProgress(IMessageHost, string, params string[]) MessageHostUtil.AddSysErr(IMessageHost, string, params string[]) MessageHostUtil.AddWarning(IMessageHost, string, params string[]) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods Add(object) Adds a new message entry to the host. object Add(object entry) Parameters entry object The message entry to add Returns object The added entry or a result object" - }, - "api/Hi.Common.Messages.IMultiTagMessageQueue.html": { - "href": "api/Hi.Common.Messages.IMultiTagMessageQueue.html", - "title": "Interface IMultiTagMessageQueue | HiAPI-C# 2025", - "summary": "Interface IMultiTagMessageQueue Namespace Hi.Common.Messages Assembly HiGeom.dll Interface for a message queue that supports messages with multiple tags. public interface IMultiTagMessageQueue Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params MessageFlag[]) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueError(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueuePrograss(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueWarning(IMultiTagMessageQueue, string, params string[]) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods Enqueue(MultiTagMessage) Enqueues a message with multiple tags into the queue. MultiTagMessage Enqueue(MultiTagMessage multiTagMessage) Parameters multiTagMessage MultiTagMessage The message to enqueue Returns MultiTagMessage The enqueued message" - }, - "api/Hi.Common.Messages.LinkedListMultiTagMessageQueue.html": { - "href": "api/Hi.Common.Messages.LinkedListMultiTagMessageQueue.html", - "title": "Class LinkedListMultiTagMessageQueue | HiAPI-C# 2025", - "summary": "Class LinkedListMultiTagMessageQueue Namespace Hi.Common.Messages Assembly HiGeom.dll Implementation of IMultiTagMessageQueue using a linked list to store messages. public class LinkedListMultiTagMessageQueue : IMultiTagMessageQueue Inheritance object LinkedListMultiTagMessageQueue Implements IMultiTagMessageQueue Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params MessageFlag[]) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueError(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueuePrograss(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueWarning(IMultiTagMessageQueue, string, params string[]) 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) Properties LinkedList Gets or sets the linked list that stores the messages. public LinkedList LinkedList { get; set; } Property Value LinkedList Methods Enqueue(MultiTagMessage) Enqueues a message with multiple tags into the queue. public MultiTagMessage Enqueue(MultiTagMessage multiTagMessage) Parameters multiTagMessage MultiTagMessage The message to enqueue Returns MultiTagMessage The enqueued message GetMessages() Gets all messages in the queue. public IEnumerable GetMessages() Returns IEnumerable An enumerable collection of messages" - }, - "api/Hi.Common.Messages.LoggingMessageQueue.html": { - "href": "api/Hi.Common.Messages.LoggingMessageQueue.html", - "title": "Class LoggingMessageQueue | HiAPI-C# 2025", - "summary": "Class LoggingMessageQueue Namespace Hi.Common.Messages Assembly HiGeom.dll A queue for logging messages with multi-tag support and file output capabilities. public class LoggingMessageQueue : IMultiTagMessageQueue, IDisposable Inheritance object LoggingMessageQueue Implements IMultiTagMessageQueue IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params MessageFlag[]) MultiTagMessageQueueUtil.Enqueue(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueError(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueuePrograss(IMultiTagMessageQueue, string, params string[]) MultiTagMessageQueueUtil.EnqueueWarning(IMultiTagMessageQueue, string, params string[]) 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) Properties Capacity Gets or sets the maximum number of messages to keep in the queue. public int Capacity { get; set; } Property Value int MessageFile Gets the path to the log file where messages are being written. public string MessageFile { get; } Property Value string Methods Clear() Clears the message queue and closes the log file. public void Clear() 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 Enqueue(MultiTagMessage) Adds a message to the queue and writes it to the log file. public MultiTagMessage Enqueue(MultiTagMessage multiTagMessage) Parameters multiTagMessage MultiTagMessage The message to enqueue Returns MultiTagMessage The enqueued message GetLastMessages() Gets all messages currently in the queue as a single string. public string GetLastMessages() Returns string A string containing all messages in the queue, separated by newlines Events ClearEvent Event triggered when the queue is cleared. public event Action ClearEvent Event Type Action MessageEvent Event triggered when a new message is added to the queue. public event Action MessageEvent Event Type Action" + "api/Hi.Common.Messages.IMessageKit.html": { + "href": "api/Hi.Common.Messages.IMessageKit.html", + "title": "Interface IMessageKit | HiAPI-C# 2025", + "summary": "Interface IMessageKit Namespace Hi.Common.Messages Assembly HiGeom.dll Interface for objects that can host and manage messages. public interface IMessageKit Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MessageHostUtil.AddError(IMessageKit, string, params string[]) MessageHostUtil.AddException(IMessageKit, Exception, params string[]) MessageHostUtil.AddInfo(IMessageKit, string, params string[]) MessageHostUtil.AddMessage(IMessageKit, string, params string[]) MessageHostUtil.AddProgress(IMessageKit, string, params string[]) MessageHostUtil.AddSuccess(IMessageKit, string, params string[]) MessageHostUtil.AddWarning(IMessageKit, string, params string[]) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods Add(object) Adds a new message entry to the host. object Add(object entry) Parameters entry object The message entry to add Returns object The added entry or a result object" }, "api/Hi.Common.Messages.MessageBoardUtil.html": { "href": "api/Hi.Common.Messages.MessageBoardUtil.html", @@ -672,28 +672,23 @@ "api/Hi.Common.Messages.MessageFlag.html": { "href": "api/Hi.Common.Messages.MessageFlag.html", "title": "Enum MessageFlag | HiAPI-C# 2025", - "summary": "Enum MessageFlag Namespace Hi.Common.Messages Assembly HiGeom.dll Enumeration of common message types used for system notifications. public enum MessageFlag Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields Error = 1 General error messages. For exception which is consciously handled. Progress = 4 Progress update messages SysErr = 0 System error messages. For exception which is not consciously handled. Warning = 2 Warning messages" + "summary": "Enum MessageFlag Namespace Hi.Common.Messages Assembly HiGeom.dll Enumeration of common message types used for system notifications. public enum MessageFlag Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields Error = 1 General error messages. For exception which is consciously handled. Exception = 0 System error messages. For exception which is not consciously handled. Info = 7 System behavior that end user not need to know. The message make help to tracing end user behavior. Message = 6 Something else from the upper flags to tell the end user. Progress = 4 Progress update messages. Success = 5 Progress complete on success messages. Warning = 2 Warning messages." }, "api/Hi.Common.Messages.MessageHostUtil.html": { "href": "api/Hi.Common.Messages.MessageHostUtil.html", "title": "Class MessageHostUtil | HiAPI-C# 2025", - "summary": "Class MessageHostUtil Namespace Hi.Common.Messages Assembly HiGeom.dll Utility methods for working with IMessageHost implementations. public static class MessageHostUtil Inheritance object MessageHostUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods AddError(IMessageHost, string, params string[]) Adds an error message to the message host. public static object AddError(this IMessageHost host, string message, params string[] otherTags) Parameters host IMessageHost The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddMessage(IMessageHost, string, params string[]) Adds a message with the specified tags to the message host. public static object AddMessage(this IMessageHost host, string msg, params string[] tags) Parameters host IMessageHost The message host msg string The message content tags string[] The tags to associate with the message Returns object The result of adding the message AddProgress(IMessageHost, string, params string[]) Adds a progress message to the message host. public static object AddProgress(this IMessageHost host, string message, params string[] otherTags) Parameters host IMessageHost The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddSysErr(IMessageHost, string, params string[]) Adds a system error message to the message host. public static object AddSysErr(this IMessageHost host, string message, params string[] otherTags) Parameters host IMessageHost The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddWarning(IMessageHost, string, params string[]) Adds a warning message to the message host. public static object AddWarning(this IMessageHost host, string message, params string[] otherTags) Parameters host IMessageHost The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message" + "summary": "Class MessageHostUtil Namespace Hi.Common.Messages Assembly HiGeom.dll Utility methods for working with IMessageKit implementations. public static class MessageHostUtil Inheritance object MessageHostUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods AddError(IMessageKit, string, params string[]) Adds an Error message to the message host. public static object AddError(this IMessageKit host, string message, params string[] otherTags) Parameters host IMessageKit The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddException(IMessageKit, Exception, params string[]) Adds an Exception message to the message host. public static object AddException(this IMessageKit host, Exception exception, params string[] otherTags) Parameters host IMessageKit The message host exception Exception The exception to log otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddInfo(IMessageKit, string, params string[]) Adds an Info message to the message host. public static object AddInfo(this IMessageKit host, string message, params string[] otherTags) Parameters host IMessageKit The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddMessage(IMessageKit, string, params string[]) Adds a message with the specified tags to the message host. public static object AddMessage(this IMessageKit host, string msg, params string[] tags) Parameters host IMessageKit The message host msg string The message content tags string[] The tags to associate with the message Returns object The result of adding the message AddProgress(IMessageKit, string, params string[]) Adds a Progress message to the message host. public static object AddProgress(this IMessageKit host, string message, params string[] otherTags) Parameters host IMessageKit The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddSuccess(IMessageKit, string, params string[]) Adds a Success message to the message host. public static object AddSuccess(this IMessageKit host, string message, params string[] otherTags) Parameters host IMessageKit The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message AddWarning(IMessageKit, string, params string[]) Adds a warning message to the message host. public static object AddWarning(this IMessageKit host, string message, params string[] otherTags) Parameters host IMessageKit The message host message string The message content otherTags string[] Additional tags to associate with the message Returns object The result of adding the message" }, "api/Hi.Common.Messages.MessageKit.html": { "href": "api/Hi.Common.Messages.MessageKit.html", "title": "Class MessageKit | HiAPI-C# 2025", - "summary": "Class MessageKit Namespace Hi.Common.Messages Assembly HiGeom.dll Provides utility methods for handling messages. public class MessageKit : IMessageHost Inheritance object MessageKit Implements IMessageHost Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MessageHostUtil.AddError(IMessageHost, string, params string[]) MessageHostUtil.AddMessage(IMessageHost, string, params string[]) MessageHostUtil.AddProgress(IMessageHost, string, params string[]) MessageHostUtil.AddSysErr(IMessageHost, string, params string[]) MessageHostUtil.AddWarning(IMessageHost, string, params string[]) 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) Properties Default Gets the default MessageKit instance. public static MessageKit Default { get; } Property Value MessageKit Methods Add(object) Adds a new message entry to the host. public object Add(object entry) Parameters entry object The message entry to add Returns object The added entry or a result object AddError(string) Adds an error message to the default message kit. public static void AddError(string message) Parameters message string The message to write. AddMessage(string) public static void AddMessage(string message) Parameters message string The message to write. AddWarning(string) public static void AddWarning(string message) Parameters message string The message to write. Default_OnAdding(object) Default handler for message adding. public static object Default_OnAdding(object arg) Parameters arg object The message argument to be processed. Returns object The processed message argument. Events OnAdding Event triggered when a message is being added. public event Func OnAdding Event Type Func" + "summary": "Class MessageKit Namespace Hi.Common.Messages Assembly HiGeom.dll Provides utility methods for handling messages. public class MessageKit : IMessageKit Inheritance object MessageKit Implements IMessageKit Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MessageHostUtil.AddError(IMessageKit, string, params string[]) MessageHostUtil.AddException(IMessageKit, Exception, params string[]) MessageHostUtil.AddInfo(IMessageKit, string, params string[]) MessageHostUtil.AddMessage(IMessageKit, string, params string[]) MessageHostUtil.AddProgress(IMessageKit, string, params string[]) MessageHostUtil.AddSuccess(IMessageKit, string, params string[]) MessageHostUtil.AddWarning(IMessageKit, string, params string[]) 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) Properties Default Gets the default MessageKit instance. public static MessageKit Default { get; set; } Property Value MessageKit Methods Add(object) Adds a new message entry to the host. public object Add(object entry) Parameters entry object The message entry to add Returns object The added entry or a result object AddError(string) Adds an error message to the default message kit. Apply ExceptionUtil.ShowException(Exception, object) if the error message comes from exception for better treatment. public static void AddError(string message) Parameters message string The message to write. AddException(Exception) Adds an exception to the default message kit. public static void AddException(Exception exception) Parameters exception Exception The exception to add. AddInfo(string) Adds an info message to the default message kit. public static void AddInfo(string message) Parameters message string The message to write. AddMessage(string) public static void AddMessage(string message) Parameters message string The message to write. AddProgress(string) public static void AddProgress(string message) Parameters message string AddSuccess(string) Adds a success message to the default message kit. public static void AddSuccess(string message) Parameters message string The message to write. AddWarning(string) public static void AddWarning(string message) Parameters message string The message to write. Default_OnAdding(object) Default handler for message adding. public static object Default_OnAdding(object arg) Parameters arg object The message argument to be processed. Returns object The processed message argument. Events OnAdding Event triggered when a message is being added. public event Func OnAdding Event Type Func" }, "api/Hi.Common.Messages.MultiTagMessage.html": { "href": "api/Hi.Common.Messages.MultiTagMessage.html", "title": "Class MultiTagMessage | HiAPI-C# 2025", "summary": "Class MultiTagMessage Namespace Hi.Common.Messages Assembly HiGeom.dll Represents a message with multiple tags for categorization and filtering. public class MultiTagMessage Inheritance object MultiTagMessage Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors MultiTagMessage(object, params string[]) Initializes a new instance of the MultiTagMessage class with the specified message and tags. public MultiTagMessage(object message, params string[] tags) Parameters message object The message content tags string[] The tags to associate with this message Properties Message Gets or sets the message content. public object Message { get; set; } Property Value object Tags Gets or sets the collection of tags associated with this message. public HashSet Tags { get; set; } Property Value HashSet Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, - "api/Hi.Common.Messages.MultiTagMessageQueueUtil.html": { - "href": "api/Hi.Common.Messages.MultiTagMessageQueueUtil.html", - "title": "Class MultiTagMessageQueueUtil | HiAPI-C# 2025", - "summary": "Class MultiTagMessageQueueUtil Namespace Hi.Common.Messages Assembly HiGeom.dll Provides extension methods for working with multi-tag message queues. public static class MultiTagMessageQueueUtil Inheritance object MultiTagMessageQueueUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Enqueue(IMultiTagMessageQueue, string) Enqueues a message without tags to the message queue. public static MultiTagMessage Enqueue(this IMultiTagMessageQueue src, string message) Parameters src IMultiTagMessageQueue The message queue. message string The message to enqueue. Returns MultiTagMessage The enqueued message. Enqueue(IMultiTagMessageQueue, string, params MessageFlag[]) Enqueues a message with enum tags to the message queue. public static MultiTagMessage Enqueue(this IMultiTagMessageQueue src, string message, params MessageFlag[] tags) Parameters src IMultiTagMessageQueue The message queue. message string The message to enqueue. tags MessageFlag[] The enum tags to associate with the message. Returns MultiTagMessage The enqueued message. Enqueue(IMultiTagMessageQueue, string, params string[]) Enqueues a message with string tags to the message queue. public static MultiTagMessage Enqueue(this IMultiTagMessageQueue src, string message, params string[] tags) Parameters src IMultiTagMessageQueue The message queue. message string The message to enqueue. tags string[] The string tags to associate with the message. Returns MultiTagMessage The enqueued message. EnqueueError(IMultiTagMessageQueue, string, params string[]) Enqueues an error message to the message queue. public static MultiTagMessage EnqueueError(this IMultiTagMessageQueue src, string message, params string[] otherTags) Parameters src IMultiTagMessageQueue The message queue. message string The message to enqueue. otherTags string[] Additional tags to associate with the message. Returns MultiTagMessage The enqueued message. EnqueuePrograss(IMultiTagMessageQueue, string, params string[]) Enqueues a progress message to the message queue. public static MultiTagMessage EnqueuePrograss(this IMultiTagMessageQueue src, string message, params string[] otherTags) Parameters src IMultiTagMessageQueue The message queue. message string The message to enqueue. otherTags string[] Additional tags to associate with the message. Returns MultiTagMessage The enqueued message. EnqueueWarning(IMultiTagMessageQueue, string, params string[]) Enqueues a warning message to the message queue. public static MultiTagMessage EnqueueWarning(this IMultiTagMessageQueue src, string message, params string[] otherTags) Parameters src IMultiTagMessageQueue The message queue. message string The message to enqueue. otherTags string[] Additional tags to associate with the message. Returns MultiTagMessage The enqueued message." - }, "api/Hi.Common.Messages.ShowMessageBoardDelegate.html": { "href": "api/Hi.Common.Messages.ShowMessageBoardDelegate.html", "title": "Delegate ShowMessageBoardDelegate | HiAPI-C# 2025", @@ -702,7 +697,7 @@ "api/Hi.Common.Messages.html": { "href": "api/Hi.Common.Messages.html", "title": "Namespace Hi.Common.Messages | HiAPI-C# 2025", - "summary": "Namespace Hi.Common.Messages Classes FilteringMultiTagMessageQueue Implementation of IMultiTagMessageQueue that supports filtering messages by tags. LinkedListMultiTagMessageQueue Implementation of IMultiTagMessageQueue using a linked list to store messages. LoggingMessageQueue A queue for logging messages with multi-tag support and file output capabilities. MessageBoardUtil Utility class for displaying messages on a message board. MessageHostUtil Utility methods for working with IMessageHost implementations. MessageKit Provides utility methods for handling messages. MultiTagMessage Represents a message with multiple tags for categorization and filtering. MultiTagMessageQueueUtil Provides extension methods for working with multi-tag message queues. Interfaces IMessageHost Interface for objects that can host and manage messages. IMultiTagMessageQueue Interface for a message queue that supports messages with multiple tags. Enums BootstrapTheme Bootstrap theme colors for UI styling. MessageFlag Enumeration of common message types used for system notifications. Delegates ShowMessageBoardDelegate Delegate for showing message board notifications." + "summary": "Namespace Hi.Common.Messages Classes MessageBoardUtil Utility class for displaying messages on a message board. MessageHostUtil Utility methods for working with IMessageKit implementations. MessageKit Provides utility methods for handling messages. MultiTagMessage Represents a message with multiple tags for categorization and filtering. Interfaces IMessageKit Interface for objects that can host and manage messages. Enums BootstrapTheme Bootstrap theme colors for UI styling. MessageFlag Enumeration of common message types used for system notifications. Delegates ShowMessageBoardDelegate Delegate for showing message board notifications." }, "api/Hi.Common.MinMaxUtils.IndexedMinMaxPos-2.html": { "href": "api/Hi.Common.MinMaxUtils.IndexedMinMaxPos-2.html", @@ -762,7 +757,7 @@ "api/Hi.Common.PacePlayer.html": { "href": "api/Hi.Common.PacePlayer.html", "title": "Class PacePlayer | HiAPI-C# 2025", - "summary": "Class PacePlayer Namespace Hi.Common Assembly HiGeom.dll Controls the pace execution of a task. public class PacePlayer : IDisposable Inheritance object PacePlayer Implements 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) Properties CancellationToken Gets the cancellation token for the running task. public CancellationToken CancellationToken { get; } Property Value CancellationToken IsFinished Is the process finished from Start(). public bool IsFinished { get; } Property Value bool IsLocked Is started but not finished. IsLocked keeps true even if Pause() is called. The property is true if a task started and the task has not yet finished. public bool IsLocked { get; } Property Value bool IsRunning Is running. Not paused either finished. The property is true if a task started and the task has not yet finished and Pause() is not called. public bool IsRunning { get; } Property Value bool MainAction Gets or sets the main action to be executed by the player. public Action MainAction { get; set; } Property Value Action Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. Pause() Pauses the execution. public void Pause() Reset() Resets the player to its initial state. public void Reset() Resume() Resumes the execution if paused. public void Resume() RunToNextPace() Runs to the next pace point. public void RunToNextPace() Start() Starts the main action execution. public void Start() Terminate() Terminates the execution by cancelling the task. public void Terminate() Wait() Waits for the task to complete. public void Wait() Events IsLockedEventHandler Event triggered when the lock state changes. public event Action IsLockedEventHandler Event Type Action IsRunningChangedEvent Event triggered when the running state changes. public event Action IsRunningChangedEvent Event Type Action ResetedEvent Event triggered after the player has been reset. public event Action ResetedEvent Event Type Action" + "summary": "Class PacePlayer Namespace Hi.Common Assembly HiGeom.dll Controls the pace execution of a task. public class PacePlayer : IDisposable Inheritance object PacePlayer Implements 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) Properties CancellationToken Gets the cancellation token for the running task. public CancellationToken CancellationToken { get; } Property Value CancellationToken IsFinished Is the process finished from Start(). public bool IsFinished { get; } Property Value bool IsLocked Is started but not finished. IsLocked keeps true even if Pause() is called. The property is true if a task started and the task has not yet finished. public bool IsLocked { get; } Property Value bool IsRunning Is running. Not paused either finished. The property is true if a task started and the task has not yet finished and Pause() is not called. public bool IsRunning { get; } Property Value bool MainAction Gets or sets the main action to be executed by the player. public Action MainAction { get; set; } Property Value Action Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. Pause() Pauses the execution. public void Pause() Reset() Resets the player to its initial state. public void Reset() Resume() Resumes the execution if paused. public void Resume() RunToNextPace() Runs to the next pace point. public void RunToNextPace() Start() Starts the main action execution. public void Start() Terminate() Terminates the execution by cancelling the task. public void Terminate() Wait() Waits for the task to complete. public void Wait() Events IsFinishedChangedEvent Event triggered when the IsFinished state changes. public event Action IsFinishedChangedEvent Event Type Action IsLockedChangedEvent Event triggered when the lock state changes. public event Action IsLockedChangedEvent Event Type Action IsRunningChangedEvent Event triggered when the running state changes. public event Action IsRunningChangedEvent Event Type Action ResetedEvent Event triggered after the player has been reset. public event Action ResetedEvent Event Type Action" }, "api/Hi.Common.Pair-2.html": { "href": "api/Hi.Common.Pair-2.html", @@ -862,12 +857,12 @@ "api/Hi.Common.RoutineBlocker.html": { "href": "api/Hi.Common.RoutineBlocker.html", "title": "Class RoutineBlocker | HiAPI-C# 2025", - "summary": "Class RoutineBlocker Namespace Hi.Common Assembly HiGeom.dll Block the thread to the given delay from the previous block. public class RoutineBlocker : IMakeXmlSource, IDisposable Inheritance object RoutineBlocker Implements IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors RoutineBlocker() Constructor public RoutineBlocker() RoutineBlocker(TimeSpan) Initializes a new instance of the RoutineBlocker class with the specified period. public RoutineBlocker(TimeSpan period) Parameters period TimeSpan The time period between blocks RoutineBlocker(XElement) Initializes a new instance of the RoutineBlocker class from an XML element. public RoutineBlocker(XElement src) Parameters src XElement The XML element containing the blocker configuration Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Properties Period Delay time between each previous Block(). public TimeSpan Period { get; set; } Property Value TimeSpan Methods Block() Delay the thread. The delay time is Period, counted from the previous Block() to the current Block(). The first function call does no delay. If the time between two Block() is over Period, the function call does no delay. public void Block() 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 HasToBlock() If calling Block() make thread delay, return true; otherwise, false. public bool HasToBlock() Returns bool Has to block IsEnabled() Enable the Block() function. public bool IsEnabled() Returns bool MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetDisable() Disables the blocker, canceling any pending operations. public void SetDisable() SetEnable(Action) Enable the Block() function. public void SetEnable(Action disablingCallback = null) Parameters disablingCallback Action" + "summary": "Class RoutineBlocker Namespace Hi.Common Assembly HiGeom.dll Block the thread to the given delay from the previous block. public class RoutineBlocker : IMakeXmlSource, IDisposable Inheritance object RoutineBlocker Implements IMakeXmlSource 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) 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 RoutineBlocker() Constructor public RoutineBlocker() RoutineBlocker(TimeSpan) Initializes a new instance of the RoutineBlocker class with the specified period. public RoutineBlocker(TimeSpan period) Parameters period TimeSpan The time period between blocks RoutineBlocker(XElement) Initializes a new instance of the RoutineBlocker class from an XML element. public RoutineBlocker(XElement src) Parameters src XElement The XML element containing the blocker configuration Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Properties Period Delay time between each previous Block(). public TimeSpan Period { get; set; } Property Value TimeSpan Methods Block() Delay the thread. The delay time is Period, counted from the previous Block() to the current Block(). The first function call does no delay. If the time between two Block() is over Period, the function call does no delay. public void Block() 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 HasToBlock() If calling Block() make thread delay, return true; otherwise, false. public bool HasToBlock() Returns bool Has to block IsEnabled() Enable the Block() function. public bool IsEnabled() Returns bool 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. SetDisable() Disables the blocker, canceling any pending operations. public void SetDisable() SetEnable(Action) Enable the Block() function. public void SetEnable(Action disablingCallback = null) Parameters disablingCallback Action" }, "api/Hi.Common.RoutineBlocker0.html": { "href": "api/Hi.Common.RoutineBlocker0.html", "title": "Class RoutineBlocker0 | HiAPI-C# 2025", - "summary": "Class RoutineBlocker0 Namespace Hi.Common Assembly HiGeom.dll Block the thread to the given delay from the previous block. public class RoutineBlocker0 : IMakeXmlSource Inheritance object RoutineBlocker0 Implements IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors RoutineBlocker0() Constructor public RoutineBlocker0() RoutineBlocker0(XElement) Initializes a new instance of the RoutineBlocker0 class from an XML element. public RoutineBlocker0(XElement src) Parameters src XElement The XML element containing the blocker configuration Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Properties Enable Enable the Block() function. public bool Enable { get; set; } Property Value bool Period Delay time between each previous Block(). public TimeSpan Period { get; set; } Property Value TimeSpan Methods Block() Delay the thread. The delay time is Period, counted from the previous Block() to the current Block(). The first function call does no delay. If the time between two Block() is over Period, the function call does no delay. public void Block() HasToBlock() If calling Block() make thread delay, return true; otherwise, false. public bool HasToBlock() Returns bool Has to block MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class RoutineBlocker0 Namespace Hi.Common Assembly HiGeom.dll Block the thread to the given delay from the previous block. public class RoutineBlocker0 : IMakeXmlSource Inheritance object RoutineBlocker0 Implements IMakeXmlSource 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) 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 RoutineBlocker0() Constructor public RoutineBlocker0() RoutineBlocker0(XElement) Initializes a new instance of the RoutineBlocker0 class from an XML element. public RoutineBlocker0(XElement src) Parameters src XElement The XML element containing the blocker configuration Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Properties Enable Enable the Block() function. public bool Enable { get; set; } Property Value bool Period Delay time between each previous Block(). public TimeSpan Period { get; set; } Property Value TimeSpan Methods Block() Delay the thread. The delay time is Period, counted from the previous Block() to the current Block(). The first function call does no delay. If the time between two Block() is over Period, the function call does no delay. public void Block() HasToBlock() If calling Block() make thread delay, return true; otherwise, false. public bool HasToBlock() Returns bool Has to block 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." }, "api/Hi.Common.SeqPair-1.html": { "href": "api/Hi.Common.SeqPair-1.html", @@ -884,11 +879,6 @@ "title": "Class ServerFileExplorerConfig | HiAPI-C# 2025", "summary": "Class ServerFileExplorerConfig Namespace Hi.Common Assembly HiGeom.dll Configuration for server file explorer functionality. public class ServerFileExplorerConfig : IEquatable Inheritance object ServerFileExplorerConfig Implements IEquatable Inherited Members object.Equals(object, object) 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) Constructors ServerFileExplorerConfig() Initializes a new instance of the ServerFileExplorerConfig class. public ServerFileExplorerConfig() ServerFileExplorerConfig(ServerFileExplorerConfig) Initializes a new instance of the ServerFileExplorerConfig class by copying another instance. public ServerFileExplorerConfig(ServerFileExplorerConfig src) Parameters src ServerFileExplorerConfig The source configuration to copy from Properties ApplyingPostfix Path Postfix for applying to the selected file path. public string ApplyingPostfix { get; set; } Property Value string DefaultFilterTitle Gets or sets the default filter title to use when no filter is selected. public string DefaultFilterTitle { get; set; } Property Value string ExtendedNamedPath Gets or sets the extended named path for the file explorer. public ExtendedNamedPath ExtendedNamedPath { get; set; } Property Value ExtendedNamedPath ExtendedNamedPathList Gets or sets the list of extended named paths available in the file explorer. public List ExtendedNamedPathList { get; set; } Property Value List ExtensionFilterList Gets or sets the list of file extension filters available in the file explorer. public List<(string FilterTitle, string FileExtension)> ExtensionFilterList { get; set; } Property Value List<(string FilterTitle, string FileExtension)> RelativeDirectory Gets or sets the relative directory path for the file explorer. public string RelativeDirectory { get; set; } Property Value string SelectedFileName Gets or sets the currently selected file name. public string SelectedFileName { get; set; } Property Value string Title Gets or sets the title of the file explorer. public string Title { get; set; } Property Value string Methods Equals(ServerFileExplorerConfig) Indicates whether the current object is equal to another object of the same type. public bool Equals(ServerFileExplorerConfig other) Parameters other ServerFileExplorerConfig An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Set(ServerFileExplorerConfig) Copy values from src. public ServerFileExplorerConfig Set(ServerFileExplorerConfig src) Parameters src ServerFileExplorerConfig src Returns ServerFileExplorerConfig this Operators operator ==(ServerFileExplorerConfig, ServerFileExplorerConfig) public static bool operator ==(ServerFileExplorerConfig left, ServerFileExplorerConfig right) Parameters left ServerFileExplorerConfig right ServerFileExplorerConfig Returns bool operator !=(ServerFileExplorerConfig, ServerFileExplorerConfig) public static bool operator !=(ServerFileExplorerConfig left, ServerFileExplorerConfig right) Parameters left ServerFileExplorerConfig right ServerFileExplorerConfig Returns bool" }, - "api/Hi.Common.SessionLogger.html": { - "href": "api/Hi.Common.SessionLogger.html", - "title": "Class SessionLogger | HiAPI-C# 2025", - "summary": "Class SessionLogger Namespace Hi.Common Assembly HiGeom.dll Provides logging functionality for sessions with file output capabilities. public class SessionLogger : IDisposable, IMakeXmlSource Inheritance object SessionLogger Implements IDisposable IMakeXmlSource 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) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors SessionLogger() Initializes a new instance of the SessionLogger class. public SessionLogger() SessionLogger(XElement) Initializes a new instance of the SessionLogger class from an XML element. public SessionLogger(XElement src) Parameters src XElement The XML element containing the logger configuration Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Properties SessionPath Gets the actual path of the current session log file. public string SessionPath { get; } Property Value string SessionPathFormat Gets or sets the format string for the session log file path. public string SessionPathFormat { get; set; } Property Value string Methods Add(string) Adds a message to the session log. public void Add(string msg) Parameters msg string The message to add to the log 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 MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Prepare() Prepare for the performance of first call of Add(string). public void Prepare() Reset() Resets the logger, closing the current log file and triggering the session end event. public void Reset() Events MessageEventHandler Event triggered when a message is added to the log. public event EventHandler MessageEventHandler Event Type EventHandler SessionEndEventHandler Event triggered when the session ends. public event EventHandler SessionEndEventHandler Event Type EventHandler" - }, "api/Hi.Common.Slice.html": { "href": "api/Hi.Common.Slice.html", "title": "Class Slice | HiAPI-C# 2025", @@ -922,12 +912,12 @@ "api/Hi.Common.XmlUtils.IMakeXmlSource.html": { "href": "api/Hi.Common.XmlUtils.IMakeXmlSource.html", "title": "Interface IMakeXmlSource | HiAPI-C# 2025", - "summary": "Interface IMakeXmlSource Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Interface for objects that can be serialized to XML format. public interface IMakeXmlSource Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Interface IMakeXmlSource Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Interface for objects that can be serialized to XML format. public interface IMakeXmlSource Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) 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) Methods MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. 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." }, - "api/Hi.Common.XmlUtils.INameNote.html": { - "href": "api/Hi.Common.XmlUtils.INameNote.html", - "title": "Interface INameNote | HiAPI-C# 2025", - "summary": "Interface INameNote Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Interface for objects that have a name and note property. public interface INameNote Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XmlUtil.GetNameNoteXElementList(INameNote) XmlUtil.SetNameNote(INameNote, XElement) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties Name Gets or sets the name of the object. string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. string Note { get; set; } Property Value string" + "api/Hi.Common.XmlUtils.IToXElement.html": { + "href": "api/Hi.Common.XmlUtils.IToXElement.html", + "title": "Interface IToXElement | HiAPI-C# 2025", + "summary": "Interface IToXElement Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Interface of ToXElement(). Which can be represented by a single XElement. public interface IToXElement 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 Relative to IMakeXmlSource, the IToXElement don't export file. So no directory information is required. A single XElement represent the object. Methods ToXElement() Get the XElement to represent the object. XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Common.XmlUtils.SetFileDelegate.html": { "href": "api/Hi.Common.XmlUtils.SetFileDelegate.html", @@ -937,7 +927,7 @@ "api/Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html": { "href": "api/Hi.Common.XmlUtils.XFactory.GenByXElementDelegate.html", "title": "Delegate XFactory.GenByXElementDelegate | HiAPI-C# 2025", - "summary": "Delegate XFactory.GenByXElementDelegate Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Delegate for generating objects from XML elements with relative file path. public delegate object XFactory.GenByXElementDelegate(XElement src, string baseDirectory, string relFile, object[] res) Parameters src XElement The source XML element baseDirectory string The base directory for resolving paths relFile string The relative file path res object[] Additional parameters for generation Returns object The generated object 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)" + "summary": "Delegate XFactory.GenByXElementDelegate Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Delegate for generating objects from XML elements with relative file path. public delegate object XFactory.GenByXElementDelegate(XElement src, string baseDirectory, string relFile, object[] res) Parameters src XElement The source XML element baseDirectory string The base directory for resolving paths relFile string The relative file path res object[] Additional parameters for generation Returns object The generated object 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 Note that the design pattern of seperating BaseDirectory and RelativePath is for easy data package moving. The pattern assume the BaseDirectory can be changed if all the content in the BaseDirectory is changed to the destinate directory." }, "api/Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate.html": { "href": "api/Hi.Common.XmlUtils.XFactory.XmlExceptionDelegate.html", @@ -947,7 +937,7 @@ "api/Hi.Common.XmlUtils.XFactory.html": { "href": "api/Hi.Common.XmlUtils.XFactory.html", "title": "Class XFactory | HiAPI-C# 2025", - "summary": "Class XFactory Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Factory class for generating objects from XML elements using registered generator functions. public class XFactory Inheritance object XFactory 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 Generator functions must be added to Regs to enable the factory to create objects from XML. Constructors XFactory() Initializes a new instance of the XFactory class. public XFactory() Fields Default Gets the global default instance of XFactory. public static XFactory Default Field Value XFactory Properties Regs Gets or sets the dictionary mapping XML element names to generator functions with relative file path. public Dictionary Regs { get; set; } Property Value Dictionary Methods GenByChild(XElement, string, SetFileDelegate, GenMode, params object[]) Generates an object of type T from a child element of the provided XML element. public T GenByChild(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class Parameters src XElement The parent XML element containing the child to process baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute when setting the file path genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns T The generated object of type T, or null if generation fails Type Parameters T The type of object to generate GenByFile(string, string, GenMode, params object[]) Generates an object of type T from an XML file. public T GenByFile(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class Parameters baseDirectory string The base directory for resolving paths relFile string The relative file path to the XML file genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns T The generated object of type T, or null if generation fails Type Parameters T The type of object to generate GenXmlFileSourceByChild(XElement, string, GenMode, params object[]) Generates an XML source and file object of type T from the first child element of the provided XML element. public XmlSourceAndFile GenXmlFileSourceByChild(XElement src, string baseDirectory, GenMode genMode, params object[] res) where T : class, IMakeXmlSource Parameters src XElement The parent XML element containing the child to process baseDirectory string The base directory for resolving paths genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns XmlSourceAndFile An XmlSourceAndFile object containing the generated object and its file path Type Parameters T The type of object to generate, must implement IMakeXmlSource GenXmlFileSourceByFile(string, string, GenMode, params object[]) Generates an XML source and file object of type T from an XML file. public XmlSourceAndFile GenXmlFileSourceByFile(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class, IMakeXmlSource Parameters baseDirectory string The base directory for resolving paths relFile string The relative file path to the XML file genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns XmlSourceAndFile An XmlSourceAndFile object containing the generated object and its file path Type Parameters T The type of object to generate, must implement IMakeXmlSource GenXmlSourceAndFile(XElement, string, SetFileDelegate, GenMode, params object[]) Generates an XML source and file object of type T from an XML element. public XmlSourceAndFile GenXmlSourceAndFile(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class, IMakeXmlSource Parameters src XElement The source XML element baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute when setting the file path genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns XmlSourceAndFile An XmlSourceAndFile object containing the generated object and its file path Type Parameters T The type of object to generate, must implement IMakeXmlSource Gen(XElement, string, SetFileDelegate, GenMode, params object[]) Generates an object of type T from an XML element with specified generation mode. public T Gen(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode mode, params object[] res) where T : class Parameters src XElement The source XML element baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute when setting the file path mode GenMode The generation mode to use res object[] Additional parameters for generation Returns T The generated object of type T, or null if generation fails Type Parameters T The type of object to generate" + "summary": "Class XFactory Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Factory class for generating objects from XML elements using registered generator functions. public static class XFactory Inheritance object XFactory Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Remarks Generator functions must be added to Regs to enable the factory to create objects from XML. Properties Regs Gets or sets the dictionary mapping XML element names to generator functions with relative file path. public static Dictionary Regs { get; set; } Property Value Dictionary Methods GenByChild(XElement, string, SetFileDelegate, GenMode, params object[]) Generates an object of type T from a child element of the provided XML element. public static T GenByChild(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class Parameters src XElement The parent XML element containing the child to process baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute when setting the file path genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns T The generated object of type T, or null if generation fails Type Parameters T The type of object to generate GenByFile(string, string, GenMode, params object[]) Generates an object of type T from an XML file. public static T GenByFile(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class Parameters baseDirectory string The base directory for resolving paths relFile string The relative file path to the XML file genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns T The generated object of type T, or null if generation fails Type Parameters T The type of object to generate GenXmlFileSourceByChild(XElement, string, GenMode, params object[]) Generates an XML source and file object of type T from the first child element of the provided XML element. public static XmlSourceAndFile GenXmlFileSourceByChild(XElement src, string baseDirectory, GenMode genMode, params object[] res) where T : class, IMakeXmlSource Parameters src XElement The parent XML element containing the child to process baseDirectory string The base directory for resolving paths genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns XmlSourceAndFile An XmlSourceAndFile object containing the generated object and its file path Type Parameters T The type of object to generate, must implement IMakeXmlSource GenXmlFileSourceByFile(string, string, GenMode, params object[]) Generates an XML source and file object of type T from an XML file. public static XmlSourceAndFile GenXmlFileSourceByFile(string baseDirectory, string relFile, GenMode genMode, params object[] res) where T : class, IMakeXmlSource Parameters baseDirectory string The base directory for resolving paths relFile string The relative file path to the XML file genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns XmlSourceAndFile An XmlSourceAndFile object containing the generated object and its file path Type Parameters T The type of object to generate, must implement IMakeXmlSource GenXmlSourceAndFile(XElement, string, SetFileDelegate, GenMode, params object[]) Generates an XML source and file object of type T from an XML element. public static XmlSourceAndFile GenXmlSourceAndFile(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode genMode, params object[] res) where T : class, IMakeXmlSource Parameters src XElement The source XML element baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute when setting the file path genMode GenMode The generation mode to use res object[] Additional parameters for generation Returns XmlSourceAndFile An XmlSourceAndFile object containing the generated object and its file path Type Parameters T The type of object to generate, must implement IMakeXmlSource Gen(XElement, string, SetFileDelegate, GenMode, params object[]) Generates an object of type T from an XML element with specified generation mode. public static T Gen(XElement src, string baseDirectory, SetFileDelegate setFileAction, GenMode mode, params object[] res) where T : class Parameters src XElement The source XML element baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute when setting the file path mode GenMode The generation mode to use res object[] Additional parameters for generation Returns T The generated object of type T, or null if generation fails Type Parameters T The type of object to generate" }, "api/Hi.Common.XmlUtils.XmlSourceAndFile-1.html": { "href": "api/Hi.Common.XmlUtils.XmlSourceAndFile-1.html", @@ -957,17 +947,17 @@ "api/Hi.Common.XmlUtils.XmlUtil.html": { "href": "api/Hi.Common.XmlUtils.XmlUtil.html", "title": "Class XmlUtil | HiAPI-C# 2025", - "summary": "Class XmlUtil Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Utility for managing XML. public static class XmlUtil Inheritance object XmlUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields FileXName Alias for XmlFileXName, used for backward compatibility. public const string FileXName = \"XmlSource\" Field Value string SelfHostName Constant representing self-hosted XML content. Used for legacy compatibility. public const string SelfHostName = \"SelfHost\" Field Value string XmlFileXName The XML element name used for file references. public const string XmlFileXName = \"XmlSource\" Field Value string Methods GetDictionaryByXmlSource(XElement, string, GenMode) Deserializes a dictionary of objects from an XML element. public static Dictionary GetDictionaryByXmlSource(this XElement src, string baseDirectory, GenMode genMode) where T : class Parameters src XElement The source XML element containing the serialized dictionary baseDirectory string The base directory for resolving paths genMode GenMode The generation mode to use for deserialization Returns Dictionary A dictionary containing the deserialized objects Type Parameters T The type of objects to deserialize into the dictionary GetFileUnwrappedXElement(XElement, string, out string) Unwraps a file reference XML element to load its actual content. public static XElement GetFileUnwrappedXElement(this XElement src, string baseDirectory, out string relFile) Parameters src XElement The source XML element that may be a file reference baseDirectory string The base directory for resolving paths relFile string Output parameter that receives the relative file path if src is a file reference, or null otherwise Returns XElement If src is a file reference element, returns the XML content loaded from the referenced file; otherwise, returns the original element GetFileWrappedXElement(XElement, string, string) Wraps an XML element in a file reference element or returns it as-is. public static XElement GetFileWrappedXElement(this XElement src, string baseDirectory, string sourceFile) Parameters src XElement The source XML element to wrap baseDirectory string The base directory for resolving paths sourceFile string The relative file path to save the element to, or null to return the element as-is Returns XElement If sourceFile is null, returns the original element; otherwise, saves the element to the specified file and returns a file reference element GetFirstChildElement(XElement) Gets the first child element of the source XElement. public static XElement GetFirstChildElement(this XElement src) Parameters src XElement The source XElement Returns XElement The first child element, or null if no children exist GetNameNoteXElementList(INameNote) Creates a list of XML elements representing the name and note properties of an INameNote object. public static List GetNameNoteXElementList(this INameNote src) Parameters src INameNote The source INameNote object Returns List A list of XML elements containing the name and note GetOrDefault(XElement, string, T) If xpath exist, return value by xpath ; Otherwise, return defaultValue. The xpath must indicates solely one XElement. public static T GetOrDefault(this XElement src, string xpath, T defaultValue) where T : IConvertible Parameters src XElement local root element xpath string xpath defaultValue T default value Returns T If xpath exist, return value by xpath ; Otherwise, return defaultValue. Type Parameters T type of defaultValue MakeXmlSourceFile(IMakeXmlSource, string) Creates an XML source file from the provided source at the specified file path. public static void MakeXmlSourceFile(this IMakeXmlSource src, string filePath) Parameters src IMakeXmlSource The source that implements IMakeXmlSource interface. filePath string The path where the XML file will be created. MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) Creates an XML representation of an object and optionally saves it to a file with path rebasing. public static XElement MakeXmlSourceWithRebaseFile(this IMakeXmlSource src, string baseDirectory, string relFile) Parameters src IMakeXmlSource The source object to serialize baseDirectory string The base directory for resolving paths relFile string The relative file path to save the XML to, or null to not save to a file Returns XElement If relFile is null or empty, returns the XML representation of the object; otherwise, saves the XML to the specified file and returns a file reference element MakeXmlSource(IDictionary, string) Creates an XML representation of a dictionary of XML-serializable objects. public static XElement MakeXmlSource(this IDictionary dictionary, string baseDirectory) where T : IMakeXmlSource Parameters dictionary IDictionary The dictionary to serialize baseDirectory string The base directory for resolving paths Returns XElement An XML element containing the serialized dictionary Type Parameters T The type of objects in the dictionary, must implement IMakeXmlSource SaveToByteArrayAsync(IMakeXmlSource, string) Asynchronously saves an XML source to a byte array. public static Task SaveToByteArrayAsync(this IMakeXmlSource src, string baseDirectory) Parameters src IMakeXmlSource The XML source to save baseDirectory string The base directory for resolving paths Returns Task A byte array containing the serialized XML data SetNameNote(INameNote, XElement) Sets the name and note properties of an INameNote object from an XML element. public static void SetNameNote(this INameNote dst, XElement src) Parameters dst INameNote The destination INameNote object to update src XElement The source XML element containing the name and note values SetOrGenerate(XElement, string, T, string) Sets a value at the specified XPath, creating the path if it doesn't exist. public static void SetOrGenerate(this XElement src, string xpath, T value, string comment = null) where T : IConvertible Parameters src XElement The source XElement xpath string The XPath to set the value at value T The value to set comment string Optional comment to add above the element Type Parameters T The type of value to set UnWrapIfFileBased(XElement, string, SetFileDelegate) Unwraps an XML element if it contains a file reference element. public static XElement UnWrapIfFileBased(this XElement src, string baseDirectory, SetFileDelegate setFileAction) Parameters src XElement The source XML element that may contain a file reference baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute with the file path, or null if no file reference is found Returns XElement If the source element contains a file reference, returns the XML content loaded from the referenced file; otherwise, returns the original element" + "summary": "Class XmlUtil Namespace Hi.Common.XmlUtils Assembly HiGeom.dll Utility for managing XML. public static class XmlUtil Inheritance object XmlUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields FileXName Alias for XmlFileXName, used for backward compatibility. public const string FileXName = \"XmlSource\" Field Value string SelfHostName Constant representing self-hosted XML content. Used for legacy compatibility. public const string SelfHostName = \"SelfHost\" Field Value string XmlFileXName The XML element name used for file references. public const string XmlFileXName = \"XmlSource\" Field Value string Methods GetDictionaryByXmlSource(XElement, string, GenMode) Deserializes a dictionary of objects from an XML element. public static Dictionary GetDictionaryByXmlSource(this XElement src, string baseDirectory, GenMode genMode) where T : class Parameters src XElement The source XML element containing the serialized dictionary baseDirectory string The base directory for resolving paths genMode GenMode The generation mode to use for deserialization Returns Dictionary A dictionary containing the deserialized objects Type Parameters T The type of objects to deserialize into the dictionary GetFileUnwrappedXElement(XElement, string, out string) Unwraps a file reference XML element to load its actual content. public static XElement GetFileUnwrappedXElement(this XElement src, string baseDirectory, out string relFile) Parameters src XElement The source XML element that may be a file reference baseDirectory string The base directory for resolving paths relFile string Output parameter that receives the relative file path if src is a file reference, or null otherwise Returns XElement If src is a file reference element, returns the XML content loaded from the referenced file; otherwise, returns the original element GetFileWrappedXElement(XElement, string, string, bool) Wraps an XML element in a file reference element or returns it as-is. public static XElement GetFileWrappedXElement(this XElement src, string baseDirectory, string sourceFile, bool exhibitionOnly) Parameters src XElement The source XML element to wrap baseDirectory string The base directory for resolving paths sourceFile string The relative file path to save the element to, or null to return the element as-is exhibitionOnly bool See MakeXmlSource(string, string, bool) for parameter description. Returns XElement If sourceFile is null, returns the original element; otherwise, saves the element to the specified file and returns a file reference element GetFirstChildElement(XElement) Gets the first child element of the source XElement. public static XElement GetFirstChildElement(this XElement src) Parameters src XElement The source XElement Returns XElement The first child element, or null if no children exist GetNameNoteXElementList(INameNote) Creates a list of XML elements representing the name and note properties of an INameNote object. public static List GetNameNoteXElementList(this INameNote src) Parameters src INameNote The source INameNote object Returns List A list of XML elements containing the name and note GetOrDefault(XElement, string, T) If xpath exist, return value by xpath ; Otherwise, return defaultValue. The xpath must indicates solely one XElement. public static T GetOrDefault(this XElement src, string xpath, T defaultValue) where T : IConvertible Parameters src XElement local root element xpath string xpath defaultValue T default value Returns T If xpath exist, return value by xpath ; Otherwise, return defaultValue. Type Parameters T type of defaultValue MakeXmlSourceFile(IMakeXmlSource, string, bool) Creates an XML source file from the provided source at the specified file path. public static void MakeXmlSourceFile(this IMakeXmlSource src, string filePath, bool exhibitionOnly = false) Parameters src IMakeXmlSource The source that implements IMakeXmlSource interface. filePath string The path where the XML file will be created. exhibitionOnly bool See MakeXmlSource(string, string, bool) for parameter description. MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) Creates an XML representation of an object and optionally saves it to a file with path rebasing. public static XElement MakeXmlSourceWithRebaseFile(this IMakeXmlSource src, string baseDirectory, string relFile, bool exhibitionOnly) Parameters src IMakeXmlSource The source object to serialize baseDirectory string The base directory for resolving paths relFile string The relative file path to save the XML to, or null to not save to a file exhibitionOnly bool See MakeXmlSource(string, string, bool) for parameter description. Returns XElement If relFile is null or empty, returns the XML representation of the object; otherwise, saves the XML to the specified file and returns a file reference element MakeXmlSource(IDictionary, string, bool) Creates an XML representation of a dictionary of XML-serializable objects. public static XElement MakeXmlSource(this IDictionary dictionary, string baseDirectory, bool exhibitionOnly) where T : IMakeXmlSource Parameters dictionary IDictionary The dictionary to serialize baseDirectory string The base directory for resolving paths exhibitionOnly bool See MakeXmlSource(string, string, bool) for parameter description. Returns XElement An XML element containing the serialized dictionary Type Parameters T The type of objects in the dictionary, must implement IMakeXmlSource SaveToByteArrayAsync(IMakeXmlSource, string) Asynchronously saves an XML source to a byte array. public static Task SaveToByteArrayAsync(this IMakeXmlSource src, string baseDirectory) Parameters src IMakeXmlSource The XML source to save baseDirectory string The base directory for resolving paths Returns Task A byte array containing the serialized XML data SetNameNote(INameNote, XElement) Sets the name and note properties of an INameNote object from an XML element. public static void SetNameNote(this INameNote dst, XElement src) Parameters dst INameNote The destination INameNote object to update src XElement The source XML element containing the name and note values SetOrGenerate(XElement, string, T, string) Sets a value at the specified XPath, creating the path if it doesn't exist. public static void SetOrGenerate(this XElement src, string xpath, T value, string comment = null) where T : IConvertible Parameters src XElement The source XElement xpath string The XPath to set the value at value T The value to set comment string Optional comment to add above the element Type Parameters T The type of value to set UnWrapIfFileBased(XElement, string, SetFileDelegate) Unwraps an XML element if it contains a file reference element. public static XElement UnWrapIfFileBased(this XElement src, string baseDirectory, SetFileDelegate setFileAction) Parameters src XElement The source XML element that may contain a file reference baseDirectory string The base directory for resolving paths setFileAction SetFileDelegate Action to execute with the file path, or null if no file reference is found Returns XElement If the source element contains a file reference, returns the XML content loaded from the referenced file; otherwise, returns the original element" }, "api/Hi.Common.XmlUtils.html": { "href": "api/Hi.Common.XmlUtils.html", "title": "Namespace Hi.Common.XmlUtils | HiAPI-C# 2025", - "summary": "Namespace Hi.Common.XmlUtils Classes XFactory Factory class for generating objects from XML elements using registered generator functions. XmlSourceAndFile A class that combines an XML-serializable data object with its source file path. XmlUtil Utility for managing XML. Interfaces IMakeXmlSource Interface for objects that can be serialized to XML format. INameNote Interface for objects that have a name and note property. Enums GenMode Enumeration of generation modes for XML factory operations. Delegates SetFileDelegate Delegate for setting the file path during XML operations. XFactory.GenByXElementDelegate Delegate for generating objects from XML elements with relative file path. XFactory.XmlExceptionDelegate Delegate for handling XML exceptions during generation." + "summary": "Namespace Hi.Common.XmlUtils Classes XFactory Factory class for generating objects from XML elements using registered generator functions. XmlSourceAndFile A class that combines an XML-serializable data object with its source file path. XmlUtil Utility for managing XML. Interfaces IMakeXmlSource Interface for objects that can be serialized to XML format. IToXElement Interface of ToXElement(). Which can be represented by a single XElement. Enums GenMode Enumeration of generation modes for XML factory operations. Delegates SetFileDelegate Delegate for setting the file path during XML operations. XFactory.GenByXElementDelegate Delegate for generating objects from XML elements with relative file path. XFactory.XmlExceptionDelegate Delegate for handling XML exceptions during generation." }, "api/Hi.Common.html": { "href": "api/Hi.Common.html", "title": "Namespace Hi.Common | HiAPI-C# 2025", - "summary": "Namespace Hi.Common Classes BinIoUtil Utility class for binary I/O operations. BitUtil Utility for bit control for integer. BlockingTimer Timer use one task and delay each event call. The delay time is Period, counted from the previous trigger to the nest trigger. The first function call does no intending delay. If the execution time is over the Period, no delay between the triggers. BytesUtil Utility class for byte array operations and memory size conversions. ConcurrentTimeCounter Thread-safe utility for measuring and tracking execution time across multiple tasks. ConsoleUtil Utility class for console window operations. CppLogUtil Internal Use Only. CultureUtil Utility class for managing culture and localization settings. DebugUtil Debug utility provides functions: pause process, count execution time and show the count. DuplicateUtil Utility methods for duplication operations. EnumUtil Utility class for enum operations. EnumerablePlayer Run enumerable with Pause(), Resume() and etc. functions. ExceptionUtil Provides utility methods for handling exceptions. HiLog Logging utility class that provides logging functionality with timestamp. IndexSegment Represents a segment of indices with a beginning and ending point. Used for defining ranges of data in collections or arrays. IntegerKeyDictionaryConverter Converts dictionaries with string keys to dictionaries with integer keys for more efficient storage and lookup. IntegerKeyDictionaryConverter Generic version of IntegerKeyDictionaryConverter that works with a specific value type. InternalException Exception that represents an internal error that should never occur during normal operation. Used to indicate programming errors or unexpected states that require developer attention. InvokeUtil Utility class for method invocation operations. LooseRunner Provides a mechanism for running actions asynchronously in a loose manner, where only the most recent action is executed and previous pending actions are discarded. ManualUtil MaskUtil Utility for bits masking. NameUtil Utility class for handling object names and display names. PacePlayee Represents an entity that can be controlled by the pace player. PacePlayer Controls the pace execution of a task. Pair Editable pair values. Range Range from Min to Max. ResourceUtil Utility class for working with resource managers and localized strings. RoutineBlocker Block the thread to the given delay from the previous block. RoutineBlocker0 Block the thread to the given delay from the previous block. SeqPairUtil Utility class for SeqPair operations. SeqPair Represents a sequence pair containing previous and current values. Used to track sequential state changes of a value. ServerFileExplorerConfig Configuration for server file explorer functionality. SessionLogger Provides logging functionality for sessions with file output capabilities. Slice Designed for mongo large bytes splision. StringLocalizer Provides localization functionality for strings using resource managers. StringUtil Utility for managing text. TaskUtil Utility class for Task-related operations. TimeCounter A utility counts the average/total time consume between the Bound(object) areas. The count of time consume for the given key starts at the first time (and the odd time) calling Bound(object); stops and accumulates at the second time (and the even time). Interfaces IAbstractNote Interface for objects that provide an abstract description or note. IBinaryIo Interface for binary input/output operations. Extends IWriteBin to provide both read and write capabilities. IClearCache Interface for objects that can clear their internal cache. IDuplicate Interface for objects that support deep cloning/duplication. IGetQuantityByKey Interface for retrieving a quantity value using a string key. IGetSelectionName Interface for objects that can provide a name for selection purposes. IPreferredFileName Interface for objects that can specify a preferred file name. Generally used to suggest a name when generating or saving files. ISourceFile Interface for objects that have a source file. IUpdateByContent Interface for objects that can update themselves based on their content. IUriGetter Interface for retrieving a URI string. IWriteBin Interface for writing binary data. Enums BinarySearchResult Represents the result of a binary search operation. Delegates CppLogUtil.LogDelegate Internal Use Only." + "summary": "Namespace Hi.Common Classes BinIoUtil Utility class for binary I/O operations. BitUtil Utility for bit control for integer. BlockingTimer Timer use one task and delay each event call. The delay time is Period, counted from the previous trigger to the nest trigger. The first function call does no intending delay. If the execution time is over the Period, no delay between the triggers. BytesUtil Utility class for byte array operations and memory size conversions. ConcurrentTimeCounter Thread-safe utility for measuring and tracking execution time across multiple tasks. ConsoleUtil Utility class for console window operations. CppLogUtil Internal Use Only. CultureUtil Utility class for managing culture and localization settings. DebugUtil Debug utility provides functions: pause process, count execution time and show the count. DuplicateUtil Utility methods for duplication operations. EnumUtil Utility class for enum operations. EnumerablePlayer Run enumerable with Pause(), Resume() and etc. functions. ExceptionUtil Provides utility methods for handling exceptions. IndexSegment Represents a segment of indices with a beginning and ending point. Used for defining ranges of data in collections or arrays. IntegerKeyDictionaryConverter Converts dictionaries with string keys to dictionaries with integer keys for more efficient storage and lookup. IntegerKeyDictionaryConverter Generic version of IntegerKeyDictionaryConverter that works with a specific value type. InternalException Exception that represents an internal error that should never occur during normal operation. Used to indicate programming errors or unexpected states that require developer attention. InvokeUtil Utility class for method invocation operations. JsonUtil LooseRunner Provides a mechanism for running actions asynchronously in a loose manner. Only the most recent action is executed and previous pending actions are discarded. ManualUtil MaskUtil Utility for bits masking. NameUtil Utility class for handling object names and display names. PacePlayee Represents an entity that can be controlled by the pace player. PacePlayer Controls the pace execution of a task. Pair Editable pair values. Range Range from Min to Max. ResourceUtil Utility class for working with resource managers and localized strings. RoutineBlocker Block the thread to the given delay from the previous block. RoutineBlocker0 Block the thread to the given delay from the previous block. SeqPairUtil Utility class for SeqPair operations. SeqPair Represents a sequence pair containing previous and current values. Used to track sequential state changes of a value. ServerFileExplorerConfig Configuration for server file explorer functionality. Slice Designed for mongo large bytes splision. StringLocalizer Provides localization functionality for strings using resource managers. StringUtil Utility for managing text. TaskUtil Utility class for Task-related operations. TimeCounter A utility counts the average/total time consume between the Bound(object) areas. The count of time consume for the given key starts at the first time (and the odd time) calling Bound(object); stops and accumulates at the second time (and the even time). Interfaces IAbstractNote Interface for objects that provide an abstract description or note. IBinaryIo Interface for binary input/output operations. Extends IWriteBin to provide both read and write capabilities. IClearCache Interface for objects that can clear their internal cache. IDuplicate Interface for objects that support deep cloning/duplication. IGetQuantityByKey Interface for retrieving a quantity value using a string key. IGetSelectionName Interface for objects that can provide a name for selection purposes. INameNote Interface for objects that have a name and note property. IPreferredFileName Interface for objects that can specify a preferred file name. Generally used to suggest a name when generating or saving files. ISourceFile Interface for objects that have a source file. IUpdateByContent Interface for objects that can update themselves based on their content. IUriGetter Interface for retrieving a URI string. IWriteBin Interface for writing binary data. Enums BinarySearchResult Represents the result of a binary search operation. Delegates CppLogUtil.LogDelegate Internal Use Only." }, "api/Hi.CutterLocations.ClPath.ClCircleArc.html": { "href": "api/Hi.CutterLocations.ClPath.ClCircleArc.html", @@ -992,12 +982,12 @@ "api/Hi.CutterLocations.ClStrips.ClStrip.html": { "href": "api/Hi.CutterLocations.ClStrips.ClStrip.html", "title": "Class ClStrip | HiAPI-C# 2025", - "summary": "Class ClStrip Namespace Hi.CutterLocations.ClStrips Assembly HiMech.dll Represents a CL (Cutter Location) strip for 3D display. This class manages the display and interaction of cutter location points and lines. public class ClStrip : IDisplayee, IExpandToBox3d, IDisposable Inheritance object ClStrip Implements IDisplayee IExpandToBox3d 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) BoundSelectorUtil.GetStepRange(ClStrip, BoundSelectorPair) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ClStrip(int) Initializes a new instance of the ClStrip class. public ClStrip(int cap = 2048) Parameters cap int The initial capacity of the strip Fields slice_distance The distance between slices for efficient rendering. public const int slice_distance = 8192 Field Value int Properties AbsDispEnd Gets the absolute display end position. If the display end is set to -1, returns the total number of positions. public int AbsDispEnd { get; } Property Value int CallRefreshDrawing internal use public bool CallRefreshDrawing { get; } Property Value bool IsShowDot Gets or sets whether to display dots at each position. public bool IsShowDot { get; set; } Property Value bool StripPoses Gets the list of strip positions. Do not add or remove elements directly. public SynList StripPoses { get; } Property Value SynList StripPosesClearLock Gets the lock for thread-safe operations on strip positions. public ReaderWriterLockSlim StripPosesClearLock { get; } Property Value ReaderWriterLockSlim StripPosesCount Gets the thread-safe count of strip positions. public int StripPosesCount { get; } Property Value int Methods Add(object, DVec3d) Adds a new position to the strip. public ClStripPos Add(object state, DVec3d programCl) Parameters state object The state object associated with the position programCl DVec3d The cutter location Returns ClStripPos The newly created strip position Clear(object) Clears all strip positions and resets the display state. public void Clear(object sender) Parameters sender object The object that initiated this clear operation Display(Bind) Displays the strip. public void Display(Bind bind) Parameters bind Bind The binding context for display Dispose() Disposes of the resources used by this strip. public void Dispose() Dispose(bool) Disposes of the resources used by this strip. protected virtual void Dispose(bool disposing) Parameters disposing bool Whether this is being called from Dispose ExpandToBox3d(Box3d) Expands the given box to include all strip positions. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand GetDispBegin() Gets the current display begin position. public int GetDispBegin() Returns int The display begin position GetDispEnd() Gets the current display end position. A value of -1 indicates that the display should follow the end of the strip. public int GetDispEnd() Returns int The display end position GetEnteredPos() Gets the currently entered position. public ClStripPos GetEnteredPos() Returns ClStripPos The entered position GetScaledFittingViewByStripDispRange(Mat4d, Mat4d) Gets a scaled fitting view based on the strip display range. public Mat4d GetScaledFittingViewByStripDispRange(Mat4d sketchView, Mat4d clStripZeroToRoot = null) Parameters sketchView Mat4d The sketch view matrix clStripZeroToRoot Mat4d The transformation from strip zero to root Returns Mat4d The scaled fitting view matrix GetSelectedPos() Gets the currently selected position. public ClStripPos GetSelectedPos() Returns ClStripPos The selected position GetStripPos(int, bool) Gets a strip position by index. public ClStripPos GetStripPos(int index, bool isLocked = false) Parameters index int The index of the position isLocked bool Whether the strip positions are already locked Returns ClStripPos The strip position at the specified index RefreshDrawing() Marks the drawing for refresh. public void RefreshDrawing() RefreshDrawingInRendering(bool) internal use public void RefreshDrawingInRendering(bool isLocked) Parameters isLocked bool SetDispBegin(int, object) Sets the display begin position. public void SetDispBegin(int value, object caller) Parameters value int The new display begin position caller object The object that initiated this change SetDispEnd(int, object) Sets the display end position. A value of -1 indicates that the display should follow the end of the strip. public void SetDispEnd(int value, object caller) Parameters value int The new display end position caller object The object that initiated this change SetEnteredPos(ClStripPos, object) Sets the currently entered position. public void SetEnteredPos(ClStripPos value, object sender) Parameters value ClStripPos The new entered position sender object The object that initiated this change SetSelectedPos(ClStripPos, object) Sets the currently selected position. public void SetSelectedPos(ClStripPos value, object sender) Parameters value ClStripPos The new selected position sender object The object that initiated this change ShrinkAttachmentMemory() Shrinks the attachment memory for all positions. public void ShrinkAttachmentMemory() StripPosesThreadSafeSelect(Func) Thread-safe selection of strip positions. public List StripPosesThreadSafeSelect(Func func) Parameters func Func The function to transform each strip position Returns List A list of transformed strip positions Type Parameters T The type of the selected data Events AbsDispEndChanged Event raised when the absolute display end position changes. public event EventHandler AbsDispEndChanged Event Type EventHandler DispBeginChanged Event raised when the display begin position changes. public event EventHandler DispBeginChanged Event Type EventHandler DispEndChanged Event raised when the display end position changes. public event EventHandler DispEndChanged Event Type EventHandler DrawingRefreshing Event raised when the drawing is being refreshed. public event EventHandler DrawingRefreshing Event Type EventHandler PosAdded Event raised when a new position is added to the strip. public event Action PosAdded Event Type Action PosEntered Event raised when the mouse enters a position. public event EventHandler PosEntered Event Type EventHandler PosSelected Event raised when a position is selected. public event EventHandler PosSelected Event Type EventHandler StaticPosSelected Static event raised when any position is selected. public static event EventHandler StaticPosSelected Event Type EventHandler" + "summary": "Class ClStrip Namespace Hi.CutterLocations.ClStrips Assembly HiMech.dll Represents a CL (Cutter Location) strip for 3D display. This class manages the display and interaction of cutter location points and lines. public class ClStrip : IDisplayee, IExpandToBox3d, IDisposable Inheritance object ClStrip Implements IDisplayee IExpandToBox3d 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) BoundSelectorUtil.GetStepRange(ClStrip, BoundSelectorPair) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ClStrip(int) Initializes a new instance of the ClStrip class. public ClStrip(int cap = 2048) Parameters cap int The initial capacity of the strip Fields slice_distance The distance between slices for efficient rendering. public const int slice_distance = 8192 Field Value int Properties AbsDispEnd Gets the absolute display end position. If the display end is set to -1, returns the total number of positions. public int AbsDispEnd { get; } Property Value int CallRefreshDrawing internal use public bool CallRefreshDrawing { get; } Property Value bool IsShowDot Gets or sets whether to display dots at each position. public bool IsShowDot { get; set; } Property Value bool StripPoses Gets the list of strip positions. Do not add or remove elements directly. public SynList StripPoses { get; } Property Value SynList StripPosesClearLock Gets the lock for thread-safe operations on strip positions. public ReaderWriterLockSlim StripPosesClearLock { get; } Property Value ReaderWriterLockSlim StripPosesCount Gets the thread-safe count of strip positions. public int StripPosesCount { get; } Property Value int Methods Add(object, DVec3d) Adds a new position to the strip. public ClStripPos Add(object state, DVec3d programCl) Parameters state object The state object associated with the position programCl DVec3d The cutter location Returns ClStripPos The newly created strip position Clear(object) Clears all strip positions and resets the display state. public void Clear(object sender) Parameters sender object The object that initiated this clear operation Display(Bind) Displays the strip. public void Display(Bind bind) Parameters bind Bind The binding context for display Dispose() Disposes of the resources used by this strip. public void Dispose() Dispose(bool) Disposes of the resources used by this strip. protected virtual void Dispose(bool disposing) Parameters disposing bool Whether this is being called from Dispose ExpandToBox3d(Box3d) Expands the given box to include all strip positions. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand GetDispBegin() Gets the current display begin position. public int GetDispBegin() Returns int The display begin position GetDispEnd() Gets the current display end position. A value of -1 indicates that the display should follow the end of the strip. public int GetDispEnd() Returns int The display end position GetEnteredPos() Gets the currently entered position. public ClStripPos GetEnteredPos() Returns ClStripPos The entered position GetFittingView(Mat4d, Mat4d) Gets a scaled fitting view based on the strip display range. public Mat4d GetFittingView(Mat4d sketchView, Mat4d clStripZeroToRoot = null) Parameters sketchView Mat4d The sketch view matrix clStripZeroToRoot Mat4d The transformation from strip zero to root Returns Mat4d The scaled fitting view matrix GetSelectedPos() Gets the currently selected position. public ClStripPos GetSelectedPos() Returns ClStripPos The selected position GetStripPos(int, bool) Gets a strip position by index. public ClStripPos GetStripPos(int index, bool isLocked = false) Parameters index int The index of the position isLocked bool Whether the strip positions are already locked Returns ClStripPos The strip position at the specified index RefreshDrawing() Marks the drawing for refresh. public void RefreshDrawing() RefreshDrawingInRendering(bool) internal use public void RefreshDrawingInRendering(bool isLocked) Parameters isLocked bool SetDispBegin(int, object) Sets the display begin position. public void SetDispBegin(int value, object caller) Parameters value int The new display begin position caller object The object that initiated this change SetDispEnd(int, object) Sets the display end position. A value of -1 indicates that the display should follow the end of the strip. public void SetDispEnd(int value, object caller) Parameters value int The new display end position caller object The object that initiated this change SetEnteredPos(ClStripPos, object) Sets the currently entered position. public void SetEnteredPos(ClStripPos value, object sender) Parameters value ClStripPos The new entered position sender object The object that initiated this change SetSelectedPos(ClStripPos, object) Sets the currently selected position. public void SetSelectedPos(ClStripPos value, object sender) Parameters value ClStripPos The new selected position sender object The object that initiated this change ShrinkAttachmentMemory() Shrinks the attachment memory for all positions. public void ShrinkAttachmentMemory() StripPosesThreadSafeSelect(Func) Thread-safe selection of strip positions. public List StripPosesThreadSafeSelect(Func func) Parameters func Func The function to transform each strip position Returns List A list of transformed strip positions Type Parameters T The type of the selected data Events AbsDispEndChanged Event raised when the absolute display end position changes. public event EventHandler AbsDispEndChanged Event Type EventHandler DispBeginChanged Event raised when the display begin position changes. public event EventHandler DispBeginChanged Event Type EventHandler DispEndChanged Event raised when the display end position changes. public event EventHandler DispEndChanged Event Type EventHandler DrawingRefreshing Event raised when the drawing is being refreshed. public event EventHandler DrawingRefreshing Event Type EventHandler PosAdded Event raised when a new position is added to the strip. public event Action PosAdded Event Type Action PosEntered Event raised when the mouse enters a position. public event EventHandler PosEntered Event Type EventHandler PosSelected Event raised when a position is selected. public event EventHandler PosSelected Event Type EventHandler StaticPosSelected Static event raised when any position is selected. public static event EventHandler StaticPosSelected Event Type EventHandler" }, "api/Hi.CutterLocations.ClStrips.ClStripPos.html": { "href": "api/Hi.CutterLocations.ClStrips.ClStripPos.html", "title": "Class ClStripPos | HiAPI-C# 2025", - "summary": "Class ClStripPos Namespace Hi.CutterLocations.ClStrips Assembly HiMech.dll Represents a position in a cutter location strip, containing program coordinates and state information. public class ClStripPos : CbtrPickable, IPickableGetter, IDisposable, IGetProgramCl Inheritance object Pickable CbtrPickable ClStripPos Implements IPickableGetter IDisposable IGetProgramCl Inherited Members CbtrPickable.Rgb CbtrPickable.AttachmentPriority CbtrPickable.Highlight(bool) CbtrPickable.CleanLinkedCbtrNodesDrawingCache() CbtrPickable.ShrinkToFitNodeMap() Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Properties Index Gets the index of this position in the strip. public int Index { get; } Property Value int MillingStep Gets or sets the milling step associated with this position. This is a convenience property that casts the State to MillingStep. public MachiningStep MillingStep { get; set; } Property Value MachiningStep ProgramCl Gets the program coordinates of this position. public DVec3d ProgramCl { get; } Property Value DVec3d State Gets or sets the state object associated with this position. When the state changes, the color is automatically refreshed. public object State { get; set; } Property Value object Methods Display(Bind) public void Display(Bind bind) Parameters bind Bind Dispose(bool) protected override void Dispose(bool disposing) Parameters disposing bool GetLastTime(bool) If time is not set, return the time from the last setted step. public TimeSpan? GetLastTime(bool isLocked = false) Parameters isLocked bool Returns TimeSpan? GetProgramCl() Get CL (Cutter Location). Where Point is tool tip position; Normal is tool orientation. public DVec3d GetProgramCl() Returns DVec3d CL OnKeyDown(key_event_t, panel_state_t) Behavior on key down. public override void OnKeyDown(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnKeyUp(key_event_t, panel_state_t) Behavior on key up public override void OnKeyUp(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnMouseDown(mouse_button_event_t, panel_state_t) Behavior on mouse down public override void OnMouseDown(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseMove(mouse_move_event_t, panel_state_t) Behavior on mouse move public override void OnMouseMove(mouse_move_event_t e, panel_state_t state) Parameters e mouse_move_event_t event state panel_state_t panel state OnMouseUp(mouse_button_event_t, panel_state_t) Behavior on mouse up public override void OnMouseUp(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseWheel(mouse_wheel_event_t, panel_state_t) Behavior on mouse wheel public override void OnMouseWheel(mouse_wheel_event_t e, panel_state_t state) Parameters e mouse_wheel_event_t event state panel_state_t panel state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class ClStripPos Namespace Hi.CutterLocations.ClStrips Assembly HiMech.dll Represents a position in a cutter location strip, containing program coordinates and state information. public class ClStripPos : CbtrPickable, IGetPickable, IDisposable, IGetProgramCl Inheritance object Pickable CbtrPickable ClStripPos Implements IGetPickable IDisposable IGetProgramCl Inherited Members CbtrPickable.Rgb CbtrPickable.AttachmentPriority CbtrPickable.Highlight(bool) CbtrPickable.CleanLinkedCbtrNodesDrawingCache() CbtrPickable.ShrinkToFitNodeMap() Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Properties Index Gets the index of this position in the strip. public int Index { get; } Property Value int MillingStep Gets or sets the milling step associated with this position. This is a convenience property that casts the State to MillingStep. public MachiningStep MillingStep { get; set; } Property Value MachiningStep ProgramCl Gets the program coordinates of this position. public DVec3d ProgramCl { get; } Property Value DVec3d State Gets or sets the state object associated with this position. When the state changes, the color is automatically refreshed. public object State { get; set; } Property Value object Methods Display(Bind) public void Display(Bind bind) Parameters bind Bind Dispose(bool) protected override void Dispose(bool disposing) Parameters disposing bool GetLastTime(bool) If time is not set, return the time from the last setted step. public TimeSpan? GetLastTime(bool isLocked = false) Parameters isLocked bool Returns TimeSpan? GetProgramCl() Get CL (Cutter Location). Where Point is tool tip position; Normal is tool orientation. public DVec3d GetProgramCl() Returns DVec3d CL OnKeyDown(key_event_t, panel_state_t) Behavior on key down. public override void OnKeyDown(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnKeyUp(key_event_t, panel_state_t) Behavior on key up public override void OnKeyUp(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnMouseDown(mouse_button_event_t, panel_state_t) Behavior on mouse down public override void OnMouseDown(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseMove(mouse_move_event_t, panel_state_t) Behavior on mouse move public override void OnMouseMove(mouse_move_event_t e, panel_state_t state) Parameters e mouse_move_event_t event state panel_state_t panel state OnMouseUp(mouse_button_event_t, panel_state_t) Behavior on mouse up public override void OnMouseUp(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseWheel(mouse_wheel_event_t, panel_state_t) Behavior on mouse wheel public override void OnMouseWheel(mouse_wheel_event_t e, panel_state_t state) Parameters e mouse_wheel_event_t event state panel_state_t panel state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.CutterLocations.ClStrips.RgbFunc.html": { "href": "api/Hi.CutterLocations.ClStrips.RgbFunc.html", @@ -1027,22 +1017,22 @@ "api/Hi.Disp.Bind.html": { "href": "api/Hi.Disp.Bind.html", "title": "Class Bind | HiAPI-C# 2025", - "summary": "Class Bind Namespace Hi.Disp Assembly HiDisp.dll Runtime rendering data for each iteration in rendering loop. It manipulates geometry transformation, such as moving, rotatingand scaling. It also deal with color and picking. A bind_t object is generated by rendering in the every beginning of each rendering iteration. public class Bind : IDisposable Inheritance object Bind Implements IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Fields bind Internal use. public bind_t* bind Field Value bind_t* Properties CanvasHeight DispEngine height. public int CanvasHeight { get; } Property Value int CanvasWidth DispEngine width. public int CanvasWidth { get; } Property Value int IsPickingMode Is current display loop in pick mode. public bool IsPickingMode { get; } Property Value bool ModelMatStack Stack-based Model matrix in MVP convention. public MatStack ModelMatStack { get; } Property Value MatStack PickID ID of picking event. public int PickID { get; set; } Property Value int PixelProjMat Pixel part of Projection matrix in MVP convention. public Mat4d PixelProjMat { get; } Property Value Mat4d See Also ProjMat PixelWidthOnModel Pixel width on model layer. public double PixelWidthOnModel { get; } Property Value double ProjMat Projection matrix in MVP convention. Projection matrix = ScaleProjMat * PixelProjMat. public Mat4d ProjMat { get; } Property Value Mat4d RGB External RGB Color for the Drawing which the KeyStamp does not contains C. public Vec3d RGB { get; set; } Property Value Vec3d Reciprocal_vs_scale Cached reciprocal value of the scale of ViewMat * ScaleProjMat. public double Reciprocal_vs_scale { get; } Property Value double ScaleProjMat Scale part of Projection matrix in MVP convention. public Mat4d ScaleProjMat { get; } Property Value Mat4d See Also ProjMat SparkleRate Gets or sets the sparkle rate for rendering effects. public float SparkleRate { get; set; } Property Value float ViewMat View matrix in MVP convention. public Mat4d ViewMat { get; } Property Value Mat4d Methods 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 ~Bind() protected ~Bind() GetMvpBoxRelation(Vec3d, double) get relation between mvpBox and a AABB (bounding with a sphere) public MvpBoxRelation GetMvpBoxRelation(Vec3d center, double r) Parameters center Vec3d center r double radius Returns MvpBoxRelation 0 if no overlap; 1 if partial overlap; 2 if B in A PopColor() Pop the color after using PushColor() and etc.. public void PopColor() See Also PushColor() PushColorByRgb(Vec3d) PopLineWidth() Pop the line width from the stack. And then set the poped line width to current line width. public void PopLineWidth() PopPointSize() Pop the stored point size from the stack. And then set the stored point size to current point size. public void PopPointSize() See Also PushPointSize() PushPointSize(double) PushColor() Push current color to stack. After PopColor(), the pushed color will be restored. public void PushColor() PushColorByHsl(Vec3d) Pushes a color onto the color stack using HSL values. public void PushColorByHsl(Vec3d hsl) Parameters hsl Vec3d The HSL color vector. PushColorByHsl(double, double, double) Pushes a color onto the color stack using HSL values. public void PushColorByHsl(double hue, double saturation, double light) Parameters hue double The hue component (0.0 to 1.0). saturation double The saturation component (0.0 to 1.0). light double The lightness component (0.0 to 1.0). PushColorByHslOffset(Vec3d) Pushes a color onto the color stack by applying HSL offsets to the current color. public void PushColorByHslOffset(Vec3d hslOffset) Parameters hslOffset Vec3d The HSL offset vector to apply. PushColorByHslOffset(double, double, double) Pushes a color onto the color stack by applying HSL offsets to the current color. public void PushColorByHslOffset(double hueOffset, double saturationOffset, double lightOffset) Parameters hueOffset double The hue offset to apply. saturationOffset double The saturation offset to apply. lightOffset double The lightness offset to apply. PushColorByRgb(Vec3d) Push current color to stack then set the color to given rgb. After PopColor(), the pushed color will be restored. If rgb is null, ignore the rgb and push. public void PushColorByRgb(Vec3d rgb) Parameters rgb Vec3d RGB color PushColorByRgb(double, double, double) Pushes a color onto the color stack using RGB values. public void PushColorByRgb(double r, double g, double b) Parameters r double The red component value (0.0 to 1.0). g double The green component value (0.0 to 1.0). b double The blue component value (0.0 to 1.0). PushCoveringPixelMode() Push covering-pixel-mode matrix to ModelMatStack to make the display in pixel scale. Call ModelMatStack.Pop() to end the mode. public void PushCoveringPixelMode() PushLineWidth() Push current line width into stack. public void PushLineWidth() See Also PopLineWidth() PushLineWidth(double) Push current line width into stack. And then set lineWidth to the current line width. public void PushLineWidth(double lineWidth) Parameters lineWidth double line width See Also PopLineWidth() PushNoRotationPixelMode() Push no-rotation-pixel-mode matrix to ModelMatStack to make the display in pixel scale. Call ModelMatStack.Pop() to end the mode. public void PushNoRotationPixelMode() PushPixelMode() Push pixel mode matrix to ModelMatStack to make the display in pixel scale. Call ModelMatStack.Pop() to end the mode. public void PushPixelMode() PushPointSize() Push current point size to the stack. public void PushPointSize() See Also PopPointSize() PushPointSize(double) Push current point size to the stack. And then set the pointSize to current point size. public void PushPointSize(double pointSize) Parameters pointSize double point size See Also PopPointSize() PushPointSize(float) Push current point size to the stack. And then set the pointSize to current point size. public void PushPointSize(float pointSize) Parameters pointSize float point size See Also PopPointSize() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class Bind Namespace Hi.Disp Assembly HiDisp.dll Runtime rendering data for each iteration in rendering loop. It manipulates geometry transformation, such as moving, rotatingand scaling. It also deal with color and picking. A bind_t object is generated by rendering in the every beginning of each rendering iteration. public class Bind : IDisposable Inheritance object Bind Implements IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Fields bind Internal use. public bind_t* bind Field Value bind_t* Properties CanvasHeight DispEngine height. public int CanvasHeight { get; } Property Value int CanvasWidth DispEngine width. public int CanvasWidth { get; } Property Value int IsPickingMode Is current display loop in pick mode. public bool IsPickingMode { get; } Property Value bool ModelMatStack Stack-based Model matrix in MVP convention. public MatStack ModelMatStack { get; } Property Value MatStack PickID ID of picking event. public int PickID { get; set; } Property Value int PixelProjMat Pixel part of Projection matrix in MVP convention. public Mat4d PixelProjMat { get; } Property Value Mat4d See Also ProjMat PixelWidthOnModel Pixel width on model layer. public double PixelWidthOnModel { get; } Property Value double ProjMat Projection matrix in MVP convention. Projection matrix = ScaleProjMat * PixelProjMat. public Mat4d ProjMat { get; } Property Value Mat4d Reciprocal_vs_scale Cached reciprocal value of the scale of ViewMat * ScaleProjMat. public double Reciprocal_vs_scale { get; } Property Value double Rgb External RGB Color for the Drawing which the KeyStamp does not contains C. public Vec3d Rgb { get; set; } Property Value Vec3d ScaleProjMat Scale part of Projection matrix in MVP convention. public Mat4d ScaleProjMat { get; } Property Value Mat4d See Also ProjMat SparkleRate Gets or sets the sparkle rate for rendering effects. public float SparkleRate { get; set; } Property Value float ViewMat View matrix in MVP convention. public Mat4d ViewMat { get; } Property Value Mat4d Methods 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 ~Bind() protected ~Bind() GetMvpBoxRelation(Vec3d, double) get relation between mvpBox and a AABB (bounding with a sphere) public MvpBoxRelation GetMvpBoxRelation(Vec3d center, double r) Parameters center Vec3d center r double radius Returns MvpBoxRelation 0 if no overlap; 1 if partial overlap; 2 if B in A PopColor() Pop the color after using PushColor() and etc.. public void PopColor() See Also PushColor() PushColorByRgb(Vec3d) PopLineWidth() Pop the line width from the stack. And then set the poped line width to current line width. public void PopLineWidth() PopPointSize() Pop the stored point size from the stack. And then set the stored point size to current point size. public void PopPointSize() See Also PushPointSize() PushPointSize(double) PushColor() Push current color to stack. After PopColor(), the pushed color will be restored. public void PushColor() PushColorByHsl(Vec3d) Pushes a color onto the color stack using HSL values. public void PushColorByHsl(Vec3d hsl) Parameters hsl Vec3d The HSL color vector. PushColorByHsl(double, double, double) Pushes a color onto the color stack using HSL values. public void PushColorByHsl(double hue, double saturation, double light) Parameters hue double The hue component (0.0 to 1.0). saturation double The saturation component (0.0 to 1.0). light double The lightness component (0.0 to 1.0). PushColorByHslOffset(Vec3d) Pushes a color onto the color stack by applying HSL offsets to the current color. public void PushColorByHslOffset(Vec3d hslOffset) Parameters hslOffset Vec3d The HSL offset vector to apply. PushColorByHslOffset(double, double, double) Pushes a color onto the color stack by applying HSL offsets to the current color. public void PushColorByHslOffset(double hueOffset, double saturationOffset, double lightOffset) Parameters hueOffset double The hue offset to apply. saturationOffset double The saturation offset to apply. lightOffset double The lightness offset to apply. PushColorByRgb(Vec3d) Push current color to stack then set the color to given rgb. After PopColor(), the pushed color will be restored. If rgb is null, ignore the rgb and push. public void PushColorByRgb(Vec3d rgb) Parameters rgb Vec3d RGB color PushColorByRgb(double, double, double) Pushes a color onto the color stack using RGB values. public void PushColorByRgb(double r, double g, double b) Parameters r double The red component value (0.0 to 1.0). g double The green component value (0.0 to 1.0). b double The blue component value (0.0 to 1.0). PushColorByRgbOffset(Vec3d) public void PushColorByRgbOffset(Vec3d rgbOffset) Parameters rgbOffset Vec3d PushColorByRgbOffset(double, double, double) public void PushColorByRgbOffset(double rOffset, double gOffset, double bOffset) Parameters rOffset double gOffset double bOffset double PushCoveringPixelMode() Push covering-pixel-mode matrix to ModelMatStack to make the display in pixel scale. Call ModelMatStack.Pop() to end the mode. public void PushCoveringPixelMode() PushLineWidth() Push current line width into stack. public void PushLineWidth() See Also PopLineWidth() PushLineWidth(double) Push current line width into stack. And then set lineWidth to the current line width. public void PushLineWidth(double lineWidth) Parameters lineWidth double line width See Also PopLineWidth() PushNoRotationPixelMode() Push no-rotation-pixel-mode matrix to ModelMatStack to make the display in pixel scale. Call ModelMatStack.Pop() to end the mode. public void PushNoRotationPixelMode() PushPixelMode() Push pixel mode matrix to ModelMatStack to make the display in pixel scale. Call ModelMatStack.Pop() to end the mode. public void PushPixelMode() PushPointSize() Push current point size to the stack. public void PushPointSize() See Also PopPointSize() PushPointSize(double) Push current point size to the stack. And then set the pointSize to current point size. public void PushPointSize(double pointSize) Parameters pointSize double point size See Also PopPointSize() PushPointSize(float) Push current point size to the stack. And then set the pointSize to current point size. public void PushPointSize(float pointSize) Parameters pointSize float point size See Also PopPointSize() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, - "api/Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel.html": { - "href": "api/Hi.Disp.Box3dUtil.BoxableExpandToBox3dDel.html", - "title": "Delegate Box3dUtil.BoxableExpandToBox3dDel | HiAPI-C# 2025", - "summary": "Delegate Box3dUtil.BoxableExpandToBox3dDel Namespace Hi.Disp Assembly HiDisp.dll Delegate for expanding a native boxable object to a box3d. public delegate void Box3dUtil.BoxableExpandToBox3dDel(nint boxablePtr, ref box3d box) Parameters boxablePtr nint Pointer to the boxable object. box box3d Reference to the box to expand. 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)" + "api/Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel.html": { + "href": "api/Hi.Disp.Box3dDispUtil.BoxableExpandToBox3dDel.html", + "title": "Delegate Box3dDispUtil.BoxableExpandToBox3dDel | HiAPI-C# 2025", + "summary": "Delegate Box3dDispUtil.BoxableExpandToBox3dDel Namespace Hi.Disp Assembly HiDisp.dll Delegate for expanding a native boxable object to a box3d. public delegate void Box3dDispUtil.BoxableExpandToBox3dDel(nint boxablePtr, ref box3d box) Parameters boxablePtr nint Pointer to the boxable object. box box3d Reference to the box to expand. 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)" }, - "api/Hi.Disp.Box3dUtil.html": { - "href": "api/Hi.Disp.Box3dUtil.html", - "title": "Class Box3dUtil | HiAPI-C# 2025", - "summary": "Class Box3dUtil Namespace Hi.Disp Assembly HiDisp.dll Utility and Extension of Box3d. public static class Box3dUtil Inheritance object Box3dUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Display(Box3d, Bind) Call DisplayLine(Box3d, Bind). public static void Display(this Box3d src, Bind bind) Parameters src Box3d src bind Bind bind DisplayFace(Box3d, Bind) Display faces of the src. public static void DisplayFace(this Box3d src, Bind bind) Parameters src Box3d src bind Bind bind DisplayLine(Box3d, Bind) Display edges of the src. public static void DisplayLine(this Box3d src, Bind bind) Parameters src Box3d src bind Bind bind ExpandToBox3d(nint, BoxableExpandToBox3dDel, Box3d) Expands a destination Box3d to include the bounds of a native boxable object. public static void ExpandToBox3d(nint boxablePtr, Box3dUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel, Box3d dst) Parameters boxablePtr nint Pointer to the boxable object. boxableExpandToBox3dDel Box3dUtil.BoxableExpandToBox3dDel Delegate to expand the boxable to a box3d. dst Box3d The destination Box3d to expand. GetBox(nint, BoxableExpandToBox3dDel) Gets a Box3d from a native boxable pointer using the provided delegate. public static Box3d GetBox(nint boxablePtr, Box3dUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel) Parameters boxablePtr nint Pointer to the boxable object. boxableExpandToBox3dDel Box3dUtil.BoxableExpandToBox3dDel Delegate to expand the boxable to a box3d. Returns Box3d A Box3d representing the bounds of the boxable object. GetFaceDraw(params Box3d[]) Get faces Drawing. public static Drawing GetFaceDraw(params Box3d[] boxs) Parameters boxs Box3d[] boxes Returns Drawing a draw with face GetLineDraw(params Box3d[]) Get the edges Drawing of boxs. public static Drawing GetLineDraw(params Box3d[] boxs) Parameters boxs Box3d[] boxs Returns Drawing The Drawing ToDraw(Box3d) Equivalent to ToDraw_Face(Box3d) public static Drawing ToDraw(this Box3d src) Parameters src Box3d src Returns Drawing Drawing ToDraw_Face(Box3d) To Face Drawing. public static Drawing ToDraw_Face(this Box3d src) Parameters src Box3d src Returns Drawing Face Drawing ToDraw_Line(Box3d) To Line Drawing. public static Drawing ToDraw_Line(this Box3d src) Parameters src Box3d src Returns Drawing Line Drawing ToLineBuf(Box3d, double[], ref int) Put the edges' data to dst, totally 72 double. The data is used according to GL_LINES. public static int ToLineBuf(this Box3d src, double[] dst, ref int p) Parameters src Box3d src dst double[] dstination buffer p int current position of the buffer Returns int The p increment: 72" + "api/Hi.Disp.Box3dDispUtil.html": { + "href": "api/Hi.Disp.Box3dDispUtil.html", + "title": "Class Box3dDispUtil | HiAPI-C# 2025", + "summary": "Class Box3dDispUtil Namespace Hi.Disp Assembly HiDisp.dll Utility and Extension of Box3d. public static class Box3dDispUtil Inheritance object Box3dDispUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Display(Box3d, Bind) Call DisplayLine(Box3d, Bind). public static void Display(this Box3d src, Bind bind) Parameters src Box3d src bind Bind bind DisplayFace(Box3d, Bind) Display faces of the src. public static void DisplayFace(this Box3d src, Bind bind) Parameters src Box3d src bind Bind bind DisplayLine(Box3d, Bind) Display edges of the src. public static void DisplayLine(this Box3d src, Bind bind) Parameters src Box3d src bind Bind bind ExpandToBox3d(nint, BoxableExpandToBox3dDel, Box3d) Expands a destination Box3d to include the bounds of a native boxable object. public static void ExpandToBox3d(nint boxablePtr, Box3dDispUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel, Box3d dst) Parameters boxablePtr nint Pointer to the boxable object. boxableExpandToBox3dDel Box3dDispUtil.BoxableExpandToBox3dDel Delegate to expand the boxable to a box3d. dst Box3d The destination Box3d to expand. GetBox(nint, BoxableExpandToBox3dDel) Gets a Box3d from a native boxable pointer using the provided delegate. public static Box3d GetBox(nint boxablePtr, Box3dDispUtil.BoxableExpandToBox3dDel boxableExpandToBox3dDel) Parameters boxablePtr nint Pointer to the boxable object. boxableExpandToBox3dDel Box3dDispUtil.BoxableExpandToBox3dDel Delegate to expand the boxable to a box3d. Returns Box3d A Box3d representing the bounds of the boxable object. GetFaceDraw(params Box3d[]) Get faces Drawing. public static Drawing GetFaceDraw(params Box3d[] boxs) Parameters boxs Box3d[] boxes Returns Drawing a draw with face GetLineDraw(params Box3d[]) Get the edges Drawing of boxs. public static Drawing GetLineDraw(params Box3d[] boxs) Parameters boxs Box3d[] boxs Returns Drawing The Drawing ToDraw(Box3d) Equivalent to ToDraw_Face(Box3d) public static Drawing ToDraw(this Box3d src) Parameters src Box3d src Returns Drawing Drawing ToDraw_Face(Box3d) To Face Drawing. public static Drawing ToDraw_Face(this Box3d src) Parameters src Box3d src Returns Drawing Face Drawing ToDraw_Line(Box3d) To Line Drawing. public static Drawing ToDraw_Line(this Box3d src) Parameters src Box3d src Returns Drawing Line Drawing ToLineBuf(Box3d, double[], ref int) Put the edges' data to dst, totally 72 double. The data is used according to GL_LINES. public static int ToLineBuf(this Box3d src, double[] dst, ref int p) Parameters src Box3d src dst double[] dstination buffer p int current position of the buffer Returns int The p increment: 72" }, "api/Hi.Disp.DelegateFuncDisplayee.html": { "href": "api/Hi.Disp.DelegateFuncDisplayee.html", "title": "Class DelegateFuncDisplayee | HiAPI-C# 2025", - "summary": "Class DelegateFuncDisplayee Namespace Hi.Disp Assembly HiDisp.dll A displayee implementation that delegates display functionality to a function. public class DelegateFuncDisplayee : IDisplayee, IExpandToBox3d Inheritance object DelegateFuncDisplayee Implements IDisplayee IExpandToBox3d 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) Constructors DelegateFuncDisplayee(Func) Initializes a new instance of the DelegateFuncDisplayee class. public DelegateFuncDisplayee(Func func) Parameters func Func The function that returns an IDisplayee instance. Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class DelegateFuncDisplayee Namespace Hi.Disp Assembly HiDisp.dll A displayee implementation that delegates display functionality to a function. public class DelegateFuncDisplayee : IDisplayee, IExpandToBox3d Inheritance object DelegateFuncDisplayee Implements IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors DelegateFuncDisplayee(Func) Initializes a new instance of the DelegateFuncDisplayee class. public DelegateFuncDisplayee(Func func) Parameters func Func The function that returns an IDisplayee instance. Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.DispEngine.ImageRequestedDelegate.html": { "href": "api/Hi.Disp.DispEngine.ImageRequestedDelegate.html", @@ -1052,7 +1042,7 @@ "api/Hi.Disp.DispEngine.html": { "href": "api/Hi.Disp.DispEngine.html", "title": "Class DispEngine | HiAPI-C# 2025", - "summary": "Class DispEngine Namespace Hi.Disp Assembly HiDisp.dll HiAPI display engine. public class DispEngine : IDisposable, IGetDispEngine Inheritance object DispEngine Implements IDisposable IGetDispEngine 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 The DispEngine is the core rendering and interaction engine for HiAPI applications. Related Documentation Using RenderingCanvas with DispEngine Building Your Own Rendering Canvas The DispEngine provides a unified API for handling rendering, user interaction, and touch gestures across different UI frameworks. Constructors DispEngine(IDisplayee) Ctor. The SetViewToHomeView() is called in this function. public DispEngine(IDisplayee displayee) Parameters displayee IDisplayee The displayee to render. DispEngine(params IDisplayee[]) Ctor. public DispEngine(params IDisplayee[] displayees) Parameters displayees IDisplayee[] displayees to render. Fields CoreDll Core dll path. public const string CoreDll = \"core.dll\" Field Value string defaultFontFile The default font file path used by the display engine. public const string defaultFontFile = \"Font/WCL06.ttf\" Field Value string Properties BackgroundColor Background color public Vec3d BackgroundColor { get; set; } Property Value Vec3d BackgroundOpacity Background opacity. Range is from 0 to 1. public double BackgroundOpacity { get; set; } Property Value double ContextProjDepth Gets the projection depth of the current context. public static double ContextProjDepth { get; } Property Value double CursorOffsetX Internal Use. public int CursorOffsetX { get; } Property Value int CursorOffsetY Internal Use. public int CursorOffsetY { get; } Property Value int CursorX Internal Use. public int CursorX { get; set; } Property Value int CursorY Internal Use. public int CursorY { get; set; } Property Value int Displayee Displayee to be rendered in the rendering loop. The SetViewToHomeView() is called in this function. public IDisplayee Displayee { get; set; } Property Value IDisplayee EnableSuppressDefaultLogo Get or Set to Enable Suppress Default Logo. The set take no effect if the license SuppressDefaultLogo is not login. public static bool EnableSuppressDefaultLogo { get; set; } Property Value bool FontFile Font file. public static string FontFile { get; set; } Property Value string IsOnDispThread Gets a value indicating whether the current thread is the display thread. public static bool IsOnDispThread { get; } Property Value bool IsVisible The anime stop running if the value is false; otherwise, the anime starts or keeps running. public bool IsVisible { get; set; } Property Value bool Model public Mat4d Model { get; set; } Property Value Mat4d Model matrix in MVP convention. This Model matrix is the first matrix in Hi.Disp.Bind.modelMatStack. PixelProj public Mat4d PixelProj { get; set; } Property Value Mat4d Pixel part of Projection matrix in MVP convention. Projection matrix = ScaleProj * PixelProj; PreCursorX Internal Use. public int PreCursorX { get; set; } Property Value int PreCursorY Internal Use. public int PreCursorY { get; set; } Property Value int PrincipleView public Mat4d PrincipleView { get; set; } Property Value Mat4d view = PrincipleView * SketchView. Where view matrix is in MVP convention. Remarks The default value is new Mat4d(new Vec3d(1, 0, 0), -Math.PI / 2). This make the 2D plane from xy plane to xz plane. The xz plane is much suit for 3D engineering display. RefreshingPeriod Image refreshing period. public TimeSpan RefreshingPeriod { get; set; } Property Value TimeSpan ScaleProj public Mat4d ScaleProj { get; set; } Property Value Mat4d Scale part of Projection matrix in MVP convention. Projection matrix = ScaleProj * PixelProj; SketchView view = PrincipleView * SketchView. Where view matrix is in MVP convention. public Mat4d SketchView { get; set; } Property Value Mat4d Methods DeleteDispContext() Deletes the current display context. public static void DeleteDispContext() 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 EnqueueDispose(IDisposable) Enqueues a disposable object to be disposed on the display thread. public static Task EnqueueDispose(IDisposable disposable) Parameters disposable IDisposable The disposable object to be disposed Returns Task A task representing the disposal operation EnqueueTask(Task) Enqueues a task to be executed on the display thread. public static Task EnqueueTask(Task task) Parameters task Task The task to be executed Returns Task The enqueued task EnqueueTask(Task) Enqueues a task to be executed on the display thread. public static Task EnqueueTask(Task task) Parameters task Task The task to be executed Returns Task The enqueued task Type Parameters T The type of the task result ~DispEngine() protected ~DispEngine() FinishDisp() Elegantly end the rendering core. Probably not essential. public static void FinishDisp() GetDispEngine() Get DispEngine. public DispEngine GetDispEngine() Returns DispEngine DispEngine Init(string) Initializes the display engine system. public static void Init(string fontFile = null) Parameters fontFile string The font file to use. If null, the default font file will be used. IsMouseButtonPressed(long) Checks if a specific mouse button is currently pressed. public bool IsMouseButtonPressed(long mouseButton) Parameters mouseButton long The mouse button to check, typically a value from the HiMouseButton enumeration. Returns bool True if the specified mouse button is pressed; otherwise, false. Remarks This method is useful for implementing conditional UI behaviors based on mouse button state: // Check if left mouse button is pressed if (dispEngine.IsMouseButtonPressed((long)HiMouseButton.Left)) { // Perform special action while left button is held down } KeyDown(long) Key down. This function is typically called in the GUI implementation for keyboard interaction. public void KeyDown(long key) Parameters key long key KeyDownTransform(long, key_table__transform_view_by_key_pressing_t) Transform SketchView by key. Home, F1, F2, F3, F4 call SetViewToHomeView(), SetViewToFrontView(), SetViewToSideView(), SetViewToTopView(), SetViewToIsometricView() respectively. PageDown and PageUp scale the SketchView. Left, Right, Down, Up translate the SketchView; Press Shift make these keys to rotate the SketchView. public void KeyDownTransform(long key, key_table__transform_view_by_key_pressing_t table) Parameters key long The key that was pressed, typically a value from the HiKey enumeration. table key_table__transform_view_by_key_pressing_t A table defining which keys trigger different transformation operations. Remarks This method is typically called from key down event handlers in the GUI implementation. KeyUp(long) Key up. This function is typically called in the GUI implementation for keyboard interaction. public void KeyUp(long key) Parameters key long key LockGlContext() Lock a opengl context. The function is only used for native OpenGL rendering. After lock the gl context, It should be unlock by UnlockGlContext(nint). public static nint LockGlContext() Returns nint Remarks If any other lock requires LockGlContext, the lock should better set inside LockGlContext. or it is easy to occur race condition. see design pattern of “Solid” class for reference. MouseButtonDown(long) Mouse button down. This function is typically called in the GUI implementation for mouse interaction. public void MouseButtonDown(long button) Parameters button long button MouseButtonUp(long) Mouse button up. This function is typically called in the GUI implementation for mouse interaction. public void MouseButtonUp(long button) Parameters button long button MouseDragTransform(int, int, mouse_button_table__transform_view_by_mouse_drag_t) Transform the view by mouse drag. If drag by left mouse button, Translate(double, double) is performed; If drag by right mouse button, Rotate(double, double) is performed. public void MouseDragTransform(int x, int y, mouse_button_table__transform_view_by_mouse_drag_t mouse_button_table) Parameters x int The current x-coordinate of the mouse cursor. y int The current y-coordinate of the mouse cursor. mouse_button_table mouse_button_table__transform_view_by_mouse_drag_t A table defining which mouse buttons trigger different transformation operations. Remarks The mouse_button_table__transform_view_by_mouse_drag_t structure allows you to configure which mouse buttons perform which transformations: var buttonTable = new mouse_button_table__transform_view_by_mouse_drag_t { LEFT_BUTTON = (long)HiMouseButton.Left, // For translation RIGHT_BUTTON = (long)HiMouseButton.Right // For rotation }; This method is typically called from mouse move event handlers when buttons are pressed. MouseMove(int, int) Mouse move. This function is typically called in the GUI implementation for mouse interaction. public void MouseMove(int x, int y) Parameters x int cursor X position y int cursor Y position MouseWheel(int, int) Mouse wheel move. This function is typically called in the GUI implementation for mouse interaction. public void MouseWheel(int deltaX, int deltaY) Parameters deltaX int mouse wheel delta X deltaY int mouse wheel delta Y. The traditional mouse wheel. MouseWheelTransform(int, int, double) Scale SketchView by mouse wheel. public void MouseWheelTransform(int deltaX, int deltaY, double zooming_ratio = 0.2) Parameters deltaX int mouse wheel delta X deltaY int mouse wheel delta Y. The traditional mouse wheel. zooming_ratio double The ratio used for zooming. Default is 0.2. Resize(int, int) Resize the opengl context. public void Resize(int w, int h) Parameters w int width of the viewport h int height of the viewport Rotate(double, double) Rotate the SketchView. Usually used by mouse drag on window. The rotation axis is along (delta_y, 0, delta_x). The rotation rad is 5 * Math.Sqrt(delta_y * delta_y + delta_x * delta_x) / window_height. public void Rotate(double delta_x, double delta_y) Parameters delta_x double delta x in window coordinate delta_y double delta y in window coordinate RotateAndScaleByTouchPad(Vec2d, Vec2d, Vec2d, Vec2d) Rotate and scale the SketchView based on touch pad gestures. public void RotateAndScaleByTouchPad(Vec2d prePosA, Vec2d curPosA, Vec2d prePosB, Vec2d curPosB) Parameters prePosA Vec2d The previous position of the first touch point. curPosA Vec2d The current position of the first touch point. prePosB Vec2d The previous position of the second touch point. curPosB Vec2d The current position of the second touch point. Remarks The method detects two types of gestures: Pinch gesture: When the distance between touch points changes, it triggers zooming via MouseWheelTransform(int, int, double) Rotation/Pan gesture: When touch points move together, it triggers rotation via Rotate(double, double) This method is typically used to implement touchpad or multi-touch gestures in custom UI implementations. RotateWithoutHeightAdjustment(double, double) Rotate the SketchView. Usually used by keyboard command. The rotation axis is along (delta_y, 0, delta_x). The rotation rad is Math.ToRad(Math.Sqrt(delta_y * delta_y + delta_x * delta_x)). public void RotateWithoutHeightAdjustment(double delta_x, double delta_y) Parameters delta_x double delta x in window coordinate delta_y double delta y in window coordinate SetViewToFrontView() Set the SketchView to front view. public void SetViewToFrontView() SetViewToHomeView() Set the SketchView to home view(front view). This is the same as SetViewToFrontView(). public void SetViewToHomeView() SetViewToIsometricView() Set the SketchView to isometric view. public void SetViewToIsometricView() SetViewToSideView() Set the SketchView to side view. public void SetViewToSideView() SetViewToTopView() Set the SketchView to top view. public void SetViewToTopView() Snapshot(string) Snapshot to BMP file with current canvas size. public void Snapshot(string filePath) Parameters filePath string Snapshot(string, int, int) Snapshot to BMP file. public void Snapshot(string filePath, int panelWidth, int panelHeight) Parameters filePath string panelWidth int panelHeight int Start(int, int) Start a thread of keeping Swapping buffers of OpenGL context. If the thread has running, this function does nothing. public void Start(int panelWidth, int panelHeight) Parameters panelWidth int panel width panelHeight int panel height Terminate() Terminate the opengl context swapping buffers thread from Start(int, int). If the thread has not running, this function does nothing. public void Terminate() TouchDown(int, int, int) Tracks a new touch point in the DispEngine's touch gesture system. public void TouchDown(int touchId, int x, int y) Parameters touchId int A unique identifier for the touch point. x int The x-coordinate of the touch point in screen coordinates. y int The y-coordinate of the touch point in screen coordinates. Remarks When a touch point is added, the method: Stores the touch point in the internal tracking dictionary If this is the first touch point, simulates a mouse move and left button press TouchMove(int, int, int) Updates the position of an existing touch point. public void TouchMove(int touchId, int x, int y) Parameters touchId int The unique identifier of the touch point to update. x int The new x-coordinate of the touch point in screen coordinates. y int The new y-coordinate of the touch point in screen coordinates. Remarks The method handles different gestures based on the number of active touch points: Single touch: Performs panning (translation) like mouse dragging Two touches: Performs pinch-to-zoom and rotation gestures TouchUp(int) Removes a touch point from tracking when the touch is released. public void TouchUp(int touchId) Parameters touchId int The unique identifier of the touch point to remove. Remarks When a touch point is released, the method: Removes the touch point from internal tracking dictionaries If all touch points are released, simulates a mouse button release If transitioning from multi-touch to single-touch, updates the mouse position to prevent “teleportation” Translate(double, double) Translate the SketchView. Usually used by mouse drag on window. The translation is (delta_x * 2.0 / h, 0, -delta_y* 2.0 / h). Where h is window height. public void Translate(double delta_x, double delta_y) Parameters delta_x double delta x in window coordinate delta_y double delta y in window coordinate UnlockGlContext(nint) Unlock opengl context. The function is only used for native OpenGL rendering. The function unlock the opengl context for LockGlContext(). public static void UnlockGlContext(nint disp_torch_p) Parameters disp_torch_p nint Events FinishingDisp Event at the begining of FinishDisp() public static event Action FinishingDisp Event Type Action ImageRequestAfterBufferSwapped Triggered after swap buffer of gl context. public event DispEngine.ImageRequestedDelegate ImageRequestAfterBufferSwapped Event Type DispEngine.ImageRequestedDelegate" + "summary": "Class DispEngine Namespace Hi.Disp Assembly HiDisp.dll HiAPI display engine. public class DispEngine : IDisposable, IGetDispEngine Inheritance object DispEngine Implements IDisposable IGetDispEngine 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 The DispEngine is the core rendering and interaction engine for HiAPI applications. Related Documentation Using RenderingCanvas with DispEngine Building Your Own Rendering Canvas The DispEngine provides a unified API for handling rendering, user interaction, and touch gestures across different UI frameworks. Constructors DispEngine(IDisplayee) Ctor. The SetViewToHomeView() is called in this function. public DispEngine(IDisplayee displayee) Parameters displayee IDisplayee The displayee to render. DispEngine(params IDisplayee[]) Ctor. public DispEngine(params IDisplayee[] displayees) Parameters displayees IDisplayee[] displayees to render. Fields CoreDll Core dll path. public const string CoreDll = \"core.dll\" Field Value string defaultFontFile The default font file path used by the display engine. public const string defaultFontFile = \"Font/WCL06.ttf\" Field Value string Properties BackgroundColor Background color public Vec3d BackgroundColor { get; set; } Property Value Vec3d BackgroundOpacity Background opacity. Range is from 0 to 1. public double BackgroundOpacity { get; set; } Property Value double ContextProjDepth Gets the projection depth of the current context. public static double ContextProjDepth { get; } Property Value double CursorOffsetX Internal Use. public int CursorOffsetX { get; } Property Value int CursorOffsetY Internal Use. public int CursorOffsetY { get; } Property Value int CursorX Internal Use. public int CursorX { get; set; } Property Value int CursorY Internal Use. public int CursorY { get; set; } Property Value int Displayee Displayee to be rendered in the rendering loop. The SetViewToHomeView() is called in this function. public IDisplayee Displayee { get; set; } Property Value IDisplayee EnableSuppressDefaultLogo Get or Set to Enable Suppress Default Logo. The set take no effect if the license SuppressDefaultLogo is not login. public static bool EnableSuppressDefaultLogo { get; set; } Property Value bool FontFile Font file. public static string FontFile { get; set; } Property Value string IsOnDispThread Gets a value indicating whether the current thread is the display thread. public static bool IsOnDispThread { get; } Property Value bool IsVisible The anime stop running if the value is false; otherwise, the anime starts or keeps running. public bool IsVisible { get; set; } Property Value bool Model public Mat4d Model { get; set; } Property Value Mat4d Model matrix in MVP convention. This Model matrix is the first matrix in Hi.Disp.Bind.modelMatStack. PixelProj public Mat4d PixelProj { get; set; } Property Value Mat4d Pixel part of Projection matrix in MVP convention. Projection matrix = ScaleProj * PixelProj; PreCursorX Internal Use. public int PreCursorX { get; set; } Property Value int PreCursorY Internal Use. public int PreCursorY { get; set; } Property Value int PrincipleView public Mat4d PrincipleView { get; set; } Property Value Mat4d view = PrincipleView * SketchView. Where view matrix is in MVP convention. Remarks The default value is new Mat4d(new Vec3d(1, 0, 0), -Math.PI / 2). This make the 2D plane from xy plane to xz plane. The xz plane is much suit for 3D engineering display. RefreshingPeriod Image refreshing period. public TimeSpan RefreshingPeriod { get; set; } Property Value TimeSpan ScaleProj public Mat4d ScaleProj { get; set; } Property Value Mat4d Scale part of Projection matrix in MVP convention. Projection matrix = ScaleProj * PixelProj; SketchView view = PrincipleView * SketchView. Where view matrix is in MVP convention. public Mat4d SketchView { get; set; } Property Value Mat4d Methods DeleteDispContext() Deletes the current display context. public static void DeleteDispContext() 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 EnqueueDispose(IDisposable) Enqueues a disposable object to be disposed on the display thread. public static Task EnqueueDispose(IDisposable disposable) Parameters disposable IDisposable The disposable object to be disposed Returns Task A task representing the disposal operation EnqueueTask(Task) Enqueues a task to be executed on the display thread. public static Task EnqueueTask(Task task) Parameters task Task The task to be executed Returns Task The enqueued task EnqueueTask(Task) Enqueues a task to be executed on the display thread. public static Task EnqueueTask(Task task) Parameters task Task The task to be executed Returns Task The enqueued task Type Parameters T The type of the task result ~DispEngine() protected ~DispEngine() FinishDisp() Elegantly end the rendering core. Probably not essential. public static void FinishDisp() GetDispEngine() Get DispEngine. public DispEngine GetDispEngine() Returns DispEngine DispEngine Init(string) Initializes the display engine system. public static void Init(string fontFile = null) Parameters fontFile string The font file to use. If null, the default font file will be used. IsMouseButtonPressed(long) Checks if a specific mouse button is currently pressed. public bool IsMouseButtonPressed(long mouseButton) Parameters mouseButton long The mouse button to check, typically a value from the HiMouseButton enumeration. Returns bool True if the specified mouse button is pressed; otherwise, false. Remarks This method is useful for implementing conditional UI behaviors based on mouse button state: // Check if left mouse button is pressed if (dispEngine.IsMouseButtonPressed((long)HiMouseButton.Left)) { // Perform special action while left button is held down } KeyDown(long) Key down. This function is typically called in the GUI implementation for keyboard interaction. public void KeyDown(long key) Parameters key long key KeyDownTransform(long, key_table__transform_view_by_key_pressing_t) Transform SketchView by key. Home, F1, F2, F3, F4 call SetViewToHomeView(), SetViewToFrontView(), SetViewToRightView(), SetViewToTopView(), SetViewToIsometricView() respectively. PageDown and PageUp scale the SketchView. Left, Right, Down, Up translate the SketchView; Press Shift make these keys to rotate the SketchView. public void KeyDownTransform(long key, key_table__transform_view_by_key_pressing_t table) Parameters key long The key that was pressed, typically a value from the HiKey enumeration. table key_table__transform_view_by_key_pressing_t A table defining which keys trigger different transformation operations. Remarks This method is typically called from key down event handlers in the GUI implementation. KeyUp(long) Key up. This function is typically called in the GUI implementation for keyboard interaction. public void KeyUp(long key) Parameters key long key LockGlContext() Lock a opengl context. The function is only used for native OpenGL rendering. After lock the gl context, It should be unlock by UnlockGlContext(nint). public static nint LockGlContext() Returns nint Remarks If any other lock requires LockGlContext, the lock should better set inside LockGlContext. or it is easy to occur race condition. see design pattern of “Solid” class for reference. MouseButtonDown(long) Mouse button down. This function is typically called in the GUI implementation for mouse interaction. public void MouseButtonDown(long button) Parameters button long button MouseButtonUp(long) Mouse button up. This function is typically called in the GUI implementation for mouse interaction. public void MouseButtonUp(long button) Parameters button long button MouseDragTransform(int, int, mouse_button_table__transform_view_by_mouse_drag_t) Transform the view by mouse drag. If drag by left mouse button, Translate(double, double) is performed; If drag by right mouse button, Rotate(double, double) is performed. public void MouseDragTransform(int x, int y, mouse_button_table__transform_view_by_mouse_drag_t mouse_button_table) Parameters x int The current x-coordinate of the mouse cursor. y int The current y-coordinate of the mouse cursor. mouse_button_table mouse_button_table__transform_view_by_mouse_drag_t A table defining which mouse buttons trigger different transformation operations. Remarks The mouse_button_table__transform_view_by_mouse_drag_t structure allows you to configure which mouse buttons perform which transformations: var buttonTable = new mouse_button_table__transform_view_by_mouse_drag_t { LEFT_BUTTON = (long)HiMouseButton.Left, // For translation RIGHT_BUTTON = (long)HiMouseButton.Right // For rotation }; This method is typically called from mouse move event handlers when buttons are pressed. MouseMove(int, int) Mouse move. This function is typically called in the GUI implementation for mouse interaction. public void MouseMove(int x, int y) Parameters x int cursor X position y int cursor Y position MouseWheel(int, int) Mouse wheel move. This function is typically called in the GUI implementation for mouse interaction. public void MouseWheel(int deltaX, int deltaY) Parameters deltaX int mouse wheel delta X deltaY int mouse wheel delta Y. The traditional mouse wheel. MouseWheelTransform(int, int, double) Scale SketchView by mouse wheel. public void MouseWheelTransform(int deltaX, int deltaY, double zooming_ratio = 0.2) Parameters deltaX int mouse wheel delta X deltaY int mouse wheel delta Y. The traditional mouse wheel. zooming_ratio double The ratio used for zooming. Default is 0.2. Resize(int, int) Resize the opengl context. public void Resize(int w, int h) Parameters w int width of the viewport h int height of the viewport Rotate(double, double) Rotate the SketchView. Usually used by mouse drag on window. The rotation axis is along (delta_y, 0, delta_x). The rotation rad is 5 * Math.Sqrt(delta_y * delta_y + delta_x * delta_x) / window_height. public void Rotate(double delta_x, double delta_y) Parameters delta_x double delta x in window coordinate delta_y double delta y in window coordinate RotateAndScaleByTouchPad(Vec2d, Vec2d, Vec2d, Vec2d) Rotate and scale the SketchView based on touch pad gestures. public void RotateAndScaleByTouchPad(Vec2d prePosA, Vec2d curPosA, Vec2d prePosB, Vec2d curPosB) Parameters prePosA Vec2d The previous position of the first touch point. curPosA Vec2d The current position of the first touch point. prePosB Vec2d The previous position of the second touch point. curPosB Vec2d The current position of the second touch point. Remarks The method detects two types of gestures: Pinch gesture: When the distance between touch points changes, it triggers zooming via MouseWheelTransform(int, int, double) Rotation/Pan gesture: When touch points move together, it triggers rotation via Rotate(double, double) This method is typically used to implement touchpad or multi-touch gestures in custom UI implementations. RotateWithoutHeightAdjustment(double, double) Rotate the SketchView. Usually used by keyboard command. The rotation axis is along (delta_y, 0, delta_x). The rotation rad is Math.ToRad(Math.Sqrt(delta_y * delta_y + delta_x * delta_x)). public void RotateWithoutHeightAdjustment(double delta_x, double delta_y) Parameters delta_x double delta x in window coordinate delta_y double delta y in window coordinate SetViewToFrontView() Set the SketchView to front view. public void SetViewToFrontView() SetViewToHomeView() Set the SketchView to home view(front view). This is the same as SetViewToFrontView(). public void SetViewToHomeView() SetViewToIsometricView() Set the SketchView to isometric view. public void SetViewToIsometricView() SetViewToRightView() Set the SketchView to side view. public void SetViewToRightView() SetViewToTopView() Set the SketchView to top view. public void SetViewToTopView() Snapshot(string) Snapshot to BMP file with current canvas size. public void Snapshot(string filePath) Parameters filePath string Snapshot(string, int, int) Snapshot to BMP file. public void Snapshot(string filePath, int panelWidth, int panelHeight) Parameters filePath string panelWidth int panelHeight int Start(int, int) Start a thread of keeping Swapping buffers of OpenGL context. If the thread has running, this function does nothing. public void Start(int panelWidth, int panelHeight) Parameters panelWidth int panel width panelHeight int panel height Terminate() Terminate the opengl context swapping buffers thread from Start(int, int). If the thread has not running, this function does nothing. public void Terminate() TouchDown(int, int, int) Tracks a new touch point in the DispEngine's touch gesture system. public void TouchDown(int touchId, int x, int y) Parameters touchId int A unique identifier for the touch point. x int The x-coordinate of the touch point in screen coordinates. y int The y-coordinate of the touch point in screen coordinates. Remarks When a touch point is added, the method: Stores the touch point in the internal tracking dictionary If this is the first touch point, simulates a mouse move and left button press TouchMove(int, int, int) Updates the position of an existing touch point. public void TouchMove(int touchId, int x, int y) Parameters touchId int The unique identifier of the touch point to update. x int The new x-coordinate of the touch point in screen coordinates. y int The new y-coordinate of the touch point in screen coordinates. Remarks The method handles different gestures based on the number of active touch points: Single touch: Performs panning (translation) like mouse dragging Two touches: Performs pinch-to-zoom and rotation gestures TouchUp(int) Removes a touch point from tracking when the touch is released. public void TouchUp(int touchId) Parameters touchId int The unique identifier of the touch point to remove. Remarks When a touch point is released, the method: Removes the touch point from internal tracking dictionaries If all touch points are released, simulates a mouse button release If transitioning from multi-touch to single-touch, updates the mouse position to prevent “teleportation” Translate(double, double) Translate the SketchView. Usually used by mouse drag on window. The translation is (delta_x * 2.0 / h, 0, -delta_y* 2.0 / h). Where h is window height. public void Translate(double delta_x, double delta_y) Parameters delta_x double delta x in window coordinate delta_y double delta y in window coordinate TurnBackView() public void TurnBackView() UnlockGlContext(nint) Unlock opengl context. The function is only used for native OpenGL rendering. The function unlock the opengl context for LockGlContext(). public static void UnlockGlContext(nint disp_torch_p) Parameters disp_torch_p nint Events FinishingDisp Event at the begining of FinishDisp() public static event Action FinishingDisp Event Type Action ImageRequestAfterBufferSwapped Triggered after swap buffer of gl context. public event DispEngine.ImageRequestedDelegate ImageRequestAfterBufferSwapped Event Type DispEngine.ImageRequestedDelegate" }, "api/Hi.Disp.DispEngineConfig.html": { "href": "api/Hi.Disp.DispEngineConfig.html", @@ -1067,37 +1057,37 @@ "api/Hi.Disp.DispList.html": { "href": "api/Hi.Disp.DispList.html", "title": "Class DispList | HiAPI-C# 2025", - "summary": "Class DispList Namespace Hi.Disp Assembly HiDisp.dll A combination of IDisplayee and SynList. public class DispList : SynList, IList, ICollection, IEnumerable, IEnumerable, IDisplayee, IExpandToBox3d Inheritance object SynList DispList Implements IList ICollection IEnumerable IEnumerable IDisplayee IExpandToBox3d Inherited Members SynList.Lock SynList.this[int] SynList.Count SynList.IsReadOnly SynList.Data SynList.Add(IDisplayee) SynList.Clear() SynList.Contains(IDisplayee) SynList.CopyTo(IDisplayee[], int) SynList.GetEnumerator() SynList.IndexOf(IDisplayee) SynList.Insert(int, IDisplayee) SynList.Remove(IDisplayee) SynList.RemoveAt(int) SynList.ToList() 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) StringUtil.ToDotSplitedString(IEnumerable) ListUtil.GetCeilIndex(IList, ItemKey, Func, out int) ListUtil.GetCeilIndex(IList, TKey, Func, out int) ListUtil.GetCeil(IList, TKey, Func, out Item) ListUtil.GetFloorIndex(IList, ItemKey, Func, out int) ListUtil.GetFloorIndex(IList, TKey, Func, out int) ListUtil.GetFloor(IList, TKey, Func, out Item) ListUtil.GetIndexBasedEnumerable(IList) ListUtil.GetIndexBasedEnumerable(IList, int, int) ListUtil.GetIndexByBinarySearch(IList, TItem) ListUtil.GetIndexByBinarySearch(IList, TItem, IComparer) ListUtil.GetIndexByBinarySearch(IList, TSearch, Func) ListUtil.GetNearestIndex(IList, TItemKey, Func, out int) ListUtil.GetNearestIndex(IList, TItemKey, Func, Func, out int) ListUtil.Swap(IList, int, int) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors DispList(DispList) public DispList(DispList src) Parameters src DispList DispList(params IDisplayee[]) public DispList(params IDisplayee[] displayees) Parameters displayees IDisplayee[] DispList(IEnumerable) public DispList(IEnumerable src) Parameters src IEnumerable DispList(int) public DispList(int cap = 8) Parameters cap int Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class DispList Namespace Hi.Disp Assembly HiDisp.dll A combination of IDisplayee and SynList. public class DispList : SynList, IList, ICollection, IEnumerable, IEnumerable, IDisplayee, IExpandToBox3d Inheritance object SynList DispList Implements IList ICollection IEnumerable IEnumerable IDisplayee IExpandToBox3d Inherited Members SynList.Lock SynList.this[int] SynList.Count SynList.IsReadOnly SynList.Data SynList.Add(IDisplayee) SynList.Clear() SynList.Contains(IDisplayee) SynList.CopyTo(IDisplayee[], int) SynList.GetEnumerator() SynList.IndexOf(IDisplayee) SynList.Insert(int, IDisplayee) SynList.Remove(IDisplayee) SynList.RemoveAt(int) SynList.ToList() 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) DispUtil.Display(IDisplayee, Bind, Mat4d) StringUtil.ToDotSplitedString(IEnumerable) ListUtil.GetCeilIndex(IList, ItemKey, Func, out int) ListUtil.GetCeilIndex(IList, TKey, Func, out int) ListUtil.GetCeil(IList, TKey, Func, out Item) ListUtil.GetFloorIndex(IList, ItemKey, Func, out int) ListUtil.GetFloorIndex(IList, TKey, Func, out int) ListUtil.GetFloor(IList, TKey, Func, out Item) ListUtil.GetIndexBasedEnumerable(IList) ListUtil.GetIndexBasedEnumerable(IList, int, int) ListUtil.GetIndexByBinarySearch(IList, TItem) ListUtil.GetIndexByBinarySearch(IList, TItem, IComparer) ListUtil.GetIndexByBinarySearch(IList, TSearch, Func) ListUtil.GetNearestIndex(IList, TItemKey, Func, out int) ListUtil.GetNearestIndex(IList, TItemKey, Func, Func, out int) ListUtil.Swap(IList, int, int) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors DispList(DispList) public DispList(DispList src) Parameters src DispList DispList(params IDisplayee[]) public DispList(params IDisplayee[] displayees) Parameters displayees IDisplayee[] DispList(IEnumerable) public DispList(IEnumerable src) Parameters src IEnumerable DispList(int) public DispList(int cap = 8) Parameters cap int Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.DispUtil.html": { "href": "api/Hi.Disp.DispUtil.html", "title": "Class DispUtil | HiAPI-C# 2025", - "summary": "Class DispUtil Namespace Hi.Disp Assembly HiDisp.dll Display Utility public static class DispUtil Inheritance object DispUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties GetRenderingWindowFunc Internal Use Only. public static Func GetRenderingWindowFunc { get; set; } Property Value Func Methods CallRenderingFrame(object, IDisplayee) Internal Use Only. public static object CallRenderingFrame(object key, IDisplayee displayee) Parameters key object displayee IDisplayee Returns object rendering window Remarks Note that the window may not be WPF window if using other OS. Display(Mat4d, Bind) execute bind.models.Mul(src); public static void Display(this Mat4d src, Bind bind) Parameters src Mat4d src bind Bind bind Display(nint, Bind) Display function for native object. public static void Display(nint displayeePtr, Bind bind) Parameters displayeePtr nint natvie object pointer bind Bind bind" + "summary": "Class DispUtil Namespace Hi.Disp Assembly HiDisp.dll Display Utility public static class DispUtil Inheritance object DispUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties GetRenderingWindowFunc Internal Use Only. public static Func GetRenderingWindowFunc { get; set; } Property Value Func Methods CallRenderingFrame(object, IDisplayee) Internal Use Only. public static object CallRenderingFrame(object key, IDisplayee displayee) Parameters key object displayee IDisplayee Returns object rendering window Remarks Note that the window may not be WPF window if using other OS. Display(IDisplayee, Bind, Mat4d) execute bind.models.Mul(src); public static void Display(this IDisplayee displayee, Bind bind, Mat4d mat) Parameters displayee IDisplayee bind Bind bind mat Mat4d Display(nint, Bind) Display function for native object. public static void Display(nint displayeePtr, Bind bind) Parameters displayeePtr nint natvie object pointer bind Bind bind" }, "api/Hi.Disp.Drawing.html": { "href": "api/Hi.Disp.Drawing.html", "title": "Class Drawing | HiAPI-C# 2025", - "summary": "Class Drawing Namespace Hi.Disp Assembly HiDisp.dll The most efficient elemental 3D rendering unit. public class Drawing : IDisplayee, IExpandToBox3d, IDisposable Inheritance object Drawing Implements IDisplayee IExpandToBox3d 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) Constructors Drawing(double[], Stamp, int) Construct a Drawing. public Drawing(double[] src, Stamp stamp, int glPrimitive) Parameters src double[] src stamp Stamp stamp glPrimitive int gl primitive Properties GlPrimitive OpenGL Primitive. public int GlPrimitive { get; set; } Property Value int KeyStamp The only Stamp of this public Stamp KeyStamp { get; } Property Value Stamp Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, double[], Stamp, int) Display by the given parameter. public static void Display(Bind bind, double[] src, Stamp stamp, int glPrimitive) Parameters bind Bind bind src double[] src stamp Stamp stamp glPrimitive int gl primitive Display(Bind, int) Display(Bind) with the forced gl primitive. Thread safe for Display(Bind), Display(Bind, int), ExpandToBox3d(Box3d) and Dispose(). public void Display(Bind bind, int forceGlPrimitive) Parameters bind Bind bind forceGlPrimitive int forced gl primitive Dispose() Dispose. Thread safe for Display(Bind), Display(Bind, int), ExpandToBox3d(Box3d) and Dispose(). public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool ExpandToBox3d(Box3d) Expand to Box. Thread safe for Display(Bind), Display(Bind, int), ExpandToBox3d(Box3d) and Dispose(). public void ExpandToBox3d(Box3d dst) Parameters dst Box3d ~Drawing() protected ~Drawing()" + "summary": "Class Drawing Namespace Hi.Disp Assembly HiDisp.dll The most efficient elemental 3D rendering unit. public class Drawing : IDisplayee, IExpandToBox3d, IDisposable Inheritance object Drawing Implements IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Drawing(double[], Stamp, int) Construct a Drawing. public Drawing(double[] src, Stamp stamp, int glPrimitive) Parameters src double[] src stamp Stamp stamp glPrimitive int gl primitive Properties GlPrimitive OpenGL Primitive. public int GlPrimitive { get; set; } Property Value int KeyStamp The only Stamp of this public Stamp KeyStamp { get; } Property Value Stamp Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, double[], Stamp, int) Display by the given parameter. public static void Display(Bind bind, double[] src, Stamp stamp, int glPrimitive) Parameters bind Bind bind src double[] src stamp Stamp stamp glPrimitive int gl primitive Display(Bind, int) Display(Bind) with the forced gl primitive. Thread safe for Display(Bind), Display(Bind, int), ExpandToBox3d(Box3d) and Dispose(). public void Display(Bind bind, int forceGlPrimitive) Parameters bind Bind bind forceGlPrimitive int forced gl primitive Dispose() Dispose. Thread safe for Display(Bind), Display(Bind, int), ExpandToBox3d(Box3d) and Dispose(). public void Dispose() Dispose(bool) protected virtual void Dispose(bool disposing) Parameters disposing bool ExpandToBox3d(Box3d) Expand to Box. Thread safe for Display(Bind), Display(Bind, int), ExpandToBox3d(Box3d) and Dispose(). public void ExpandToBox3d(Box3d dst) Parameters dst Box3d ~Drawing() protected ~Drawing()" }, "api/Hi.Disp.Flag.ColorScaleBar.html": { "href": "api/Hi.Disp.Flag.ColorScaleBar.html", "title": "Class ColorScaleBar | HiAPI-C# 2025", - "summary": "Class ColorScaleBar Namespace Hi.Disp.Flag Assembly HiDisp.dll ColorScaleBar. For Covering mode. public class ColorScaleBar : IDisplayee, IExpandToBox3d Inheritance object ColorScaleBar Implements IDisplayee IExpandToBox3d 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) Constructors ColorScaleBar(double, double, Func, string, string) Initializes a new instance of the ColorScaleBar class. public ColorScaleBar(double floor, double ceiling, Func rgbFunc, string tag, string unit) Parameters floor double The minimum value for the color scale. ceiling double The maximum value for the color scale. rgbFunc Func The function that converts a value to an RGB color. tag string The tag text for the color scale bar. unit string The unit text for the color scale values. Properties Ceiling Gets or sets the maximum value for the color scale. public double Ceiling { get; set; } Property Value double Floor Gets or sets the minimum value for the color scale. public double Floor { get; set; } Property Value double LengthW Gets the width length of the color scale bar. public static int LengthW { get; } Property Value int OffsetH Gets the vertical offset of the color scale bar. public static double OffsetH { get; } Property Value double OffsetW Gets the horizontal offset of the color scale bar. public static double OffsetW { get; } Property Value double RgbFunc Gets or sets the function that converts a value to an RGB color. public Func RgbFunc { get; set; } Property Value Func Tag Gets or sets the tag text for the color scale bar. public string Tag { get; set; } Property Value string Unit Gets or sets the unit text for the color scale values. public string Unit { get; set; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, double, double, Func, string, string) Displays the color scale bar on the specified binding context. public static void Display(Bind bind, double floor, double ceiling, Func rgbFunc, string tag, string unit) Parameters bind Bind The binding context to display on. floor double The minimum value for the color scale. ceiling double The maximum value for the color scale. rgbFunc Func The function that converts a value to an RGB color. tag string The tag text for the color scale bar. unit string The unit text for the color scale values. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class ColorScaleBar Namespace Hi.Disp.Flag Assembly HiDisp.dll ColorScaleBar. For Covering mode. public class ColorScaleBar : IDisplayee, IExpandToBox3d Inheritance object ColorScaleBar Implements IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ColorScaleBar(double, double, Func, string, string) Initializes a new instance of the ColorScaleBar class. public ColorScaleBar(double floor, double ceiling, Func rgbFunc, string tag, string unit) Parameters floor double The minimum value for the color scale. ceiling double The maximum value for the color scale. rgbFunc Func The function that converts a value to an RGB color. tag string The tag text for the color scale bar. unit string The unit text for the color scale values. Properties Ceiling Gets or sets the maximum value for the color scale. public double Ceiling { get; set; } Property Value double Floor Gets or sets the minimum value for the color scale. public double Floor { get; set; } Property Value double LengthW Gets the width length of the color scale bar. public static int LengthW { get; } Property Value int OffsetH Gets the vertical offset of the color scale bar. public static double OffsetH { get; } Property Value double OffsetW Gets the horizontal offset of the color scale bar. public static double OffsetW { get; } Property Value double RgbFunc Gets or sets the function that converts a value to an RGB color. public Func RgbFunc { get; set; } Property Value Func Tag Gets or sets the tag text for the color scale bar. public string Tag { get; set; } Property Value string Unit Gets or sets the unit text for the color scale values. public string Unit { get; set; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, double, double, Func, string, string) Displays the color scale bar on the specified binding context. public static void Display(Bind bind, double floor, double ceiling, Func rgbFunc, string tag, string unit) Parameters bind Bind The binding context to display on. floor double The minimum value for the color scale. ceiling double The maximum value for the color scale. rgbFunc Func The function that converts a value to an RGB color. tag string The tag text for the color scale bar. unit string The unit text for the color scale values. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.Flag.CoordinateDrawing.html": { "href": "api/Hi.Disp.Flag.CoordinateDrawing.html", "title": "Class CoordinateDrawing | HiAPI-C# 2025", - "summary": "Class CoordinateDrawing Namespace Hi.Disp.Flag Assembly HiDisp.dll Draw a Cartesian Coordinate. public class CoordinateDrawing : IDisplayee, IExpandToBox3d, IDisposable, IMakeXmlSource Inheritance object CoordinateDrawing Implements IDisplayee IExpandToBox3d IDisposable IMakeXmlSource 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) Constructors CoordinateDrawing() Ctor. public CoordinateDrawing() CoordinateDrawing(string) Ctor with setter of TextAtOrigin. public CoordinateDrawing(string textAtOrigin) Parameters textAtOrigin string text at origin CoordinateDrawing(XElement) Ctor. public CoordinateDrawing(XElement src) Parameters src XElement XML Properties DimensionInPixels public double DimensionInPixels { get; set; } Property Value double Edge length in pixels. HslOffset public static Vec3d HslOffset { get; set; } Property Value Vec3d HSL offset for coloring this. TextAtOrigin public string TextAtOrigin { get; set; } Property Value string Text displays at the origin of this coordinate. XName Name for XML IO. public static string XName { get; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, string) Displays a coordinate drawing with the specified binding context and tag. public static void Display(Bind bind, string tag) Parameters bind Bind The binding context to display on. tag string The tag text to display at the origin. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CoordinateDrawing Namespace Hi.Disp.Flag Assembly HiDisp.dll Draw a Cartesian Coordinate. public class CoordinateDrawing : IDisplayee, IExpandToBox3d, IDisposable, IMakeXmlSource Inheritance object CoordinateDrawing Implements IDisplayee IExpandToBox3d IDisposable IMakeXmlSource 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CoordinateDrawing() Ctor. public CoordinateDrawing() CoordinateDrawing(string) Ctor with setter of TextAtOrigin. public CoordinateDrawing(string textAtOrigin) Parameters textAtOrigin string text at origin CoordinateDrawing(XElement) Ctor. public CoordinateDrawing(XElement src) Parameters src XElement XML Properties DimensionInPixels public double DimensionInPixels { get; set; } Property Value double Edge length in pixels. HslOffset public static Vec3d HslOffset { get; set; } Property Value Vec3d HSL offset for coloring this. TextAtOrigin public string TextAtOrigin { get; set; } Property Value string Text displays at the origin of this coordinate. XName Name for XML IO. public static string XName { get; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, string) Displays a coordinate drawing with the specified binding context and tag. public static void Display(Bind bind, string tag) Parameters bind Bind The binding context to display on. tag string The tag text to display at the origin. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box 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." }, "api/Hi.Disp.Flag.CubicalFlagDrawing.html": { "href": "api/Hi.Disp.Flag.CubicalFlagDrawing.html", "title": "Class CubicalFlagDrawing | HiAPI-C# 2025", - "summary": "Class CubicalFlagDrawing Namespace Hi.Disp.Flag Assembly HiDisp.dll A drawing class for cubical flag visualization. public class CubicalFlagDrawing : IDisplayee, IExpandToBox3d Inheritance object CubicalFlagDrawing Implements IDisplayee IExpandToBox3d 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) Constructors CubicalFlagDrawing(double) Initializes a new instance of the CubicalFlagDrawing class. public CubicalFlagDrawing(double planDim = 16) Parameters planDim double The dimension of the plan. Fields planDim Gets or sets the dimension of the plan. public double planDim Field Value double Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box StaticDisplay(Bind, double) Displays the cubical flag with the specified binding context. public static void StaticDisplay(Bind bind, double planDim = 16) Parameters bind Bind The binding context to display on. planDim double The dimension of the plan." + "summary": "Class CubicalFlagDrawing Namespace Hi.Disp.Flag Assembly HiDisp.dll A drawing class for cubical flag visualization. public class CubicalFlagDrawing : IDisplayee, IExpandToBox3d Inheritance object CubicalFlagDrawing Implements IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CubicalFlagDrawing(double) Initializes a new instance of the CubicalFlagDrawing class. public CubicalFlagDrawing(double planDim = 16) Parameters planDim double The dimension of the plan. Fields planDim Gets or sets the dimension of the plan. public double planDim Field Value double Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box StaticDisplay(Bind, double) Displays the cubical flag with the specified binding context. public static void StaticDisplay(Bind bind, double planDim = 16) Parameters bind Bind The binding context to display on. planDim double The dimension of the plan." }, "api/Hi.Disp.Flag.DimensionBar.html": { "href": "api/Hi.Disp.Flag.DimensionBar.html", "title": "Class DimensionBar | HiAPI-C# 2025", - "summary": "Class DimensionBar Namespace Hi.Disp.Flag Assembly HiDisp.dll DimensionBar. For Covering mode. public class DimensionBar : IDisplayee, IExpandToBox3d Inheritance object DimensionBar Implements IDisplayee IExpandToBox3d 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) Properties OffsetH Gets the vertical offset of the dimension bar. public static double OffsetH { get; } Property Value double Unit Gets or sets the unit of measurement to display. public string Unit { get; set; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, string) Displays the dimension bar on the specified binding context. public static void Display(Bind bind, string unit) Parameters bind Bind The binding context to display on. unit string The unit of measurement to display. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class DimensionBar Namespace Hi.Disp.Flag Assembly HiDisp.dll DimensionBar. For Covering mode. public class DimensionBar : IDisplayee, IExpandToBox3d Inheritance object DimensionBar Implements IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties OffsetH Gets the vertical offset of the dimension bar. public static double OffsetH { get; } Property Value double Unit Gets or sets the unit of measurement to display. public string Unit { get; set; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, string) Displays the dimension bar on the specified binding context. public static void Display(Bind bind, string unit) Parameters bind Bind The binding context to display on. unit string The unit of measurement to display. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.Flag.DispCoverUtil.html": { "href": "api/Hi.Disp.Flag.DispCoverUtil.html", @@ -1109,6 +1099,11 @@ "title": "Namespace Hi.Disp.Flag | HiAPI-C# 2025", "summary": "Namespace Hi.Disp.Flag Classes ColorScaleBar ColorScaleBar. For Covering mode. CoordinateDrawing Draw a Cartesian Coordinate. CubicalFlagDrawing A drawing class for cubical flag visualization. DimensionBar DimensionBar. For Covering mode. DispCoverUtil Utility class for display covering functionality." }, + "api/Hi.Disp.FuncDisplayee.html": { + "href": "api/Hi.Disp.FuncDisplayee.html", + "title": "Class FuncDisplayee | HiAPI-C# 2025", + "summary": "Class FuncDisplayee Namespace Hi.Disp Assembly HiDisp.dll A displayee implementation that delegates display functionality to function delegates. public class FuncDisplayee : IDisplayee, IExpandToBox3d Inheritance object FuncDisplayee Implements IDisplayee IExpandToBox3d 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) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors FuncDisplayee() Initializes a new instance of the FuncDisplayee class. public FuncDisplayee() FuncDisplayee(Action, Action) Initializes a new instance of the FuncDisplayee class with display and expand delegates. public FuncDisplayee(Action displayDelegate, Action expandToBox3dDelegate) Parameters displayDelegate Action The delegate for the Display method. expandToBox3dDelegate Action The delegate for the ExpandToBox3d method. Properties DisplayDelegate Gets or sets the delegate for the Display method. public Action DisplayDelegate { get; set; } Property Value Action ExpandToBox3dDelegate Gets or sets the delegate for the ExpandToBox3d method. public Action ExpandToBox3dDelegate { get; set; } Property Value Action Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + }, "api/Hi.Disp.GL.html": { "href": "api/Hi.Disp.GL.html", "title": "Class GL | HiAPI-C# 2025", @@ -1117,28 +1112,23 @@ "api/Hi.Disp.IDisplayee.html": { "href": "api/Hi.Disp.IDisplayee.html", "title": "Interface IDisplayee | HiAPI-C# 2025", - "summary": "Interface IDisplayee Namespace Hi.Disp Assembly HiDisp.dll An object which can be displayed in DispEngine. public interface IDisplayee : IExpandToBox3d Inherited Members IExpandToBox3d.ExpandToBox3d(Box3d) 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) Methods Display(Bind) Display function called in DispEngine rendering loop. void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind." + "summary": "Interface IDisplayee Namespace Hi.Disp Assembly HiDisp.dll An object which can be displayed in DispEngine. public interface IDisplayee : IExpandToBox3d Inherited Members IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) DispUtil.Display(IDisplayee, Bind, Mat4d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods Display(Bind) Display function called in DispEngine rendering loop. void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind." }, "api/Hi.Disp.IGetDispEngine.html": { "href": "api/Hi.Disp.IGetDispEngine.html", "title": "Interface IGetDispEngine | HiAPI-C# 2025", "summary": "Interface IGetDispEngine Namespace Hi.Disp Assembly HiDisp.dll Interface fo getting DispEngine. public interface IGetDispEngine 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) Methods GetDispEngine() Get DispEngine. DispEngine GetDispEngine() Returns DispEngine DispEngine" }, + "api/Hi.Disp.IGetPickable.html": { + "href": "api/Hi.Disp.IGetPickable.html", + "title": "Interface IGetPickable | HiAPI-C# 2025", + "summary": "Interface IGetPickable Namespace Hi.Disp Assembly HiDisp.dll Get Pickable interface. public interface IGetPickable 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) Methods GetPickable() Get Pickable Pickable GetPickable() Returns Pickable pickable" + }, "api/Hi.Disp.IGlContextDirver.html": { "href": "api/Hi.Disp.IGlContextDirver.html", "title": "Interface IGlContextDirver | HiAPI-C# 2025", "summary": "Interface IGlContextDirver Namespace Hi.Disp Assembly HiDisp.dll Bridge of Native OpenGL Context. public interface IGlContextDirver : IDisposable Inherited Members IDisposable.Dispose() 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) Methods FreeCurrent() OpenGL context free current. void FreeCurrent() MakeCurrent() OpenGL context make current. void MakeCurrent() Resize(double, double) Resize the opengl context. void Resize(double width, double height) Parameters width double viewport width height double viewport height SwapBuffers() OpenGL context swap buffers. void SwapBuffers()" }, - "api/Hi.Disp.IPickableGetter.html": { - "href": "api/Hi.Disp.IPickableGetter.html", - "title": "Interface IPickableGetter | HiAPI-C# 2025", - "summary": "Interface IPickableGetter Namespace Hi.Disp Assembly HiDisp.dll Get Pickable interface. public interface IPickableGetter 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) Methods GetPickable() Get Pickable Pickable GetPickable() Returns Pickable pickable" - }, - "api/Hi.Disp.ITopoDisplayee.html": { - "href": "api/Hi.Disp.ITopoDisplayee.html", - "title": "Interface ITopoDisplayee | HiAPI-C# 2025", - "summary": "Interface ITopoDisplayee Namespace Hi.Disp Assembly HiMech.dll Defines an interface for displaying topological elements that combines assembly, anchoring, and display capabilities. public interface ITopoDisplayee : IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList Inherited Members IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object)" - }, "api/Hi.Disp.MatStack.ItemDisposable.html": { "href": "api/Hi.Disp.MatStack.ItemDisposable.html", "title": "Class MatStack.ItemDisposable | HiAPI-C# 2025", @@ -1157,27 +1147,27 @@ "api/Hi.Disp.Pickable.html": { "href": "api/Hi.Disp.Pickable.html", "title": "Class Pickable | HiAPI-C# 2025", - "summary": "Class Pickable Namespace Hi.Disp Assembly HiDisp.dll Picking event handler for rendering. Note that it has to be disposed manually or the object occurs memory leak. public class Pickable : IPickableGetter, IDisposable Inheritance object Pickable Implements IPickableGetter IDisposable Derived CbtrPickable ShowEventPickable 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) Constructors Pickable() Ctor. public Pickable() Fields mark Internal only. protected picking_mark_t* mark Field Value picking_mark_t* Properties Pickables public static ConcurrentDictionary Pickables { get; } Property Value ConcurrentDictionary Remarks Design Concern: Substitude of ConcurrentSet. PickingID ID of picking event. public int PickingID { get; } Property Value int Methods 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 ~Pickable() protected ~Pickable() GetPickable() Get Pickable public Pickable GetPickable() Returns Pickable pickable OnKeyDown(key_event_t, panel_state_t) Behavior on key down. public virtual void OnKeyDown(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnKeyUp(key_event_t, panel_state_t) Behavior on key up public virtual void OnKeyUp(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnMouseDown(mouse_button_event_t, panel_state_t) Behavior on mouse down public virtual void OnMouseDown(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public virtual void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public virtual void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseMove(mouse_move_event_t, panel_state_t) Behavior on mouse move public virtual void OnMouseMove(mouse_move_event_t e, panel_state_t state) Parameters e mouse_move_event_t event state panel_state_t panel state OnMouseUp(mouse_button_event_t, panel_state_t) Behavior on mouse up public virtual void OnMouseUp(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseWheel(mouse_wheel_event_t, panel_state_t) Behavior on mouse wheel public virtual void OnMouseWheel(mouse_wheel_event_t e, panel_state_t state) Parameters e mouse_wheel_event_t event state panel_state_t panel state" + "summary": "Class Pickable Namespace Hi.Disp Assembly HiDisp.dll Picking event handler for rendering. Note that it has to be disposed manually or the object occurs memory leak. public class Pickable : IGetPickable, IDisposable Inheritance object Pickable Implements IGetPickable IDisposable Derived CbtrPickable ShowEventPickable 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) Constructors Pickable() Ctor. public Pickable() Fields mark Internal only. protected picking_mark_t* mark Field Value picking_mark_t* Properties Pickables public static ConcurrentDictionary Pickables { get; } Property Value ConcurrentDictionary Remarks Design Concern: Substitude of ConcurrentSet. PickingID ID of picking event. public int PickingID { get; } Property Value int Methods 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 ~Pickable() protected ~Pickable() GetPickable() Get Pickable public Pickable GetPickable() Returns Pickable pickable OnKeyDown(key_event_t, panel_state_t) Behavior on key down. public virtual void OnKeyDown(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnKeyUp(key_event_t, panel_state_t) Behavior on key up public virtual void OnKeyUp(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnMouseDown(mouse_button_event_t, panel_state_t) Behavior on mouse down public virtual void OnMouseDown(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public virtual void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public virtual void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseMove(mouse_move_event_t, panel_state_t) Behavior on mouse move public virtual void OnMouseMove(mouse_move_event_t e, panel_state_t state) Parameters e mouse_move_event_t event state panel_state_t panel state OnMouseUp(mouse_button_event_t, panel_state_t) Behavior on mouse up public virtual void OnMouseUp(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseWheel(mouse_wheel_event_t, panel_state_t) Behavior on mouse wheel public virtual void OnMouseWheel(mouse_wheel_event_t e, panel_state_t state) Parameters e mouse_wheel_event_t event state panel_state_t panel state" }, "api/Hi.Disp.PopModelMat.html": { "href": "api/Hi.Disp.PopModelMat.html", "title": "Class PopModelMat | HiAPI-C# 2025", - "summary": "Class PopModelMat Namespace Hi.Disp Assembly HiDisp.dll Call Pop() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PushModelMat. public class PopModelMat : IDisplayee, IExpandToBox3d Inheritance object PopModelMat Implements IDisplayee IExpandToBox3d 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) Constructors PopModelMat() Initializes a new instance of the PopModelMat class. public PopModelMat() Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class PopModelMat Namespace Hi.Disp Assembly HiDisp.dll Call Pop() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PushModelMat. public class PopModelMat : IDisplayee, IExpandToBox3d Inheritance object PopModelMat Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors PopModelMat() Initializes a new instance of the PopModelMat class. public PopModelMat() Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.PushModelMat.html": { "href": "api/Hi.Disp.PushModelMat.html", "title": "Class PushModelMat | HiAPI-C# 2025", - "summary": "Class PushModelMat Namespace Hi.Disp Assembly HiDisp.dll Call Push() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PopModelMat. public class PushModelMat : IDisplayee, IExpandToBox3d Inheritance object PushModelMat Implements IDisplayee IExpandToBox3d 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) Constructors PushModelMat() Initializes a new instance of the PushModelMat class. public PushModelMat() Properties Mat Pushed matrix. public Mat4d Mat { get; set; } Property Value Mat4d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class PushModelMat Namespace Hi.Disp Assembly HiDisp.dll Call Push() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PopModelMat. public class PushModelMat : IDisplayee, IExpandToBox3d Inheritance object PushModelMat Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors PushModelMat() Initializes a new instance of the PushModelMat class. public PushModelMat() Properties Mat Pushed matrix. public Mat4d Mat { get; set; } Property Value Mat4d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, - "api/Hi.Disp.RawFuncDisplayee.html": { - "href": "api/Hi.Disp.RawFuncDisplayee.html", - "title": "Class RawFuncDisplayee | HiAPI-C# 2025", - "summary": "Class RawFuncDisplayee Namespace Hi.Disp Assembly HiDisp.dll A displayee implementation that delegates display functionality to function delegates. public class RawFuncDisplayee : IDisplayee, IExpandToBox3d Inheritance object RawFuncDisplayee Implements IDisplayee IExpandToBox3d 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) Constructors RawFuncDisplayee() Initializes a new instance of the RawFuncDisplayee class. public RawFuncDisplayee() RawFuncDisplayee(Action, Action) Initializes a new instance of the RawFuncDisplayee class with display and expand delegates. public RawFuncDisplayee(Action displayDelegate, Action expandToBox3dDelegate) Parameters displayDelegate Action The delegate for the Display method. expandToBox3dDelegate Action The delegate for the ExpandToBox3d method. Properties DisplayDelegate Gets or sets the delegate for the Display method. public Action DisplayDelegate { get; set; } Property Value Action ExpandToBox3dDelegate Gets or sets the delegate for the ExpandToBox3d method. public Action ExpandToBox3dDelegate { get; set; } Property Value Action Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "api/Hi.Disp.Segment3dDispUtil.html": { + "href": "api/Hi.Disp.Segment3dDispUtil.html", + "title": "Class Segment3dDispUtil | HiAPI-C# 2025", + "summary": "Class Segment3dDispUtil Namespace Hi.Disp Assembly HiDisp.dll public static class Segment3dDispUtil Inheritance object Segment3dDispUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ToDrawing(IEnumerable) public static Drawing ToDrawing(this IEnumerable segments) Parameters segments IEnumerable Returns Drawing" }, "api/Hi.Disp.ShowEventPickable.html": { "href": "api/Hi.Disp.ShowEventPickable.html", "title": "Class ShowEventPickable | HiAPI-C# 2025", - "summary": "Class ShowEventPickable Namespace Hi.Disp Assembly HiDisp.dll Show pick events in console. public class ShowEventPickable : Pickable, IPickableGetter, IDisposable Inheritance object Pickable ShowEventPickable Implements IPickableGetter IDisposable Inherited Members Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.Dispose(bool) Pickable.Dispose() 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) Constructors ShowEventPickable() ctor. public ShowEventPickable() Properties Tag Tag shows in pick events. public object Tag { get; set; } Property Value object Methods OnKeyDown(key_event_t, panel_state_t) Behavior on key down. public override void OnKeyDown(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnKeyUp(key_event_t, panel_state_t) Behavior on key up public override void OnKeyUp(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnMouseDown(mouse_button_event_t, panel_state_t) Behavior on mouse down public override void OnMouseDown(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseMove(mouse_move_event_t, panel_state_t) Behavior on mouse move public override void OnMouseMove(mouse_move_event_t e, panel_state_t state) Parameters e mouse_move_event_t event state panel_state_t panel state OnMouseUp(mouse_button_event_t, panel_state_t) Behavior on mouse up public override void OnMouseUp(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseWheel(mouse_wheel_event_t, panel_state_t) Behavior on mouse wheel public override void OnMouseWheel(mouse_wheel_event_t e, panel_state_t state) Parameters e mouse_wheel_event_t event state panel_state_t panel state" + "summary": "Class ShowEventPickable Namespace Hi.Disp Assembly HiDisp.dll Show pick events in console. public class ShowEventPickable : Pickable, IGetPickable, IDisposable Inheritance object Pickable ShowEventPickable Implements IGetPickable IDisposable Inherited Members Pickable.Pickables Pickable.mark Pickable.PickingID Pickable.GetPickable() Pickable.Dispose(bool) Pickable.Dispose() 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) Constructors ShowEventPickable() ctor. public ShowEventPickable() Properties Tag Tag shows in pick events. public object Tag { get; set; } Property Value object Methods OnKeyDown(key_event_t, panel_state_t) Behavior on key down. public override void OnKeyDown(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnKeyUp(key_event_t, panel_state_t) Behavior on key up public override void OnKeyUp(key_event_t e, panel_state_t state) Parameters e key_event_t event state panel_state_t panel state OnMouseDown(mouse_button_event_t, panel_state_t) Behavior on mouse down public override void OnMouseDown(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseEnter(ui_event_type, panel_state_t) Behavior on mouse enter public override void OnMouseEnter(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseLeave(ui_event_type, panel_state_t) Behavior on mouse leave public override void OnMouseLeave(ui_event_type e, panel_state_t state) Parameters e ui_event_type event type state panel_state_t panel state OnMouseMove(mouse_move_event_t, panel_state_t) Behavior on mouse move public override void OnMouseMove(mouse_move_event_t e, panel_state_t state) Parameters e mouse_move_event_t event state panel_state_t panel state OnMouseUp(mouse_button_event_t, panel_state_t) Behavior on mouse up public override void OnMouseUp(mouse_button_event_t e, panel_state_t state) Parameters e mouse_button_event_t event state panel_state_t panel state OnMouseWheel(mouse_wheel_event_t, panel_state_t) Behavior on mouse wheel public override void OnMouseWheel(mouse_wheel_event_t e, panel_state_t state) Parameters e mouse_wheel_event_t event state panel_state_t panel state" }, "api/Hi.Disp.Stamp.html": { "href": "api/Hi.Disp.Stamp.html", @@ -1187,17 +1177,7 @@ "api/Hi.Disp.StringDrawing.html": { "href": "api/Hi.Disp.StringDrawing.html", "title": "Class StringDrawing | HiAPI-C# 2025", - "summary": "Class StringDrawing Namespace Hi.Disp Assembly HiDisp.dll An IDisplayee to draw string. public class StringDrawing : IDisplayee, IExpandToBox3d, IDisposable Inheritance object StringDrawing Implements IDisplayee IExpandToBox3d 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) Constructors StringDrawing(string) Constructor. public StringDrawing(string text) Parameters text string text Fields text Text to draw. public readonly string text Field Value string Properties Height Gets the height of the string drawing in pixels. public int Height { get; } Property Value int IsAlwaysOnTop Is text always on top. public bool IsAlwaysOnTop { get; set; } Property Value bool Width Gets the width of the string drawing in pixels. public int Width { get; } Property Value int Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, Vec3d, bool) Display at p. public void Display(Bind bind, Vec3d p, bool isAlwaysOnTop = false) Parameters bind Bind bind p Vec3d position isAlwaysOnTop bool is always on top Display(Bind, string, Vec3d, bool) Display text at p. public static void Display(Bind bind, string text, Vec3d p = null, bool isAlwaysOnTop = false) Parameters bind Bind bind text string text p Vec3d position isAlwaysOnTop bool is always on top 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~StringDrawing() protected ~StringDrawing()" - }, - "api/Hi.Disp.TopoDisplayee.html": { - "href": "api/Hi.Disp.TopoDisplayee.html", - "title": "Class TopoDisplayee | HiAPI-C# 2025", - "summary": "Class TopoDisplayee Namespace Hi.Disp Assembly HiMech.dll Implements a displayable topological element that manages a collection of anchored displayees within an assembly. public class TopoDisplayee : ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList Inheritance object TopoDisplayee Implements ITopoDisplayee IGetAsmb IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IGetAnchoredDisplayeeList Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) 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) Constructors TopoDisplayee(Anchor, Asmb, params IAnchoredDisplayee[]) Initializes a new instance of the TopoDisplayee class with the specified root anchor, assembly, and displayees. public TopoDisplayee(Anchor rootAnchor, Asmb asmb, params IAnchoredDisplayee[] displayees) Parameters rootAnchor Anchor The root anchor for the topological displayee. asmb Asmb The assembly associated with the topological displayee. displayees IAnchoredDisplayee[] The array of anchored displayees to be managed. Properties AnchoredDisplayeeList Gets or sets the list of anchored displayees managed by this instance. public List AnchoredDisplayeeList { get; set; } Property Value List Asmb Gets or sets the assembly associated with this topological displayee. public Asmb Asmb { get; set; } Property Value Asmb RootAnchor Gets or sets the root anchor for this topological displayee. public Anchor RootAnchor { get; set; } Property Value Anchor Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor." - }, - "api/Hi.Disp.TopoDisplayeeUtil.html": { - "href": "api/Hi.Disp.TopoDisplayeeUtil.html", - "title": "Class TopoDisplayeeUtil | HiAPI-C# 2025", - "summary": "Class TopoDisplayeeUtil Namespace Hi.Disp Assembly HiMech.dll Provides utility methods for displaying and manipulating topological displayees. public static class TopoDisplayeeUtil Inheritance object TopoDisplayeeUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Display(ITopoDisplayee, Bind) Displays the topological displayee using the specified bind context. public static void Display(this ITopoDisplayee src, Bind bind) Parameters src ITopoDisplayee The topological displayee to display. bind Bind The bind context used for displaying. ExpandToBox3d(ITopoDisplayee, Box3d) Expands the bounding box to include the topological displayee's geometry. public static void ExpandToBox3d(this ITopoDisplayee src, Box3d dst) Parameters src ITopoDisplayee The topological displayee whose geometry should be included. dst Box3d The bounding box to expand." + "summary": "Class StringDrawing Namespace Hi.Disp Assembly HiDisp.dll An IDisplayee to draw string. public class StringDrawing : IDisplayee, IExpandToBox3d, IDisposable Inheritance object StringDrawing Implements IDisplayee IExpandToBox3d IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors StringDrawing(string) Constructor. public StringDrawing(string text) Parameters text string text Fields text Text to draw. public readonly string text Field Value string Properties Height Gets the height of the string drawing in pixels. public int Height { get; } Property Value int IsAlwaysOnTop Is text always on top. public bool IsAlwaysOnTop { get; set; } Property Value bool Width Gets the width of the string drawing in pixels. public int Width { get; } Property Value int Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, Vec3d, bool) Display at p. public void Display(Bind bind, Vec3d p, bool isAlwaysOnTop = false) Parameters bind Bind bind p Vec3d position isAlwaysOnTop bool is always on top Display(Bind, string, Vec3d, bool) Display text at p. public static void Display(Bind bind, string text, Vec3d p = null, bool isAlwaysOnTop = false) Parameters bind Bind bind text string text p Vec3d position isAlwaysOnTop bool is always on top 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~StringDrawing() protected ~StringDrawing()" }, "api/Hi.Disp.Treat.LineWidthSwap.html": { "href": "api/Hi.Disp.Treat.LineWidthSwap.html", @@ -1207,7 +1187,7 @@ "api/Hi.Disp.Treat.LineWidthTreat.html": { "href": "api/Hi.Disp.Treat.LineWidthTreat.html", "title": "Class LineWidthTreat | HiAPI-C# 2025", - "summary": "Class LineWidthTreat Namespace Hi.Disp.Treat Assembly HiDisp.dll Object for set line width of opengl drawing. public class LineWidthTreat : IDisplayee, IExpandToBox3d Inheritance object LineWidthTreat Implements IDisplayee IExpandToBox3d 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) Constructors LineWidthTreat(float) Initializes a new instance of the LineWidthTreat class. public LineWidthTreat(float lineWidth) Parameters lineWidth float The line width to set. Properties LineWidth Gets or sets the line width value. public float LineWidth { get; set; } Property Value float Methods Display(Bind) Sets the line width in the OpenGL context. public void Display(Bind bind) Parameters bind Bind The binding context. ExpandToBox3d(Box3d) This implementation does nothing as line width does not affect bounding box. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The destination box to expand." + "summary": "Class LineWidthTreat Namespace Hi.Disp.Treat Assembly HiDisp.dll Object for set line width of opengl drawing. public class LineWidthTreat : IDisplayee, IExpandToBox3d Inheritance object LineWidthTreat Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors LineWidthTreat(float) Initializes a new instance of the LineWidthTreat class. public LineWidthTreat(float lineWidth) Parameters lineWidth float The line width to set. Properties LineWidth Gets or sets the line width value. public float LineWidth { get; set; } Property Value float Methods Display(Bind) Sets the line width in the OpenGL context. public void Display(Bind bind) Parameters bind Bind The binding context. ExpandToBox3d(Box3d) This implementation does nothing as line width does not affect bounding box. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The destination box to expand." }, "api/Hi.Disp.Treat.PointSizeSwap.html": { "href": "api/Hi.Disp.Treat.PointSizeSwap.html", @@ -1217,7 +1197,7 @@ "api/Hi.Disp.Treat.PointSizeTreat.html": { "href": "api/Hi.Disp.Treat.PointSizeTreat.html", "title": "Class PointSizeTreat | HiAPI-C# 2025", - "summary": "Class PointSizeTreat Namespace Hi.Disp.Treat Assembly HiDisp.dll Object for set point size of opengl drawing. public class PointSizeTreat : IDisplayee, IExpandToBox3d Inheritance object PointSizeTreat Implements IDisplayee IExpandToBox3d 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) Constructors PointSizeTreat(int) Initializes a new instance of the PointSizeTreat class. public PointSizeTreat(int pointSize) Parameters pointSize int The point size to set. Properties PointSize Gets or sets the point size value. public int PointSize { get; set; } Property Value int Methods Display(Bind) Sets the point size in the OpenGL context. public void Display(Bind bind) Parameters bind Bind The binding context. ExpandToBox3d(Box3d) This implementation does nothing as point size does not affect bounding box. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The destination box to expand." + "summary": "Class PointSizeTreat Namespace Hi.Disp.Treat Assembly HiDisp.dll Object for set point size of opengl drawing. public class PointSizeTreat : IDisplayee, IExpandToBox3d Inheritance object PointSizeTreat Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors PointSizeTreat(int) Initializes a new instance of the PointSizeTreat class. public PointSizeTreat(int pointSize) Parameters pointSize int The point size to set. Properties PointSize Gets or sets the point size value. public int PointSize { get; set; } Property Value int Methods Display(Bind) Sets the point size in the OpenGL context. public void Display(Bind bind) Parameters bind Bind The binding context. ExpandToBox3d(Box3d) This implementation does nothing as point size does not affect bounding box. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The destination box to expand." }, "api/Hi.Disp.Treat.RgbSwap.html": { "href": "api/Hi.Disp.Treat.RgbSwap.html", @@ -1227,37 +1207,37 @@ "api/Hi.Disp.Treat.RgbTreat.html": { "href": "api/Hi.Disp.Treat.RgbTreat.html", "title": "Class RgbTreat | HiAPI-C# 2025", - "summary": "Class RgbTreat Namespace Hi.Disp.Treat Assembly HiDisp.dll A displayee that sets the RGB color in the binding context. public class RgbTreat : IDisplayee, IExpandToBox3d Inheritance object RgbTreat Implements IDisplayee IExpandToBox3d 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) Constructors RgbTreat(Vec3d) Initializes a new instance of the RgbTreat class. public RgbTreat(Vec3d rgb = null) Parameters rgb Vec3d The RGB color vector to set. RgbTreat(double, double, double) Initializes a new instance of the RgbTreat class with RGB component values. public RgbTreat(double r, double g, double b) Parameters r double The red component (0.0 to 1.0). g double The green component (0.0 to 1.0). b double The blue component (0.0 to 1.0). Properties Rgb Gets or sets the RGB color vector. public Vec3d Rgb { get; set; } Property Value Vec3d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class RgbTreat Namespace Hi.Disp.Treat Assembly HiDisp.dll A displayee that sets the RGB color in the binding context. public class RgbTreat : IDisplayee, IExpandToBox3d Inheritance object RgbTreat Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors RgbTreat(Vec3d) Initializes a new instance of the RgbTreat class. public RgbTreat(Vec3d rgb = null) Parameters rgb Vec3d The RGB color vector to set. RgbTreat(double, double, double) Initializes a new instance of the RgbTreat class with RGB component values. public RgbTreat(double r, double g, double b) Parameters r double The red component (0.0 to 1.0). g double The green component (0.0 to 1.0). b double The blue component (0.0 to 1.0). Properties Rgb Gets or sets the RGB color vector. public Vec3d Rgb { get; set; } Property Value Vec3d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.Treat.RgbWrapper.html": { "href": "api/Hi.Disp.Treat.RgbWrapper.html", "title": "Class RgbWrapper | HiAPI-C# 2025", - "summary": "Class RgbWrapper Namespace Hi.Disp.Treat Assembly HiDisp.dll A wrapper displayee that applies an RGB color to the wrapped displayee. public class RgbWrapper : IDisplayee, IExpandToBox3d Inheritance object RgbWrapper Implements IDisplayee IExpandToBox3d 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) Constructors RgbWrapper() Initializes a new instance of the RgbWrapper class. public RgbWrapper() RgbWrapper(IDisplayee, Vec3d) Initializes a new instance of the RgbWrapper class with a displayee and RGB color. public RgbWrapper(IDisplayee displayee, Vec3d rgb = null) Parameters displayee IDisplayee The displayee to be wrapped. rgb Vec3d The RGB color to apply to the wrapped displayee. Properties Displayee Gets or sets the displayee to be wrapped. public IDisplayee Displayee { get; set; } Property Value IDisplayee Rgb Gets or sets the RGB color to apply to the wrapped displayee. public Vec3d Rgb { get; set; } Property Value Vec3d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class RgbWrapper Namespace Hi.Disp.Treat Assembly HiDisp.dll A wrapper displayee that applies an RGB color to the wrapped displayee. public class RgbWrapper : IDisplayee, IExpandToBox3d Inheritance object RgbWrapper Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors RgbWrapper() Initializes a new instance of the RgbWrapper class. public RgbWrapper() RgbWrapper(IDisplayee, Vec3d) Initializes a new instance of the RgbWrapper class with a displayee and RGB color. public RgbWrapper(IDisplayee displayee, Vec3d rgb = null) Parameters displayee IDisplayee The displayee to be wrapped. rgb Vec3d The RGB color to apply to the wrapped displayee. Properties Displayee Gets or sets the displayee to be wrapped. public IDisplayee Displayee { get; set; } Property Value IDisplayee Rgb Gets or sets the RGB color to apply to the wrapped displayee. public Vec3d Rgb { get; set; } Property Value Vec3d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.Treat.TransformationWrapper.html": { "href": "api/Hi.Disp.Treat.TransformationWrapper.html", "title": "Class TransformationWrapper | HiAPI-C# 2025", - "summary": "Class TransformationWrapper Namespace Hi.Disp.Treat Assembly HiDisp.dll A wrapper displayee that applies a transformation matrix to the wrapped displayees. public class TransformationWrapper : IDisplayee, IExpandToBox3d Inheritance object TransformationWrapper Implements IDisplayee IExpandToBox3d 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) Constructors TransformationWrapper(Mat4d, params IDisplayee[]) Initializes a new instance of the TransformationWrapper class. public TransformationWrapper(Mat4d mat, params IDisplayee[] displayees) Parameters mat Mat4d The transformation matrix to apply. displayees IDisplayee[] The displayees to be transformed. Properties Displayees Gets or sets the collection of displayees to be transformed. public SynList Displayees { get; set; } Property Value SynList TransformingMat Gets or sets the transformation matrix to apply to the wrapped displayees. public Mat4d TransformingMat { get; set; } Property Value Mat4d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class TransformationWrapper Namespace Hi.Disp.Treat Assembly HiDisp.dll A wrapper displayee that applies a transformation matrix to the wrapped displayees. public class TransformationWrapper : IDisplayee, IExpandToBox3d Inheritance object TransformationWrapper Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors TransformationWrapper(Mat4d, params IDisplayee[]) Initializes a new instance of the TransformationWrapper class. public TransformationWrapper(Mat4d mat, params IDisplayee[] displayees) Parameters mat Mat4d The transformation matrix to apply. displayees IDisplayee[] The displayees to be transformed. Properties Displayees Gets or sets the collection of displayees to be transformed. public SynList Displayees { get; set; } Property Value SynList TransformingMat Gets or sets the transformation matrix to apply to the wrapped displayees. public Mat4d TransformingMat { get; set; } Property Value Mat4d Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.Treat.html": { "href": "api/Hi.Disp.Treat.html", "title": "Namespace Hi.Disp.Treat | HiAPI-C# 2025", "summary": "Namespace Hi.Disp.Treat Classes LineWidthSwap A utility class for temporarily changing the line width and restoring it when disposed. LineWidthTreat Object for set line width of opengl drawing. PointSizeSwap A utility class for temporarily changing the point size and restoring it when disposed. PointSizeTreat Object for set point size of opengl drawing. RgbSwap A utility class for temporarily changing the RGB color and restoring it when disposed. RgbTreat A displayee that sets the RGB color in the binding context. RgbWrapper A wrapper displayee that applies an RGB color to the wrapped displayee. TransformationWrapper A wrapper displayee that applies a transformation matrix to the wrapped displayees." }, - "api/Hi.Disp.Tri3dUtil.html": { - "href": "api/Hi.Disp.Tri3dUtil.html", - "title": "Class Tri3dUtil | HiAPI-C# 2025", - "summary": "Class Tri3dUtil Namespace Hi.Disp Assembly HiDisp.dll Utility and Extension of Tri3d. public static class Tri3dUtil Inheritance object Tri3dUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Display(Tri3d, Bind) Display the face of src. public static void Display(this Tri3d src, Bind bind) Parameters src Tri3d triangle bind Bind Bind GetFaceDrawing(IEnumerable) Get ccw faces draw of tris. public static Drawing GetFaceDrawing(this IEnumerable tris) Parameters tris IEnumerable triangles Returns Drawing Drawing GetLineDrawing(IEnumerable) Get lines draw of the tris. public static Drawing GetLineDrawing(this IEnumerable tris) Parameters tris IEnumerable triangles Returns Drawing Drawing ToDrawing(Tri3d) Equivalent to ToDrawing_Face(Tri3d) public static Drawing ToDrawing(this Tri3d src) Parameters src Tri3d src Returns Drawing Drawing ToDrawing_Face(Tri3d) To Face Drawing. public static Drawing ToDrawing_Face(this Tri3d src) Parameters src Tri3d src Returns Drawing Face Drawing ToDrawing_Line(Tri3d) To Line Drawing. public static Drawing ToDrawing_Line(this Tri3d src) Parameters src Tri3d src Returns Drawing Line Drawing ToFaceBuf(Tri3d, double[], ref int) set n,p0,n,p1,n,p2 to double array. Where n is normal. public static int ToFaceBuf(this Tri3d src, double[] dst, ref int p) Parameters src Tri3d src dst double[] dst array p int current array position Returns int pushed double size:18 ToLineBuf(Tri3d, double[], ref int) Put lines array to the dst. The lines array contains 3 edges x 2 end points. public static int ToLineBuf(this Tri3d src, double[] dst, ref int p) Parameters src Tri3d src dst double[] dst p int position of the dst Returns int Which is pushed length, in number of double" + "api/Hi.Disp.Tri3dDispUtil.html": { + "href": "api/Hi.Disp.Tri3dDispUtil.html", + "title": "Class Tri3dDispUtil | HiAPI-C# 2025", + "summary": "Class Tri3dDispUtil Namespace Hi.Disp Assembly HiDisp.dll Utility and Extension of Tri3d. public static class Tri3dDispUtil Inheritance object Tri3dDispUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Display(Tri3d, Bind) Display the face of src. public static void Display(this Tri3d src, Bind bind) Parameters src Tri3d triangle bind Bind Bind GetFaceDrawing(IEnumerable) Get ccw faces draw of tris. public static Drawing GetFaceDrawing(this IEnumerable tris) Parameters tris IEnumerable triangles Returns Drawing Drawing GetLineDrawing(IEnumerable) Get lines draw of the tris. public static Drawing GetLineDrawing(this IEnumerable tris) Parameters tris IEnumerable triangles Returns Drawing Drawing ToDrawing(Tri3d) Equivalent to ToDrawing_Face(Tri3d) public static Drawing ToDrawing(this Tri3d src) Parameters src Tri3d src Returns Drawing Drawing ToDrawing_Face(Tri3d) To Face Drawing. public static Drawing ToDrawing_Face(this Tri3d src) Parameters src Tri3d src Returns Drawing Face Drawing ToDrawing_Line(Tri3d) To Line Drawing. public static Drawing ToDrawing_Line(this Tri3d src) Parameters src Tri3d src Returns Drawing Line Drawing ToFaceBuf(Tri3d, double[], ref int) set n,p0,n,p1,n,p2 to double array. Where n is normal. public static int ToFaceBuf(this Tri3d src, double[] dst, ref int p) Parameters src Tri3d src dst double[] dst array p int current array position Returns int pushed double size:18 ToLineBuf(Tri3d, double[], ref int) Put lines array to the dst. The lines array contains 3 edges x 2 end points. public static int ToLineBuf(this Tri3d src, double[] dst, ref int p) Parameters src Tri3d src dst double[] dst p int position of the dst Returns int Which is pushed length, in number of double" }, "api/Hi.Disp.WrappedDisplayee.html": { "href": "api/Hi.Disp.WrappedDisplayee.html", "title": "Class WrappedDisplayee | HiAPI-C# 2025", - "summary": "Class WrappedDisplayee Namespace Hi.Disp Assembly HiDisp.dll A wrapper class for IDisplayee that allows customizing display and bounding box behavior. public class WrappedDisplayee : IDisplayee, IExpandToBox3d Inheritance object WrappedDisplayee Implements IDisplayee IExpandToBox3d 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) Constructors WrappedDisplayee() Initializes a new instance of the WrappedDisplayee class. public WrappedDisplayee() WrappedDisplayee(IDisplayee, Action, Action) Initializes a new instance of the WrappedDisplayee class with specified displayee and delegates. public WrappedDisplayee(IDisplayee displayee, Action displayDelegate, Action expandToBox3dDelegate) Parameters displayee IDisplayee The displayee to wrap. displayDelegate Action The delegate for custom display behavior. expandToBox3dDelegate Action The delegate for custom bounding box expansion behavior. Properties DisplayDelegate Gets or sets the delegate for custom display behavior. public Action DisplayDelegate { get; set; } Property Value Action Displayee Gets or sets the wrapped displayee object. public IDisplayee Displayee { get; set; } Property Value IDisplayee ExpandToBox3dDelegate Gets or sets the delegate for custom bounding box expansion behavior. public Action ExpandToBox3dDelegate { get; set; } Property Value Action Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class WrappedDisplayee Namespace Hi.Disp Assembly HiDisp.dll A wrapper class for IDisplayee that allows customizing display and bounding box behavior. public class WrappedDisplayee : IDisplayee, IExpandToBox3d Inheritance object WrappedDisplayee Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors WrappedDisplayee() Initializes a new instance of the WrappedDisplayee class. public WrappedDisplayee() WrappedDisplayee(IDisplayee, Action, Action) Initializes a new instance of the WrappedDisplayee class with specified displayee and delegates. public WrappedDisplayee(IDisplayee displayee, Action displayDelegate, Action expandToBox3dDelegate) Parameters displayee IDisplayee The displayee to wrap. displayDelegate Action The delegate for custom display behavior. expandToBox3dDelegate Action The delegate for custom bounding box expansion behavior. Properties DisplayDelegate Gets or sets the delegate for custom display behavior. public Action DisplayDelegate { get; set; } Property Value Action Displayee Gets or sets the wrapped displayee object. public IDisplayee Displayee { get; set; } Property Value IDisplayee ExpandToBox3dDelegate Gets or sets the delegate for custom bounding box expansion behavior. public Action ExpandToBox3dDelegate { get; set; } Property Value Action Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Disp.html": { "href": "api/Hi.Disp.html", "title": "Namespace Hi.Disp | HiAPI-C# 2025", - "summary": "Namespace Hi.Disp Classes Bind Runtime rendering data for each iteration in rendering loop. It manipulates geometry transformation, such as moving, rotatingand scaling. It also deal with color and picking. A bind_t object is generated by rendering in the every beginning of each rendering iteration. Box3dUtil Utility and Extension of Box3d. DelegateFuncDisplayee A displayee implementation that delegates display functionality to a function. DispEngine HiAPI display engine. DispEngineConfig Configuration class for display engine. DispFrameUtil Utility class for display frame management. DispList A combination of IDisplayee and SynList. DispUtil Display Utility Drawing The most efficient elemental 3D rendering unit. GL Native opengl functions wrapper. MatStack Stack-based Matrix. MatStack.ItemDisposable A disposable class that manages push and pop operations on a matrix stack. Pickable Picking event handler for rendering. Note that it has to be disposed manually or the object occurs memory leak. PopModelMat Call Pop() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PushModelMat. PushModelMat Call Push() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PopModelMat. RawFuncDisplayee A displayee implementation that delegates display functionality to function delegates. ShowEventPickable Show pick events in console. StringDrawing An IDisplayee to draw string. TopoDisplayee Implements a displayable topological element that manages a collection of anchored displayees within an assembly. TopoDisplayeeUtil Provides utility methods for displaying and manipulating topological displayees. Tri3dUtil Utility and Extension of Tri3d. WrappedDisplayee A wrapper class for IDisplayee that allows customizing display and bounding box behavior. Interfaces IDisplayee An object which can be displayed in DispEngine. IGetDispEngine Interface fo getting DispEngine. IGlContextDirver Bridge of Native OpenGL Context. IPickableGetter Get Pickable interface. ITopoDisplayee Defines an interface for displaying topological elements that combines assembly, anchoring, and display capabilities. Enums MvpBoxRelation Relation between mvpBox and an AABB Stamp Data scope of the double array for Drawing. Delegates Box3dUtil.BoxableExpandToBox3dDel Delegate for expanding a native boxable object to a box3d. DispEngine.ImageRequestedDelegate For ImageRequestAfterBufferSwapped." + "summary": "Namespace Hi.Disp Classes Bind Runtime rendering data for each iteration in rendering loop. It manipulates geometry transformation, such as moving, rotatingand scaling. It also deal with color and picking. A bind_t object is generated by rendering in the every beginning of each rendering iteration. Box3dDispUtil Utility and Extension of Box3d. DelegateFuncDisplayee A displayee implementation that delegates display functionality to a function. DispEngine HiAPI display engine. DispEngineConfig Configuration class for display engine. DispFrameUtil Utility class for display frame management. DispList A combination of IDisplayee and SynList. DispUtil Display Utility Drawing The most efficient elemental 3D rendering unit. FuncDisplayee A displayee implementation that delegates display functionality to function delegates. GL Native opengl functions wrapper. MatStack Stack-based Matrix. MatStack.ItemDisposable A disposable class that manages push and pop operations on a matrix stack. Pickable Picking event handler for rendering. Note that it has to be disposed manually or the object occurs memory leak. PopModelMat Call Pop() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PushModelMat. PushModelMat Call Push() for Hi.Disp.Bind.modelMatStack in Display(Bind). This function is only for test purpose. Since the ExpandToBox3d(Box3d) just expand the translation part of the mat to the target box. This function should be use with PopModelMat. Segment3dDispUtil ShowEventPickable Show pick events in console. StringDrawing An IDisplayee to draw string. Tri3dDispUtil Utility and Extension of Tri3d. WrappedDisplayee A wrapper class for IDisplayee that allows customizing display and bounding box behavior. Interfaces IDisplayee An object which can be displayed in DispEngine. IGetDispEngine Interface fo getting DispEngine. IGetPickable Get Pickable interface. IGlContextDirver Bridge of Native OpenGL Context. Enums MvpBoxRelation Relation between mvpBox and an AABB Stamp Data scope of the double array for Drawing. Delegates Box3dDispUtil.BoxableExpandToBox3dDel Delegate for expanding a native boxable object to a box3d. DispEngine.ImageRequestedDelegate For ImageRequestAfterBufferSwapped." }, "api/Hi.Fanuc.FanucVarTable.html": { "href": "api/Hi.Fanuc.FanucVarTable.html", @@ -1282,7 +1262,7 @@ "api/Hi.Geom.AxisAngle4d.html": { "href": "api/Hi.Geom.AxisAngle4d.html", "title": "Class AxisAngle4d | HiAPI-C# 2025", - "summary": "Class AxisAngle4d Namespace Hi.Geom Assembly HiGeom.dll Axis(3d) and angle(1d) public class AxisAngle4d Inheritance object AxisAngle4d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors AxisAngle4d(Vec3d, double) Initializes a new instance of the AxisAngle4d class with the specified axis and angle. public AxisAngle4d(Vec3d axis, double angle_rad) Parameters axis Vec3d The rotation axis. angle_rad double The rotation angle in radians. AxisAngle4d(string) Initializes a new instance of the AxisAngle4d class from a string representation. public AxisAngle4d(string s) Parameters s string The string representation of the axis-angle in the format \"(axis,angle)\". Properties Angle_rad Angle in radian. public double Angle_rad { get; set; } Property Value double Axis Gets or sets the rotation axis. public Vec3d Axis { get; set; } Property Value Vec3d Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class AxisAngle4d Namespace Hi.Geom Assembly HiGeom.dll Axis(3d) and angle(1d) public class AxisAngle4d : IFormattable Inheritance object AxisAngle4d Implements IFormattable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors AxisAngle4d(Vec3d, double) Initializes a new instance of the AxisAngle4d class with the specified axis and angle. public AxisAngle4d(Vec3d axis, double angle_rad) Parameters axis Vec3d The rotation axis. angle_rad double The rotation angle in radians. AxisAngle4d(string) Initializes a new instance of the AxisAngle4d class from a string representation. public AxisAngle4d(string s) Parameters s string The string representation of the axis-angle in the format \"(axis,angle)\". Properties Angle_rad Angle in radian. public double Angle_rad { get; set; } Property Value double Axis Gets or sets the rotation axis. public Vec3d Axis { get; set; } Property Value Vec3d Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string, IFormatProvider) Formats the value of the current instance using the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use. -or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation. formatProvider IFormatProvider The provider to use to format the value. -or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. Returns string The value of the current instance in the specified format." }, "api/Hi.Geom.Box2d.NoInit.html": { "href": "api/Hi.Geom.Box2d.NoInit.html", @@ -1292,7 +1272,7 @@ "api/Hi.Geom.Box2d.html": { "href": "api/Hi.Geom.Box2d.html", "title": "Class Box2d | HiAPI-C# 2025", - "summary": "Class Box2d Namespace Hi.Geom Assembly HiGeom.dll Lightweight 2d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box2d is Min and Max. public class Box2d : IExpandToBox2d, IEquatable, IBinaryIo, IWriteBin Inheritance object Box2d Implements IExpandToBox2d IEquatable IBinaryIo IWriteBin Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) 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) Constructors Box2d() Ctor. public Box2d() Box2d(NoInit) Ctor. The Ctor keeps Min and Max to null. public Box2d(Box2d.NoInit noInit) Parameters noInit Box2d.NoInit Box2d(params IExpandToBox2d[]) Initializes a new instance of the Box2d class that encompasses all the specified objects. public Box2d(params IExpandToBox2d[] src) Parameters src IExpandToBox2d[] The objects to include in the box. Box2d(Vec2d, Vec2d) Ctor. public Box2d(Vec2d min, Vec2d max) Parameters min Vec2d Min max Vec2d Max Box2d(box2d) Ctor. public Box2d(box2d src) Parameters src box2d src Box2d(IEnumerable) Initializes a new instance of the Box2d class that encompasses all the objects in the specified collection. public Box2d(IEnumerable src) Parameters src IEnumerable The collection of objects to include in the box. Box2d(double, double, double, double) Initializes a new instance of the Box2d class with the specified minimum and maximum coordinates. public Box2d(double minx, double miny, double maxx, double maxy) Parameters minx double The minimum X coordinate. miny double The minimum Y coordinate. maxx double The maximum X coordinate. maxy double The maximum Y coordinate. Box2d(BinaryReader) Initializes a new instance of the Box2d class from binary data. public Box2d(BinaryReader reader) Parameters reader BinaryReader The binary reader to read the data from. Box2d(XElement) Ctor. public Box2d(XElement src) Parameters src XElement XML Properties Center Center public Vec2d Center { get; } Property Value Vec2d CenterUnitBox Generate a center unit box which min~max is (-0.5,-0.5,-0.5)~(-0.5,0.5,0.5). public static Box2d CenterUnitBox { get; } Property Value Box2d DiagonalLength Diagonal length. public double DiagonalLength { get; } Property Value double Dim Dimension. public Vec2d Dim { get; } Property Value Vec2d HasVolume Gets a value indicating whether this box has a non-zero volume. public bool HasVolume { get; } Property Value bool IsAllNaN Determines whether all coordinates of this box are NaN. public bool IsAllNaN { get; } Property Value bool IsFinite True if the box is finite. public bool IsFinite { get; } Property Value bool IsReversedPoleBox True if the box is ReversedPoleBox public bool IsReversedPoleBox { get; } Property Value bool Max Maximum point of the box. public Vec2d Max { get; set; } Property Value Vec2d Min Minimum point of the box. public Vec2d Min { get; set; } Property Value Vec2d NaN Generate a nan box which min~max is (nan,nan,nan)~(nan,nan,nan). public static Box2d NaN { get; } Property Value Box2d NativeByteSize Gets the size in bytes of the native representation of this box. public static int NativeByteSize { get; } Property Value int ReversedPoleBox Generate a reversed pole box which min~max is (∞,∞,∞)~(-∞,-∞,-∞). public static Box2d ReversedPoleBox { get; } Property Value Box2d UnitBox Generate a unit box which min~max is (0,0,0)~(1,1,1). public static Box2d UnitBox { get; } Property Value Box2d Volume Gets the volume (area) of this box. public double Volume { get; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZeroBox Generate a zero box which min~max is (0,0,0)~(0,0,0). public static Box2d ZeroBox { get; } Property Value Box2d Methods ApexAt(int) Get Apex at the box. public Vec2d ApexAt(int index) Parameters index int index 0~7. all of 8 apex. Returns Vec2d Equals(Box2d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Box2d other) Parameters other Box2d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. Expand(Box2d) Expands this box to include the specified box. public Box2d Expand(Box2d src) Parameters src Box2d The box to include. Returns Box2d This box instance after expansion. Expand(Vec2d) Expands this box to include the specified point. public Box2d Expand(Vec2d p) Parameters p Vec2d The point to include in the box. Returns Box2d This box instance after expansion. ExpandToBox2d(Box2d) Expands the specified destination box to include this box. public void ExpandToBox2d(Box2d dst) Parameters dst Box2d The destination box to expand. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. IsOverlapped(Box2d) Is the box overlapped to otherBox. public bool IsOverlapped(Box2d otherBox) Parameters otherBox Box2d other box Returns bool is overlapped MakeXmlSource(string) public XElement MakeXmlSource(string baseDirectory) Parameters baseDirectory string Returns XElement ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Scale(double) Scale the box from the coordinate origin. The operation is equal to: Min *= s; Max *= s; public Box2d Scale(double s) Parameters s double scale Returns Box2d this ScaleFromCenter(double) Scales this box from its center by the specified factor. public Box2d ScaleFromCenter(double s) Parameters s double The scale factor. Returns Box2d This box instance after scaling. Set(Box2d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box2d Set(Box2d src) Parameters src Box2d src Returns Box2d this Set(box2d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box2d Set(box2d src) Parameters src box2d src Returns Box2d this Set(double, double, double, double) Sets the minimum and maximum coordinates of this box. public Box2d Set(double minx, double miny, double maxx, double maxy) Parameters minx double The minimum X coordinate. miny double The minimum Y coordinate. maxx double The maximum X coordinate. maxy double The maximum Y coordinate. Returns Box2d This box instance. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Translate(Vec2d) Translate the box. public Box2d Translate(Vec2d vec) Parameters vec Vec2d translation vector Returns Box2d this WriteBin(BinaryWriter) Writes the box data to a binary writer. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write the data to." + "summary": "Class Box2d Namespace Hi.Geom Assembly HiGeom.dll Lightweight 2d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box2d is Min and Max. public class Box2d : IExpandToBox2d, IEquatable, IBinaryIo, IWriteBin, IFormattable Inheritance object Box2d Implements IExpandToBox2d IEquatable IBinaryIo IWriteBin IFormattable Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) 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) Constructors Box2d() Ctor. public Box2d() Box2d(NoInit) Ctor. The Ctor keeps Min and Max to null. public Box2d(Box2d.NoInit noInit) Parameters noInit Box2d.NoInit Box2d(params IExpandToBox2d[]) Initializes a new instance of the Box2d class that encompasses all the specified objects. public Box2d(params IExpandToBox2d[] src) Parameters src IExpandToBox2d[] The objects to include in the box. Box2d(Vec2d, Vec2d) Ctor. public Box2d(Vec2d min, Vec2d max) Parameters min Vec2d Min max Vec2d Max Box2d(box2d) Ctor. public Box2d(box2d src) Parameters src box2d src Box2d(IEnumerable) Initializes a new instance of the Box2d class that encompasses all the objects in the specified collection. public Box2d(IEnumerable src) Parameters src IEnumerable The collection of objects to include in the box. Box2d(double, double, double, double) Initializes a new instance of the Box2d class with the specified minimum and maximum coordinates. public Box2d(double minx, double miny, double maxx, double maxy) Parameters minx double The minimum X coordinate. miny double The minimum Y coordinate. maxx double The maximum X coordinate. maxy double The maximum Y coordinate. Box2d(BinaryReader) Initializes a new instance of the Box2d class from binary data. public Box2d(BinaryReader reader) Parameters reader BinaryReader The binary reader to read the data from. Box2d(XElement) Ctor. public Box2d(XElement src) Parameters src XElement XML Properties Center Center public Vec2d Center { get; } Property Value Vec2d CenterUnitBox Generate a center unit box which min~max is (-0.5,-0.5,-0.5)~(-0.5,0.5,0.5). public static Box2d CenterUnitBox { get; } Property Value Box2d DiagonalLength Diagonal length. public double DiagonalLength { get; } Property Value double Dim Dimension. public Vec2d Dim { get; } Property Value Vec2d HasVolume Gets a value indicating whether this box has a non-zero volume. public bool HasVolume { get; } Property Value bool IsAllNaN Determines whether all coordinates of this box are NaN. public bool IsAllNaN { get; } Property Value bool IsFinite True if the box is finite. public bool IsFinite { get; } Property Value bool IsReversedPoleBox True if the box is ReversedPoleBox public bool IsReversedPoleBox { get; } Property Value bool Max Maximum point of the box. public Vec2d Max { get; set; } Property Value Vec2d Min Minimum point of the box. public Vec2d Min { get; set; } Property Value Vec2d NaN Generate a nan box which min~max is (nan,nan,nan)~(nan,nan,nan). public static Box2d NaN { get; } Property Value Box2d NativeByteSize Gets the size in bytes of the native representation of this box. public static int NativeByteSize { get; } Property Value int ReversedPoleBox Generate a reversed pole box which min~max is (∞,∞,∞)~(-∞,-∞,-∞). public static Box2d ReversedPoleBox { get; } Property Value Box2d UnitBox Generate a unit box which min~max is (0,0,0)~(1,1,1). public static Box2d UnitBox { get; } Property Value Box2d Volume Gets the volume (area) of this box. public double Volume { get; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZeroBox Generate a zero box which min~max is (0,0,0)~(0,0,0). public static Box2d ZeroBox { get; } Property Value Box2d Methods ApexAt(int) Get Apex at the box. public Vec2d ApexAt(int index) Parameters index int index 0~7. all of 8 apex. Returns Vec2d Equals(Box2d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Box2d other) Parameters other Box2d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. Expand(Box2d) Expands this box to include the specified box. public Box2d Expand(Box2d src) Parameters src Box2d The box to include. Returns Box2d This box instance after expansion. Expand(Vec2d) Expands this box to include the specified point. public Box2d Expand(Vec2d p) Parameters p Vec2d The point to include in the box. Returns Box2d This box instance after expansion. ExpandToBox2d(Box2d) Expands the specified destination box to include this box. public void ExpandToBox2d(Box2d dst) Parameters dst Box2d The destination box to expand. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. IsOverlapped(Box2d) Is the box overlapped to otherBox. public bool IsOverlapped(Box2d otherBox) Parameters otherBox Box2d other box Returns bool is overlapped MakeXmlSource(string) public XElement MakeXmlSource(string baseDirectory) Parameters baseDirectory string Returns XElement ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Scale(double) Scale the box from the coordinate origin. The operation is equal to: Min *= s; Max *= s; public Box2d Scale(double s) Parameters s double scale Returns Box2d this ScaleFromCenter(double) Scales this box from its center by the specified factor. public Box2d ScaleFromCenter(double s) Parameters s double The scale factor. Returns Box2d This box instance after scaling. Set(Box2d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box2d Set(Box2d src) Parameters src Box2d src Returns Box2d this Set(box2d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box2d Set(box2d src) Parameters src box2d src Returns Box2d this Set(double, double, double, double) Sets the minimum and maximum coordinates of this box. public Box2d Set(double minx, double miny, double maxx, double maxy) Parameters minx double The minimum X coordinate. miny double The minimum Y coordinate. maxx double The maximum X coordinate. maxy double The maximum Y coordinate. Returns Box2d This box instance. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string, IFormatProvider) Returns a string representation of the box formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the box Translate(Vec2d) Translate the box. public Box2d Translate(Vec2d vec) Parameters vec Vec2d translation vector Returns Box2d this WriteBin(BinaryWriter) Writes the box data to a binary writer. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write the data to." }, "api/Hi.Geom.Box3d.NoInit.html": { "href": "api/Hi.Geom.Box3d.NoInit.html", @@ -1302,32 +1282,42 @@ "api/Hi.Geom.Box3d.html": { "href": "api/Hi.Geom.Box3d.html", "title": "Class Box3d | HiAPI-C# 2025", - "summary": "Class Box3d Namespace Hi.Geom Assembly HiGeom.dll Lightweight 3d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box3d is Min and Max. public class Box3d : IExpandToBox3d, IEquatable, IStlSource, IGetStl, IMakeXmlSource, IBinaryIo, IWriteBin, IDuplicate Inheritance object Box3d Implements IExpandToBox3d IEquatable IStlSource IGetStl IMakeXmlSource IBinaryIo IWriteBin IDuplicate Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Box3d() Ctor. public Box3d() Box3d(NoInit) Ctor. The Ctor keeps Min and Max to null. public Box3d(Box3d.NoInit noInit) Parameters noInit Box3d.NoInit Box3d(params IExpandToBox3d[]) Creates a box that encompasses all the provided expandable objects. public Box3d(params IExpandToBox3d[] src) Parameters src IExpandToBox3d[] Array of objects that can expand to a box Box3d(Vec3d, Vec3d) Ctor. public Box3d(Vec3d min, Vec3d max) Parameters min Vec3d Min max Vec3d Max Box3d(box3d) Ctor. public Box3d(box3d src) Parameters src box3d src Box3d(IEnumerable) Creates a box that encompasses all the provided expandable objects. public Box3d(IEnumerable src) Parameters src IEnumerable Collection of objects that can expand to a box Box3d(double, double, double, double, double, double) Creates a box with the specified minimum and maximum coordinates. public Box3d(double minx, double miny, double minz, double maxx, double maxy, double maxz) Parameters minx double Minimum X coordinate miny double Minimum Y coordinate minz double Minimum Z coordinate maxx double Maximum X coordinate maxy double Maximum Y coordinate maxz double Maximum Z coordinate Box3d(BinaryReader) Creates a box from binary data. public Box3d(BinaryReader reader) Parameters reader BinaryReader Binary reader to read the box data from Box3d(XElement) Ctor. public Box3d(XElement src) Parameters src XElement XML Properties BottomCenter Center of the bottom surface. public Vec3d BottomCenter { get; } Property Value Vec3d BottomView Gets a transformation matrix for viewing the box from the bottom. public Mat4d BottomView { get; } Property Value Mat4d Center Center public Vec3d Center { get; } Property Value Vec3d CenterUnitBox Generate a center unit box which min~max is (-0.5,-0.5,-0.5)~(0.5,0.5,0.5). public static Box3d CenterUnitBox { get; } Property Value Box3d DiagonalLength Diagonal length. public double DiagonalLength { get; } Property Value double Dim Dimension. public Vec3d Dim { get; } Property Value Vec3d FrontView Gets a transformation matrix for viewing the box from the front. public Mat4d FrontView { get; } Property Value Mat4d HasVolume Checks if the box has a positive volume (all dimensions are greater than zero). public bool HasVolume { get; } Property Value bool IsAllNaN True if all components of Min and Max are NaN. public bool IsAllNaN { get; } Property Value bool IsFinite True if the box is finite. public bool IsFinite { get; } Property Value bool IsReversedPoleBox True if the box is ReversedPoleBox public bool IsReversedPoleBox { get; } Property Value bool IsometricView Gets a transformation matrix for viewing the box from an isometric perspective. public Mat4d IsometricView { get; } Property Value Mat4d LeftSideView Gets a transformation matrix for viewing the box from the left side. public Mat4d LeftSideView { get; } Property Value Mat4d Max Maximum point of the box. public Vec3d Max { get; set; } Property Value Vec3d Min Minimum point of the box. public Vec3d Min { get; set; } Property Value Vec3d NaN Generate a nan box which min~max is (nan,nan,nan)~(nan,nan,nan). public static Box3d NaN { get; } Property Value Box3d NativeByteSize Gets the native byte size of a Box3d (2 Vec3d objects). public static int NativeByteSize { get; } Property Value int RearView Gets a transformation matrix for viewing the box from the rear. public Mat4d RearView { get; } Property Value Mat4d ReversedPoleBox Generate a reversed pole box which min~max is (∞,∞,∞)~(-∞,-∞,-∞). public static Box3d ReversedPoleBox { get; } Property Value Box3d RightSideView Gets a transformation matrix for viewing the box from the right side. public Mat4d RightSideView { get; } Property Value Mat4d TopCenter Center of the top surface. public Vec3d TopCenter { get; } Property Value Vec3d TopView Gets a transformation matrix for viewing the box from the top. public Mat4d TopView { get; } Property Value Mat4d UnitBox Generate a unit box which min~max is (0,0,0)~(1,1,1). public static Box3d UnitBox { get; } Property Value Box3d Volume Gets the volume of the box. public double Volume { get; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZeroBox Generate a zero box which min~max is (0,0,0)~(0,0,0). public static Box3d ZeroBox { get; } Property Value Box3d Methods ApexAt(int) Get Apex at the box. public Vec3d ApexAt(int index) Parameters index int index 0~7. all of 8 apex. Returns Vec3d Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object Equals(Box3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Box3d other) Parameters other Box3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. Expand(Box3d) Expands this box to include another box. public Box3d Expand(Box3d src) Parameters src Box3d The box to include Returns Box3d This box after expansion Expand(Vec3d) Expands the box to include the specified point. public Box3d Expand(Vec3d p) Parameters p Vec3d Point to include in the box Returns Box3d This box after expansion ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetStl() Generate Stl. public Stl GetStl() Returns Stl stl GetTransformedBoundingBox(Mat4d) Get the bounding box of the transformed box. public Box3d GetTransformedBoundingBox(Mat4d mat) Parameters mat Mat4d matrix Returns Box3d GetTris(ICollection) Generates triangles representing the box's surfaces. public int GetTris(ICollection dst) Parameters dst ICollection Collection to add the triangles to Returns int The number of triangles added (12) IsOverlapped(Box3d) Is the box overlapped to otherBox. public bool IsOverlapped(Box3d otherBox) Parameters otherBox Box3d other box Returns bool is overlapped MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state MemberAt(int) Get member at the location. public Vec3d MemberAt(int iter) Parameters iter int iterator Returns Vec3d Minif iter is 0; otherwise, return Max ReadBin(BinaryReader) Reads box data from a binary reader. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader Binary reader to read the box data from ScaleFromCenter(double) Scales the box from its center point. public Box3d ScaleFromCenter(double s) Parameters s double Scale factor Returns Box3d This box after scaling Set(Box3d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box3d Set(Box3d src) Parameters src Box3d src Returns Box3d this Set(box3d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box3d Set(box3d src) Parameters src box3d src Returns Box3d this Set(double, double, double, double, double, double) Sets the box coordinates to the specified values. public Box3d Set(double minx, double miny, double minz, double maxx, double maxy, double maxz) Parameters minx double Minimum X coordinate miny double Minimum Y coordinate minz double Minimum Z coordinate maxx double Maximum X coordinate maxy double Maximum Y coordinate maxz double Maximum Z coordinate Returns Box3d This box after modification SetToTransformedBoundingBox(Mat4d) Set the box to the bounding box of the matrix-transformed box. public Box3d SetToTransformedBoundingBox(Mat4d mat) Parameters mat Mat4d matrix Returns Box3d this ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Translate(Vec3d) Translate the box. public Box3d Translate(Vec3d vec) Parameters vec Vec3d translation vector Returns Box3d this WriteBin(BinaryWriter) Writes box data to a binary writer. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter Binary writer to write the box data to" + "summary": "Class Box3d Namespace Hi.Geom Assembly HiGeom.dll Lightweight 3d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box3d is Min and Max. public class Box3d : IExpandToBox3d, IEquatable, IStlSource, IGetStl, IMakeXmlSource, IBinaryIo, IWriteBin, IDuplicate, IFormattable Inheritance object Box3d Implements IExpandToBox3d IEquatable IStlSource IGetStl IMakeXmlSource IBinaryIo IWriteBin IDuplicate IFormattable Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Box3d() Ctor. public Box3d() Box3d(NoInit) Ctor. The Ctor keeps Min and Max to null. public Box3d(Box3d.NoInit noInit) Parameters noInit Box3d.NoInit Box3d(params IExpandToBox3d[]) Creates a box that encompasses all the provided expandable objects. public Box3d(params IExpandToBox3d[] src) Parameters src IExpandToBox3d[] Array of objects that can expand to a box Box3d(Vec3d, Vec3d) Ctor. public Box3d(Vec3d min, Vec3d max) Parameters min Vec3d Min max Vec3d Max Box3d(box3d) Ctor. public Box3d(box3d src) Parameters src box3d src Box3d(IEnumerable) Creates a box that encompasses all the provided expandable objects. public Box3d(IEnumerable src) Parameters src IEnumerable Collection of objects that can expand to a box Box3d(double, double, double, double, double, double) Creates a box with the specified minimum and maximum coordinates. public Box3d(double minx, double miny, double minz, double maxx, double maxy, double maxz) Parameters minx double Minimum X coordinate miny double Minimum Y coordinate minz double Minimum Z coordinate maxx double Maximum X coordinate maxy double Maximum Y coordinate maxz double Maximum Z coordinate Box3d(BinaryReader) Creates a box from binary data. public Box3d(BinaryReader reader) Parameters reader BinaryReader Binary reader to read the box data from Box3d(XElement) Ctor. public Box3d(XElement src) Parameters src XElement XML Properties BottomCenter Center of the bottom surface. public Vec3d BottomCenter { get; } Property Value Vec3d BottomView Gets a transformation matrix for viewing the box from the bottom. public Mat4d BottomView { get; } Property Value Mat4d Center Center public Vec3d Center { get; } Property Value Vec3d CenterUnitBox Generate a center unit box which min~max is (-0.5,-0.5,-0.5)~(0.5,0.5,0.5). public static Box3d CenterUnitBox { get; } Property Value Box3d DiagonalLength Diagonal length. public double DiagonalLength { get; } Property Value double Dim Dimension. public Vec3d Dim { get; } Property Value Vec3d FrontView Gets a transformation matrix for viewing the box from the front. public Mat4d FrontView { get; } Property Value Mat4d HasVolume Checks if the box has a positive volume (all dimensions are greater than zero). public bool HasVolume { get; } Property Value bool InfiniteBox Generate a infinite box which min~max is (-∞,-∞,-∞)~(∞,∞,∞). public static Box3d InfiniteBox { get; } Property Value Box3d IsAllNaN True if all components of Min and Max are NaN. public bool IsAllNaN { get; } Property Value bool IsFinite True if the box is finite. public bool IsFinite { get; } Property Value bool IsReversedPoleBox True if the box is ReversedPoleBox public bool IsReversedPoleBox { get; } Property Value bool IsometricView Gets a transformation matrix for viewing the box from an isometric perspective. public Mat4d IsometricView { get; } Property Value Mat4d LeftSideView Gets a transformation matrix for viewing the box from the left side. public Mat4d LeftSideView { get; } Property Value Mat4d Max Maximum point of the box. public Vec3d Max { get; set; } Property Value Vec3d Min Minimum point of the box. public Vec3d Min { get; set; } Property Value Vec3d NaN Generate a nan box which min~max is (nan,nan,nan)~(nan,nan,nan). public static Box3d NaN { get; } Property Value Box3d NativeByteSize Gets the native byte size of a Box3d (2 Vec3d objects). public static int NativeByteSize { get; } Property Value int RearView Gets a transformation matrix for viewing the box from the rear. public Mat4d RearView { get; } Property Value Mat4d ReversedPoleBox Generate a reversed pole box which min~max is (∞,∞,∞)~(-∞,-∞,-∞). public static Box3d ReversedPoleBox { get; } Property Value Box3d RightSideView Gets a transformation matrix for viewing the box from the right side. public Mat4d RightSideView { get; } Property Value Mat4d TopCenter Center of the top surface. public Vec3d TopCenter { get; } Property Value Vec3d TopView Gets a transformation matrix for viewing the box from the top. public Mat4d TopView { get; } Property Value Mat4d UnitBox Generate a unit box which min~max is (0,0,0)~(1,1,1). public static Box3d UnitBox { get; } Property Value Box3d Volume Gets the volume of the box. public double Volume { get; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZeroBox Generate a zero box which min~max is (0,0,0)~(0,0,0). public static Box3d ZeroBox { get; } Property Value Box3d Methods ApexAt(int) Get Apex at the box. public Vec3d ApexAt(int index) Parameters index int index 0~7. all of 8 apex. Returns Vec3d Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object Equals(Box3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Box3d other) Parameters other Box3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. Expand(Box3d) Expands this box to include another box. public Box3d Expand(Box3d src) Parameters src Box3d The box to include Returns Box3d This box after expansion Expand(Vec3d) Expands the box to include the specified point. public Box3d Expand(Vec3d p) Parameters p Vec3d Point to include in the box Returns Box3d This box after expansion ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetStl() Generate Stl. public Stl GetStl() Returns Stl stl GetTransformedBoundingBox(Mat4d) Get the bounding box of the transformed box. public Box3d GetTransformedBoundingBox(Mat4d mat) Parameters mat Mat4d matrix Returns Box3d GetTris(ICollection) Generates triangles representing the box's surfaces. public int GetTris(ICollection dst) Parameters dst ICollection Collection to add the triangles to Returns int The number of triangles added (12) IsOverlapped(Box3d) Is the box overlapped to otherBox. public bool IsOverlapped(Box3d otherBox) Parameters otherBox Box3d other box Returns bool is overlapped 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. MemberAt(int) Get member at the location. public Vec3d MemberAt(int iter) Parameters iter int iterator Returns Vec3d Minif iter is 0; otherwise, return Max ReadBin(BinaryReader) Reads box data from a binary reader. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader Binary reader to read the box data from ScaleFromCenter(double) Scales the box from its center point. public Box3d ScaleFromCenter(double s) Parameters s double Scale factor Returns Box3d This box after scaling Set(Box3d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box3d Set(Box3d src) Parameters src Box3d src Returns Box3d this Set(box3d) Copy the src. The Min and Max are kept the same object. Only the double values changed. public Box3d Set(box3d src) Parameters src box3d src Returns Box3d this Set(double, double, double, double, double, double) Sets the box coordinates to the specified values. public Box3d Set(double minx, double miny, double minz, double maxx, double maxy, double maxz) Parameters minx double Minimum X coordinate miny double Minimum Y coordinate minz double Minimum Z coordinate maxx double Maximum X coordinate maxy double Maximum Y coordinate maxz double Maximum Z coordinate Returns Box3d This box after modification SetToTransformedBoundingBox(Mat4d) Set the box to the bounding box of the matrix-transformed box. public Box3d SetToTransformedBoundingBox(Mat4d mat) Parameters mat Mat4d matrix Returns Box3d this ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string, IFormatProvider) Returns a string representation of the box formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the box Translate(Vec3d) Translate the box. public Box3d Translate(Vec3d vec) Parameters vec Vec3d translation vector Returns Box3d this WriteBin(BinaryWriter) Writes box data to a binary writer. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter Binary writer to write the box data to" }, "api/Hi.Geom.Cylindroid.html": { "href": "api/Hi.Geom.Cylindroid.html", "title": "Class Cylindroid | HiAPI-C# 2025", - "summary": "Class Cylindroid Namespace Hi.Geom Assembly HiGeom.dll Geometry of Cylindroid. public class Cylindroid : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList Inheritance object Cylindroid Implements IStlSource IGetStl IMakeXmlSource IExpandToBox3d IGetZrContour IDuplicate IGetZrList Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) PairZrUtil.GetVolume(IGetZrList) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Cylindroid() Initializes a new instance of the Cylindroid class with an empty list of PairZr objects. public Cylindroid() Cylindroid(Cylindroid) Initializes a new instance of the Cylindroid class by copying another Cylindroid. public Cylindroid(Cylindroid src) Parameters src Cylindroid The source Cylindroid to copy from. Cylindroid(int, params PairZr[]) Ctor. The order of z values should be from small to large in general case. public Cylindroid(int longitudeNum = 12, params PairZr[] pairZRs) Parameters longitudeNum int See LongitudeNum. pairZRs PairZr[] See PairZrs. Cylindroid(XElement) Ctor. public Cylindroid(XElement src) Parameters src XElement XML Properties AngleResolution_deg Gets or sets the angular resolution in degrees. public double AngleResolution_deg { get; set; } Property Value double AngleResolution_rad Gets or sets the angular resolution in radians. public double AngleResolution_rad { get; set; } Property Value double LongitudeNum Longtitude number. public int LongitudeNum { get; set; } Property Value int PairZrs ZR values. The order of z values should be from small to large in general case. public List PairZrs { get; set; } Property Value List UnitCylinder Generate a cylindroid that height is 1 and radius is 0.5. public static Cylindroid UnitCylinder { get; } Property Value Cylindroid XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenCylinder(double, double, int) Generates a cylinder with the specified height, radius, and longitude number. public static Cylindroid GenCylinder(double height, double r, int longtitudeNum = 12) Parameters height double The height of the cylinder. r double The radius of the cylinder. longtitudeNum int The number of longitude divisions. Returns Cylindroid A new Cylindroid representing the cylinder. GenStl() Generate a new Stl. public Stl GenStl() Returns Stl newly created Stl GenStl(int, params PairZr[]) Generate a cylindroid stl. public static Stl GenStl(int longtitudeNum = 12, params PairZr[] pairZRs) Parameters longtitudeNum int longtitude number pairZRs PairZr[] zr values Returns Stl cylindroid stl GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetZrContour(double) Gets Z-R contour data as a list of PairZr objects. The Z values should generally be ordered from smallest to largest. public IList GetZrContour(double latitudeAngleResolution_rad) Parameters latitudeAngleResolution_rad double Resolution of latitude angle in radians Returns IList Z-R contour data as a list of PairZr objects GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class Cylindroid Namespace Hi.Geom Assembly HiGeom.dll Geometry of Cylindroid. public class Cylindroid : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList, IGenStl Inheritance object Cylindroid Implements IStlSource IGetStl IMakeXmlSource IExpandToBox3d IGetZrContour IDuplicate IGetZrList IGenStl Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) PairZrUtil.GetVolume(IGetZrList) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Cylindroid() Initializes a new instance of the Cylindroid class with an empty list of PairZr objects. public Cylindroid() Cylindroid(Cylindroid) Initializes a new instance of the Cylindroid class by copying another Cylindroid. public Cylindroid(Cylindroid src) Parameters src Cylindroid The source Cylindroid to copy from. Cylindroid(params PairZr[]) Ctor. The order of z values should be from small to large in general case. public Cylindroid(params PairZr[] pairZRs) Parameters pairZRs PairZr[] See PairZrs. Cylindroid(XElement) Ctor. public Cylindroid(XElement src) Parameters src XElement XML Properties DefaultPolarResolution2d public static IPolarResolution2d DefaultPolarResolution2d { get; set; } Property Value IPolarResolution2d PairZrs ZR values. The order of z values should be from small to large in general case. public List PairZrs { get; set; } Property Value List UnitCylinder Generate a cylindroid that height is 1 and radius is 0.5. public static Cylindroid UnitCylinder { get; } Property Value Cylindroid XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenCylinder(double, double) Generates a cylinder with the specified height, radius, and longitude number. public static Cylindroid GenCylinder(double height, double r) Parameters height double The height of the cylinder. r double The radius of the cylinder. Returns Cylindroid A new Cylindroid representing the cylinder. GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetZrContour(double) Gets Z-R contour data as a list of PairZr objects. The Z values should generally be ordered from smallest to largest. public IList GetZrContour(double latitudeAngleResolution_rad) Parameters latitudeAngleResolution_rad double Resolution of latitude angle in radians Returns IList Z-R contour data as a list of PairZr objects GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. 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." }, "api/Hi.Geom.DVec3d.html": { "href": "api/Hi.Geom.DVec3d.html", "title": "Class DVec3d | HiAPI-C# 2025", - "summary": "Class DVec3d Namespace Hi.Geom Assembly HiGeom.dll Dual Vec3d with p(Vec3d) and n(Vec3d). public class DVec3d : IEquatable, IWriteBin, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IMultiplyOperators, IDivisionOperators, IVec Inheritance object DVec3d Implements IEquatable IWriteBin IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IMultiplyOperators IDivisionOperators IVec Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) 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) Constructors DVec3d() Ctor. The members are initialized to null. public DVec3d() DVec3d(DVec3d, bool) Initializes a new instance of the DVec3d class by copying another DVec3d. public DVec3d(DVec3d src, bool shareFields = false) Parameters src DVec3d The source DVec3d to copy from. shareFields bool If true, references to the source Point and Normal are used; otherwise, new instances are created with copied values. DVec3d(Mat4d) Ctor. set mat[12] to Point.x; set mat[13] to Point.y; set mat[14] to Point.z; set mat[8] to Normal.x; set mat[9] to Normal.y; set mat[10] to Normal.z; public DVec3d(Mat4d mat) Parameters mat Mat4d matrix DVec3d(UnnullableDVec3d) Initializes a new instance of the DVec3d class from an UnnullableDVec3d. public DVec3d(UnnullableDVec3d src) Parameters src UnnullableDVec3d The source UnnullableDVec3d to copy from. DVec3d(Vec3d, Vec3d) Ctor. public DVec3d(Vec3d p, Vec3d n) Parameters p Vec3d Point n Vec3d Normal DVec3d(IEnumerable) Initializes a new instance of the DVec3d class from an enumerable collection of doubles. public DVec3d(IEnumerable src) Parameters src IEnumerable The source collection containing at least 6 double values. The first 3 values initialize the Point, and the last 3 values initialize the Normal. DVec3d(double, double, double, double, double, double) Ctor. public DVec3d(double px, double py, double pz, double nx, double ny, double nz) Parameters px double Point.x py double Point.y pz double Point.z nx double Normal.x ny double Normal.y nz double Normal.z DVec3d(double[]) Ctor. public DVec3d(double[] src) Parameters src double[] Array elements 0,1,2 initialize Point x,y,z; Array elements 3,4,5 initialize Point x,y,z DVec3d(Func) Initializes a new instance of the DVec3d class using a function that maps indices to values. public DVec3d(Func dirToValueFunc) Parameters dirToValueFunc Func A function that takes an index (0-5) and returns the corresponding coordinate value. Indices 0-2 are for Point coordinates, and 3-5 are for Normal coordinates. DVec3d(BinaryReader) Initializes a new instance of the DVec3d class from binary data. public DVec3d(BinaryReader reader) Parameters reader BinaryReader The binary reader to read the data from. DVec3d(string) Ctor. The reading format is ((x,y,z),(x,y,z)), the first xyz is for Point; the second xyz is for Normal. public DVec3d(string str) Parameters str string string See Also ToString() Properties ElementNum Element number: 6 for (Point(x,y,z),Normal(x,y,z)). public static int ElementNum { get; } Property Value int IsAllNaN Gets a value indicating whether all components of both Point and Normal are NaN. public bool IsAllNaN { get; } Property Value bool IsFinite Gets a value indicating whether all components of both Point and Normal are finite. public bool IsFinite { get; } Property Value bool this[int] Gets or sets the element at the specified index. public double this[int index] { get; set; } Parameters index int The zero-based index of the element to get or set. Property Value double The element at the specified index. NaN Gets a DVec3d with all components set to NaN. public static DVec3d NaN { get; } Property Value DVec3d Normal Normal. public Vec3d Normal { get; set; } Property Value Vec3d Point Point. public Vec3d Point { get; set; } Property Value Vec3d Rank Dimension (i.e. Size) of the Vector. public int Rank { get; } Property Value int Zero Gets a DVec3d with all components set to zero. public static DVec3d Zero { get; } Property Value DVec3d Methods At(int) Gets a reference to the component at the specified index. public ref double At(int dir) Parameters dir int The index of the component to access (0-5). Indices 0-2 access Point coordinates (x,y,z), and indices 3-5 access Normal coordinates (x,y,z). Returns double A reference to the specified component. Enumerate() For each. Point first. Normal second. public IEnumerable Enumerate() Returns IEnumerable Equals(DVec3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(DVec3d other) Parameters other DVec3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GenNaN() Creates a new DVec3d with all components set to NaN. public static DVec3d GenNaN() Returns DVec3d A new DVec3d with all components set to NaN. GenZero() Creates a new DVec3d with all components set to zero. public static DVec3d GenZero() Returns DVec3d A new DVec3d with all components set to zero. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Interpolate(DVec3d, DVec3d, double) Interpolates between two DVec3d instances. public static DVec3d Interpolate(DVec3d a, DVec3d b, double ratio) Parameters a DVec3d The first DVec3d. b DVec3d The second DVec3d. ratio double The interpolation ratio (0.0 to 1.0). Returns DVec3d A new DVec3d interpolated between a and b. Set(DVec3d, bool) Sets the values of this instance from another DVec3d. public void Set(DVec3d src, bool shareFields = false) Parameters src DVec3d The source DVec3d to copy values from. shareFields bool If true, references to the source Point and Normal are used; otherwise, their values are copied. Set(double, double, double, double, double, double) Call Point.Set(double, double, double) and Normal.Set(double, double, double) to set the values. public void Set(double px, double py, double pz, double nx, double ny, double nz) Parameters px double Point.x py double Point.y pz double Point.z nx double Normal.x ny double Normal.y nz double Normal.z Remarks If the Point or Normal is null, the function will corrupt. SetEachValueAbs() Sets each component of both Point and Normal to its absolute value. public DVec3d SetEachValueAbs() Returns DVec3d This instance after the operation. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string) Returns a string representation of this DVec3d using the specified format for component values. public string ToString(string format) Parameters format string The format string to use for component values. Returns string A string representation of this DVec3d. ToUnnullableDVec3d() Converts this DVec3d to an UnnullableDVec3d. public UnnullableDVec3d ToUnnullableDVec3d() Returns UnnullableDVec3d A new UnnullableDVec3d containing the data from this DVec3d. WriteBin(BinaryWriter) Writes the object's data to a binary stream. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write to Operators operator +(DVec3d, DVec3d) Adds two values together to compute their sum. public static DVec3d operator +(DVec3d a, DVec3d b) Parameters a DVec3d b DVec3d Returns DVec3d The sum of left and right. operator /(DVec3d, double) Divides one value by another to compute their quotient. public static DVec3d operator /(DVec3d src, double s) Parameters src DVec3d s double Returns DVec3d The quotient of left divided by right. operator ==(DVec3d, DVec3d) Compares two values to determine equality. public static bool operator ==(DVec3d left, DVec3d right) Parameters left DVec3d The value to compare with right. right DVec3d The value to compare with left. Returns bool true if left is equal to right; otherwise, false. operator !=(DVec3d, DVec3d) Compares two values to determine inequality. public static bool operator !=(DVec3d left, DVec3d right) Parameters left DVec3d The value to compare with right. right DVec3d The value to compare with left. Returns bool true if left is not equal to right; otherwise, false. operator *(DVec3d, Mat4d) Multiplies two values together to compute their product. public static DVec3d operator *(DVec3d a, Mat4d b) Parameters a DVec3d b Mat4d Returns DVec3d The product of left multiplied by right. operator *(DVec3d, double) Multiplies two values together to compute their product. public static DVec3d operator *(DVec3d src, double s) Parameters src DVec3d s double Returns DVec3d The product of left multiplied by right. operator -(DVec3d, DVec3d) Subtracts two values to compute their difference. public static DVec3d operator -(DVec3d a, DVec3d b) Parameters a DVec3d b DVec3d Returns DVec3d The value of right subtracted from left. operator -(DVec3d) Create a negate DVec3d. The field objects are created, i.e. the field objects are not shared with this. public static DVec3d operator -(DVec3d src) Parameters src DVec3d src Returns DVec3d negate DVec3d" + "summary": "Class DVec3d Namespace Hi.Geom Assembly HiGeom.dll Dual Vec3d with p(Vec3d) and n(Vec3d). public class DVec3d : IEquatable, IWriteBin, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IMultiplyOperators, IDivisionOperators, IVec, IFormattable Inheritance object DVec3d Implements IEquatable IWriteBin IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IMultiplyOperators IDivisionOperators IVec IFormattable Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) 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) Constructors DVec3d() Ctor. The members are initialized to null. public DVec3d() DVec3d(DVec3d, bool) Initializes a new instance of the DVec3d class by copying another DVec3d. public DVec3d(DVec3d src, bool shareFields = false) Parameters src DVec3d The source DVec3d to copy from. shareFields bool If true, references to the source Point and Normal are used; otherwise, new instances are created with copied values. DVec3d(Mat4d) Ctor. set mat[12] to Point.x; set mat[13] to Point.y; set mat[14] to Point.z; set mat[8] to Normal.x; set mat[9] to Normal.y; set mat[10] to Normal.z; public DVec3d(Mat4d mat) Parameters mat Mat4d matrix DVec3d(UnnullableDVec3d) Initializes a new instance of the DVec3d class from an UnnullableDVec3d. public DVec3d(UnnullableDVec3d src) Parameters src UnnullableDVec3d The source UnnullableDVec3d to copy from. DVec3d(Vec3d, Vec3d) Ctor. public DVec3d(Vec3d p, Vec3d n) Parameters p Vec3d Point n Vec3d Normal DVec3d(IEnumerable) Initializes a new instance of the DVec3d class from an enumerable collection of doubles. public DVec3d(IEnumerable src) Parameters src IEnumerable The source collection containing at least 6 double values. The first 3 values initialize the Point, and the last 3 values initialize the Normal. DVec3d(double, double, double, double, double, double) Ctor. public DVec3d(double px, double py, double pz, double nx, double ny, double nz) Parameters px double Point.x py double Point.y pz double Point.z nx double Normal.x ny double Normal.y nz double Normal.z DVec3d(double[]) Ctor. public DVec3d(double[] src) Parameters src double[] Array elements 0,1,2 initialize Point x,y,z; Array elements 3,4,5 initialize Point x,y,z DVec3d(Func) Initializes a new instance of the DVec3d class using a function that maps indices to values. public DVec3d(Func dirToValueFunc) Parameters dirToValueFunc Func A function that takes an index (0-5) and returns the corresponding coordinate value. Indices 0-2 are for Point coordinates, and 3-5 are for Normal coordinates. DVec3d(BinaryReader) Initializes a new instance of the DVec3d class from binary data. public DVec3d(BinaryReader reader) Parameters reader BinaryReader The binary reader to read the data from. DVec3d(string) Ctor. The reading format is ((x,y,z),(x,y,z)), the first xyz is for Point; the second xyz is for Normal. public DVec3d(string str) Parameters str string string See Also ToString() Properties ElementNum Element number: 6 for (Point(x,y,z),Normal(x,y,z)). public static int ElementNum { get; } Property Value int IsAllNaN Gets a value indicating whether all components of both Point and Normal are NaN. public bool IsAllNaN { get; } Property Value bool IsFinite Gets a value indicating whether all components of both Point and Normal are finite. public bool IsFinite { get; } Property Value bool this[int] Gets or sets the element at the specified index. public double this[int index] { get; set; } Parameters index int The zero-based index of the element to get or set. Property Value double The element at the specified index. NaN Gets a DVec3d with all components set to NaN. public static DVec3d NaN { get; } Property Value DVec3d Normal Normal. public Vec3d Normal { get; set; } Property Value Vec3d Point Point. public Vec3d Point { get; set; } Property Value Vec3d Rank Dimension (i.e. Size) of the Vector. public int Rank { get; } Property Value int Zero Gets a DVec3d with all components set to zero. public static DVec3d Zero { get; } Property Value DVec3d Methods At(int) Gets a reference to the component at the specified index. public ref double At(int dir) Parameters dir int The index of the component to access (0-5). Indices 0-2 access Point coordinates (x,y,z), and indices 3-5 access Normal coordinates (x,y,z). Returns double A reference to the specified component. Enumerate() For each. Point first. Normal second. public IEnumerable Enumerate() Returns IEnumerable Equals(DVec3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(DVec3d other) Parameters other DVec3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GenNaN() Creates a new DVec3d with all components set to NaN. public static DVec3d GenNaN() Returns DVec3d A new DVec3d with all components set to NaN. GenZero() Creates a new DVec3d with all components set to zero. public static DVec3d GenZero() Returns DVec3d A new DVec3d with all components set to zero. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Interpolate(DVec3d, DVec3d, double) Interpolates between two DVec3d instances. public static DVec3d Interpolate(DVec3d a, DVec3d b, double ratio) Parameters a DVec3d The first DVec3d. b DVec3d The second DVec3d. ratio double The interpolation ratio (0.0 to 1.0). Returns DVec3d A new DVec3d interpolated between a and b. Set(DVec3d, bool) Sets the values of this instance from another DVec3d. public void Set(DVec3d src, bool shareFields = false) Parameters src DVec3d The source DVec3d to copy values from. shareFields bool If true, references to the source Point and Normal are used; otherwise, their values are copied. Set(double, double, double, double, double, double) Call Point.Set(double, double, double) and Normal.Set(double, double, double) to set the values. public void Set(double px, double py, double pz, double nx, double ny, double nz) Parameters px double Point.x py double Point.y pz double Point.z nx double Normal.x ny double Normal.y nz double Normal.z Remarks If the Point or Normal is null, the function will corrupt. SetEachValueAbs() Sets each component of both Point and Normal to its absolute value. public DVec3d SetEachValueAbs() Returns DVec3d This instance after the operation. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string) Returns a string representation of this DVec3d using the specified format for component values. public string ToString(string format) Parameters format string The format string to use for component values. Returns string A string representation of this DVec3d. ToString(string, IFormatProvider) Returns a string representation of the dual vector formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the dual vector ToUnnullableDVec3d() Converts this DVec3d to an UnnullableDVec3d. public UnnullableDVec3d ToUnnullableDVec3d() Returns UnnullableDVec3d A new UnnullableDVec3d containing the data from this DVec3d. WriteBin(BinaryWriter) Writes the object's data to a binary stream. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write to Operators operator +(DVec3d, DVec3d) Adds two values together to compute their sum. public static DVec3d operator +(DVec3d a, DVec3d b) Parameters a DVec3d b DVec3d Returns DVec3d The sum of left and right. operator /(DVec3d, double) Divides one value by another to compute their quotient. public static DVec3d operator /(DVec3d src, double s) Parameters src DVec3d s double Returns DVec3d The quotient of left divided by right. operator ==(DVec3d, DVec3d) Compares two values to determine equality. public static bool operator ==(DVec3d left, DVec3d right) Parameters left DVec3d The value to compare with right. right DVec3d The value to compare with left. Returns bool true if left is equal to right; otherwise, false. operator !=(DVec3d, DVec3d) Compares two values to determine inequality. public static bool operator !=(DVec3d left, DVec3d right) Parameters left DVec3d The value to compare with right. right DVec3d The value to compare with left. Returns bool true if left is not equal to right; otherwise, false. operator *(DVec3d, Mat4d) Multiplies two values together to compute their product. public static DVec3d operator *(DVec3d a, Mat4d b) Parameters a DVec3d b Mat4d Returns DVec3d The product of left multiplied by right. operator *(DVec3d, double) Multiplies two values together to compute their product. public static DVec3d operator *(DVec3d src, double s) Parameters src DVec3d s double Returns DVec3d The product of left multiplied by right. operator -(DVec3d, DVec3d) Subtracts two values to compute their difference. public static DVec3d operator -(DVec3d a, DVec3d b) Parameters a DVec3d b DVec3d Returns DVec3d The value of right subtracted from left. operator -(DVec3d) Create a negate DVec3d. The field objects are created, i.e. the field objects are not shared with this. public static DVec3d operator -(DVec3d src) Parameters src DVec3d src Returns DVec3d negate DVec3d" }, "api/Hi.Geom.Dir.html": { "href": "api/Hi.Geom.Dir.html", "title": "Enum Dir | HiAPI-C# 2025", "summary": "Enum Dir Namespace Hi.Geom Assembly HiGeom.dll Enumeration of coordinate axis directions in 3D space. public enum Dir Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields X = 0 X-axis direction (index 0). Y = 1 Y-axis direction (index 1). Z = 2 Z-axis direction (index 2)." }, + "api/Hi.Geom.ExtendedCylinder.html": { + "href": "api/Hi.Geom.ExtendedCylinder.html", + "title": "Class ExtendedCylinder | HiAPI-C# 2025", + "summary": "Class ExtendedCylinder Namespace Hi.Geom Assembly HiGeom.dll public class ExtendedCylinder : IStlSource, IGetStl, IExpandToBox3d, IGetZrContour, IDuplicate, IGetZrList, IGenStl, IMakeXmlSource, IToXElement Inheritance object ExtendedCylinder Implements IStlSource IGetStl IExpandToBox3d IGetZrContour IDuplicate IGetZrList IGenStl IMakeXmlSource IToXElement Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) PairZrUtil.GetVolume(IGetZrList) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ExtendedCylinder() public ExtendedCylinder() ExtendedCylinder(double, Func) public ExtendedCylinder(double fullLength, Func beginPairZrSource = null) Parameters fullLength double beginPairZrSource Func ExtendedCylinder(XElement) Initializes a new instance of the ExtendedCylinder class from XML data. public ExtendedCylinder(XElement src) Parameters src XElement The XML element containing extended cylinder data. Properties BeginPairZrSource public Func BeginPairZrSource { get; set; } Property Value Func Cylindroid public Cylindroid Cylindroid { get; } Property Value Cylindroid FullLength public double FullLength { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetZrContour(double) Gets Z-R contour data as a list of PairZr objects. The Z values should generally be ordered from smallest to largest. public IList GetZrContour(double latitudeAngleResolution_rad) Parameters latitudeAngleResolution_rad double Resolution of latitude angle in radians Returns IList Z-R contour data as a list of PairZr objects GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." + }, + "api/Hi.Geom.Flat3d.html": { + "href": "api/Hi.Geom.Flat3d.html", + "title": "Class Flat3d | HiAPI-C# 2025", + "summary": "Class Flat3d Namespace Hi.Geom Assembly HiGeom.dll Represents a 3D plane defined by a unit normal vector and its signed distance from the origin. The plane equation is: Ax + By + Cz + d = 0, where (A,B,C) is the normal vector and d is the distance to origin. public class Flat3d : IFlat3d, IBinaryIo, IWriteBin, IEquatable Inheritance object Flat3d Implements IFlat3d IBinaryIo IWriteBin IEquatable Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) 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) Constructors Flat3d() Initializes a new instance of the Flat3d class. public Flat3d() Flat3d(IFlat3d) public Flat3d(IFlat3d src) Parameters src IFlat3d Flat3d(Vec3d, double) Initializes a new instance of the Flat3d class with a normal vector and distance to origin. public Flat3d(Vec3d normal, double distanceToOrigin) Parameters normal Vec3d The unit normal vector of the plane. distanceToOrigin double The signed distance from origin to the plane. Properties DistanceToOrigin The signed distance from the origin (0,0,0) to this plane. A positive distance means the origin is on the same side as the normal vector. public double DistanceToOrigin { get; set; } Property Value double Normal The unit normal to the plane. public Vec3d Normal { get; set; } Property Value Vec3d Methods DistanceTo(Vec3d) Gets the distance from a point to this plane. public double DistanceTo(Vec3d point) Parameters point Vec3d The point to calculate distance to. Returns double The signed distance from the point to the plane. Equals(Flat3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Flat3d other) Parameters other Flat3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. FromPointAndNormal(Vec3d, Vec3d) Creates a plane from a point and normal vector. public static Flat3d FromPointAndNormal(Vec3d point, Vec3d normal) Parameters point Vec3d A point on the plane. normal Vec3d The normal vector of the plane. Returns Flat3d A new plane instance. GetDistanceToOrigin() Signed Distance To Origin. public double GetDistanceToOrigin() Returns double Signed Distance To Origin. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetLocate() Gets a point on the plane closest to the origin. public Vec3d GetLocate() Returns Vec3d GetNormal() Gets the normal vector of the flat surface. public Vec3d GetNormal() Returns Vec3d The unit normal vector ProjectPoint(Vec3d) Projects a point onto this plane. public Vec3d ProjectPoint(Vec3d point) Parameters point Vec3d The point to project. Returns Vec3d The projected point on the plane. ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from ToString() Returns a string representation of the plane. public override string ToString() Returns string WriteBin(BinaryWriter) Writes the object's data to a binary stream. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write to" + }, "api/Hi.Geom.GeomCombination.html": { "href": "api/Hi.Geom.GeomCombination.html", "title": "Class GeomCombination | HiAPI-C# 2025", - "summary": "Class GeomCombination Namespace Hi.Geom Assembly HiGeom.dll A class that manages multiple STL sources as a single source. public class GeomCombination : IStlSource, IGetStl, IMakeXmlSource Inheritance object GeomCombination Implements IStlSource IGetStl IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) PairZrUtil.GetZrList(IGetStl) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeomCombination() Default constructor that initializes an empty collection of STL sources. public GeomCombination() GeomCombination(XElement, string, string) Ctor. public GeomCombination(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string Base directory path relFile string Relative file path Properties StlSources Collection of STL sources managed by this instance. public List StlSources { get; } Property Value List XName Name for XML IO. public static string XName { get; } Property Value string Methods CleanStlCache() Clears the cached STL data, forcing it to be regenerated on the next request. public void CleanStlCache() Duplicate(params object[]) public object Duplicate(params object[] res) Parameters res object[] Returns object GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class GeomCombination Namespace Hi.Geom Assembly HiGeom.dll A class that manages multiple STL sources as a single source. public class GeomCombination : IStlSource, IGetStl, IMakeXmlSource, IGenStl Inheritance object GeomCombination Implements IStlSource IGetStl IMakeXmlSource IGenStl Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) PairZrUtil.GetZrList(IGetStl) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeomCombination() Default constructor that initializes an empty collection of STL sources. public GeomCombination() GeomCombination(params IStlSource[]) public GeomCombination(params IStlSource[] stlSources) Parameters stlSources IStlSource[] GeomCombination(XElement, string, string) Ctor. public GeomCombination(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string Base directory path relFile string Relative file path Properties StlSources Collection of STL sources managed by this instance. public List StlSources { get; } Property Value List XName Name for XML IO. public static string XName { get; } Property Value string Methods CleanStlCache() Clears the cached STL data, forcing it to be regenerated on the next request. public void CleanStlCache() Duplicate(params object[]) public object Duplicate(params object[] res) Parameters res object[] Returns object GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry 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." }, "api/Hi.Geom.GeomUtil.html": { "href": "api/Hi.Geom.GeomUtil.html", "title": "Class GeomUtil | HiAPI-C# 2025", - "summary": "Class GeomUtil Namespace Hi.Geom Assembly HiGeom.dll Utility of Geometry. public static class GeomUtil Inheritance object GeomUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetBox3d(IExpandToBox3d) Gets a Box3d representation of the specified object that implements IExpandToBox3d. public static Box3d GetBox3d(this IExpandToBox3d src) Parameters src IExpandToBox3d The source object that implements IExpandToBox3d. Returns Box3d A Box3d representation of the source object. GetNearestPointOnLineSegment(Vec2d, Vec2d, Vec2d) Get the nearest point on a line segment to a given point. public static Vec2d GetNearestPointOnLineSegment(Vec2d point, Vec2d lineStart, Vec2d lineEnd) Parameters point Vec2d The point to find the nearest point from lineStart Vec2d Start point of the line segment lineEnd Vec2d End point of the line segment Returns Vec2d The nearest point on the line segment GetNearestPointOnLineSegment(Vec3d, Vec3d, Vec3d) Get the nearest point on a line segment to a given point. public static Vec3d GetNearestPointOnLineSegment(Vec3d point, Vec3d lineStart, Vec3d lineEnd) Parameters point Vec3d The point to find the nearest point from lineStart Vec3d Start point of the line segment lineEnd Vec3d End point of the line segment Returns Vec3d The nearest point on the line segment GetRayIntersection(Vec3d, Vec3d, Vec3d, Vec3d) Calculates the intersection point of two rays in 3D space. public static Vec3d GetRayIntersection(Vec3d rayABegin, Vec3d rayAVec, Vec3d rayBBegin, Vec3d rayBVec) Parameters rayABegin Vec3d The starting point of the first ray. rayAVec Vec3d The direction vector of the first ray. rayBBegin Vec3d The starting point of the second ray. rayBVec Vec3d The direction vector of the second ray. Returns Vec3d The intersection point of the two rays, or null if they don't intersect. IntersectLineSegmentCircle(Vec2d, Vec2d, double, out Vec2d, out Vec2d) Intersect line segment and circle. public static double IntersectLineSegmentCircle(Vec2d p0, Vec2d p1, double rr, out Vec2d pA, out Vec2d pB) Parameters p0 Vec2d line segment begin point p1 Vec2d line segment end point rr double radius*radius pA Vec2d first intersect point along p0 to p1 pB Vec2d second intersect point along p0 to p1 Returns double determinant" + "summary": "Class GeomUtil Namespace Hi.Geom Assembly HiGeom.dll Utility of Geometry. public static class GeomUtil Inheritance object GeomUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) public static void ExpandToBox3d(this IExpandToBox3d src, Mat4d mat, Box3d dst) Parameters src IExpandToBox3d mat Mat4d dst Box3d GetBox3d(IExpandToBox3d) Gets a Box3d representation of the specified object that implements IExpandToBox3d. public static Box3d GetBox3d(this IExpandToBox3d src) Parameters src IExpandToBox3d The source object that implements IExpandToBox3d. Returns Box3d A Box3d representation of the source object. GetNearestPointOnLineSegment(Vec2d, Vec2d, Vec2d) Get the nearest point on a line segment to a given point. public static Vec2d GetNearestPointOnLineSegment(Vec2d point, Vec2d lineStart, Vec2d lineEnd) Parameters point Vec2d The point to find the nearest point from lineStart Vec2d Start point of the line segment lineEnd Vec2d End point of the line segment Returns Vec2d The nearest point on the line segment GetNearestPointOnLineSegment(Vec3d, Vec3d, Vec3d) Get the nearest point on a line segment to a given point. public static Vec3d GetNearestPointOnLineSegment(Vec3d point, Vec3d lineStart, Vec3d lineEnd) Parameters point Vec3d The point to find the nearest point from lineStart Vec3d Start point of the line segment lineEnd Vec3d End point of the line segment Returns Vec3d The nearest point on the line segment GetRayIntersection(Vec3d, Vec3d, Vec3d, Vec3d) Calculates the intersection point of two rays in 3D space. public static Vec3d GetRayIntersection(Vec3d rayABegin, Vec3d rayAVec, Vec3d rayBBegin, Vec3d rayBVec) Parameters rayABegin Vec3d The starting point of the first ray. rayAVec Vec3d The direction vector of the first ray. rayBBegin Vec3d The starting point of the second ray. rayBVec Vec3d The direction vector of the second ray. Returns Vec3d The intersection point of the two rays, or null if they don't intersect. IntersectLineSegmentCircle(Vec2d, Vec2d, double, out Vec2d, out Vec2d) Intersect line segment and circle. public static double IntersectLineSegmentCircle(Vec2d p0, Vec2d p1, double rr, out Vec2d pA, out Vec2d pB) Parameters p0 Vec2d line segment begin point p1 Vec2d line segment end point rr double radius*radius pA Vec2d first intersect point along p0 to p1 pB Vec2d second intersect point along p0 to p1 Returns double determinant" }, "api/Hi.Geom.IExpandToBox2d.html": { "href": "api/Hi.Geom.IExpandToBox2d.html", @@ -1337,12 +1327,17 @@ "api/Hi.Geom.IExpandToBox3d.html": { "href": "api/Hi.Geom.IExpandToBox3d.html", "title": "Interface IExpandToBox3d | HiAPI-C# 2025", - "summary": "Interface IExpandToBox3d Namespace Hi.Geom Assembly HiGeom.dll Object that can be expanded to a Box3d. public interface IExpandToBox3d Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) GeomUtil.GetBox3d(IExpandToBox3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Interface IExpandToBox3d Namespace Hi.Geom Assembly HiGeom.dll Object that can be expanded to a Box3d. public interface IExpandToBox3d Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Geom.IFlat3d.html": { "href": "api/Hi.Geom.IFlat3d.html", "title": "Interface IFlat3d | HiAPI-C# 2025", - "summary": "Interface IFlat3d Namespace Hi.Geom Assembly HiGeom.dll Interface for a 3D flat surface that provides location and normal vector. public interface IFlat3d 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) Methods GetLocate() Gets an anchor point on this flat surface. Vec3d GetLocate() Returns Vec3d A point on the flat surface GetNormal() Gets the normal vector of the flat surface. Vec3d GetNormal() Returns Vec3d The unit normal vector" + "summary": "Interface IFlat3d Namespace Hi.Geom Assembly HiGeom.dll Interface for a 3D flat surface that provides location and normal vector. public interface IFlat3d 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) Methods GetDistanceToOrigin() Signed Distance To Origin. double GetDistanceToOrigin() Returns double Signed Distance To Origin. GetLocate() Gets an anchor point on this flat surface. Vec3d GetLocate() Returns Vec3d A point on the flat surface GetLocate(Vec3d, double) public static Vec3d GetLocate(Vec3d normal, double distanceToOrigin) Parameters normal Vec3d distanceToOrigin double Returns Vec3d GetNormal() Gets the normal vector of the flat surface. Vec3d GetNormal() Returns Vec3d The unit normal vector" + }, + "api/Hi.Geom.IGenStl.html": { + "href": "api/Hi.Geom.IGenStl.html", + "title": "Interface IGenStl | HiAPI-C# 2025", + "summary": "Interface IGenStl Namespace Hi.Geom Assembly HiGeom.dll public interface IGenStl 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) Methods GenStl(IPolarResolution2d) Generate a new Stl. Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl" }, "api/Hi.Geom.IGeomProperty.html": { "href": "api/Hi.Geom.IGeomProperty.html", @@ -1364,26 +1359,26 @@ "title": "Interface IGetZrList | HiAPI-C# 2025", "summary": "Interface IGetZrList Namespace Hi.Geom Assembly HiGeom.dll Interface for getting a list of Z-R pairs. public interface IGetZrList Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) PairZrUtil.GetVolume(IGetZrList) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods GetZrList() Gets a list of Z-R coordinate pairs. List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates." }, - "api/Hi.Geom.ILinearAndRoundStlResolutionHost.html": { - "href": "api/Hi.Geom.ILinearAndRoundStlResolutionHost.html", - "title": "Interface ILinearAndRoundStlResolutionHost | HiAPI-C# 2025", - "summary": "Interface ILinearAndRoundStlResolutionHost Namespace Hi.Geom Assembly HiGeom.dll Interface for objects that control STL resolution parameters for both linear and angular measurements. public interface ILinearAndRoundStlResolutionHost 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) Properties AngleResolution_rad Gets or sets the angular resolution in radians. double AngleResolution_rad { get; set; } Property Value double LinearResolution_mm Gets or sets the linear resolution in millimeters. double LinearResolution_mm { get; set; } Property Value double" - }, "api/Hi.Geom.IStlSource.html": { "href": "api/Hi.Geom.IStlSource.html", "title": "Interface IStlSource | HiAPI-C# 2025", - "summary": "Interface IStlSource Namespace Hi.Geom Assembly HiGeom.dll Stl provider with xml support. public interface IStlSource : IGetStl, IMakeXmlSource Inherited Members IGetStl.GetStl() IMakeXmlSource.MakeXmlSource(string, string) Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) PairZrUtil.GetZrList(IGetStl) 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)" + "summary": "Interface IStlSource Namespace Hi.Geom Assembly HiGeom.dll Stl provider with xml support. public interface IStlSource : IGetStl, IMakeXmlSource Inherited Members IGetStl.GetStl() IMakeXmlSource.MakeXmlSource(string, string, bool) Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) PairZrUtil.GetZrList(IGetStl) 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)" }, "api/Hi.Geom.ITri3d.html": { "href": "api/Hi.Geom.ITri3d.html", "title": "Interface ITri3d | HiAPI-C# 2025", - "summary": "Interface ITri3d Namespace Hi.Geom Assembly HiGeom.dll Interface for 3D triangles. public interface ITri3d : IFlat3d, IExpandToBox3d Inherited Members IFlat3d.GetLocate() IFlat3d.GetNormal() IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods GeomUtil.GetBox3d(IExpandToBox3d) 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) Methods GetApex(int) Gets the specified vertex (apex) of this triangle. Vec3d GetApex(int i) Parameters i int Index of the vertex (0-2) Returns Vec3d The position of the specified vertex" + "summary": "Interface ITri3d Namespace Hi.Geom Assembly HiGeom.dll Interface for 3D triangles. public interface ITri3d : IFlat3d, IExpandToBox3d Inherited Members IFlat3d.GetDistanceToOrigin() IFlat3d.GetLocate() IFlat3d.GetNormal() IFlat3d.GetLocate(Vec3d, double) IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) 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) Methods GetApex(int) Gets the specified vertex (apex) of this triangle. Vec3d GetApex(int i) Parameters i int Index of the vertex (0-2) Returns Vec3d The position of the specified vertex" }, "api/Hi.Geom.IVec-1.html": { "href": "api/Hi.Geom.IVec-1.html", "title": "Interface IVec | HiAPI-C# 2025", "summary": "Interface IVec Namespace Hi.Geom Assembly HiGeom.dll Interface for vector types with generic element type. public interface IVec Type Parameters T The type of elements in the vector 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) Properties this[int] Gets or sets the element at the specified index. T this[int index] { get; set; } Parameters index int The zero-based index of the element to get or set. Property Value T The element at the specified index. Rank Dimension (i.e. Size) of the Vector. int Rank { get; } Property Value int" }, + "api/Hi.Geom.IZrListSourceProperty.html": { + "href": "api/Hi.Geom.IZrListSourceProperty.html", + "title": "Interface IZrListSourceProperty | HiAPI-C# 2025", + "summary": "Interface IZrListSourceProperty Namespace Hi.Geom Assembly HiGeom.dll public interface IZrListSourceProperty 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) Properties ZrListSource Func ZrListSource { get; set; } Property Value Func" + }, "api/Hi.Geom.Mat4d.IndexFlag.html": { "href": "api/Hi.Geom.Mat4d.IndexFlag.html", "title": "Enum Mat4d.IndexFlag | HiAPI-C# 2025", @@ -1412,17 +1407,17 @@ "api/Hi.Geom.NativeTopoStld.html": { "href": "api/Hi.Geom.NativeTopoStld.html", "title": "Class NativeTopoStld | HiAPI-C# 2025", - "summary": "Class NativeTopoStld Namespace Hi.Geom Assembly HiDisp.dll Native TopoStl with element type double. public class NativeTopoStld : IDisposable, IDisplayee, IExpandToBox3d Inheritance object NativeTopoStld Implements IDisposable IDisplayee IExpandToBox3d 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) Constructors NativeTopoStld(Stl) Initializes a new instance of the NativeTopoStld class. public NativeTopoStld(Stl stl) Parameters stl Stl The STL model to convert to a native topology. Properties CosRoundAngle Gets or sets the cosine of the angle used for rounding. public double CosRoundAngle { get; set; } Property Value double Size Gets the number of triangles in the native topology. public int Size { get; } Property Value int TopoStlPtr Gets the pointer to the native topology structure. public nint TopoStlPtr { get; } Property Value nint Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~NativeTopoStld() protected ~NativeTopoStld() GenStl() Generates an STL model from the native topology. public Stl GenStl() Returns Stl A new STL model." + "summary": "Class NativeTopoStld Namespace Hi.Geom Assembly HiDisp.dll Native TopoStl with element type double. public class NativeTopoStld : IDisposable, IDisplayee, IExpandToBox3d Inheritance object NativeTopoStld Implements IDisposable IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors NativeTopoStld(Stl) Initializes a new instance of the NativeTopoStld class. public NativeTopoStld(Stl stl) Parameters stl Stl The STL model to convert to a native topology. Properties CosRoundAngle Gets or sets the cosine of the angle used for rounding. public double CosRoundAngle { get; set; } Property Value double Size Gets the number of triangles in the native topology. public int Size { get; } Property Value int TopoStlPtr Gets the pointer to the native topology structure. public nint TopoStlPtr { get; } Property Value nint Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. DisplaySharpEdges(Bind) Renders only the edges of the topology. public void DisplaySharpEdges(Bind bind) Parameters bind Bind The binding context for rendering. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~NativeTopoStld() protected ~NativeTopoStld() GenStl() Generates an STL model from the native topology. public Stl GenStl() Returns Stl A new STL model." }, "api/Hi.Geom.NativeTopoStlfr.html": { "href": "api/Hi.Geom.NativeTopoStlfr.html", "title": "Class NativeTopoStlfr | HiAPI-C# 2025", - "summary": "Class NativeTopoStlfr Namespace Hi.Geom Assembly HiDisp.dll Native TopoStl with element type fraction. public class NativeTopoStlfr : IDisposable, IDisplayee, IExpandToBox3d Inheritance object NativeTopoStlfr Implements IDisposable IDisplayee IExpandToBox3d 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) Constructors NativeTopoStlfr(Stl, double) Initializes a new instance of the NativeTopoStlfr class. public NativeTopoStlfr(Stl stl, double fractionTolerance) Parameters stl Stl The STL model to convert to a native topology. fractionTolerance double The tolerance for fraction calculations. Properties Size Gets the number of triangles in the native topology. public int Size { get; } Property Value int TopoStlPtr Gets the pointer to the native topology structure. public nint TopoStlPtr { get; } Property Value nint Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~NativeTopoStlfr() protected ~NativeTopoStlfr() GenStl() Generates an STL model from the native topology. public Stl GenStl() Returns Stl A new STL model." + "summary": "Class NativeTopoStlfr Namespace Hi.Geom Assembly HiDisp.dll Native TopoStl with element type fraction. public class NativeTopoStlfr : IDisposable, IDisplayee, IExpandToBox3d Inheritance object NativeTopoStlfr Implements IDisposable IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors NativeTopoStlfr(Stl, double) Initializes a new instance of the NativeTopoStlfr class. public NativeTopoStlfr(Stl stl, double fractionTolerance) Parameters stl Stl The STL model to convert to a native topology. fractionTolerance double The tolerance for fraction calculations. Properties Size Gets the number of triangles in the native topology. public int Size { get; } Property Value int TopoStlPtr Gets the pointer to the native topology structure. public nint TopoStlPtr { get; } Property Value nint Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ~NativeTopoStlfr() protected ~NativeTopoStlfr() GenStl() Generates an STL model from the native topology. public Stl GenStl() Returns Stl A new STL model." }, "api/Hi.Geom.PairZr.html": { "href": "api/Hi.Geom.PairZr.html", "title": "Class PairZr | HiAPI-C# 2025", - "summary": "Class PairZr Namespace Hi.Geom Assembly HiGeom.dll Value pair of Z and R. public class PairZr : IMakeXmlSource, IExpandToBox3d, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IDivisionOperators Inheritance object PairZr Implements IMakeXmlSource IExpandToBox3d IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IDivisionOperators Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) GeomUtil.GetBox3d(IExpandToBox3d) 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) Constructors PairZr() Ctor. public PairZr() PairZr(PairZr) Copy ctor. public PairZr(PairZr src) Parameters src PairZr PairZr(double, double) Ctor. public PairZr(double z, double r) Parameters z double see Z r double see R PairZr(string) Ctor. public PairZr(string src) Parameters src string PairZr(XElement) Ctor. public PairZr(XElement src) Parameters src XElement XML Properties R R value. public double R { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Z Z value. public double Z { get; set; } Property Value double ZR (x,y)=(z,r). public Vec2d ZR { get; set; } Property Value Vec2d Methods Equals(PairZr) public bool Equals(PairZr other) Parameters other PairZr Returns bool 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenCircle(int) Generates a collection of Vec3d points forming a circle at the Z coordinate with radius R. public IEnumerable GenCircle(int posNum) Parameters posNum int The number of points to generate around the circle Returns IEnumerable An enumerable collection of Vec3d points GenPolarCircle(int) Generates a collection of Polar3d points forming a circle at the Z coordinate with radius R. public IEnumerable GenPolarCircle(int posNum) Parameters posNum int The number of points to generate around the circle Returns IEnumerable An enumerable collection of Polar3d points GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Operators operator +(PairZr, PairZr) Addition operator that adds two PairZr instances. public static PairZr operator +(PairZr left, PairZr right) Parameters left PairZr The left operand right PairZr The right operand Returns PairZr A new PairZr instance with the sum of Z and R values operator /(PairZr, double) Division operator that divides a PairZr instance by a scalar value. public static PairZr operator /(PairZr left, double right) Parameters left PairZr The PairZr instance right double The scalar value Returns PairZr A new PairZr instance with Z and R values divided by the scalar operator ==(PairZr, PairZr) Equality operator that compares two PairZr instances. public static bool operator ==(PairZr left, PairZr right) Parameters left PairZr The left operand right PairZr The right operand Returns bool True if both instances are equal; otherwise, false operator !=(PairZr, PairZr) Inequality operator that compares two PairZr instances. public static bool operator !=(PairZr left, PairZr right) Parameters left PairZr The left operand right PairZr The right operand Returns bool True if the instances are not equal; otherwise, false operator *(PairZr, double) Multiplication operator that multiplies a PairZr instance by a scalar value. public static PairZr operator *(PairZr left, double right) Parameters left PairZr The PairZr instance right double The scalar value Returns PairZr A new PairZr instance with Z and R values multiplied by the scalar operator -(PairZr, PairZr) Subtraction operator that subtracts one PairZr instance from another. public static PairZr operator -(PairZr a, PairZr b) Parameters a PairZr The left operand b PairZr The right operand to subtract Returns PairZr A new PairZr instance with the difference of Z and R values" + "summary": "Class PairZr Namespace Hi.Geom Assembly HiGeom.dll Value pair of Z and R. public class PairZr : IMakeXmlSource, IExpandToBox3d, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IDivisionOperators, IFormattable Inheritance object PairZr Implements IMakeXmlSource IExpandToBox3d IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IDivisionOperators IFormattable Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) 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) Constructors PairZr() Ctor. public PairZr() PairZr(PairZr) Copy ctor. public PairZr(PairZr src) Parameters src PairZr PairZr(double, double) Ctor. public PairZr(double z, double r) Parameters z double see Z r double see R PairZr(string) Ctor. public PairZr(string src) Parameters src string PairZr(XElement) Ctor. public PairZr(XElement src) Parameters src XElement XML Properties R R value. public double R { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Z Z value. public double Z { get; set; } Property Value double ZR (x,y)=(z,r). public Vec2d ZR { get; set; } Property Value Vec2d Methods Equals(PairZr) public bool Equals(PairZr other) Parameters other PairZr Returns bool 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenCircle(int) Generates a collection of Vec3d points forming a circle at the Z coordinate with radius R. public IEnumerable GenCircle(int posNum) Parameters posNum int The number of points to generate around the circle Returns IEnumerable An enumerable collection of Vec3d points GenPolarCircle(int) Generates a collection of Polar3d points forming a circle at the Z coordinate with radius R. public IEnumerable GenPolarCircle(int posNum) Parameters posNum int The number of points to generate around the circle Returns IEnumerable An enumerable collection of Polar3d points 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. ToString(string, IFormatProvider) Returns a string representation of the PairZr formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the PairZr Operators operator +(PairZr, PairZr) Addition operator that adds two PairZr instances. public static PairZr operator +(PairZr left, PairZr right) Parameters left PairZr The left operand right PairZr The right operand Returns PairZr A new PairZr instance with the sum of Z and R values operator /(PairZr, double) Division operator that divides a PairZr instance by a scalar value. public static PairZr operator /(PairZr left, double right) Parameters left PairZr The PairZr instance right double The scalar value Returns PairZr A new PairZr instance with Z and R values divided by the scalar operator ==(PairZr, PairZr) Equality operator that compares two PairZr instances. public static bool operator ==(PairZr left, PairZr right) Parameters left PairZr The left operand right PairZr The right operand Returns bool True if both instances are equal; otherwise, false operator !=(PairZr, PairZr) Inequality operator that compares two PairZr instances. public static bool operator !=(PairZr left, PairZr right) Parameters left PairZr The left operand right PairZr The right operand Returns bool True if the instances are not equal; otherwise, false operator *(PairZr, double) Multiplication operator that multiplies a PairZr instance by a scalar value. public static PairZr operator *(PairZr left, double right) Parameters left PairZr The PairZr instance right double The scalar value Returns PairZr A new PairZr instance with Z and R values multiplied by the scalar operator -(PairZr, PairZr) Subtraction operator that subtracts one PairZr instance from another. public static PairZr operator -(PairZr a, PairZr b) Parameters a PairZr The left operand b PairZr The right operand to subtract Returns PairZr A new PairZr instance with the difference of Z and R values" }, "api/Hi.Geom.PairZrUtil.html": { "href": "api/Hi.Geom.PairZrUtil.html", @@ -1432,7 +1427,32 @@ "api/Hi.Geom.Polar3d.html": { "href": "api/Hi.Geom.Polar3d.html", "title": "Class Polar3d | HiAPI-C# 2025", - "summary": "Class Polar3d Namespace Hi.Geom Assembly HiGeom.dll Represents a point in 3D space using polar coordinates public class Polar3d : IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IDivisionOperators, ICsvRowIo Inheritance object Polar3d Implements IAdditionOperators ISubtractionOperators IMultiplyOperators IDivisionOperators ICsvRowIo 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Polar3d() Ctor. public Polar3d() Polar3d(Polar3d) Copy constructor public Polar3d(Polar3d src) Parameters src Polar3d The source Polar3d object to copy Polar3d(Vec3d) Ctor. public Polar3d(Vec3d src) Parameters src Vec3d src Polar3d(double, double, double) Ctor. public Polar3d(double r, double angle_rad, double z) Parameters r double r angle_rad double angle_rad z double z Polar3d(BinaryReader) Ctor by bytes: r = reader.ReadDouble(); angle = reader.ReadDouble(); z = reader.ReadDouble(); public Polar3d(BinaryReader reader) Parameters reader BinaryReader reader Polar3d(string) Ctor by string. The format is (r,angle_rad,z). public Polar3d(string src) Parameters src string src Fields angle_rad Angle in radian. public double angle_rad Field Value double r Radius. public double r Field Value double z Height. public double z Field Value double Properties Angle_deg Angle in degree. public double Angle_deg { get; set; } Property Value double Angle_rad Angle in radian. public double Angle_rad { get; set; } Property Value double CsvText Csv text. public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. public string CsvTitleText { get; } Property Value string IsAllFinite public bool IsAllFinite { get; } Property Value bool Is r,angle_rad,z all finite. IsAllNaN public bool IsAllNaN { get; } Property Value bool is r,angle_rad,z all NaN. IsAnyNaN public bool IsAnyNaN { get; } Property Value bool Is any of {r,angle_rad,z} NaN. NaN public static Polar3d NaN { get; } Property Value Polar3d Generate Polar3d(double.NaN, double.NaN, double.NaN). NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(double) * 3. R Radius. public double R { get; set; } Property Value double StaticCsvTitleText Gets the CSV column headers for Polar3d objects public static string StaticCsvTitleText { get; } Property Value string Text Gets or sets the text representation of this Polar3d object public string Text { get; set; } Property Value string Z Height. public double Z { get; set; } Property Value double Zero public static Polar3d Zero { get; } Property Value Polar3d Generate Polar3d(0, 0, 0). Methods Dot(Polar3d) this dot src. public double Dot(Polar3d src) Parameters src Polar3d src Returns double dotted value Equals(Polar3d) public bool Equals(Polar3d other) Parameters other Polar3d Returns bool 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. ExpandToBox3d(Box3d) public void ExpandToBox3d(Box3d dst) Parameters dst Box3d GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Interpolate(Polar3d, Polar3d, double) Interpolate from a to b with ratio alpha:(1-alpha). public static Polar3d Interpolate(Polar3d a, Polar3d b, double alpha) Parameters a Polar3d a b Polar3d b alpha double ratio Returns Polar3d a * (1 - alpha) + b * alpha Parse(string) If src is not null and not empty string, return Polar3d(string); otherwise return null. public static Polar3d Parse(string src) Parameters src string src Returns Polar3d parsed Polar3d ReadBin(BinaryReader) public void ReadBin(BinaryReader reader) Parameters reader BinaryReader Set(Polar3d) Set values by copy. public Polar3d Set(Polar3d src) Parameters src Polar3d src Returns Polar3d this Set(double, double, double) Set values. public Polar3d Set(double r, double angle_rad, double z) Parameters r double r angle_rad double angle_rad z double z Returns Polar3d this Set(double[]) Set values by array. public Polar3d Set(double[] src) Parameters src double[] double[]{r,angle_rad,z} Returns Polar3d this SetEachNanToZero() Set NaN to 0 for each value. public Polar3d SetEachNanToZero() Returns Polar3d this ToArray() return new double[] { r, angle_rad, z } public double[] ToArray() Returns double[] { r, angle_rad, z } ToBuf(double[]) Set r,angle_rad,z to the dst array. public void ToBuf(double[] dst) Parameters dst double[] dst ToBuf(double[], ref int) Set r,angle_rad,z to the dst array from postion p and increase p by the pushed number. public int ToBuf(double[] dst, ref int p) Parameters dst double[] dst p int position from dst Returns int Which is pushed number of double ToString() To representative string with format:(r,angle_rad,z). public override string ToString() Returns string Representative string ToString(string) To string with format: (r,angle_rad,z) public string ToString(string format) Parameters format string format of ToString(string) Returns string Representative string TryParse(string, out Polar3d) Attempts to parse a string into a Polar3d object public static bool TryParse(string src, out Polar3d dst) Parameters src string The string to parse dst Polar3d When this method returns, contains the Polar3d object if parsing succeeded, or null if parsing failed Returns bool true if parsing succeeded; otherwise, false WriteBin(BinaryWriter) Output to bytes: writer.Write(r); writer.Write(angle); writer.Write(z); public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer Operators operator +(Polar3d, Polar3d) Plus. public static Polar3d operator +(Polar3d a, Polar3d b) Parameters a Polar3d a b Polar3d b Returns Polar3d new Polar3d(a.r + b.r, a.angle_rad + b.angle_rad, a.z + b.z) operator /(Polar3d, double) Get a new object from a scaled by 1/d. public static Polar3d operator /(Polar3d a, double d) Parameters a Polar3d a d double denominator Returns Polar3d result operator *(Polar3d, double) Scale a by s. public static Polar3d operator *(Polar3d a, double s) Parameters a Polar3d vector s double scale Returns Polar3d new Polar3d(a.r * s, a.angle_rad * s, a.z * s) operator -(Polar3d, Polar3d) Minus. public static Polar3d operator -(Polar3d a, Polar3d b) Parameters a Polar3d a b Polar3d b Returns Polar3d new Polar3d(a.r - b.r, a.angle_rad - b.angle_rad, a.z - b.z) operator -(Polar3d) Get negate vector. public static Polar3d operator -(Polar3d src) Parameters src Polar3d src Returns Polar3d new Polar3d(-src.r, -src.angle_rad, -src.z)" + "summary": "Class Polar3d Namespace Hi.Geom Assembly HiGeom.dll Represents a point in 3D space using polar coordinates public class Polar3d : IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IDivisionOperators, ICsvRowIo, IFormattable Inheritance object Polar3d Implements IAdditionOperators ISubtractionOperators IMultiplyOperators IDivisionOperators ICsvRowIo IFormattable 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Polar3d() Ctor. public Polar3d() Polar3d(Polar3d) Copy constructor public Polar3d(Polar3d src) Parameters src Polar3d The source Polar3d object to copy Polar3d(Vec3d) Ctor. public Polar3d(Vec3d src) Parameters src Vec3d src Polar3d(double, double, double) Ctor. public Polar3d(double r, double angle_rad, double z) Parameters r double r angle_rad double angle_rad z double z Polar3d(BinaryReader) Ctor by bytes: r = reader.ReadDouble(); angle = reader.ReadDouble(); z = reader.ReadDouble(); public Polar3d(BinaryReader reader) Parameters reader BinaryReader reader Polar3d(string) Ctor by string. The format is (r,angle_rad,z). public Polar3d(string src) Parameters src string src Fields angle_rad Angle in radian. public double angle_rad Field Value double r Radius. public double r Field Value double z Height. public double z Field Value double Properties Angle_deg Angle in degree. public double Angle_deg { get; set; } Property Value double Angle_rad Angle in radian. public double Angle_rad { get; set; } Property Value double CsvText Csv text. public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. public string CsvTitleText { get; } Property Value string IsAllFinite public bool IsAllFinite { get; } Property Value bool Is r,angle_rad,z all finite. IsAllNaN public bool IsAllNaN { get; } Property Value bool is r,angle_rad,z all NaN. IsAnyNaN public bool IsAnyNaN { get; } Property Value bool Is any of {r,angle_rad,z} NaN. NaN public static Polar3d NaN { get; } Property Value Polar3d Generate Polar3d(double.NaN, double.NaN, double.NaN). NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(double) * 3. R Radius. public double R { get; set; } Property Value double StaticCsvTitleText Gets the CSV column headers for Polar3d objects public static string StaticCsvTitleText { get; } Property Value string Text Gets or sets the text representation of this Polar3d object public string Text { get; set; } Property Value string Z Height. public double Z { get; set; } Property Value double Zero public static Polar3d Zero { get; } Property Value Polar3d Generate Polar3d(0, 0, 0). Methods Dot(Polar3d) this dot src. public double Dot(Polar3d src) Parameters src Polar3d src Returns double dotted value Equals(Polar3d) public bool Equals(Polar3d other) Parameters other Polar3d Returns bool 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. ExpandToBox3d(Box3d) public void ExpandToBox3d(Box3d dst) Parameters dst Box3d GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Interpolate(Polar3d, Polar3d, double) Interpolate from a to b with ratio alpha:(1-alpha). public static Polar3d Interpolate(Polar3d a, Polar3d b, double alpha) Parameters a Polar3d a b Polar3d b alpha double ratio Returns Polar3d a * (1 - alpha) + b * alpha Parse(string) If src is not null and not empty string, return Polar3d(string); otherwise return null. public static Polar3d Parse(string src) Parameters src string src Returns Polar3d parsed Polar3d ReadBin(BinaryReader) public void ReadBin(BinaryReader reader) Parameters reader BinaryReader Set(Polar3d) Set values by copy. public Polar3d Set(Polar3d src) Parameters src Polar3d src Returns Polar3d this Set(double, double, double) Set values. public Polar3d Set(double r, double angle_rad, double z) Parameters r double r angle_rad double angle_rad z double z Returns Polar3d this Set(double[]) Set values by array. public Polar3d Set(double[] src) Parameters src double[] double[]{r,angle_rad,z} Returns Polar3d this SetEachNanToZero() Set NaN to 0 for each value. public Polar3d SetEachNanToZero() Returns Polar3d this ToArray() return new double[] { r, angle_rad, z } public double[] ToArray() Returns double[] { r, angle_rad, z } ToBuf(double[]) Set r,angle_rad,z to the dst array. public void ToBuf(double[] dst) Parameters dst double[] dst ToBuf(double[], ref int) Set r,angle_rad,z to the dst array from postion p and increase p by the pushed number. public int ToBuf(double[] dst, ref int p) Parameters dst double[] dst p int position from dst Returns int Which is pushed number of double ToString() To representative string with format:(r,angle_rad,z). public override string ToString() Returns string Representative string ToString(string) To string with format: (r,angle_rad,z) public string ToString(string format) Parameters format string format of ToString(string) Returns string Representative string ToString(string, IFormatProvider) Returns a string representation of the polar coordinates formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the polar coordinates TryParse(string, out Polar3d) Attempts to parse a string into a Polar3d object public static bool TryParse(string src, out Polar3d dst) Parameters src string The string to parse dst Polar3d When this method returns, contains the Polar3d object if parsing succeeded, or null if parsing failed Returns bool true if parsing succeeded; otherwise, false WriteBin(BinaryWriter) Output to bytes: writer.Write(r); writer.Write(angle); writer.Write(z); public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer Operators operator +(Polar3d, Polar3d) Plus. public static Polar3d operator +(Polar3d a, Polar3d b) Parameters a Polar3d a b Polar3d b Returns Polar3d new Polar3d(a.r + b.r, a.angle_rad + b.angle_rad, a.z + b.z) operator /(Polar3d, double) Get a new object from a scaled by 1/d. public static Polar3d operator /(Polar3d a, double d) Parameters a Polar3d a d double denominator Returns Polar3d result operator *(Polar3d, double) Scale a by s. public static Polar3d operator *(Polar3d a, double s) Parameters a Polar3d vector s double scale Returns Polar3d new Polar3d(a.r * s, a.angle_rad * s, a.z * s) operator -(Polar3d, Polar3d) Minus. public static Polar3d operator -(Polar3d a, Polar3d b) Parameters a Polar3d a b Polar3d b Returns Polar3d new Polar3d(a.r - b.r, a.angle_rad - b.angle_rad, a.z - b.z) operator -(Polar3d) Get negate vector. public static Polar3d operator -(Polar3d src) Parameters src Polar3d src Returns Polar3d new Polar3d(-src.r, -src.angle_rad, -src.z)" + }, + "api/Hi.Geom.Resolution.IPolarResolution2d.html": { + "href": "api/Hi.Geom.Resolution.IPolarResolution2d.html", + "title": "Interface IPolarResolution2d | HiAPI-C# 2025", + "summary": "Interface IPolarResolution2d Namespace Hi.Geom.Resolution Assembly HiGeom.dll Interface for objects that control STL resolution parameters for both linear and angular measurements. public interface IPolarResolution2d 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) Properties AngleResolution_deg Gets or sets the angular resolution in degrees. double AngleResolution_deg { get; set; } Property Value double AngleResolution_rad Gets or sets the angular resolution in radians. double AngleResolution_rad { get; set; } Property Value double LinearResolution_mm Gets or sets the linear resolution in millimeters. double LinearResolution_mm { get; set; } Property Value double" + }, + "api/Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html": { + "href": "api/Hi.Geom.Resolution.IPolarResolution2dSourceProperty.html", + "title": "Interface IPolarResolution2dSourceProperty | HiAPI-C# 2025", + "summary": "Interface IPolarResolution2dSourceProperty Namespace Hi.Geom.Resolution Assembly HiGeom.dll public interface IPolarResolution2dSourceProperty 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) Properties PolarResolution2dSource Func PolarResolution2dSource { get; set; } Property Value Func" + }, + "api/Hi.Geom.Resolution.PolarResolution2d.html": { + "href": "api/Hi.Geom.Resolution.PolarResolution2d.html", + "title": "Class PolarResolution2d | HiAPI-C# 2025", + "summary": "Class PolarResolution2d Namespace Hi.Geom.Resolution Assembly HiGeom.dll public class PolarResolution2d : IPolarResolution2d, IMakeXmlSource, IToXElement Inheritance object PolarResolution2d Implements IPolarResolution2d IMakeXmlSource IToXElement Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) 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) Constructors PolarResolution2d() public PolarResolution2d() PolarResolution2d(double, double) public PolarResolution2d(double linearResolution_mm, double angleResolution_rad) Parameters linearResolution_mm double angleResolution_rad double PolarResolution2d(XElement) Initializes a new instance of the PolarResolution2d class from XML data. public PolarResolution2d(XElement src) Parameters src XElement The XML element containing polar resolution data. Properties AngleResolution_deg Gets or sets the angular resolution in degrees. public double AngleResolution_deg { get; set; } Property Value double AngleResolution_rad Gets or sets the angular resolution in radians. public double AngleResolution_rad { get; set; } Property Value double LinearResolution_mm Gets or sets the linear resolution in millimeters. public double LinearResolution_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." + }, + "api/Hi.Geom.Resolution.html": { + "href": "api/Hi.Geom.Resolution.html", + "title": "Namespace Hi.Geom.Resolution | HiAPI-C# 2025", + "summary": "Namespace Hi.Geom.Resolution Classes PolarResolution2d Interfaces IPolarResolution2d Interface for objects that control STL resolution parameters for both linear and angular measurements. IPolarResolution2dSourceProperty" + }, + "api/Hi.Geom.Segment3d.html": { + "href": "api/Hi.Geom.Segment3d.html", + "title": "Class Segment3d | HiAPI-C# 2025", + "summary": "Class Segment3d Namespace Hi.Geom Assembly HiGeom.dll Represents a 3D line segment defined by two endpoints. public class Segment3d : IExpandToBox3d, IEquatable, IBinaryIo, IWriteBin, IEnumerable, IEnumerable Inheritance object Segment3d Implements IExpandToBox3d IEquatable IBinaryIo IWriteBin IEnumerable IEnumerable Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) EnumerableUtil.GetIntensiveItems(IEnumerable, double, Func) MathUtil.Average(IEnumerable) MathUtil.Sum(IEnumerable) Tri3dUtil.GenTrisByFan(IEnumerable, Vec3d) StringUtil.ToDotSplitedString(IEnumerable) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Segment3d() public Segment3d() Segment3d(Vec3d, Vec3d) public Segment3d(Vec3d begin, Vec3d end) Parameters begin Vec3d end Vec3d Properties Arrow Gets the arrow vector from Begin to End. public Vec3d Arrow { get; } Property Value Vec3d Begin public Vec3d Begin { get; set; } Property Value Vec3d Center Gets the midpoint of the segment. public Vec3d Center { get; } Property Value Vec3d End public Vec3d End { get; set; } Property Value Vec3d Length Gets the length of the segment. public double Length { get; } Property Value double LengthSquare public double LengthSquare { get; } Property Value double Methods ClosestPoint(Vec3d) Gets the closest point on the segment to the specified point. public Vec3d ClosestPoint(Vec3d point) Parameters point Vec3d Point to find closest point to. Returns Vec3d Closest point on the segment. Equals(Segment3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Segment3d other) Parameters other Segment3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetEnumerator() Returns an enumerator that iterates through the collection. public IEnumerator GetEnumerator() Returns IEnumerator An enumerator that can be used to iterate through the collection. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. PointAt(double) Gets a point on the segment at the specified parameter t (0 <= t <= 1). public Vec3d PointAt(double t) Parameters t double Parameter value between 0 and 1. Returns Vec3d Point on the segment. ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Swap() public void Swap() ToString() Returns a string representation of the segment. public override string ToString() Returns string WriteBin(BinaryWriter) Writes the object's data to a binary stream. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write to" }, "api/Hi.Geom.Solvers.BinarySolverUtil.html": { "href": "api/Hi.Geom.Solvers.BinarySolverUtil.html", @@ -1497,12 +1517,12 @@ "api/Hi.Geom.Stl.html": { "href": "api/Hi.Geom.Stl.html", "title": "Class Stl | HiAPI-C# 2025", - "summary": "Class Stl Namespace Hi.Geom Assembly HiGeom.dll STL (stereolithography). Composed by Triangles. Provide Stl File R/W. public class Stl : IGetStl, IExpandToBox3d Inheritance object Stl Implements IGetStl IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) 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) Constructors Stl(Box3d) Ctor by box. public Stl(Box3d box) Parameters box Box3d box Stl(Stl) Copy ctor. public Stl(Stl stl) Parameters stl Stl src stl Stl(params Stl[]) Ctor. Copy triangles from stls. public Stl(params Stl[] stls) Parameters stls Stl[] source stls Stl(IEnumerable) Ctor. The content of tris is copied by this.tris = new List(tris). public Stl(IEnumerable tris) Parameters tris IEnumerable triangles Stl(Stream, StlType) Ctor by stream. public Stl(Stream stream, Stl.StlType stlType = StlType.UNKNOWN) Parameters stream Stream stl data stream stlType Stl.StlType stl data format Stl(int) Ctor with preserved triangle grid capacity. public Stl(int cap = 16) Parameters cap int Preserved triangle grid capacity Stl(string, StlType) ctor by file. public Stl(string file, Stl.StlType stlType = StlType.UNKNOWN) Parameters file string stl file stlType Stl.StlType stl file format Properties Area Gets the total surface area of the STL model public double Area { get; } Property Value double Tris public List Tris { get; set; } Property Value List Triangle grid of this. Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object IsAscii(Stream) Is the stream ascii format stl. public static bool IsAscii(Stream stream) Parameters stream Stream stream Returns bool true if the stream is ascii format stl; otherwise, return false. IsAscii(string) Is the file ascii format stl. public static bool IsAscii(string file) Parameters file string file Returns bool true if the file is ascii format stl; otherwise, return false. ReBuildNormal() Re-build normal for all triangles. public void ReBuildNormal() Transform(Mat4d) Trasnform all the triangles by the given matrix. public Stl Transform(Mat4d mat) Parameters mat Mat4d matrix Returns Stl this WriteBin(BinaryWriter) Write this to the writer with binary format. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer WriteBin(string) Write this to the file with binary format. public void WriteBin(string file) Parameters file string dst file" + "summary": "Class Stl Namespace Hi.Geom Assembly HiGeom.dll STL (stereolithography). Composed by Triangles. Provide Stl File R/W. public class Stl : IGetStl, IExpandToBox3d Inheritance object Stl Implements IGetStl IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) 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) Constructors Stl(Box3d) Ctor by box. public Stl(Box3d box) Parameters box Box3d box Stl(Stl) Copy ctor. public Stl(Stl stl) Parameters stl Stl src stl Stl(params Stl[]) Ctor. Copy triangles from stls. public Stl(params Stl[] stls) Parameters stls Stl[] source stls Stl(IEnumerable) Ctor. The content of tris is copied by this.tris = new List(tris). public Stl(IEnumerable tris) Parameters tris IEnumerable triangles Stl(Stream, StlType) Ctor by stream. public Stl(Stream stream, Stl.StlType stlType = StlType.UNKNOWN) Parameters stream Stream stl data stream stlType Stl.StlType stl data format Stl(int) Ctor with preserved triangle grid capacity. public Stl(int cap = 16) Parameters cap int Preserved triangle grid capacity Stl(string, StlType) ctor by file. public Stl(string file, Stl.StlType stlType = StlType.UNKNOWN) Parameters file string stl file stlType Stl.StlType stl file format Properties Area Gets the total surface area of the STL model public double Area { get; } Property Value double Tris public List Tris { get; set; } Property Value List Triangle grid of this. Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object IsAscii(Stream) Is the stream ascii format stl. public static bool IsAscii(Stream stream) Parameters stream Stream stream Returns bool true if the stream is ascii format stl; otherwise, return false. IsAscii(string) Is the file ascii format stl. public static bool IsAscii(string file) Parameters file string file Returns bool true if the file is ascii format stl; otherwise, return false. ReBuildNormal() Re-build normal for all triangles. public void ReBuildNormal() Transform(Mat4d) Trasnform all the triangles by the given matrix. public Stl Transform(Mat4d mat) Parameters mat Mat4d matrix Returns Stl this WriteBin(BinaryWriter) Write this to the writer with binary format. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer WriteBin(string) Write this to the file with binary format. public void WriteBin(string file) Parameters file string dst file" }, "api/Hi.Geom.StlFile.html": { "href": "api/Hi.Geom.StlFile.html", "title": "Class StlFile | HiAPI-C# 2025", - "summary": "Class StlFile Namespace Hi.Geom Assembly HiGeom.dll Represents an STL file with loading and saving capabilities public class StlFile : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IDuplicate, ISourceFile Inheritance object StlFile Implements IStlSource IGetStl IMakeXmlSource IExpandToBox3d IDuplicate ISourceFile Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) 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) Constructors StlFile() Ctor. public StlFile() StlFile(string) Ctor. public StlFile(string filePath) Parameters filePath string file path StlFile(XElement, string) Ctor. public StlFile(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path Properties CacheStl CacheStl is loaded by the xml construtor. public Stl CacheStl { get; set; } Property Value Stl SourceFile Stl file path. public string SourceFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object LoadStlByFile(string) Loads an STL file from the specified base directory into the cache public Stl LoadStlByFile(string baseDirectory) Parameters baseDirectory string The base directory where the file is located Returns Stl The loaded STL object, or null if the file path is empty or loading fails MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Remarks if the file does not exist, the cached Stl will be saved; if the file existed, the file will not be overwrited. The mechanism is for multi-base-directory setting. SaveStlToFile(string) Saves the cached STL data to a file in the specified base directory public void SaveStlToFile(string baseDirectory) Parameters baseDirectory string The base directory where the file will be saved" + "summary": "Class StlFile Namespace Hi.Geom Assembly HiGeom.dll Represents an STL file with loading and saving capabilities public class StlFile : IStlSource, IGetStl, IMakeXmlSource, IExpandToBox3d, IDuplicate, ISourceFile Inheritance object StlFile Implements IStlSource IGetStl IMakeXmlSource IExpandToBox3d IDuplicate ISourceFile Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) PairZrUtil.GetZrList(IGetStl) 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) Constructors StlFile() Ctor. public StlFile() StlFile(string) Ctor. public StlFile(string filePath) Parameters filePath string file path StlFile(string, string) public StlFile(string filePath, string baseDirectory) Parameters filePath string baseDirectory string StlFile(XElement, string) Ctor. public StlFile(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path Properties CacheStl CacheStl is loaded by the xml construtor. public Stl CacheStl { get; set; } Property Value Stl SourceFile Stl file path. public string SourceFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object LoadStlByFile(string) Loads an STL file from the specified base directory into the cache public Stl LoadStlByFile(string baseDirectory) Parameters baseDirectory string The base directory where the file is located Returns Stl The loaded STL object, or null if the file path is empty or loading fails 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. SaveStlToFile(string) Saves the cached STL data to a file in the specified base directory public void SaveStlToFile(string baseDirectory) Parameters baseDirectory string The base directory where the file will be saved" }, "api/Hi.Geom.StlFuncHost.html": { "href": "api/Hi.Geom.StlFuncHost.html", @@ -1517,23 +1537,28 @@ "api/Hi.Geom.TransformationGeom.html": { "href": "api/Hi.Geom.TransformationGeom.html", "title": "Class TransformationGeom | HiAPI-C# 2025", - "summary": "Class TransformationGeom Namespace Hi.Geom Assembly HiMech.dll Represents a geometric transformation that can be applied to a geometry object. This class combines a transformer with a target geometry to produce transformed geometric results. public class TransformationGeom : IStlSource, IGetStl, IMakeXmlSource, IGeomProperty, IExpandToBox3d, IDuplicate Inheritance object TransformationGeom Implements IStlSource IGetStl IMakeXmlSource IGeomProperty IExpandToBox3d IDuplicate Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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 The TransformationGeom class provides functionality to: Apply geometric transformations to STL geometry Support XML serialization and deserialization Handle duplication of transformation configurations Manage transformation matrices and their application to geometry Constructors TransformationGeom() Initializes a new instance of the TransformationGeom class with default values. public TransformationGeom() TransformationGeom(IGetStl) Initializes a new instance of the TransformationGeom class with a specified geometry. public TransformationGeom(IGetStl geom) Parameters geom IGetStl The geometry object to be transformed. TransformationGeom(XElement, string) Initializes a new instance of the TransformationGeom class from XML data. public TransformationGeom(XElement src, string baseDirectory) Parameters src XElement The XML element containing the transformation data. baseDirectory string The base directory for resolving relative paths. Remarks This constructor deserializes both the transformer and geometry data from the provided XML. If either element is missing or invalid, the corresponding property will be null. Properties Geom Gets or sets the target geometry that will be transformed. public IGetStl Geom { get; set; } Property Value IGetStl Remarks This property represents the base geometry object that will have the transformation applied to it. If null, operations involving this geometry will return null results. Transformer Gets or sets the transformer that defines the geometric transformation. The transformation is applied from left (first element) to right (last element), with the target geometry being on the left side. public ITransformer Transformer { get; set; } Property Value ITransformer Remarks The transformer can be null, in which case no transformation is applied to the geometry. XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string The string “TransformationGeom”. Methods Duplicate(params object[]) Creates a deep copy of the current TransformationGeom instance. public object Duplicate(params object[] res) Parameters res object[] Additional resources for duplication (not used in current implementation). Returns object A new TransformationGeom instance with copied transformer and geometry data. Remarks The duplication process creates new instances of both the transformer and geometry objects if they implement the appropriate cloning interfaces. ExpandToBox3d(Box3d) Expands the given box to include the bounds of the transformed geometry. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand. Remarks This method updates the provided box to encompass the transformed geometry. If the geometry or its STL representation is null, no expansion occurs. GetStl() Gets the transformed STL representation of the geometry. public Stl GetStl() Returns Stl The transformed STL if both geometry and transformer are valid; the original STL if transformer is null; null if geometry is null or produces null STL. Remarks If the transformer is null, the method returns the untransformed geometry. If the geometry is null or produces a null STL, the method returns null. MakeXmlSource(string, string) Creates an XML representation of the current TransformationGeom instance. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths. relFile string The relative file path (not used in current implementation). Returns XElement An XElement containing the serialized data of this instance. Remarks The generated XML includes both the transformer and geometry data if they are available. Null properties are handled gracefully and will not cause errors in the XML generation." + "summary": "Class TransformationGeom Namespace Hi.Geom Assembly HiMech.dll Represents a geometric transformation that can be applied to a geometry object. This class combines a transformer with a target geometry to produce transformed geometric results. public class TransformationGeom : IStlSource, IGetStl, IMakeXmlSource, IGeomProperty, IGenStl, IExpandToBox3d, IDuplicate Inheritance object TransformationGeom Implements IStlSource IGetStl IMakeXmlSource IGeomProperty IGenStl IExpandToBox3d IDuplicate Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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 The TransformationGeom class provides functionality to: Apply geometric transformations to STL geometry Support XML serialization and deserialization Handle duplication of transformation configurations Manage transformation matrices and their application to geometry Constructors TransformationGeom() Initializes a new instance of the TransformationGeom class with default values. public TransformationGeom() TransformationGeom(IGetStl) Initializes a new instance of the TransformationGeom class with a specified geometry. public TransformationGeom(IGetStl geom) Parameters geom IGetStl The geometry object to be transformed. TransformationGeom(XElement, string) Initializes a new instance of the TransformationGeom class from XML data. public TransformationGeom(XElement src, string baseDirectory) Parameters src XElement The XML element containing the transformation data. baseDirectory string The base directory for resolving relative paths. Remarks This constructor deserializes both the transformer and geometry data from the provided XML. If either element is missing or invalid, the corresponding property will be null. Properties Geom Gets or sets the target geometry that will be transformed. public IGetStl Geom { get; set; } Property Value IGetStl Remarks This property represents the base geometry object that will have the transformation applied to it. If null, operations involving this geometry will return null results. Transformer Gets or sets the transformer that defines the geometric transformation. The transformation is applied from left (first element) to right (last element), with the target geometry being on the left side. public ITransformer Transformer { get; set; } Property Value ITransformer Remarks The transformer can be null, in which case no transformation is applied to the geometry. XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string The string “TransformationGeom”. Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object Remarks The duplication process creates new instances of both the transformer and geometry objects if they implement the appropriate cloning interfaces. ExpandToBox3d(Box3d) Expands the given box to include the bounds of the transformed geometry. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand. Remarks This method updates the provided box to encompass the transformed geometry. If the geometry or its STL representation is null, no expansion occurs. GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetStl() Gets the transformed STL representation of the geometry. public Stl GetStl() Returns Stl The transformed STL if both geometry and transformer are valid; the original STL if transformer is null; null if geometry is null or produces null STL. Remarks If the transformer is null, the method returns the untransformed geometry. If the geometry is null or produces a null STL, the method returns null. 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." }, "api/Hi.Geom.Tri3d.html": { "href": "api/Hi.Geom.Tri3d.html", "title": "Class Tri3d | HiAPI-C# 2025", - "summary": "Class Tri3d Namespace Hi.Geom Assembly HiGeom.dll Basic 3D Triangle. public class Tri3d : ITri3d, IFlat3d, IExpandToBox3d, IEquatable, IBinaryIo, IWriteBin Inheritance object Tri3d Implements ITri3d IFlat3d IExpandToBox3d IEquatable IBinaryIo IWriteBin Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) GeomUtil.GetBox3d(IExpandToBox3d) 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) Constructors Tri3d(ITri3d) Creates a triangle from an ITri3d interface public Tri3d(ITri3d t) Parameters t ITri3d The source triangle implementing ITri3d Tri3d(ITri3d, Mat4d) Creates a triangle from an ITri3d interface and transforms it using a matrix public Tri3d(ITri3d t, Mat4d mat) Parameters t ITri3d The source triangle implementing ITri3d mat Mat4d The transformation matrix to apply Tri3d(Tri3d, bool) Creates a triangle by copying or referencing another triangle public Tri3d(Tri3d t, bool useRef = false) Parameters t Tri3d The source triangle useRef bool If true, references to the source triangle's vertices and normal are used; otherwise, copies are created Tri3d(Vec3d, Vec3d, Vec3d) Ctor. public Tri3d(Vec3d p0, Vec3d p1, Vec3d p2) Parameters p0 Vec3d apex0 p1 Vec3d apex1 p2 Vec3d apex2 Tri3d(Vec3d, Vec3d, Vec3d, Vec3d) Creates a triangle with the specified vertices and normal vector public Tri3d(Vec3d p0, Vec3d p1, Vec3d p2, Vec3d n) Parameters p0 Vec3d First vertex p1 Vec3d Second vertex p2 Vec3d Third vertex n Vec3d Normal vector Tri3d(tri3d) Ctor. public Tri3d(tri3d src) Parameters src tri3d src Tri3d(bool) Ctor. public Tri3d(bool initAllMemberToNull = false) Parameters initAllMemberToNull bool If true, the three apexes and normal are null; otherwise, they are initialized by the default constructor of Vec3d. Tri3d(BinaryReader) Creates a triangle by reading its data from a binary reader public Tri3d(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Fields n normal vector of this triangle. public Vec3d n Field Value Vec3d ps Points. Three apexs. public Vec3d[] ps Field Value Vec3d[] Properties Area Gets the area of the triangle public double Area { get; } Property Value double NativeByteSize Native byte size. public static int NativeByteSize { get; } Property Value int Methods Equals(Tri3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Tri3d other) Parameters other Tri3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetApex(int) Gets the specified vertex (apex) of this triangle. public Vec3d GetApex(int i) Parameters i int Index of the vertex (0-2) Returns Vec3d The position of the specified vertex GetEdgeArrow(int) Gets the edge vector from vertex i to vertex i+1. public Vec3d GetEdgeArrow(int i) Parameters i int The index of the starting vertex (0, 1, or 2). Returns Vec3d The vector representing the edge. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetLocate() Gets an anchor point on this flat surface. public Vec3d GetLocate() Returns Vec3d A point on the flat surface GetNormal() Gets the normal vector of the flat surface. public Vec3d GetNormal() Returns Vec3d The unit normal vector GetRewind() Creates a new triangle with reversed vertex order and flipped normal public Tri3d GetRewind() Returns Tri3d A new triangle with reversed vertex order GetTransform(Mat4d) Creates a new triangle by transforming this triangle using the specified matrix. public Tri3d GetTransform(Mat4d mat) Parameters mat Mat4d The transformation matrix. Returns Tri3d A new transformed triangle. GetTranslate(Vec3d) Creates a new triangle by translating this triangle by the specified vector. public Tri3d GetTranslate(Vec3d v) Parameters v Vec3d The translation vector. Returns Tri3d A new translated triangle. GetTriSplition(double[], out Tri3d[], out Tri3d[]) Get triangles splition by pointWeights interpolation. negativeTris or positiveTris are null if no triangles generated. If all pointWeights is 0, no triangle generated. public void GetTriSplition(double[] pointWeights, out Tri3d[] positiveTris, out Tri3d[] negativeTris) Parameters pointWeights double[] weights of points positiveTris Tri3d[] triangles with positive or zero weight negativeTris Tri3d[] triangles with negative or zero weight ReBuildNormal() Rebuilds the normal vector of the triangle based on its vertices. public Vec3d ReBuildNormal() Returns Vec3d The rebuilt normal vector. ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Rewind() Reverses the order of the triangle's vertices, which flips the normal direction public void Rewind() Rotate(Vec3d, double) Rotates the triangle around the specified axis by the given angle. public Tri3d Rotate(Vec3d axis, double rad) Parameters axis Vec3d The axis of rotation. rad double The angle of rotation in radians. Returns Tri3d This triangle after rotation. Set(ITri3d) Sets this triangle's vertices and normal from an ITri3d interface public Tri3d Set(ITri3d t) Parameters t ITri3d The source triangle implementing ITri3d Returns Tri3d This triangle instance Set(ITri3d, Mat4d) Sets this triangle's vertices and normal from an ITri3d interface and transforms them using a matrix public Tri3d Set(ITri3d t, Mat4d mat) Parameters t ITri3d The source triangle implementing ITri3d mat Mat4d The transformation matrix to apply Returns Tri3d This triangle instance Set(Tri3d, bool) Sets this triangle's vertices and normal from another triangle public Tri3d Set(Tri3d t, bool useRef = false) Parameters t Tri3d The source triangle useRef bool If true, references to the source triangle's vertices and normal are used; otherwise, copies are created Returns Tri3d This triangle instance Set(Vec3d, Vec3d, Vec3d) Set value. public Tri3d Set(Vec3d p0, Vec3d p1, Vec3d p2) Parameters p0 Vec3d apex0 p1 Vec3d apex1 p2 Vec3d apex2 Returns Tri3d this Set(Vec3d, Vec3d, Vec3d, Vec3d) Sets the triangle's vertices and normal vector public Tri3d Set(Vec3d p0, Vec3d p1, Vec3d p2, Vec3d n) Parameters p0 Vec3d First vertex p1 Vec3d Second vertex p2 Vec3d Third vertex n Vec3d Normal vector Returns Tri3d This triangle instance SetOrderForward(int) Reorders the triangle's vertices to make the specified vertex the first one public void SetOrderForward(int index) Parameters index int The index of the vertex to make first (0, 1, or 2) ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Transform(Mat4d) Transforms the triangle using the specified transformation matrix. public Tri3d Transform(Mat4d mat) Parameters mat Mat4d The transformation matrix. Returns Tri3d This triangle after transformation. Translate(Vec3d) Translates the triangle by the specified vector. public Tri3d Translate(Vec3d v) Parameters v Vec3d The translation vector. Returns Tri3d This triangle after translation. Translate(double, double, double) Translates the triangle by the specified x, y, and z coordinates. public Tri3d Translate(double x, double y, double z) Parameters x double The x-coordinate of the translation. y double The y-coordinate of the translation. z double The z-coordinate of the translation. Returns Tri3d This triangle after translation. WriteBin(BinaryWriter) Writes the object's data to a binary stream. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write to" + "summary": "Class Tri3d Namespace Hi.Geom Assembly HiGeom.dll Basic 3D Triangle. public class Tri3d : ITri3d, IFlat3d, IExpandToBox3d, IEquatable, IBinaryIo, IWriteBin Inheritance object Tri3d Implements ITri3d IFlat3d IExpandToBox3d IEquatable IBinaryIo IWriteBin Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) 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) Constructors Tri3d(ITri3d) Creates a triangle from an ITri3d interface public Tri3d(ITri3d t) Parameters t ITri3d The source triangle implementing ITri3d Tri3d(ITri3d, Mat4d) Creates a triangle from an ITri3d interface and transforms it using a matrix public Tri3d(ITri3d t, Mat4d mat) Parameters t ITri3d The source triangle implementing ITri3d mat Mat4d The transformation matrix to apply Tri3d(Tri3d, bool) Creates a triangle by copying or referencing another triangle public Tri3d(Tri3d t, bool useRef = false) Parameters t Tri3d The source triangle useRef bool If true, references to the source triangle's vertices and normal are used; otherwise, copies are created Tri3d(Vec3d, Vec3d, Vec3d) Ctor. public Tri3d(Vec3d p0, Vec3d p1, Vec3d p2) Parameters p0 Vec3d apex0 p1 Vec3d apex1 p2 Vec3d apex2 Tri3d(Vec3d, Vec3d, Vec3d, Vec3d) Creates a triangle with the specified vertices and normal vector public Tri3d(Vec3d p0, Vec3d p1, Vec3d p2, Vec3d n) Parameters p0 Vec3d First vertex p1 Vec3d Second vertex p2 Vec3d Third vertex n Vec3d Normal vector Tri3d(tri3d) Ctor. public Tri3d(tri3d src) Parameters src tri3d src Tri3d(bool) Ctor. public Tri3d(bool initAllMemberToNull = false) Parameters initAllMemberToNull bool If true, the three apexes and normal are null; otherwise, they are initialized by the default constructor of Vec3d. Tri3d(BinaryReader) Creates a triangle by reading its data from a binary reader public Tri3d(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Fields n normal vector of this triangle. public Vec3d n Field Value Vec3d ps Points. Three apexs. public Vec3d[] ps Field Value Vec3d[] Properties Area Gets the area of the triangle public double Area { get; } Property Value double NativeByteSize Native byte size. public static int NativeByteSize { get; } Property Value int Methods Equals(Tri3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Tri3d other) Parameters other Tri3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetApex(int) Gets the specified vertex (apex) of this triangle. public Vec3d GetApex(int i) Parameters i int Index of the vertex (0-2) Returns Vec3d The position of the specified vertex GetDistanceToOrigin() Signed Distance To Origin. public double GetDistanceToOrigin() Returns double Signed Distance To Origin. GetEdgeArrow(int) Gets the edge vector from vertex i to vertex i+1. public Vec3d GetEdgeArrow(int i) Parameters i int The index of the starting vertex (0, 1, or 2). Returns Vec3d The vector representing the edge. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetLocate() Gets an anchor point on this flat surface. public Vec3d GetLocate() Returns Vec3d A point on the flat surface GetNormal() Gets the normal vector of the flat surface. public Vec3d GetNormal() Returns Vec3d The unit normal vector GetRewind() Creates a new triangle with reversed vertex order and flipped normal public Tri3d GetRewind() Returns Tri3d A new triangle with reversed vertex order GetSegmentsFromPlaneClip(IFlat3d) Gets the line segments resulting from intersecting this triangle with a clipping plane. public IEnumerable GetSegmentsFromPlaneClip(IFlat3d clipPlane) Parameters clipPlane IFlat3d The clipping plane Returns IEnumerable An enumerable of line segments representing the intersection GetTransform(Mat4d) Creates a new triangle by transforming this triangle using the specified matrix. public Tri3d GetTransform(Mat4d mat) Parameters mat Mat4d The transformation matrix. Returns Tri3d A new transformed triangle. GetTranslate(Vec3d) Creates a new triangle by translating this triangle by the specified vector. public Tri3d GetTranslate(Vec3d v) Parameters v Vec3d The translation vector. Returns Tri3d A new translated triangle. GetTriSplition(double[], out Tri3d[], out Tri3d[]) Get triangles splition by pointWeights interpolation. negativeTris or positiveTris are null if no triangles generated. If all pointWeights is 0, no triangle generated. public void GetTriSplition(double[] pointWeights, out Tri3d[] positiveTris, out Tri3d[] negativeTris) Parameters pointWeights double[] weights of points positiveTris Tri3d[] triangles with positive or zero weight negativeTris Tri3d[] triangles with negative or zero weight ReBuildNormal() Rebuilds the normal vector of the triangle based on its vertices. public Vec3d ReBuildNormal() Returns Vec3d The rebuilt normal vector. ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Rewind() Reverses the order of the triangle's vertices, which flips the normal direction public void Rewind() Rotate(Vec3d, double) Rotates the triangle around the specified axis by the given angle. public Tri3d Rotate(Vec3d axis, double rad) Parameters axis Vec3d The axis of rotation. rad double The angle of rotation in radians. Returns Tri3d This triangle after rotation. Set(ITri3d) Sets this triangle's vertices and normal from an ITri3d interface public Tri3d Set(ITri3d t) Parameters t ITri3d The source triangle implementing ITri3d Returns Tri3d This triangle instance Set(ITri3d, Mat4d) Sets this triangle's vertices and normal from an ITri3d interface and transforms them using a matrix public Tri3d Set(ITri3d t, Mat4d mat) Parameters t ITri3d The source triangle implementing ITri3d mat Mat4d The transformation matrix to apply Returns Tri3d This triangle instance Set(Tri3d, bool) Sets this triangle's vertices and normal from another triangle public Tri3d Set(Tri3d t, bool useRef = false) Parameters t Tri3d The source triangle useRef bool If true, references to the source triangle's vertices and normal are used; otherwise, copies are created Returns Tri3d This triangle instance Set(Vec3d, Vec3d, Vec3d) Set value. public Tri3d Set(Vec3d p0, Vec3d p1, Vec3d p2) Parameters p0 Vec3d apex0 p1 Vec3d apex1 p2 Vec3d apex2 Returns Tri3d this Set(Vec3d, Vec3d, Vec3d, Vec3d) Sets the triangle's vertices and normal vector public Tri3d Set(Vec3d p0, Vec3d p1, Vec3d p2, Vec3d n) Parameters p0 Vec3d First vertex p1 Vec3d Second vertex p2 Vec3d Third vertex n Vec3d Normal vector Returns Tri3d This triangle instance SetOrderForward(int) Reorders the triangle's vertices to make the specified vertex the first one public void SetOrderForward(int index) Parameters index int The index of the vertex to make first (0, 1, or 2) ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Transform(Mat4d) Transforms the triangle using the specified transformation matrix. public Tri3d Transform(Mat4d mat) Parameters mat Mat4d The transformation matrix. Returns Tri3d This triangle after transformation. Translate(Vec3d) Translates the triangle by the specified vector. public Tri3d Translate(Vec3d v) Parameters v Vec3d The translation vector. Returns Tri3d This triangle after translation. Translate(double, double, double) Translates the triangle by the specified x, y, and z coordinates. public Tri3d Translate(double x, double y, double z) Parameters x double The x-coordinate of the translation. y double The y-coordinate of the translation. z double The z-coordinate of the translation. Returns Tri3d This triangle after translation. WriteBin(BinaryWriter) Writes the object's data to a binary stream. public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter The binary writer to write to" }, "api/Hi.Geom.Tri3dUtil.html": { "href": "api/Hi.Geom.Tri3dUtil.html", "title": "Class Tri3dUtil | HiAPI-C# 2025", - "summary": "Class Tri3dUtil Namespace Hi.Geom Assembly HiGeom.dll Utility of Tri3d. Include generator of triangles from points. public static class Tri3dUtil Inheritance object Tri3dUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GenTrisByAlignedLists(IList, IList, IList) public static void GenTrisByAlignedLists(IList ps, IList rrps, IList dst) Parameters ps IList rrps IList dst IList GenTrisByAlignedLoops(IList, IList, IList) Generates triangles between two aligned loops of points. public static void GenTrisByAlignedLoops(IList ps, IList rrps, IList dst) Parameters ps IList First loop of points rrps IList Second loop of points dst IList The collection to add the generated triangles to GenTrisByFan(IEnumerable, Vec3d) Generates triangles in a fan pattern from a sequence of points. public static IEnumerable GenTrisByFan(this IEnumerable ps, Vec3d faceNormal = null) Parameters ps IEnumerable The sequence of points faceNormal Vec3d Optional face normal for the triangles Returns IEnumerable An enumerable of triangles forming a fan GenTrisByNumAlignment(List, List, IList) Generates triangles between two lists of points with different numbers of points. public static void GenTrisByNumAlignment(List psA, List psB, IList dst) Parameters psA List First list of points psB List Second list of points dst IList The collection to add the generated triangles to GenTrisByQuad(Vec3d, Vec3d, Vec3d, Vec3d, IList) Generates two triangles from a quadrilateral defined by four points. public static void GenTrisByQuad(Vec3d p0, Vec3d p1, Vec3d p2, Vec3d p3, IList dst) Parameters p0 Vec3d First point of the quadrilateral p1 Vec3d Second point of the quadrilateral p2 Vec3d Third point of the quadrilateral p3 Vec3d Fourth point of the quadrilateral dst IList The collection to add the generated triangles to GenTrisByStar(Vec3d, IList, IList) Generates triangles in a star pattern from a center point to a list of points. public static void GenTrisByStar(Vec3d starP, IList ps, IList dst) Parameters starP Vec3d The center point of the star ps IList The list of points forming the perimeter dst IList The collection to add the generated triangles to GenTrisByStar(IList, Vec3d, IList) Generates triangles in a star pattern from a list of points to a center point. public static void GenTrisByStar(IList ps, Vec3d starP, IList dst) Parameters ps IList The list of points forming the perimeter starP Vec3d The center point of the star dst IList The collection to add the generated triangles to" + "summary": "Class Tri3dUtil Namespace Hi.Geom Assembly HiGeom.dll Utility of Tri3d. Include generator of triangles from points. public static class Tri3dUtil Inheritance object Tri3dUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GenTrisByAlignedLists(IList, IList, IList) public static void GenTrisByAlignedLists(IList ps, IList rrps, IList dst) Parameters ps IList rrps IList dst IList GenTrisByAlignedLoops(IList, IList, IList) Generates triangles between two aligned loops of points. public static void GenTrisByAlignedLoops(IList ps, IList rrps, IList dst) Parameters ps IList First loop of points rrps IList Second loop of points dst IList The collection to add the generated triangles to GenTrisByFan(IEnumerable, Vec3d) Generates triangles in a fan pattern from a sequence of points. public static IEnumerable GenTrisByFan(this IEnumerable ps, Vec3d faceNormal = null) Parameters ps IEnumerable The sequence of points faceNormal Vec3d Optional face normal for the triangles Returns IEnumerable An enumerable of triangles forming a fan GenTrisByNumAlignment(List, List, IList) Generates triangles between two lists of points with different numbers of points. public static void GenTrisByNumAlignment(List psA, List psB, IList dst) Parameters psA List First list of points psB List Second list of points dst IList The collection to add the generated triangles to GenTrisByQuad(Vec3d, Vec3d, Vec3d, Vec3d, IList) Generates two triangles from a quadrilateral defined by four points. public static void GenTrisByQuad(Vec3d p0, Vec3d p1, Vec3d p2, Vec3d p3, IList dst) Parameters p0 Vec3d First point of the quadrilateral p1 Vec3d Second point of the quadrilateral p2 Vec3d Third point of the quadrilateral p3 Vec3d Fourth point of the quadrilateral dst IList The collection to add the generated triangles to GenTrisByStar(Vec3d, IList, IList) Generates triangles in a star pattern from a center point to a list of points. public static void GenTrisByStar(Vec3d starP, IList ps, IList dst) Parameters starP Vec3d The center point of the star ps IList The list of points forming the perimeter dst IList The collection to add the generated triangles to GenTrisByStar(IList, Vec3d, IList) Generates triangles in a star pattern from a list of points to a center point. public static void GenTrisByStar(IList ps, Vec3d starP, IList dst) Parameters ps IList The list of points forming the perimeter starP Vec3d The center point of the star dst IList The collection to add the generated triangles to GetSegmentsFromPlaneClip(IEnumerable, IFlat3d) Gets line segments resulting from intersecting triangles with a clipping plane. public static List GetSegmentsFromPlaneClip(this IEnumerable tris, IFlat3d clipPlane) Parameters tris IEnumerable The collection of triangles to clip clipPlane IFlat3d The clipping plane Returns List A list of line segments representing the intersection" }, "api/Hi.Geom.UnitUtils.PhysicsUnit.html": { "href": "api/Hi.Geom.UnitUtils.PhysicsUnit.html", "title": "Enum PhysicsUnit | HiAPI-C# 2025", "summary": "Enum PhysicsUnit Namespace Hi.Geom.UnitUtils Assembly HiMech.dll Represents physical units used in the system. [Flags] public enum PhysicsUnit Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) UnitConvertUtil.ToUnitString(PhysicsUnit) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields [StringValue(\"oC\")] C = mm3 | kJ Represents degrees Celsius (temperature measurement). [StringValue(\"J\")] J = deg | MPa Represents Joules (energy measurement). [StringValue(\"oK\")] K = deg | C Represents Kelvin (temperature measurement). [StringValue(\"MPa\")] MPa = sec | N Represents Megapascals (pressure measurement). [StringValue(\"N\")] N = mm3 | rpm Represents Newtons (force measurement). [StringValue(\"Nm\")] Nm = deg | N Represents Newton-meters (torque measurement). [StringValue(null)] None = 0 Represents no unit. [StringValue(\"deg\")] deg = 1 Represents degrees (angular measurement). [StringValue(\"g\")] g = sec | rpm Represents grams (mass measurement). [StringValue(\"kJ\")] kJ = 16 Represents kilojoules (energy measurement). [StringValue(\"kW\")] kW = deg | watt Represents kilowatts (power measurement). [StringValue(\"kWh\")] kWh = deg | kJ Represents kilowatt-hours (energy measurement). [StringValue(\"mg\")] mg = deg | g Represents milligrams (mass measurement). [StringValue(\"mm\")] mm = deg | sec Represents millimeters (length measurement). [StringValue(\"mm3\")] mm3 = 4 Represents cubic millimeters (volume measurement). [StringValue(\"mm3/s\")] mm3ds = deg | rpm Represents cubic millimeters per second (volume flow rate measurement). [StringValue(\"mm/min\")] mmdmin = deg | mmds Represents millimeters per minute (feed rate measurement). [StringValue(\"mm/s\")] mmds = sec | mm3 Represents millimeters per second (velocity measurement). [StringValue(\"rpm\")] rpm = 8 Represents revolutions per minute (rotational speed measurement). [StringValue(\"sec\")] sec = 2 Represents seconds (time measurement). [StringValue(\"um\")] um = deg | mm3 Represents micrometers (length measurement). [StringValue(\"watt\")] watt = sec | kJ Represents watts (power measurement)." }, + "api/Hi.Geom.UnitUtils.StringValueAttribute.html": { + "href": "api/Hi.Geom.UnitUtils.StringValueAttribute.html", + "title": "Class StringValueAttribute | HiAPI-C# 2025", + "summary": "Class StringValueAttribute Namespace Hi.Geom.UnitUtils Assembly HiMech.dll Attribute for associating a string value with an enum value or other element. public class StringValueAttribute : Attribute Inheritance object Attribute StringValueAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) 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) Constructors StringValueAttribute(string) Initializes a new instance of the StringValueAttribute class with the specified value. public StringValueAttribute(string value) Parameters value string The string value to associate with the element. Properties Value Gets or sets the string value associated with the element. public string Value { get; set; } Property Value string" + }, "api/Hi.Geom.UnitUtils.UnitConvertUtil.html": { "href": "api/Hi.Geom.UnitUtils.UnitConvertUtil.html", "title": "Class UnitConvertUtil | HiAPI-C# 2025", @@ -1542,7 +1567,7 @@ "api/Hi.Geom.UnitUtils.html": { "href": "api/Hi.Geom.UnitUtils.html", "title": "Namespace Hi.Geom.UnitUtils | HiAPI-C# 2025", - "summary": "Namespace Hi.Geom.UnitUtils Classes UnitConvertUtil Provides utility methods for converting between different physical units and their string representations. Enums PhysicsUnit Represents physical units used in the system." + "summary": "Namespace Hi.Geom.UnitUtils Classes StringValueAttribute Attribute for associating a string value with an enum value or other element. UnitConvertUtil Provides utility methods for converting between different physical units and their string representations. Enums PhysicsUnit Represents physical units used in the system." }, "api/Hi.Geom.UnnullableDVec3d.html": { "href": "api/Hi.Geom.UnnullableDVec3d.html", @@ -1552,17 +1577,17 @@ "api/Hi.Geom.Vec2d.html": { "href": "api/Hi.Geom.Vec2d.html", "title": "Class Vec2d | HiAPI-C# 2025", - "summary": "Class Vec2d Namespace Hi.Geom Assembly HiGeom.dll Basic 2D point (or vector). public class Vec2d : IExpandToBox2d, IEquatable, ICsvRowIo, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IDivisionOperators, IVec Inheritance object Vec2d Implements IExpandToBox2d IEquatable ICsvRowIo IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IDivisionOperators IVec 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Vec2d() Default constructor. Creates a vector with coordinates (0,0). public Vec2d() Vec2d(Vec2d) Copy ctor. public Vec2d(Vec2d src) Parameters src Vec2d src Vec2d(Vec2i) Creates a vector from Vec2i by converting integer coordinates to double. public Vec2d(Vec2i src) Parameters src Vec2i Source Vec2i vector with integer coordinates Vec2d(vec2d) ctor. public Vec2d(vec2d src) Parameters src vec2d src Vec2d(double, double) Ctor. public Vec2d(double x, double y) Parameters x double x y double y Vec2d(Func) Ctor using a function that maps direction index to value. public Vec2d(Func dirToValueFunc) Parameters dirToValueFunc Func Function that maps direction index to value Vec2d(BinaryReader) Ctor by bytes: x = reader.ReadDouble(); y = reader.ReadDouble(); public Vec2d(BinaryReader reader) Parameters reader BinaryReader reader Vec2d(int, double, double) Ctor by direction offset. Direction 0,1 indicate x,y respectively. public Vec2d(int dir, double a, double b) Parameters dir int direction offset a double value at direction (0+dir)%2 b double value at direction (1+dir)%2 Vec2d(string) Ctor by string. The format is (x,y). public Vec2d(string src) Parameters src string src Fields x Value at x direction. public double x Field Value double y Value at y direction. public double y Field Value double Properties AbsSum Sum of abs(x) and abs(y). public double AbsSum { get; } Property Value double AllOne Generate vec (1,1). public static Vec2d AllOne { get; } Property Value Vec2d (1,1) AmpPhase Create AmpPhase instance. public AmpPhase AmpPhase { get; } Property Value AmpPhase Angle_deg Angle in degree between vec(x,y) and vec(1,0). public double Angle_deg { get; } Property Value double Angle_rad Angle in radian between vec(x,y) and vec(1,0). public double Angle_rad { get; } Property Value double CsvText Csv text. public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. public string CsvTitleText { get; } Property Value string IsAllFinite public bool IsAllFinite { get; } Property Value bool Is x,y,z all finite. IsAllNaN public bool IsAllNaN { get; } Property Value bool is x,y all NaN. IsAllNegativeInfinity public bool IsAllNegativeInfinity { get; } Property Value bool is x,y all NegativeInfinity. IsAllPositiveInfinity public bool IsAllPositiveInfinity { get; } Property Value bool is x,y all PositiveInfinity. IsAnyFinite public bool IsAnyFinite { get; } Property Value bool Is at least one of x,y finite. IsAnyNaN Is any member nan. public bool IsAnyNaN { get; } Property Value bool IsZero public bool IsZero { get; } Property Value bool Is zero vector. Which is x == 0 && y == 0. this[int] Gets or sets the element at the specified index. public double this[int dir] { get; set; } Parameters dir int Property Value double The element at the specified index. Length Length. public double Length { get; } Property Value double LengthSquare Length square. public double LengthSquare { get; } Property Value double MaxAbsDir Get the direction of the max absolute value. public int MaxAbsDir { get; } Property Value int MaxDir Get the direction of the max value. public int MaxDir { get; } Property Value int MaxValue Get max value from {x,y}. public double MaxValue { get; } Property Value double MinDir Get the direction index with minimum value. If {x,y} is the smallest, return {0,1}. public int MinDir { get; } Property Value int MinValue Get min value from {x,y}. public double MinValue { get; } Property Value double NaN Generate NAN vec. public static Vec2d NaN { get; } Property Value Vec2d (nan,nan) NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(double) * 2. NegativeInfinity Generate negative infinity vec. public static Vec2d NegativeInfinity { get; } Property Value Vec2d (-inf,-inf) PositiveInfinity Generate positive infinity vec. public static Vec2d PositiveInfinity { get; } Property Value Vec2d (inf,inf) Rank Dimension (i.e. Size) of the Vector. public int Rank { get; } Property Value int UnitX Generate vec (1,0). public static Vec2d UnitX { get; } Property Value Vec2d (1,0) UnitY Generate vec (0,1). public static Vec2d UnitY { get; } Property Value Vec2d (0,1) X Gets or sets the X coordinate value. public double X { get; set; } Property Value double Y Gets or sets the Y coordinate value. public double Y { get; set; } Property Value double Zero Generate vec (0,0). public static Vec2d Zero { get; } Property Value Vec2d (0,0) Methods All(double) Generate Vec2d with all components set to the given value. public static Vec2d All(double v) Parameters v double Returns Vec2d At(int) Member at direction. public ref double At(int dir) Parameters dir int direction Returns double member Cross(Vec2d) Cross. public double Cross(Vec2d src) Parameters src Vec2d src Returns double cross value Dot(Vec2d) Dot. public double Dot(Vec2d src) Parameters src Vec2d src Returns double dotted value Equals(Vec2d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Vec2d other) Parameters other Vec2d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(Vec2d, double) check equals for each component with tolerance. public bool Equals(Vec2d other, double toleranceForEachComponent) Parameters other Vec2d other vec toleranceForEachComponent double tolerance for each component Returns bool check equals for each component with tolerance. 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. ExpandMax(Vec2d) Find and expand maximum values from src. public void ExpandMax(Vec2d src) Parameters src Vec2d src ExpandMin(Vec2d) Find and expand minimum values from src. public void ExpandMin(Vec2d src) Parameters src Vec2d src ExpandToBox2d(Box2d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox2d(Box2d dst) Parameters dst Box2d Destination box GenNaN() Generate NAN vec. public static Vec2d GenNaN() Returns Vec2d (nan,nan) GenNegativeInfinity() Generate negative infinity vec. public static Vec2d GenNegativeInfinity() Returns Vec2d (-inf,-inf) GenOne() Generate vec (1,1). public static Vec2d GenOne() Returns Vec2d (1,1) GenPositiveInfinity() Generate positive infinity vec. public static Vec2d GenPositiveInfinity() Returns Vec2d (inf,inf) GenUnitX() Generate vec (1,0). public static Vec2d GenUnitX() Returns Vec2d (1,0) GenUnitY() Generate vec (0,1). public static Vec2d GenUnitY() Returns Vec2d (0,1) GenZero() Generate vec (0,0). public static Vec2d GenZero() Returns Vec2d (0,0) GetCosSquareWith(Vec2d) Get Cos(theta)^2. theta is the angle between this and src. This function is faster than GetCosWith(Vec2d) since it lacks one square root operation. public double GetCosSquareWith(Vec2d src) Parameters src Vec2d one of edge vector Returns double Cos(theta)^2 GetCosWith(Vec2d) Get cos(angle). The angle is between v and this. public double GetCosWith(Vec2d v) Parameters v Vec2d v Returns double cos(angle) GetCsvText(string) Get CSV text with specified format. public string GetCsvText(string format) Parameters format string Format string for each component Returns string CSV formatted string GetEachValueAbs() Get a new vector with each value set to its absolute value. public Vec2d GetEachValueAbs() Returns Vec2d A new vector with absolute values GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetMulEach(Vec2d) Get a new vector with each component multiplied with the corresponding component of the given vector. public Vec2d GetMulEach(Vec2d vec) Parameters vec Vec2d The vector to multiply with Returns Vec2d A new vector with multiplied components GetNormalized() Generate normalized vec. public Vec2d GetNormalized() Returns Vec2d Normalized vec GetRadian(Vec2d) Get angle between this and v. The angle has no sign. This vector is not required to be an unit vector. public double GetRadian(Vec2d v) Parameters v Vec2d one of the edge vector. Not required to be an unit vector. Returns double Angle in radian GetTransform(Func) Get the new Vec2d by transforming each element by the function. public Vec2d GetTransform(Func transformingFunc) Parameters transformingFunc Func Returns Vec2d Interpolate(Vec2d, Vec2d, double) Linear interpolate between a and b. public static Vec2d Interpolate(Vec2d a, Vec2d b, double alpha) Parameters a Vec2d a b Vec2d b alpha double ratio Returns Vec2d interpolation IsNormalized(double) Check if this vector is normalized. public bool IsNormalized(double toleranceSquare = 1E-07) Parameters toleranceSquare double Tolerance for checking if length squared is 1 Returns bool True if the vector is normalized MulEach(Vec2d) Multiply each component with the corresponding component of the given vector. public Vec2d MulEach(Vec2d vec) Parameters vec Vec2d The vector to multiply with Returns Vec2d this Normalize() Normalize. public Vec2d Normalize() Returns Vec2d this Set(Vec2d) Set values by copy. public Vec2d Set(Vec2d src) Parameters src Vec2d src Returns Vec2d this Set(vec2d) Set values by copy. public Vec2d Set(vec2d src) Parameters src vec2d src Returns Vec2d this Set(double, double) Set values. public Vec2d Set(double x, double y) Parameters x double x y double y Returns Vec2d this Set(double[]) Set values by array. public Vec2d Set(double[] xy) Parameters xy double[] double[]{x,y} Returns Vec2d this Set(Func) Set values using a function that maps direction index and current value to new value. public Vec2d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that maps direction index and current value to new value Returns Vec2d this Set(Func) Set values using a function that maps direction index to value. public Vec2d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that maps direction index to value Returns Vec2d this Set(int, double, double) Set values by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec2d Set(int dir, double a, double b) Parameters dir int direction offset a double value at direction (0+dir)%2 b double value at direction (1+dir)%2 Returns Vec2d this SetEachNanToZero() Set NaN to 0 for each value. public Vec2d SetEachNanToZero() Returns Vec2d this SetEachValueAbs() Set all member to absolute value. public Vec2d SetEachValueAbs() Returns Vec2d this ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string) To string with format: (x,y) public string ToString(string format) Parameters format string Format string for the double values Returns string Formatted string representation of the vector ToString(string, int) Format the vector with padding. public string ToString(string format, int leftPadding) Parameters format string Format string for each component leftPadding int Left padding for each component Returns string Formatted string Transform(Func) Transform each element by the function. public Vec2d Transform(Func transformingFunc) Parameters transformingFunc Func Returns Vec2d WriteBin(BinaryWriter) Output to bytes: writer.Write(x); writer.Write(y); public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer Operators operator +(Vec2d, Vec2d) Plus. public static Vec2d operator +(Vec2d left, Vec2d right) Parameters left Vec2d a right Vec2d b Returns Vec2d a+b operator /(Vec2d, double) a/d. public static Vec2d operator /(Vec2d a, double d) Parameters a Vec2d a d double d Returns Vec2d a/d operator ==(Vec2d, Vec2d) Equality operator for comparing two Vec2d objects. public static bool operator ==(Vec2d left, Vec2d right) Parameters left Vec2d Left operand right Vec2d Right operand Returns bool True if the vectors are equal, false otherwise operator !=(Vec2d, Vec2d) Inequality operator for comparing two Vec2d objects. public static bool operator !=(Vec2d left, Vec2d right) Parameters left Vec2d Left operand right Vec2d Right operand Returns bool True if the vectors are not equal, false otherwise operator *(Vec2d, double) a*s. public static Vec2d operator *(Vec2d a, double s) Parameters a Vec2d a s double s Returns Vec2d a*s operator -(Vec2d, Vec2d) a-b. public static Vec2d operator -(Vec2d a, Vec2d b) Parameters a Vec2d a b Vec2d b Returns Vec2d a-b operator -(Vec2d) Negate. public static Vec2d operator -(Vec2d src) Parameters src Vec2d src Returns Vec2d Negate" + "summary": "Class Vec2d Namespace Hi.Geom Assembly HiGeom.dll Basic 2D point (or vector). public class Vec2d : IExpandToBox2d, IEquatable, ICsvRowIo, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IDivisionOperators, IVec, IFormattable Inheritance object Vec2d Implements IExpandToBox2d IEquatable ICsvRowIo IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IDivisionOperators IVec IFormattable 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Vec2d() Default constructor. Creates a vector with coordinates (0,0). public Vec2d() Vec2d(Vec2d) Copy ctor. public Vec2d(Vec2d src) Parameters src Vec2d src Vec2d(Vec2i) Creates a vector from Vec2i by converting integer coordinates to double. public Vec2d(Vec2i src) Parameters src Vec2i Source Vec2i vector with integer coordinates Vec2d(vec2d) ctor. public Vec2d(vec2d src) Parameters src vec2d src Vec2d(double, double) Ctor. public Vec2d(double x, double y) Parameters x double x y double y Vec2d(Func) Ctor using a function that maps direction index to value. public Vec2d(Func dirToValueFunc) Parameters dirToValueFunc Func Function that maps direction index to value Vec2d(BinaryReader) Ctor by bytes: x = reader.ReadDouble(); y = reader.ReadDouble(); public Vec2d(BinaryReader reader) Parameters reader BinaryReader reader Vec2d(int, double, double) Ctor by direction offset. Direction 0,1 indicate x,y respectively. public Vec2d(int dir, double a, double b) Parameters dir int direction offset a double value at direction (0+dir)%2 b double value at direction (1+dir)%2 Vec2d(string) Ctor by string. The format is (x,y). public Vec2d(string src) Parameters src string src Fields x Value at x direction. public double x Field Value double y Value at y direction. public double y Field Value double Properties AbsSum Sum of abs(x) and abs(y). public double AbsSum { get; } Property Value double AllOne Generate vec (1,1). public static Vec2d AllOne { get; } Property Value Vec2d (1,1) AmpPhase Create AmpPhase instance. public AmpPhase AmpPhase { get; } Property Value AmpPhase Angle_deg Angle in degree between vec(x,y) and vec(1,0). public double Angle_deg { get; } Property Value double Angle_rad Angle in radian between vec(x,y) and vec(1,0). public double Angle_rad { get; } Property Value double CsvText Csv text. public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. public string CsvTitleText { get; } Property Value string IsAllFinite public bool IsAllFinite { get; } Property Value bool Is x,y,z all finite. IsAllNaN public bool IsAllNaN { get; } Property Value bool is x,y all NaN. IsAllNegativeInfinity public bool IsAllNegativeInfinity { get; } Property Value bool is x,y all NegativeInfinity. IsAllPositiveInfinity public bool IsAllPositiveInfinity { get; } Property Value bool is x,y all PositiveInfinity. IsAnyFinite public bool IsAnyFinite { get; } Property Value bool Is at least one of x,y finite. IsAnyNaN Is any member nan. public bool IsAnyNaN { get; } Property Value bool IsZero public bool IsZero { get; } Property Value bool Is zero vector. Which is x == 0 && y == 0. this[int] Gets or sets the element at the specified index. public double this[int dir] { get; set; } Parameters dir int Property Value double The element at the specified index. Length Length. public double Length { get; } Property Value double LengthSquare Length square. public double LengthSquare { get; } Property Value double MaxAbsDir Get the direction of the max absolute value. public int MaxAbsDir { get; } Property Value int MaxDir Get the direction of the max value. public int MaxDir { get; } Property Value int MaxValue Get max value from {x,y}. public double MaxValue { get; } Property Value double MinDir Get the direction index with minimum value. If {x,y} is the smallest, return {0,1}. public int MinDir { get; } Property Value int MinValue Get min value from {x,y}. public double MinValue { get; } Property Value double NaN Generate NAN vec. public static Vec2d NaN { get; } Property Value Vec2d (nan,nan) NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(double) * 2. NegativeInfinity Generate negative infinity vec. public static Vec2d NegativeInfinity { get; } Property Value Vec2d (-inf,-inf) PositiveInfinity Generate positive infinity vec. public static Vec2d PositiveInfinity { get; } Property Value Vec2d (inf,inf) Rank Dimension (i.e. Size) of the Vector. public int Rank { get; } Property Value int UnitX Generate vec (1,0). public static Vec2d UnitX { get; } Property Value Vec2d (1,0) UnitY Generate vec (0,1). public static Vec2d UnitY { get; } Property Value Vec2d (0,1) X Gets or sets the X coordinate value. public double X { get; set; } Property Value double Y Gets or sets the Y coordinate value. public double Y { get; set; } Property Value double Zero Generate vec (0,0). public static Vec2d Zero { get; } Property Value Vec2d (0,0) Methods All(double) Generate Vec2d with all components set to the given value. public static Vec2d All(double v) Parameters v double Returns Vec2d At(int) Member at direction. public ref double At(int dir) Parameters dir int direction Returns double member Cross(Vec2d) Cross. public double Cross(Vec2d src) Parameters src Vec2d src Returns double cross value Dot(Vec2d) Dot. public double Dot(Vec2d src) Parameters src Vec2d src Returns double dotted value Equals(Vec2d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Vec2d other) Parameters other Vec2d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(Vec2d, double) check equals for each component with tolerance. public bool Equals(Vec2d other, double toleranceForEachComponent) Parameters other Vec2d other vec toleranceForEachComponent double tolerance for each component Returns bool check equals for each component with tolerance. 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. ExpandMax(Vec2d) Find and expand maximum values from src. public void ExpandMax(Vec2d src) Parameters src Vec2d src ExpandMin(Vec2d) Find and expand minimum values from src. public void ExpandMin(Vec2d src) Parameters src Vec2d src ExpandToBox2d(Box2d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox2d(Box2d dst) Parameters dst Box2d Destination box GenNaN() Generate NAN vec. public static Vec2d GenNaN() Returns Vec2d (nan,nan) GenNegativeInfinity() Generate negative infinity vec. public static Vec2d GenNegativeInfinity() Returns Vec2d (-inf,-inf) GenOne() Generate vec (1,1). public static Vec2d GenOne() Returns Vec2d (1,1) GenPositiveInfinity() Generate positive infinity vec. public static Vec2d GenPositiveInfinity() Returns Vec2d (inf,inf) GenUnitX() Generate vec (1,0). public static Vec2d GenUnitX() Returns Vec2d (1,0) GenUnitY() Generate vec (0,1). public static Vec2d GenUnitY() Returns Vec2d (0,1) GenZero() Generate vec (0,0). public static Vec2d GenZero() Returns Vec2d (0,0) GetCosSquareWith(Vec2d) Get Cos(theta)^2. theta is the angle between this and src. This function is faster than GetCosWith(Vec2d) since it lacks one square root operation. public double GetCosSquareWith(Vec2d src) Parameters src Vec2d one of edge vector Returns double Cos(theta)^2 GetCosWith(Vec2d) Get cos(angle). The angle is between v and this. public double GetCosWith(Vec2d v) Parameters v Vec2d v Returns double cos(angle) GetCsvText(string) Get CSV text with specified format. public string GetCsvText(string format) Parameters format string Format string for each component Returns string CSV formatted string GetEachValueAbs() Get a new vector with each value set to its absolute value. public Vec2d GetEachValueAbs() Returns Vec2d A new vector with absolute values GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetMulEach(Vec2d) Get a new vector with each component multiplied with the corresponding component of the given vector. public Vec2d GetMulEach(Vec2d vec) Parameters vec Vec2d The vector to multiply with Returns Vec2d A new vector with multiplied components GetNormalized() Generate normalized vec. public Vec2d GetNormalized() Returns Vec2d Normalized vec GetRadian(Vec2d) Get angle between this and v. The angle has no sign. This vector is not required to be an unit vector. public double GetRadian(Vec2d v) Parameters v Vec2d one of the edge vector. Not required to be an unit vector. Returns double Angle in radian GetTransform(Func) Get the new Vec2d by transforming each element by the function. public Vec2d GetTransform(Func transformingFunc) Parameters transformingFunc Func Returns Vec2d Interpolate(Vec2d, Vec2d, double) Linear interpolate between a and b. public static Vec2d Interpolate(Vec2d a, Vec2d b, double alpha) Parameters a Vec2d a b Vec2d b alpha double ratio Returns Vec2d interpolation IsNormalized(double) Check if this vector is normalized. public bool IsNormalized(double toleranceSquare = 1E-07) Parameters toleranceSquare double Tolerance for checking if length squared is 1 Returns bool True if the vector is normalized MulEach(Vec2d) Multiply each component with the corresponding component of the given vector. public Vec2d MulEach(Vec2d vec) Parameters vec Vec2d The vector to multiply with Returns Vec2d this Normalize() Normalize. public Vec2d Normalize() Returns Vec2d this Set(Vec2d) Set values by copy. public Vec2d Set(Vec2d src) Parameters src Vec2d src Returns Vec2d this Set(vec2d) Set values by copy. public Vec2d Set(vec2d src) Parameters src vec2d src Returns Vec2d this Set(double, double) Set values. public Vec2d Set(double x, double y) Parameters x double x y double y Returns Vec2d this Set(double[]) Set values by array. public Vec2d Set(double[] xy) Parameters xy double[] double[]{x,y} Returns Vec2d this Set(Func) Set values using a function that maps direction index and current value to new value. public Vec2d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that maps direction index and current value to new value Returns Vec2d this Set(Func) Set values using a function that maps direction index to value. public Vec2d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that maps direction index to value Returns Vec2d this Set(int, double, double) Set values by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec2d Set(int dir, double a, double b) Parameters dir int direction offset a double value at direction (0+dir)%2 b double value at direction (1+dir)%2 Returns Vec2d this SetEachNanToZero() Set NaN to 0 for each value. public Vec2d SetEachNanToZero() Returns Vec2d this SetEachValueAbs() Set all member to absolute value. public Vec2d SetEachValueAbs() Returns Vec2d this ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string) To string with format: (x,y) public string ToString(string format) Parameters format string Format string for the double values Returns string Formatted string representation of the vector ToString(string, IFormatProvider) Returns a string representation of the vector formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the vector ToString(string, int) Format the vector with padding. public string ToString(string format, int leftPadding) Parameters format string Format string for each component leftPadding int Left padding for each component Returns string Formatted string Transform(Func) Transform each element by the function. public Vec2d Transform(Func transformingFunc) Parameters transformingFunc Func Returns Vec2d WriteBin(BinaryWriter) Output to bytes: writer.Write(x); writer.Write(y); public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer Operators operator +(Vec2d, Vec2d) Plus. public static Vec2d operator +(Vec2d left, Vec2d right) Parameters left Vec2d a right Vec2d b Returns Vec2d a+b operator /(Vec2d, double) a/d. public static Vec2d operator /(Vec2d a, double d) Parameters a Vec2d a d double d Returns Vec2d a/d operator ==(Vec2d, Vec2d) Equality operator for comparing two Vec2d objects. public static bool operator ==(Vec2d left, Vec2d right) Parameters left Vec2d Left operand right Vec2d Right operand Returns bool True if the vectors are equal, false otherwise operator !=(Vec2d, Vec2d) Inequality operator for comparing two Vec2d objects. public static bool operator !=(Vec2d left, Vec2d right) Parameters left Vec2d Left operand right Vec2d Right operand Returns bool True if the vectors are not equal, false otherwise operator *(Vec2d, double) a*s. public static Vec2d operator *(Vec2d a, double s) Parameters a Vec2d a s double s Returns Vec2d a*s operator -(Vec2d, Vec2d) a-b. public static Vec2d operator -(Vec2d a, Vec2d b) Parameters a Vec2d a b Vec2d b Returns Vec2d a-b operator -(Vec2d) Negate. public static Vec2d operator -(Vec2d src) Parameters src Vec2d src Returns Vec2d Negate" }, "api/Hi.Geom.Vec2i.html": { "href": "api/Hi.Geom.Vec2i.html", "title": "Class Vec2i | HiAPI-C# 2025", - "summary": "Class Vec2i Namespace Hi.Geom Assembly HiGeom.dll Basic 2D point (or vector). public class Vec2i : IEquatable Inheritance object Vec2i Implements IEquatable 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Vec2i(Vec2i) Copy ctor. public Vec2i(Vec2i src) Parameters src Vec2i src Vec2i(BinaryReader) Ctor by bytes: x = reader.ReadDouble(); y = reader.ReadDouble(); public Vec2i(BinaryReader reader) Parameters reader BinaryReader reader Vec2i(int, int) Ctor. public Vec2i(int x = 0, int y = 0) Parameters x int x y int y Vec2i(int, int, int) Ctor by direction offset. Direction 0,1 indicate x,y respectively. public Vec2i(int dir, int a, int b) Parameters dir int direction offset a int value at direction (0+dir)%3 b int value at direction (1+dir)%3 Vec2i(string) Ctor by string. The format is (x,y). public Vec2i(string src) Parameters src string src Fields x Value at x direction. public int x Field Value int y Value at y direction. public int y Field Value int Properties AbsSum Sum of abs(x) and abs(y). public int AbsSum { get; } Property Value int LengthSquare Length square. public int LengthSquare { get; } Property Value int Max Get max value from {x,y}. public int Max { get; } Property Value int MaxAbsDir Get the direction of the max absolute value. public int MaxAbsDir { get; } Property Value int MaxDir Get the direction of the max value. public int MaxDir { get; } Property Value int Min Get min value from {x,y}. public int Min { get; } Property Value int NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(int) * 2. One Generate vec (1,1). public static Vec2i One { get; } Property Value Vec2i (1,1) UnitX Generate vec (1,0). public static Vec2i UnitX { get; } Property Value Vec2i (1,0) UnitY Generate vec (0,1). public static Vec2i UnitY { get; } Property Value Vec2i (0,1) Zero Generate vec (0,0). public static Vec2i Zero { get; } Property Value Vec2i (0,0) Methods At(int) Member at direction. public ref int At(int dir) Parameters dir int direction Returns int member Cross(Vec2i) Cross. public int Cross(Vec2i src) Parameters src Vec2i src Returns int cross value Dot(Vec2i) Dot. public int Dot(Vec2i src) Parameters src Vec2i src Returns int dotted value Equals(Vec2i) Indicates whether the current object is equal to another object of the same type. public bool Equals(Vec2i other) Parameters other Vec2i An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GenOne() Generate vec (1,1). public static Vec2i GenOne() Returns Vec2i (1,1) GenUnitX() Generate vec (1,0). public static Vec2i GenUnitX() Returns Vec2i (1,0) GenUnitY() Generate vec (0,1). public static Vec2i GenUnitY() Returns Vec2i (0,1) GenZero() Generate vec (0,0). public static Vec2i GenZero() Returns Vec2i (0,0) GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Output(BinaryWriter) Output to bytes: writer.Write(x); writer.Write(y); public void Output(BinaryWriter writer) Parameters writer BinaryWriter writer Set(Vec2i) Set values by copy. public Vec2i Set(Vec2i src) Parameters src Vec2i src Returns Vec2i this Set(int, int) Set values. public Vec2i Set(int x, int y) Parameters x int x y int y Returns Vec2i this Set(int, int, int) Set values by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec2i Set(int dir, int a, int b) Parameters dir int direction offset a int value at direction (0+dir)%3 b int value at direction (1+dir)%3 Returns Vec2i this Set(int[]) Set values by array. public Vec2i Set(int[] xy) Parameters xy int[] int[]{x,y} Returns Vec2i this SetEachValueAbs() Set all member to absolute value. public Vec2i SetEachValueAbs() Returns Vec2i this ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. Operators operator +(Vec2i, Vec2i) Plus. public static Vec2i operator +(Vec2i a, Vec2i b) Parameters a Vec2i a b Vec2i b Returns Vec2i a+b operator /(Vec2i, int) a/d. public static Vec2i operator /(Vec2i a, int d) Parameters a Vec2i a d int d Returns Vec2i a/d operator *(Vec2i, int) a*s. public static Vec2i operator *(Vec2i a, int s) Parameters a Vec2i a s int s Returns Vec2i a*s operator -(Vec2i, Vec2i) a-b. public static Vec2i operator -(Vec2i a, Vec2i b) Parameters a Vec2i a b Vec2i b Returns Vec2i a-b operator -(Vec2i) Negate. public static Vec2i operator -(Vec2i src) Parameters src Vec2i src Returns Vec2i Negate" + "summary": "Class Vec2i Namespace Hi.Geom Assembly HiGeom.dll Basic 2D point (or vector). public class Vec2i : IEquatable, IFormattable Inheritance object Vec2i Implements IEquatable IFormattable 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Vec2i(Vec2i) Copy ctor. public Vec2i(Vec2i src) Parameters src Vec2i src Vec2i(BinaryReader) Ctor by bytes: x = reader.ReadDouble(); y = reader.ReadDouble(); public Vec2i(BinaryReader reader) Parameters reader BinaryReader reader Vec2i(int, int) Ctor. public Vec2i(int x = 0, int y = 0) Parameters x int x y int y Vec2i(int, int, int) Ctor by direction offset. Direction 0,1 indicate x,y respectively. public Vec2i(int dir, int a, int b) Parameters dir int direction offset a int value at direction (0+dir)%3 b int value at direction (1+dir)%3 Vec2i(string) Ctor by string. The format is (x,y). public Vec2i(string src) Parameters src string src Fields x Value at x direction. public int x Field Value int y Value at y direction. public int y Field Value int Properties AbsSum Sum of abs(x) and abs(y). public int AbsSum { get; } Property Value int LengthSquare Length square. public int LengthSquare { get; } Property Value int Max Get max value from {x,y}. public int Max { get; } Property Value int MaxAbsDir Get the direction of the max absolute value. public int MaxAbsDir { get; } Property Value int MaxDir Get the direction of the max value. public int MaxDir { get; } Property Value int Min Get min value from {x,y}. public int Min { get; } Property Value int NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(int) * 2. One Generate vec (1,1). public static Vec2i One { get; } Property Value Vec2i (1,1) UnitX Generate vec (1,0). public static Vec2i UnitX { get; } Property Value Vec2i (1,0) UnitY Generate vec (0,1). public static Vec2i UnitY { get; } Property Value Vec2i (0,1) Zero Generate vec (0,0). public static Vec2i Zero { get; } Property Value Vec2i (0,0) Methods At(int) Member at direction. public ref int At(int dir) Parameters dir int direction Returns int member Cross(Vec2i) Cross. public int Cross(Vec2i src) Parameters src Vec2i src Returns int cross value Dot(Vec2i) Dot. public int Dot(Vec2i src) Parameters src Vec2i src Returns int dotted value Equals(Vec2i) Indicates whether the current object is equal to another object of the same type. public bool Equals(Vec2i other) Parameters other Vec2i An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GenOne() Generate vec (1,1). public static Vec2i GenOne() Returns Vec2i (1,1) GenUnitX() Generate vec (1,0). public static Vec2i GenUnitX() Returns Vec2i (1,0) GenUnitY() Generate vec (0,1). public static Vec2i GenUnitY() Returns Vec2i (0,1) GenZero() Generate vec (0,0). public static Vec2i GenZero() Returns Vec2i (0,0) GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. Output(BinaryWriter) Output to bytes: writer.Write(x); writer.Write(y); public void Output(BinaryWriter writer) Parameters writer BinaryWriter writer Set(Vec2i) Set values by copy. public Vec2i Set(Vec2i src) Parameters src Vec2i src Returns Vec2i this Set(int, int) Set values. public Vec2i Set(int x, int y) Parameters x int x y int y Returns Vec2i this Set(int, int, int) Set values by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec2i Set(int dir, int a, int b) Parameters dir int direction offset a int value at direction (0+dir)%3 b int value at direction (1+dir)%3 Returns Vec2i this Set(int[]) Set values by array. public Vec2i Set(int[] xy) Parameters xy int[] int[]{x,y} Returns Vec2i this SetEachValueAbs() Set all member to absolute value. public Vec2i SetEachValueAbs() Returns Vec2i this ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToString(string, IFormatProvider) Returns a string representation of the vector formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the vector Operators operator +(Vec2i, Vec2i) Plus. public static Vec2i operator +(Vec2i a, Vec2i b) Parameters a Vec2i a b Vec2i b Returns Vec2i a+b operator /(Vec2i, int) a/d. public static Vec2i operator /(Vec2i a, int d) Parameters a Vec2i a d int d Returns Vec2i a/d operator *(Vec2i, int) a*s. public static Vec2i operator *(Vec2i a, int s) Parameters a Vec2i a s int s Returns Vec2i a*s operator -(Vec2i, Vec2i) a-b. public static Vec2i operator -(Vec2i a, Vec2i b) Parameters a Vec2i a b Vec2i b Returns Vec2i a-b operator -(Vec2i) Negate. public static Vec2i operator -(Vec2i src) Parameters src Vec2i src Returns Vec2i Negate" }, "api/Hi.Geom.Vec3d.html": { "href": "api/Hi.Geom.Vec3d.html", "title": "Class Vec3d | HiAPI-C# 2025", - "summary": "Class Vec3d Namespace Hi.Geom Assembly HiGeom.dll Basic 3D point (or vector). [BsonIgnoreExtraElements] public class Vec3d : IEquatable, IExpandToBox3d, IBinaryIo, IWriteBin, ICsvRowIo, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IMultiplyOperators, IDivisionOperators, IVec Inheritance object Vec3d Implements IEquatable IExpandToBox3d IBinaryIo IWriteBin ICsvRowIo IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IMultiplyOperators IDivisionOperators IVec Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) GeomUtil.GetBox3d(IExpandToBox3d) 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) Constructors Vec3d() Ctor. public Vec3d() Vec3d(Polar3d) Ctor. public Vec3d(Polar3d src) Parameters src Polar3d src Vec3d(Vec3d) Copy ctor. public Vec3d(Vec3d src) Parameters src Vec3d src Vec3d(vec3d) ctor. public Vec3d(vec3d src) Parameters src vec3d src Vec3d(vec3f) ctor. public Vec3d(vec3f src) Parameters src vec3f src Vec3d(IEnumerable) Creates a vector from an enumerable collection of three double values. public Vec3d(IEnumerable src) Parameters src IEnumerable Source collection containing three double values Vec3d(double, double, double) Ctor. public Vec3d(double x, double y, double z) Parameters x double x y double y z double z Vec3d(Func) Creates a vector using a function that maps direction index to value. public Vec3d(Func dirToValueFunc) Parameters dirToValueFunc Func Function that takes direction index (0=X, 1=Y, 2=Z) and returns the corresponding value Vec3d(BinaryReader) Ctor by bytes: x = reader.ReadDouble(); y = reader.ReadDouble(); z = reader.ReadDouble(); public Vec3d(BinaryReader reader) Parameters reader BinaryReader reader Vec3d(int, double, double, double) Ctor by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec3d(int dir, double a, double b, double c) Parameters dir int direction offset a double value at direction (0+dir)%3 b double value at direction (1+dir)%3 c double value at direction (2+dir)%3 Vec3d(string) Ctor by string. The format is (x,y,z). public Vec3d(string src) Parameters src string src Vec3d((double, double, double)) Ctor. public Vec3d((double, double, double) src) Parameters src (double, double, double) src Fields x Value at x direction. public double x Field Value double y Value at y direction. public double y Field Value double z Value at z direction. public double z Field Value double Properties AbsSum [BsonIgnore] public double AbsSum { get; } Property Value double Sum of the abs {x,y,z}. Which is Math.Abs(x) + Math.Abs(y) + Math.Abs(z). AllOne public static Vec3d AllOne { get; } Property Value Vec3d Generate Vec3d(1, 1, 1). CsvText Csv text. [BsonIgnore] public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. [BsonIgnore] public string CsvTitleText { get; } Property Value string ElementNum Element number: 3 for (x,y,z). public static int ElementNum { get; } Property Value int IsAllFinite [BsonIgnore] public bool IsAllFinite { get; } Property Value bool Is x,y,z all finite. IsAllNaN [BsonIgnore] public bool IsAllNaN { get; } Property Value bool is x,y,z all NaN. IsAllNegativeInfinity [BsonIgnore] public bool IsAllNegativeInfinity { get; } Property Value bool is x,y,z all NegativeInfinity. IsAllPositiveInfinity [BsonIgnore] public bool IsAllPositiveInfinity { get; } Property Value bool is x,y,z all PositiveInfinity. IsAnyFinite [BsonIgnore] public bool IsAnyFinite { get; } Property Value bool Is at least one of x,y,z finite. IsAnyNaN [BsonIgnore] public bool IsAnyNaN { get; } Property Value bool Is any of {x,y,z} NaN. IsZero [BsonIgnore] public bool IsZero { get; } Property Value bool Is zero vector. Which is x == 0 && y == 0 && z == 0. this[int] Gets or sets the element at the specified index. public double this[int dir] { get; set; } Parameters dir int Property Value double The element at the specified index. Length [BsonIgnore] public double Length { get; } Property Value double Geometry length of this. LengthSquare [BsonIgnore] public double LengthSquare { get; } Property Value double Geometry length ^ 2. Which is x * x + y * y + z * z. MaxAbsDir [BsonIgnore] public int MaxAbsDir { get; } Property Value int Get the direction index with maximum absolute value. If the absolute of {x,y,z} is the biggest, return {0,1,2}. MaxDir [BsonIgnore] public int MaxDir { get; } Property Value int Get the direction index with maximum value. If {x,y,z} is the biggest, return {0,1,2}. MaxValue [BsonIgnore] public double MaxValue { get; } Property Value double The max value selected from {x,y,z}. Which is Math.Max(Math.Max(x, y), z). MinDir [BsonIgnore] public int MinDir { get; } Property Value int Get the direction index with maximum value. If {x,y,z} is the biggest, return {0,1,2}. MinValue [BsonIgnore] public double MinValue { get; } Property Value double The min value selected from {x,y,z}. Which is Math.Min(Math.Min(x, y), z). NaN public static Vec3d NaN { get; } Property Value Vec3d Generate Vec3d(double.NaN, double.NaN, double.NaN). NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(double) * 3. NegativeInfinity public static Vec3d NegativeInfinity { get; } Property Value Vec3d Generate Vec3d(double.NegativeInfinity, double.NegativeInfinity, double.NegativeInfinity) PositiveInfinity public static Vec3d PositiveInfinity { get; } Property Value Vec3d Generate Vec3d(double.PositiveInfinity, double.PositiveInfinity, double.PositiveInfinity) Rank Dimension (i.e. Size) of the Vector. public int Rank { get; } Property Value int Text Gets or sets the vector as a string representation. [BsonIgnore] public string Text { get; set; } Property Value string UnitX public static Vec3d UnitX { get; } Property Value Vec3d Generate Vec3d(1, 0, 0). UnitY public static Vec3d UnitY { get; } Property Value Vec3d Generate Vec3d(0, 1, 0). UnitZ public static Vec3d UnitZ { get; } Property Value Vec3d Generate Vec3d(0, 0, 1). X Value at x direction. [BsonElement] public double X { get; set; } Property Value double XY Vec2d of X and Y. The getter gets a copied object. [BsonIgnore] public Vec2d XY { get; set; } Property Value Vec2d Y Value at y direction. [BsonElement] public double Y { get; set; } Property Value double Z Value at z direction. [BsonElement] public double Z { get; set; } Property Value double Zero public static Vec3d Zero { get; } Property Value Vec3d Generate Vec3d(0, 0, 0). Methods All(double) Creates a vector with all components set to the specified value. public static Vec3d All(double v) Parameters v double Value to set for all components Returns Vec3d A new vector with all components set to the specified value At(int) Get the value at the dirction. Direction 0,1,2 are x,y,z. If direction index is larger than 2, the return value is at z direction. public ref double At(int dir) Parameters dir int direction index Returns double value at the direction BilinearInterpolate(Vec3d, Vec3d, Vec3d, Vec3d, double, double) Performs bilinear interpolation between four points. public static Vec3d BilinearInterpolate(Vec3d p00, Vec3d p01, Vec3d p10, Vec3d p11, double u, double v) Parameters p00 Vec3d Point at (0,0) p01 Vec3d Point at (0,1) p10 Vec3d Point at (1,0) p11 Vec3d Point at (1,1) u double Interpolation parameter in first dimension (0.0 to 1.0) v double Interpolation parameter in second dimension (0.0 to 1.0) Returns Vec3d The interpolated point Cross(Vec3d, Vec3d) Get a cross b. public static Vec3d Cross(Vec3d a, Vec3d b) Parameters a Vec3d a b Vec3d b Returns Vec3d a x b Dot(Vec3d) this dot src. public double Dot(Vec3d src) Parameters src Vec3d src Returns double dotted value Enumerate() Enumerates the components of the vector. public IEnumerable Enumerate() Returns IEnumerable An enumerable sequence of the vector's components (X, Y, Z) Equals(Vec3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Vec3d other) Parameters other Vec3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(Vec3d, double) check equals for each component with tolerance. public bool Equals(Vec3d other, double toleranceForEachComponent) Parameters other Vec3d other vec toleranceForEachComponent double tolerance for each component Returns bool check equals for each component with tolerance. 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. ExpandMax(Vec3d) Find and expand maximum values from src. public void ExpandMax(Vec3d src) Parameters src Vec3d src ExpandMin(Vec3d) Find and expand minimum values from src. public void ExpandMin(Vec3d src) Parameters src Vec3d src ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetCosSquareWith(Vec3d) Get Cos(theta)^2. theta is the angle between this and src. This function is faster than GetCosWith(Vec3d) since it lacks one square root operation. public double GetCosSquareWith(Vec3d src) Parameters src Vec3d one of edge vector Returns double Cos(theta)^2 GetCosWith(Vec3d) Get Cos(theta). theta is the angle between this and v. public double GetCosWith(Vec3d v) Parameters v Vec3d a vector Returns double Cos(theta) GetCross(Vec3d) Get this cross src. public Vec3d GetCross(Vec3d src) Parameters src Vec3d src Returns Vec3d GetCsvText(string) Gets the CSV text representation of this vector with the specified format. public string GetCsvText(string format) Parameters format string Format string for the double values Returns string CSV formatted string GetEachValueAbs() Creates a new vector with the absolute value of each component. public Vec3d GetEachValueAbs() Returns Vec3d A new vector with absolute values of each component GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetMulEach(Vec3d) Creates a new vector by multiplying each component of this vector with the corresponding component of another vector. public Vec3d GetMulEach(Vec3d vec) Parameters vec Vec3d The vector to multiply with Returns Vec3d A new vector with component-wise multiplication results GetMulWithoutTrans(Mat4d) Get a new object by this*mat without translation part. public Vec3d GetMulWithoutTrans(Mat4d mat) Parameters mat Mat4d transform matrix Returns Vec3d new Vec3d(x * mat.At(0, 0) + y * mat.At(1, 0) + z * mat.At(2, 0) , x* mat.At(0, 1) + y* mat.At(1, 1) + z* mat.At(2, 1) , x* mat.At(0, 2) + y* mat.At(1, 2) + z* mat.At(2, 2)) GetNormalized() Generate normalized vec. public Vec3d GetNormalized() Returns Vec3d Normalized vec GetRadian(Vec3d) Get angle between this and v. The angle has no sign. This vector is not required to be an unit vector. public double GetRadian(Vec3d v) Parameters v Vec3d one of the edge vector. Not required to be an unit vector. Returns double Angle in radian GetRadian(Vec3d, Vec3d) Get angle between this and v. This function applies normal vector to determine the sign of angle. This vector is not required to be an unit vector. public double GetRadian(Vec3d v, Vec3d n) Parameters v Vec3d vector of ending edge. Not required to be an unit vector. n Vec3d normal vector. Not required to be an unit vector. Returns double angle in radian GetRadianByUnitVector(Vec3d) Get angle between this and v. The angle has no sign. This vector is not required to be an unit vector. Both this and v should be unit vector. Much efficient than GetRadian(Vec3d). public double GetRadianByUnitVector(Vec3d v) Parameters v Vec3d one of the edge vector. Not required to be an unit vector. Returns double Angle in radian GetTransform(Func) Get the new Vec3d by transforming each element by the function. public Vec3d GetTransform(Func transformingFunc) Parameters transformingFunc Func Returns Vec3d GetVec2dByPlaneDir(int) Gets a 2D vector by projecting the 3D vector onto a plane. public Vec2d GetVec2dByPlaneDir(int dir) Parameters dir int Direction index: 0 for YZ plane, 1 for ZX plane, 2 for XY plane Returns Vec2d A 2D vector representing the projection GetXRotation(double) Get rotated Vec3d along x direction. CCW. Much efficient than using Mat4d multiplication. public Vec3d GetXRotation(double rad) Parameters rad double rotation radian Returns Vec3d rotated Vec3d GetYRotation(double) Get rotated Vec3d along y direction. CCW. Much efficient than using Mat4d multiplication. public Vec3d GetYRotation(double rad) Parameters rad double rotation radian Returns Vec3d rotated Vec3d GetZRotation(double) Get rotated Vec3d along z direction. CCW. Much efficient than using Mat4d multiplication. public Vec3d GetZRotation(double rad) Parameters rad double rotation radian Returns Vec3d rotated Vec3d Interpolate(Vec3d, Vec3d, double) Interpolate from a to b with ratio alpha:(1-alpha). public static Vec3d Interpolate(Vec3d a, Vec3d b, double alpha) Parameters a Vec3d a b Vec3d b alpha double ratio Returns Vec3d a * (1 - alpha) + b * alpha IsNormalized(double) Checks if the vector is normalized (has a length of approximately 1). public bool IsNormalized(double toleranceSquare = 1E-07) Parameters toleranceSquare double Square of the tolerance value for comparing with 1 (default: 1e-7) Returns bool True if the vector is normalized within the specified tolerance MulEach(Vec3d) Multiplies each component of this vector with the corresponding component of another vector. public Vec3d MulEach(Vec3d vec) Parameters vec Vec3d The vector to multiply with Returns Vec3d This vector after multiplication MulWithoutTrans(Mat4d) this*=mat without translation part. public Vec3d MulWithoutTrans(Mat4d mat) Parameters mat Mat4d transformation matrix Returns Vec3d this See Also GetMulWithoutTrans(Mat4d) Normalize() Normalize this. public Vec3d Normalize() Returns Vec3d this Parse(string) If src is not null and not empty string, return Vec3d(string); otherwise return null. public static Vec3d Parse(string src) Parameters src string src Returns Vec3d parsed Vec3d ParseByCsv(string) Parses a vector from a CSV text string. public static Vec3d ParseByCsv(string csvText) Parameters csvText string CSV formatted string containing vector components Returns Vec3d A new vector parsed from the CSV text ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Set(Vec3d) Set values by copy. public Vec3d Set(Vec3d src) Parameters src Vec3d src Returns Vec3d this Set(vec3d) Set values by copy. public Vec3d Set(vec3d src) Parameters src vec3d src Returns Vec3d this Set(double, double, double) Set values. public Vec3d Set(double x, double y, double z) Parameters x double x y double y z double z Returns Vec3d this Set(double[]) Set values by array. public Vec3d Set(double[] xyz) Parameters xyz double[] double[]{x,y,z} Returns Vec3d this Set(Func) Sets vector components using a function that maps direction index and current value to new value. public Vec3d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that takes direction index (0=X, 1=Y, 2=Z) and current value, and returns the new value Returns Vec3d This vector after modification Set(Func) Sets vector components using a function that maps direction index to value. public Vec3d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that takes direction index (0=X, 1=Y, 2=Z) and returns the corresponding value Returns Vec3d This vector after modification Set(int, double, double, double) Set values by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec3d Set(int dir, double a, double b, double c) Parameters dir int direction offset a double value at direction (0+dir)%3 b double value at direction (1+dir)%3 c double value at direction (2+dir)%3 Returns Vec3d this SetEachNanToZero() Set NaN to 0 for each value. public Vec3d SetEachNanToZero() Returns Vec3d this SetEachValueAbs() Set each value to absolute. public Vec3d SetEachValueAbs() Returns Vec3d this ToArray() return new double[] { x, y, z } public double[] ToArray() Returns double[] { x, y, z } ToBuf(double[]) Set x,y,z to the dst array. public void ToBuf(double[] dst) Parameters dst double[] dst ToBuf(double[], ref int) Set x,y,z to the dst array from postion p and increase p by the pushed number. public int ToBuf(double[] dst, ref int p) Parameters dst double[] dst p int position from dst Returns int Which is pushed number of double ToString() To representative string with format:(x,y,z). public override string ToString() Returns string Representative string ToString(string) To string with format: (x,y,z) public string ToString(string format) Parameters format string format of ToString(string) Returns string Representative string ToString(string, int) Converts the vector to a string with the specified format and left padding. public string ToString(string format, int leftPadding) Parameters format string Format string for the double values leftPadding int Number of characters to pad on the left of each value Returns string Formatted string representation of the vector Transform(Func) Transform each element by the function. public Vec3d Transform(Func transformingFunc) Parameters transformingFunc Func Returns Vec3d TryParse(string, out Vec3d) Attempts to parse a string into a Vec3d. public static bool TryParse(string src, out Vec3d dst) Parameters src string The string to parse in format “(x,y,z)” dst Vec3d When this method returns, contains the Vec3d value if parsing succeeded, or null if parsing failed Returns bool true if parsing succeeded; otherwise, false WriteBin(BinaryWriter) Output to bytes: writer.Write(x); writer.Write(y); writer.Write(z); public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer Operators operator +(Vec3d, Vec3d) Plus. public static Vec3d operator +(Vec3d left, Vec3d right) Parameters left Vec3d a right Vec3d b Returns Vec3d new Vec3d(a.x + b.x, a.y + b.y, a.z + b.z) operator /(Vec3d, double) Get a new object from a scaled by 1/d. public static Vec3d operator /(Vec3d a, double d) Parameters a Vec3d d double Returns Vec3d operator ==(Vec3d, Vec3d) Equality operator for comparing two Vec3d objects. public static bool operator ==(Vec3d left, Vec3d right) Parameters left Vec3d Left operand right Vec3d Right operand Returns bool True if the vectors are equal, false otherwise operator !=(Vec3d, Vec3d) Inequality operator for comparing two Vec3d objects. public static bool operator !=(Vec3d left, Vec3d right) Parameters left Vec3d Left operand right Vec3d Right operand Returns bool True if the vectors are not equal, false otherwise operator *(Vec3d, Mat4d) Get p*src. public static Vec3d operator *(Vec3d p, Mat4d src) Parameters p Vec3d point src Mat4d transmform matrix Returns Vec3d new Vec3d(p.x * src.At(0, 0) + p.y * src.At(1, 0) + p.z * src.At(2, 0) + src.At(3, 0) , p.x* src.At(0, 1) + p.y* src.At(1, 1) + p.z* src.At(2, 1) + src.At(3, 1) , p.x* src.At(0, 2) + p.y* src.At(1, 2) + p.z* src.At(2, 2) + src.At(3, 2)) operator *(Vec3d, double) Scale a by s. public static Vec3d operator *(Vec3d a, double s) Parameters a Vec3d vector s double scale Returns Vec3d new Vec3d(a.x * s, a.y * s, a.z * s) operator -(Vec3d, Vec3d) Minus. public static Vec3d operator -(Vec3d a, Vec3d b) Parameters a Vec3d a b Vec3d b Returns Vec3d new Vec3d(a.x - b.x, a.y - b.y, a.z - b.z) operator -(Vec3d) Get negate vector. public static Vec3d operator -(Vec3d src) Parameters src Vec3d src Returns Vec3d new Vec3d(-src.x, -src.y, -src.z)" + "summary": "Class Vec3d Namespace Hi.Geom Assembly HiGeom.dll Basic 3D point (or vector). [BsonIgnoreExtraElements] public class Vec3d : IEquatable, IExpandToBox3d, IBinaryIo, IWriteBin, ICsvRowIo, IEqualityOperators, IAdditionOperators, ISubtractionOperators, IMultiplyOperators, IMultiplyOperators, IDivisionOperators, IVec, IFormattable Inheritance object Vec3d Implements IEquatable IExpandToBox3d IBinaryIo IWriteBin ICsvRowIo IEqualityOperators IAdditionOperators ISubtractionOperators IMultiplyOperators IMultiplyOperators IDivisionOperators IVec IFormattable Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods BinIoUtil.ToBytes(IWriteBin) GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) 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) Constructors Vec3d() Ctor. public Vec3d() Vec3d(Polar3d) Ctor. public Vec3d(Polar3d src) Parameters src Polar3d src Vec3d(Vec3d) Copy ctor. public Vec3d(Vec3d src) Parameters src Vec3d src Vec3d(vec3d) ctor. public Vec3d(vec3d src) Parameters src vec3d src Vec3d(vec3f) ctor. public Vec3d(vec3f src) Parameters src vec3f src Vec3d(IEnumerable) Creates a vector from an enumerable collection of three double values. public Vec3d(IEnumerable src) Parameters src IEnumerable Source collection containing three double values Vec3d(double, double, double) Ctor. public Vec3d(double x, double y, double z) Parameters x double x y double y z double z Vec3d(Func) Creates a vector using a function that maps direction index to value. public Vec3d(Func dirToValueFunc) Parameters dirToValueFunc Func Function that takes direction index (0=X, 1=Y, 2=Z) and returns the corresponding value Vec3d(BinaryReader) Ctor by bytes: x = reader.ReadDouble(); y = reader.ReadDouble(); z = reader.ReadDouble(); public Vec3d(BinaryReader reader) Parameters reader BinaryReader reader Vec3d(int, double, double, double) Ctor by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec3d(int dir, double a, double b, double c) Parameters dir int direction offset a double value at direction (0+dir)%3 b double value at direction (1+dir)%3 c double value at direction (2+dir)%3 Vec3d(string) Ctor by string. The format is (x,y,z). public Vec3d(string src) Parameters src string src Vec3d((double, double, double)) Ctor. public Vec3d((double, double, double) src) Parameters src (double, double, double) src Fields x Value at x direction. public double x Field Value double y Value at y direction. public double y Field Value double z Value at z direction. public double z Field Value double Properties AbsSum [BsonIgnore] public double AbsSum { get; } Property Value double Sum of the abs {x,y,z}. Which is Math.Abs(x) + Math.Abs(y) + Math.Abs(z). AllOne public static Vec3d AllOne { get; } Property Value Vec3d Generate Vec3d(1, 1, 1). CsvText Csv text. [BsonIgnore] public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. [BsonIgnore] public string CsvTitleText { get; } Property Value string ElementNum Element number: 3 for (x,y,z). public static int ElementNum { get; } Property Value int IsAllFinite [BsonIgnore] public bool IsAllFinite { get; } Property Value bool Is x,y,z all finite. IsAllNaN [BsonIgnore] public bool IsAllNaN { get; } Property Value bool is x,y,z all NaN. IsAllNegativeInfinity [BsonIgnore] public bool IsAllNegativeInfinity { get; } Property Value bool is x,y,z all NegativeInfinity. IsAllPositiveInfinity [BsonIgnore] public bool IsAllPositiveInfinity { get; } Property Value bool is x,y,z all PositiveInfinity. IsAnyFinite [BsonIgnore] public bool IsAnyFinite { get; } Property Value bool Is at least one of x,y,z finite. IsAnyNaN [BsonIgnore] public bool IsAnyNaN { get; } Property Value bool Is any of {x,y,z} NaN. IsZero [BsonIgnore] public bool IsZero { get; } Property Value bool Is zero vector. Which is x == 0 && y == 0 && z == 0. this[int] Gets or sets the element at the specified index. public double this[int dir] { get; set; } Parameters dir int Property Value double The element at the specified index. Length [BsonIgnore] public double Length { get; } Property Value double Geometry length of this. LengthSquare [BsonIgnore] public double LengthSquare { get; } Property Value double Geometry length ^ 2. Which is x * x + y * y + z * z. MaxAbsDir [BsonIgnore] public int MaxAbsDir { get; } Property Value int Get the direction index with maximum absolute value. If the absolute of {x,y,z} is the biggest, return {0,1,2}. MaxDir [BsonIgnore] public int MaxDir { get; } Property Value int Get the direction index with maximum value. If {x,y,z} is the biggest, return {0,1,2}. MaxValue [BsonIgnore] public double MaxValue { get; } Property Value double The max value selected from {x,y,z}. Which is Math.Max(Math.Max(x, y), z). MinDir [BsonIgnore] public int MinDir { get; } Property Value int Get the direction index with maximum value. If {x,y,z} is the biggest, return {0,1,2}. MinValue [BsonIgnore] public double MinValue { get; } Property Value double The min value selected from {x,y,z}. Which is Math.Min(Math.Min(x, y), z). NaN public static Vec3d NaN { get; } Property Value Vec3d Generate Vec3d(double.NaN, double.NaN, double.NaN). NativeByteSize public static int NativeByteSize { get; } Property Value int Byte size: sizeof(double) * 3. NegativeInfinity public static Vec3d NegativeInfinity { get; } Property Value Vec3d Generate Vec3d(double.NegativeInfinity, double.NegativeInfinity, double.NegativeInfinity) PositiveInfinity public static Vec3d PositiveInfinity { get; } Property Value Vec3d Generate Vec3d(double.PositiveInfinity, double.PositiveInfinity, double.PositiveInfinity) Rank Dimension (i.e. Size) of the Vector. public int Rank { get; } Property Value int Text Gets or sets the vector as a string representation. [BsonIgnore] public string Text { get; set; } Property Value string UnitX public static Vec3d UnitX { get; } Property Value Vec3d Generate Vec3d(1, 0, 0). UnitY public static Vec3d UnitY { get; } Property Value Vec3d Generate Vec3d(0, 1, 0). UnitZ public static Vec3d UnitZ { get; } Property Value Vec3d Generate Vec3d(0, 0, 1). X Value at x direction. [BsonElement] public double X { get; set; } Property Value double XY Vec2d of X and Y. The getter gets a copied object. [BsonIgnore] public Vec2d XY { get; set; } Property Value Vec2d Y Value at y direction. [BsonElement] public double Y { get; set; } Property Value double Z Value at z direction. [BsonElement] public double Z { get; set; } Property Value double Zero public static Vec3d Zero { get; } Property Value Vec3d Generate Vec3d(0, 0, 0). Methods All(double) Creates a vector with all components set to the specified value. public static Vec3d All(double v) Parameters v double Value to set for all components Returns Vec3d A new vector with all components set to the specified value At(int) Get the value at the dirction. Direction 0,1,2 are x,y,z. If direction index is larger than 2, the return value is at z direction. public ref double At(int dir) Parameters dir int direction index Returns double value at the direction BilinearInterpolate(Vec3d, Vec3d, Vec3d, Vec3d, double, double) Performs bilinear interpolation between four points. public static Vec3d BilinearInterpolate(Vec3d p00, Vec3d p01, Vec3d p10, Vec3d p11, double u, double v) Parameters p00 Vec3d Point at (0,0) p01 Vec3d Point at (0,1) p10 Vec3d Point at (1,0) p11 Vec3d Point at (1,1) u double Interpolation parameter in first dimension (0.0 to 1.0) v double Interpolation parameter in second dimension (0.0 to 1.0) Returns Vec3d The interpolated point Cross(Vec3d, Vec3d) Get a cross b. public static Vec3d Cross(Vec3d a, Vec3d b) Parameters a Vec3d a b Vec3d b Returns Vec3d a x b Dot(Vec3d) this dot src. public double Dot(Vec3d src) Parameters src Vec3d src Returns double dotted value Enumerate() Enumerates the components of the vector. public IEnumerable Enumerate() Returns IEnumerable An enumerable sequence of the vector's components (X, Y, Z) Equals(Vec3d) Indicates whether the current object is equal to another object of the same type. public bool Equals(Vec3d other) Parameters other Vec3d An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. Equals(Vec3d, double) check equals for each component with tolerance. public bool Equals(Vec3d other, double toleranceForEachComponent) Parameters other Vec3d other vec toleranceForEachComponent double tolerance for each component Returns bool check equals for each component with tolerance. 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. ExpandMax(Vec3d) Find and expand maximum values from src. public void ExpandMax(Vec3d src) Parameters src Vec3d src ExpandMin(Vec3d) Find and expand minimum values from src. public void ExpandMin(Vec3d src) Parameters src Vec3d src ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetCosSquareWith(Vec3d) Get Cos(theta)^2. theta is the angle between this and src. This function is faster than GetCosWith(Vec3d) since it lacks one square root operation. public double GetCosSquareWith(Vec3d src) Parameters src Vec3d one of edge vector Returns double Cos(theta)^2 GetCosWith(Vec3d) Get Cos(theta). theta is the angle between this and v. public double GetCosWith(Vec3d v) Parameters v Vec3d a vector Returns double Cos(theta) GetCross(Vec3d) Get this cross src. public Vec3d GetCross(Vec3d src) Parameters src Vec3d src Returns Vec3d GetCsvText(string) Gets the CSV text representation of this vector with the specified format. public string GetCsvText(string format) Parameters format string Format string for the double values Returns string CSV formatted string GetEachValueAbs() Creates a new vector with the absolute value of each component. public Vec3d GetEachValueAbs() Returns Vec3d A new vector with absolute values of each component GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetMulEach(Vec3d) Creates a new vector by multiplying each component of this vector with the corresponding component of another vector. public Vec3d GetMulEach(Vec3d vec) Parameters vec Vec3d The vector to multiply with Returns Vec3d A new vector with component-wise multiplication results GetMulWithoutTrans(Mat4d) Get a new object by this*mat without translation part. public Vec3d GetMulWithoutTrans(Mat4d mat) Parameters mat Mat4d transform matrix Returns Vec3d new Vec3d(x * mat.At(0, 0) + y * mat.At(1, 0) + z * mat.At(2, 0) , x* mat.At(0, 1) + y* mat.At(1, 1) + z* mat.At(2, 1) , x* mat.At(0, 2) + y* mat.At(1, 2) + z* mat.At(2, 2)) GetNormalized() Generate normalized vec. public Vec3d GetNormalized() Returns Vec3d Normalized vec GetRadian(Vec3d) Get angle between this and v. The angle has no sign. This vector is not required to be an unit vector. public double GetRadian(Vec3d v) Parameters v Vec3d one of the edge vector. Not required to be an unit vector. Returns double Angle in radian GetRadian(Vec3d, Vec3d) Get angle between this and v. This function applies normal vector to determine the sign of angle. This vector is not required to be an unit vector. public double GetRadian(Vec3d v, Vec3d n) Parameters v Vec3d vector of ending edge. Not required to be an unit vector. n Vec3d normal vector. Not required to be an unit vector. Returns double angle in radian GetRadianByUnitVector(Vec3d) Get angle between this and v. The angle has no sign. This vector is not required to be an unit vector. Both this and v should be unit vector. Much efficient than GetRadian(Vec3d). public double GetRadianByUnitVector(Vec3d v) Parameters v Vec3d one of the edge vector. Not required to be an unit vector. Returns double Angle in radian GetTransform(Func) Get the new Vec3d by transforming each element by the function. public Vec3d GetTransform(Func transformingFunc) Parameters transformingFunc Func Returns Vec3d GetVec2dByPlaneDir(int) Gets a 2D vector by projecting the 3D vector onto a plane. public Vec2d GetVec2dByPlaneDir(int dir) Parameters dir int Direction index: 0 for YZ plane, 1 for ZX plane, 2 for XY plane Returns Vec2d A 2D vector representing the projection GetXRotation(double) Get rotated Vec3d along x direction. CCW. Much efficient than using Mat4d multiplication. public Vec3d GetXRotation(double rad) Parameters rad double rotation radian Returns Vec3d rotated Vec3d GetYRotation(double) Get rotated Vec3d along y direction. CCW. Much efficient than using Mat4d multiplication. public Vec3d GetYRotation(double rad) Parameters rad double rotation radian Returns Vec3d rotated Vec3d GetZRotation(double) Get rotated Vec3d along z direction. CCW. Much efficient than using Mat4d multiplication. public Vec3d GetZRotation(double rad) Parameters rad double rotation radian Returns Vec3d rotated Vec3d Interpolate(Vec3d, Vec3d, double) Interpolate from a to b with ratio alpha:(1-alpha). public static Vec3d Interpolate(Vec3d a, Vec3d b, double alpha) Parameters a Vec3d a b Vec3d b alpha double ratio Returns Vec3d a * (1 - alpha) + b * alpha IsNormalized(double) Checks if the vector is normalized (has a length of approximately 1). public bool IsNormalized(double toleranceSquare = 1E-07) Parameters toleranceSquare double Square of the tolerance value for comparing with 1 (default: 1e-7) Returns bool True if the vector is normalized within the specified tolerance MulEach(Vec3d) Multiplies each component of this vector with the corresponding component of another vector. public Vec3d MulEach(Vec3d vec) Parameters vec Vec3d The vector to multiply with Returns Vec3d This vector after multiplication MulWithoutTrans(Mat4d) this*=mat without translation part. public Vec3d MulWithoutTrans(Mat4d mat) Parameters mat Mat4d transformation matrix Returns Vec3d this See Also GetMulWithoutTrans(Mat4d) Normalize() Normalize this. public Vec3d Normalize() Returns Vec3d this Parse(string) If src is not null and not empty string, return Vec3d(string); otherwise return null. public static Vec3d Parse(string src) Parameters src string src Returns Vec3d parsed Vec3d ParseByCsv(string) Parses a vector from a CSV text string. public static Vec3d ParseByCsv(string csvText) Parameters csvText string CSV formatted string containing vector components Returns Vec3d A new vector parsed from the CSV text ReadBin(BinaryReader) Reads binary data to initialize the object. public void ReadBin(BinaryReader reader) Parameters reader BinaryReader The binary reader to read from Set(Vec3d) Set values by copy. public Vec3d Set(Vec3d src) Parameters src Vec3d src Returns Vec3d this Set(vec3d) Set values by copy. public Vec3d Set(vec3d src) Parameters src vec3d src Returns Vec3d this Set(double, double, double) Set values. public Vec3d Set(double x, double y, double z) Parameters x double x y double y z double z Returns Vec3d this Set(double[]) Set values by array. public Vec3d Set(double[] xyz) Parameters xyz double[] double[]{x,y,z} Returns Vec3d this Set(Func) Sets vector components using a function that maps direction index and current value to new value. public Vec3d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that takes direction index (0=X, 1=Y, 2=Z) and current value, and returns the new value Returns Vec3d This vector after modification Set(Func) Sets vector components using a function that maps direction index to value. public Vec3d Set(Func dirToValueFunc) Parameters dirToValueFunc Func Function that takes direction index (0=X, 1=Y, 2=Z) and returns the corresponding value Returns Vec3d This vector after modification Set(int, double, double, double) Set values by direction offset. Direction 0,1,2 indicate x,y,z respectively. public Vec3d Set(int dir, double a, double b, double c) Parameters dir int direction offset a double value at direction (0+dir)%3 b double value at direction (1+dir)%3 c double value at direction (2+dir)%3 Returns Vec3d this SetEachNanToZero() Set NaN to 0 for each value. public Vec3d SetEachNanToZero() Returns Vec3d this SetEachValueAbs() Set each value to absolute. public Vec3d SetEachValueAbs() Returns Vec3d this ToArray() return new double[] { x, y, z } public double[] ToArray() Returns double[] { x, y, z } ToBuf(double[]) Set x,y,z to the dst array. public void ToBuf(double[] dst) Parameters dst double[] dst ToBuf(double[], ref int) Set x,y,z to the dst array from postion p and increase p by the pushed number. public int ToBuf(double[] dst, ref int p) Parameters dst double[] dst p int position from dst Returns int Which is pushed number of double ToString() To representative string with format:(x,y,z). public override string ToString() Returns string Representative string ToString(string) To string with format: (x,y,z) public string ToString(string format) Parameters format string format of ToString(string) Returns string Representative string ToString(string, IFormatProvider) Returns a string representation of the vector formatted according to the specified format. public string ToString(string format, IFormatProvider formatProvider) Parameters format string The format to use for each component formatProvider IFormatProvider The format provider to use Returns string A formatted string representation of the vector ToString(string, int) Converts the vector to a string with the specified format and left padding. public string ToString(string format, int leftPadding) Parameters format string Format string for the double values leftPadding int Number of characters to pad on the left of each value Returns string Formatted string representation of the vector Transform(Func) Transform each element by the function. public Vec3d Transform(Func transformingFunc) Parameters transformingFunc Func Returns Vec3d TryParse(string, out Vec3d) Attempts to parse a string into a Vec3d. public static bool TryParse(string src, out Vec3d dst) Parameters src string The string to parse in format “(x,y,z)” dst Vec3d When this method returns, contains the Vec3d value if parsing succeeded, or null if parsing failed Returns bool true if parsing succeeded; otherwise, false WriteBin(BinaryWriter) Output to bytes: writer.Write(x); writer.Write(y); writer.Write(z); public void WriteBin(BinaryWriter writer) Parameters writer BinaryWriter writer Operators operator +(Vec3d, Vec3d) Plus. public static Vec3d operator +(Vec3d left, Vec3d right) Parameters left Vec3d a right Vec3d b Returns Vec3d new Vec3d(a.x + b.x, a.y + b.y, a.z + b.z) operator /(Vec3d, double) Get a new object from a scaled by 1/d. public static Vec3d operator /(Vec3d a, double d) Parameters a Vec3d d double Returns Vec3d operator ==(Vec3d, Vec3d) Equality operator for comparing two Vec3d objects. public static bool operator ==(Vec3d left, Vec3d right) Parameters left Vec3d Left operand right Vec3d Right operand Returns bool True if the vectors are equal, false otherwise operator !=(Vec3d, Vec3d) Inequality operator for comparing two Vec3d objects. public static bool operator !=(Vec3d left, Vec3d right) Parameters left Vec3d Left operand right Vec3d Right operand Returns bool True if the vectors are not equal, false otherwise operator *(Vec3d, Mat4d) Get p*src. public static Vec3d operator *(Vec3d p, Mat4d src) Parameters p Vec3d point src Mat4d transmform matrix Returns Vec3d new Vec3d(p.x * src.At(0, 0) + p.y * src.At(1, 0) + p.z * src.At(2, 0) + src.At(3, 0) , p.x* src.At(0, 1) + p.y* src.At(1, 1) + p.z* src.At(2, 1) + src.At(3, 1) , p.x* src.At(0, 2) + p.y* src.At(1, 2) + p.z* src.At(2, 2) + src.At(3, 2)) operator *(Vec3d, double) Scale a by s. public static Vec3d operator *(Vec3d a, double s) Parameters a Vec3d vector s double scale Returns Vec3d new Vec3d(a.x * s, a.y * s, a.z * s) operator -(Vec3d, Vec3d) Minus. public static Vec3d operator -(Vec3d a, Vec3d b) Parameters a Vec3d a b Vec3d b Returns Vec3d new Vec3d(a.x - b.x, a.y - b.y, a.z - b.z) operator -(Vec3d) Get negate vector. public static Vec3d operator -(Vec3d src) Parameters src Vec3d src Returns Vec3d new Vec3d(-src.x, -src.y, -src.z)" }, "api/Hi.Geom.Vec3dUtil.html": { "href": "api/Hi.Geom.Vec3dUtil.html", @@ -1572,7 +1597,7 @@ "api/Hi.Geom.html": { "href": "api/Hi.Geom.html", "title": "Namespace Hi.Geom | HiAPI-C# 2025", - "summary": "Namespace Hi.Geom Classes ArrayUtil Utility class for array operations. AxisAngle4d Axis(3d) and angle(1d) Box2d Lightweight 2d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box2d is Min and Max. Box2d.NoInit Flag for calling Box2d(NoInit). Box3d Lightweight 3d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box3d is Min and Max. Box3d.NoInit Flag for calling Box3d(NoInit). Cylindroid Geometry of Cylindroid. DVec3d Dual Vec3d with p(Vec3d) and n(Vec3d). GeomCombination A class that manages multiple STL sources as a single source. GeomUtil Utility of Geometry. Mat4d 4x4 Matrix. MathNetUtil Utility class for MathNet.Numerics operations. MathUtil Math Utility. NativeStl Native Stl. For purpose of efficient swept volume. NativeTopoStld Native TopoStl with element type double. NativeTopoStlfr Native TopoStl with element type fraction. PairZr Value pair of Z and R. PairZrUtil Utility class for working with PairZr objects Polar3d Represents a point in 3D space using polar coordinates Stl STL (stereolithography). Composed by Triangles. Provide Stl File R/W. StlFile Represents an STL file with loading and saving capabilities StlFuncHost A class that hosts a function to generate STL geometry. StlUtil Utility for Stl. TransformationGeom Represents a geometric transformation that can be applied to a geometry object. This class combines a transformer with a target geometry to produce transformed geometric results. Tri3d Basic 3D Triangle. Tri3dUtil Utility of Tri3d. Include generator of triangles from points. UnnullableDVec3d For Unnullable IO for DVec3d. Vec2d Basic 2D point (or vector). Vec2i Basic 2D point (or vector). Vec3d Basic 3D point (or vector). Vec3dUtil Utility and Extension of Vec3d. Interfaces IExpandToBox2d Object that can be expanded to a Box2d. IExpandToBox3d Object that can be expanded to a Box3d. IFlat3d Interface for a 3D flat surface that provides location and normal vector. IGeomProperty Interface for objects that have a geometry property. IGetStl Interface for retrieving STL geometry data. IGetZrContour Interface for retrieving Z-R contour data for rotational geometries. IGetZrList Interface for getting a list of Z-R pairs. ILinearAndRoundStlResolutionHost Interface for objects that control STL resolution parameters for both linear and angular measurements. IStlSource Stl provider with xml support. ITri3d Interface for 3D triangles. IVec Interface for vector types with generic element type. Enums Dir Enumeration of coordinate axis directions in 3D space. Mat4d.IndexFlag Specifies the indexing method for matrix construction from vectors. Stl.StlType Stl file format." + "summary": "Namespace Hi.Geom Classes ArrayUtil Utility class for array operations. AxisAngle4d Axis(3d) and angle(1d) Box2d Lightweight 2d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box2d is Min and Max. Box2d.NoInit Flag for calling Box2d(NoInit). Box3d Lightweight 3d box. An orthogonal box which the edges are all parallel with Cartesian Coordinate. The data contains in a Box3d is Min and Max. Box3d.NoInit Flag for calling Box3d(NoInit). Cylindroid Geometry of Cylindroid. DVec3d Dual Vec3d with p(Vec3d) and n(Vec3d). ExtendedCylinder Flat3d Represents a 3D plane defined by a unit normal vector and its signed distance from the origin. The plane equation is: Ax + By + Cz + d = 0, where (A,B,C) is the normal vector and d is the distance to origin. GeomCombination A class that manages multiple STL sources as a single source. GeomUtil Utility of Geometry. Mat4d 4x4 Matrix. MathNetUtil Utility class for MathNet.Numerics operations. MathUtil Math Utility. NativeStl Native Stl. For purpose of efficient swept volume. NativeTopoStld Native TopoStl with element type double. NativeTopoStlfr Native TopoStl with element type fraction. PairZr Value pair of Z and R. PairZrUtil Utility class for working with PairZr objects Polar3d Represents a point in 3D space using polar coordinates Segment3d Represents a 3D line segment defined by two endpoints. Stl STL (stereolithography). Composed by Triangles. Provide Stl File R/W. StlFile Represents an STL file with loading and saving capabilities StlFuncHost A class that hosts a function to generate STL geometry. StlUtil Utility for Stl. TransformationGeom Represents a geometric transformation that can be applied to a geometry object. This class combines a transformer with a target geometry to produce transformed geometric results. Tri3d Basic 3D Triangle. Tri3dUtil Utility of Tri3d. Include generator of triangles from points. UnnullableDVec3d For Unnullable IO for DVec3d. Vec2d Basic 2D point (or vector). Vec2i Basic 2D point (or vector). Vec3d Basic 3D point (or vector). Vec3dUtil Utility and Extension of Vec3d. Interfaces IExpandToBox2d Object that can be expanded to a Box2d. IExpandToBox3d Object that can be expanded to a Box3d. IFlat3d Interface for a 3D flat surface that provides location and normal vector. IGenStl IGeomProperty Interface for objects that have a geometry property. IGetStl Interface for retrieving STL geometry data. IGetZrContour Interface for retrieving Z-R contour data for rotational geometries. IGetZrList Interface for getting a list of Z-R pairs. IStlSource Stl provider with xml support. ITri3d Interface for 3D triangles. IVec Interface for vector types with generic element type. IZrListSourceProperty Enums Dir Enumeration of coordinate axis directions in 3D space. Mat4d.IndexFlag Specifies the indexing method for matrix construction from vectors. Stl.StlType Stl file format." }, "api/Hi.Grpcs.ClStripService.ClStripServiceBase.html": { "href": "api/Hi.Grpcs.ClStripService.ClStripServiceBase.html", @@ -1642,12 +1667,32 @@ "api/Hi.HiNcKits.HiNcHost.html": { "href": "api/Hi.HiNcKits.HiNcHost.html", "title": "Class HiNcHost | HiAPI-C# 2025", - "summary": "Class HiNcHost Namespace Hi.HiNcKits Assembly HiNc.dll Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration. public class HiNcHost : IDisposable Inheritance object HiNcHost Implements 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) Constructors HiNcHost(string, int, string) public HiNcHost(string adminDirectory, int mongodbPort, string displayEngineFontFile) Parameters adminDirectory string mongodbPort int displayEngineFontFile string The default value will be alternative if the value is null. Fields HiNcUserDbMetaName Gets the name of the HiNC user database metadata. public const string HiNcUserDbMetaName = \"UserDbMeta\" Field Value string HiNcUserDbName Gets the name of the HiNC user database. public const string HiNcUserDbName = \"HiNcUserDb\" Field Value string Properties AdminDir Admin absolute directory. public string AdminDir { get; } Property Value string AdminExtendedNamedPath Gets the admin extended named path. public ExtendedNamedPath AdminExtendedNamedPath { get; } Property Value ExtendedNamedPath AdminNamedPath Gets the admin named path. public NamedPath AdminNamedPath { get; } Property Value NamedPath CacheDbId Gets the cache database ID. public static string CacheDbId { get; set; } Property Value string DirectoryRoute The BaseDirectory is admin directory. The SubDirectory is current applied project directory. public BaseAndSubDirectory DirectoryRoute { get; } Property Value BaseAndSubDirectory MachiningProject Gets the current MachiningProject instance. public MachiningProject MachiningProject { get; } Property Value MachiningProject MongoServer Gets the main MongoDB runner. public IMongoRunner MongoServer { get; } Property Value IMongoRunner ProjectDir Project Absolute Directory. public string ProjectDir { get; } Property Value string ProjectExtendedNamedPath Gets the project extended named path. public ExtendedNamedPath ProjectExtendedNamedPath { get; } Property Value ExtendedNamedPath ProjectNamedPath Gets the project named path. public NamedPath ProjectNamedPath { get; } Property Value NamedPath ProjectPathRoute Gets the project path route. public PathRoute ProjectPathRoute { get; } Property Value PathRoute ProjectRelativeDirectory Gets the relative project directory path. public string ProjectRelativeDirectory { get; } Property Value string ResourceDir Resource absolute directory. public string ResourceDir { get; } Property Value string ResourceExtendedNamedPath Gets the resource extended named path. public ExtendedNamedPath ResourceExtendedNamedPath { get; } Property Value ExtendedNamedPath ResourceNamedPath Gets the resource named path. public NamedPath ResourceNamedPath { get; } Property Value NamedPath ResourceRelDir Relative directory from AdminDir for resource. public string ResourceRelDir { get; set; } Property Value string Methods CloseProject() Closes the current project. public Task CloseProject() Returns Task A task representing the asynchronous operation CopyResourceIfNotExisted() Copies resources if they don't already exist in the target location. public void CopyResourceIfNotExisted() 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 GetExtendedNamedPathByNamePath(string) Gets an extended named path by its name path. public ExtendedNamedPath GetExtendedNamedPathByNamePath(string namePath) Parameters namePath string The name path to look up. Returns ExtendedNamedPath The extended named path for the specified name path, or null if not found. GetExtendedNamedPathByPath(string) Gets an extended named path by its path. public ExtendedNamedPath GetExtendedNamedPathByPath(string path) Parameters path string The path to look up. Returns ExtendedNamedPath The extended named path with the specified path, or null if not found. GetExtendedNamedPathByUriPara(string) GetExtendedNamedPath By blazor page parameter. public ExtendedNamedPath GetExtendedNamedPathByUriPara(string uriPara) Parameters uriPara string Returns ExtendedNamedPath GetExtendedNamedPathList(params BasePathEnum[]) Gets a list of extended named paths for the specified base path types. public List GetExtendedNamedPathList(params BasePathEnum[] basePathEnums) Parameters basePathEnums BasePathEnum[] The base path types to include. Returns List A list of extended named paths. GetNamedPathByName(string) Gets a named path by its name. public NamedPath GetNamedPathByName(string name) Parameters name string The name of the path to retrieve Returns NamedPath The named path with the specified name, or null if not found GetNamedPathByPath(string) Gets a named path by its path. public NamedPath GetNamedPathByPath(string path) Parameters path string The path to look up. Returns NamedPath The named path with the specified path, or null if not found. GetNamedPathList(params BasePathEnum[]) Gets a list of named paths for the specified base path types. public List GetNamedPathList(params BasePathEnum[] basePathEnums) Parameters basePathEnums BasePathEnum[] The base path types to include. Returns List A list of named paths. LoadProjectByRelativePath(string) Loads a project from the specified relative file path. public Task LoadProjectByRelativePath(string relativeFilePathFromAdminRoot) Parameters relativeFilePathFromAdminRoot string The relative file path from the admin directory root Returns Task A task representing the asynchronous operation NewProjectByRelFile(string) Creates a new project from a relative file path. public void NewProjectByRelFile(string relFilePath) Parameters relFilePath string The relative file path from the admin directory ReloadProject() Reloads the current project. public Task ReloadProject() Returns Task A task representing the asynchronous operation SaveAsProject(string) Saves the current project to a specified relative file path. public void SaveAsProject(string relativeFilePathFromAdminRoot) Parameters relativeFilePathFromAdminRoot string The relative file path from the admin directory root SaveProject() Save project by ProjectPathRoute. public void SaveProject() ShowMessageBoard(string, string, BootstrapTheme) Shows a message board with specified title, message and theme. public void ShowMessageBoard(string title, string message, BootstrapTheme bootstrapThemeColor) Parameters title string The title of the message board message string The message to display bootstrapThemeColor BootstrapTheme The bootstrap theme color for the message board Events OnMachiningProjectDisposing Event raised when the MachiningProject is about to be disposed. public event Func OnMachiningProjectDisposing Event Type Func OnShownMessageBoard Event raised when a message board is shown. public event ShowMessageBoardDelegate OnShownMessageBoard Event Type ShowMessageBoardDelegate" + "summary": "Class HiNcHost Namespace Hi.HiNcKits Assembly HiNc.dll Rich HiNC Service. Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration. public class HiNcHost : IDisposable Inheritance object HiNcHost Implements 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) Constructors HiNcHost(string, int, string) public HiNcHost(string adminDirectory, int mongodbPort, string displayEngineFontFile) Parameters adminDirectory string mongodbPort int displayEngineFontFile string The default value will be alternative if the value is null. Fields HiNcUserDbMetaName Gets the name of the HiNC user database metadata. public const string HiNcUserDbMetaName = \"UserDbMeta\" Field Value string HiNcUserDbName Gets the name of the HiNC user database. public const string HiNcUserDbName = \"HiNcUserDb\" Field Value string Properties AdminDir Admin absolute directory. public string AdminDir { get; } Property Value string AdminExtendedNamedPath Gets the admin extended named path. public ExtendedNamedPath AdminExtendedNamedPath { get; } Property Value ExtendedNamedPath AdminNamedPath Gets the admin named path. public NamedPath AdminNamedPath { get; } Property Value NamedPath CacheDbId Gets the cache database ID. public static string CacheDbId { get; set; } Property Value string DirectoryRoute The BaseDirectory is admin directory. The SubDirectory is current applied project directory. public BaseAndSubDirectory DirectoryRoute { get; } Property Value BaseAndSubDirectory MachiningProject Gets the current MachiningProject instance. public MachiningProject MachiningProject { get; } Property Value MachiningProject MongoServer Gets the main MongoDB runner. public IMongoRunner MongoServer { get; } Property Value IMongoRunner ProjectDir Project Absolute Directory. public string ProjectDir { get; } Property Value string ProjectExtendedNamedPath Gets the project extended named path. public ExtendedNamedPath ProjectExtendedNamedPath { get; } Property Value ExtendedNamedPath ProjectNamedPath Gets the project named path. public NamedPath ProjectNamedPath { get; } Property Value NamedPath ProjectPathRoute Gets the project path route. public PathRoute ProjectPathRoute { get; } Property Value PathRoute ProjectRelativeDirectory Gets the relative project directory path. public string ProjectRelativeDirectory { get; } Property Value string ResourceDir Resource absolute directory. public string ResourceDir { get; } Property Value string ResourceExtendedNamedPath Gets the resource extended named path. public ExtendedNamedPath ResourceExtendedNamedPath { get; } Property Value ExtendedNamedPath ResourceNamedPath Gets the resource named path. public NamedPath ResourceNamedPath { get; } Property Value NamedPath ResourceRelDir Relative directory from AdminDir for resource. public string ResourceRelDir { get; set; } Property Value string Methods CloseProject() Closes the current project. public Task CloseProject() Returns Task A task representing the asynchronous operation CopyResourceIfNotExisted() Copies resources if they don't already exist in the target location. public void CopyResourceIfNotExisted() 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 GetExtendedNamedPathByNamePath(string) Gets an extended named path by its name path. public ExtendedNamedPath GetExtendedNamedPathByNamePath(string namePath) Parameters namePath string The name path to look up. Returns ExtendedNamedPath The extended named path for the specified name path, or null if not found. GetExtendedNamedPathByPath(string) Gets an extended named path by its path. public ExtendedNamedPath GetExtendedNamedPathByPath(string path) Parameters path string The path to look up. Returns ExtendedNamedPath The extended named path with the specified path, or null if not found. GetExtendedNamedPathByUriPara(string) GetExtendedNamedPath By blazor page parameter. public ExtendedNamedPath GetExtendedNamedPathByUriPara(string uriPara) Parameters uriPara string Returns ExtendedNamedPath GetExtendedNamedPathList(params BasePathEnum[]) Gets a list of extended named paths for the specified base path types. public List GetExtendedNamedPathList(params BasePathEnum[] basePathEnums) Parameters basePathEnums BasePathEnum[] The base path types to include. Returns List A list of extended named paths. GetNamedPathByName(string) Gets a named path by its name. public NamedPath GetNamedPathByName(string name) Parameters name string The name of the path to retrieve Returns NamedPath The named path with the specified name, or null if not found GetNamedPathByPath(string) Gets a named path by its path. public NamedPath GetNamedPathByPath(string path) Parameters path string The path to look up. Returns NamedPath The named path with the specified path, or null if not found. GetNamedPathList(params BasePathEnum[]) Gets a list of named paths for the specified base path types. public List GetNamedPathList(params BasePathEnum[] basePathEnums) Parameters basePathEnums BasePathEnum[] The base path types to include. Returns List A list of named paths. LoadProjectByRelativePath(string) Loads a project from the specified relative file path. public Task LoadProjectByRelativePath(string relativeFilePathFromAdminRoot) Parameters relativeFilePathFromAdminRoot string The relative file path from the admin directory root Returns Task A task representing the asynchronous operation NewProjectByRelFile(string) Creates a new project from a relative file path. public void NewProjectByRelFile(string relFilePath) Parameters relFilePath string The relative file path from the admin directory ReloadProject() Reloads the current project. public Task ReloadProject() Returns Task A task representing the asynchronous operation SaveAsProject(string) Saves the current project to a specified relative file path. public void SaveAsProject(string relativeFilePathFromAdminRoot) Parameters relativeFilePathFromAdminRoot string The relative file path from the admin directory root SaveProject() Save project by ProjectPathRoute. public void SaveProject() ShowMessageBoard(string, string, BootstrapTheme) Shows a message board with specified title, message and theme. public void ShowMessageBoard(string title, string message, BootstrapTheme bootstrapThemeColor) Parameters title string The title of the message board message string The message to display bootstrapThemeColor BootstrapTheme The bootstrap theme color for the message board Events OnMachiningProjectDisposing Event raised when the MachiningProject is about to be disposed. public event Func OnMachiningProjectDisposing Event Type Func OnShownMessageBoard Event raised when a message board is shown. public event ShowMessageBoardDelegate OnShownMessageBoard Event Type ShowMessageBoardDelegate" + }, + "api/Hi.HiNcKits.HostConfig.html": { + "href": "api/Hi.HiNcKits.HostConfig.html", + "title": "Class HostConfig | HiAPI-C# 2025", + "summary": "Class HostConfig Namespace Hi.HiNcKits Assembly HiNc.dll public class HostConfig Inheritance object HostConfig 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) Constructors HostConfig() public HostConfig() HostConfig(XElement, string) Initializes a new instance of the HostConfig class from XML data. public HostConfig(XElement src, string baseDirectory) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths Properties MongoPort public int MongoPort { get; set; } Property Value int XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string relFile string Returns XElement" + }, + "api/Hi.HiNcKits.LocalApp.html": { + "href": "api/Hi.HiNcKits.LocalApp.html", + "title": "Class LocalApp | HiAPI-C# 2025", + "summary": "Class LocalApp Namespace Hi.HiNcKits Assembly HiNc.dll public static class LocalApp Inheritance object LocalApp Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields HostConfigPath public const string HostConfigPath = \"hinc-host-config.xml\" Field Value string UserConfigPath public const string UserConfigPath = \"hinc-user-config.xml\" Field Value string Properties HostConfig public static HostConfig HostConfig { get; set; } Property Value HostConfig UserConfig public static UserConfig UserConfig { get; } Property Value UserConfig UserEnv public static UserEnv UserEnv { get; } Property Value UserEnv Methods AppBegin() public static void AppBegin() AppEnd() public static void AppEnd() LooseSaveUserConfig() public static void LooseSaveUserConfig() SaveUserConfig() public static void SaveUserConfig()" + }, + "api/Hi.HiNcKits.UserConfig.html": { + "href": "api/Hi.HiNcKits.UserConfig.html", + "title": "Class UserConfig | HiAPI-C# 2025", + "summary": "Class UserConfig Namespace Hi.HiNcKits Assembly HiNc.dll public class UserConfig : IMakeXmlSource Inheritance object UserConfig Implements IMakeXmlSource 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) Constructors UserConfig() Default constructor public UserConfig() UserConfig(XElement, string) Initializes a new instance of the UserConfig class from XML data. public UserConfig(XElement src, string baseDirectory) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths Properties DisplayedStepPresentKeyList Step infomation key list to show. public List DisplayedStepPresentKeyList { get; set; } Property Value List EquipmentWorkpieceSetupDisplayeeConfig Configuration for EquipmentWorkpieceSetupDisplayee public WorkpieceEditorDisplayeeConfig EquipmentWorkpieceSetupDisplayeeConfig { get; set; } Property Value WorkpieceEditorDisplayeeConfig FixtureSetupDisplayeeConfig Configuration for FixtureSetupDisplayee public FixtureEditorDisplayeeConfig FixtureSetupDisplayeeConfig { get; set; } Property Value FixtureEditorDisplayeeConfig GraphicCacheLowerLimitMb public double GraphicCacheLowerLimitMb { get; set; } Property Value double GraphicCacheMb public long GraphicCacheMb { get; set; } Property Value long GraphicCacheUpperLimitMb public double GraphicCacheUpperLimitMb { get; set; } Property Value double LanguageCode public string LanguageCode { get; set; } Property Value string ShowPhysicsOptions public bool ShowPhysicsOptions { get; set; } Property Value bool XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." + }, + "api/Hi.HiNcKits.UserEnv.html": { + "href": "api/Hi.HiNcKits.UserEnv.html", + "title": "Class UserEnv | HiAPI-C# 2025", + "summary": "Class UserEnv Namespace Hi.HiNcKits Assembly HiNc.dll Environment of a HiNC user. public class UserEnv Inheritance object UserEnv 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) Properties AdditionalStepPresentAccess public Dictionary AdditionalStepPresentAccess { get; set; } Property Value Dictionary CandidateStepPresentKeyList Candidate Step Present Key List for display. Read only. public List CandidateStepPresentKeyList { get; } Property Value List DisplayedStepPresentAccessList StepPresentAccessList for display. Read only. public List> DisplayedStepPresentAccessList { get; } Property Value List> EnablePhysics public bool EnablePhysics { get; } Property Value bool IsPhysicsLicensed public bool IsPhysicsLicensed { get; } Property Value bool SelectedItem public object SelectedItem { get; set; } Property Value object StepPresentAccessDictionary StepPresentAccessDictionary. Read only. public Dictionary StepPresentAccessDictionary { get; } Property Value Dictionary UserConfig public UserConfig UserConfig { get; set; } Property Value UserConfig" }, "api/Hi.HiNcKits.html": { "href": "api/Hi.HiNcKits.html", "title": "Namespace Hi.HiNcKits | HiAPI-C# 2025", - "summary": "Namespace Hi.HiNcKits Classes HiNcHost Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration. Enums BasePathEnum Enumeration of base path types used in the HiNC system." + "summary": "Namespace Hi.HiNcKits Classes HiNcHost Rich HiNC Service. Host class for HiNC functionality that provides project management, path resolution, and MongoDB integration. HostConfig LocalApp UserConfig UserEnv Environment of a HiNC user. Enums BasePathEnum Enumeration of base path types used in the HiNC system." }, "api/Hi.Licenses.AuthFeature.html": { "href": "api/Hi.Licenses.AuthFeature.html", @@ -1679,15 +1724,15 @@ "title": "Namespace Hi.Licenses | HiAPI-C# 2025", "summary": "Namespace Hi.Licenses Classes AuthorizationFailedEventArgs Event arguments for authorization failure events. License License of this module. Enums AuthFeature Internal Use Only. BlockType Block type. LicenseType Defines the types of licenses available." }, - "api/Hi.Machining.FreeformCutter.html": { - "href": "api/Hi.Machining.FreeformCutter.html", - "title": "Class FreeformCutter | HiAPI-C# 2025", - "summary": "Class FreeformCutter Namespace Hi.Machining Assembly HiMech.dll Represents a freeform cutting tool that can be used in machining operations. This cutter type supports complex geometries for both the noble (upper) part and the shaper (cutting) part. public class FreeformCutter : ICutter, IGetSweptable, IVolumeRemover, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache Inheritance object FreeformCutter Implements ICutter IGetSweptable IVolumeRemover ITopoDisplayee IGetAsmb IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IGetAnchoredDisplayeeList IGetFletchBuckle IMakeXmlSource IAbstractNote IAnchoredCollidableStem IAnchoredCollidableNode IAnchoredCollidableBased IExpandToBox3d IDuplicate IDisposable IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) CutterUtil.GetCutterBodyCoolingArea_mm2(ICutter) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks The FreeformCutter class provides functionality for: Managing complex cutting tool geometries Supporting both spinning and non-spinning cutting operations Handling collision detection and display Managing tool assembly and anchoring Supporting XML serialization and deserialization Constructors FreeformCutter() Initializes a new instance of the FreeformCutter class. public FreeformCutter() Remarks This constructor initializes the cutter with default settings and creates the necessary anchors and topology bricks for both the noble and shaper parts. FreeformCutter(XElement, string, string, params object[]) Initializes a new instance of the FreeformCutter class from XML data. public FreeformCutter(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement The XML element containing the cutter data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path for resolving references. res object[] Additional resources for initialization. Properties AbstractNote Gets a brief description of the cutter, including its height. public string AbstractNote { get; } Property Value string Remarks The abstract note includes the cutter type and its height dimension, formatted as \"Freeform-H{height}\". CollidableName Gets the name used for collision detection purposes. public string CollidableName { get; } Property Value string CutterTip Gets the cutter tip anchor point. public Anchor CutterTip { get; } Property Value Anchor Remarks The cutter tip represents the reference point for the cutting edge or surface. This point is used for positioning and orientation calculations during machining operations. IsSpinningCutter Gets or sets a value indicating whether this is a spinning cutting tool. public bool IsSpinningCutter { get; set; } Property Value bool Remarks This property affects how the cutter interacts with the workpiece during machining operations. Spinning cutters typically perform rotary cutting operations, while non-spinning cutters may be used for other types of machining. NobleGeom Gets or sets the noble (upper) part geometry of the cutter. public IGetStl NobleGeom { get; set; } Property Value IGetStl Remarks The noble geometry represents the non-cutting portion of the tool, typically including the tool holder and shank. This geometry is important for collision checking and visualization. ShaperGeom Gets or sets the shaper (cutting) part geometry of the cutter. public IGetStl ShaperGeom { get; set; } Property Value IGetStl Remarks The shaper geometry represents the cutting portion of the tool that directly interacts with the workpiece during machining operations. ShaperTopoBrick Gets the topology brick representing the shaper (cutting) part of the cutter. public ITopoBrick ShaperTopoBrick { get; } Property Value ITopoBrick UpperBeamTopoBrick Gets the topology brick representing the upper (noble) part of the cutter. public ITopoBrick UpperBeamTopoBrick { get; } Property Value ITopoBrick XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears all cached data associated with the cutter. public void ClearCache() Remarks This includes clearing the cached sweptable and solid representations of both the noble and shaper parts of the cutter. Display(Bind) Displays the cutter using the provided binding context. public void Display(Bind bind) Parameters bind Bind The binding context for display operations. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources used by the FreeformCutter and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. Duplicate(params object[]) Creates a deep copy of the current FreeformCutter instance. public object Duplicate(params object[] res) Parameters res object[] Additional resources for duplication. Returns object A new FreeformCutter instance with copied geometry data. ExpandToBox3d(Box3d) Expands the given bounding box to include the cutter's geometry. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand. GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredCollidables() Gets the list of anchored collidable nodes contained by this stem. public List GetAnchoredCollidables() Returns List A list of anchored collidable nodes. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetNobleAnchoredDisplayee() Gets the noble (upper) part displayee for visualization purposes. public AnchoredDisplayee GetNobleAnchoredDisplayee() Returns AnchoredDisplayee An AnchoredDisplayee representing the noble part of the cutter with modified display properties. Remarks This method creates a display representation of the noble geometry with slightly darker coloring to distinguish it from the shaper part during visualization. GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetShaperDisplayee() Gets the shaper displayee for visualization purposes. public IAnchoredDisplayee GetShaperDisplayee() Returns IAnchoredDisplayee An IAnchoredDisplayee representing the shaper (cutting) part of the cutter. Remarks This method creates a display representation of the shaper geometry, which can be either the raw geometry if it implements IDisplayee, or the topology brick representation. GetSweptable(double) Gets the sweptable representation of the cutter for swept volume calculations. public Sweptable GetSweptable(double fractionTolerance) Parameters fractionTolerance double The tolerance value for swept volume calculations. Returns Sweptable A Sweptable object representing the cutter's swept volume, or null if the shaper geometry is not available. Remarks The sweptable representation is cached for performance. Use ClearCache to reset the cached data. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "api/Hi.Machining.FreeformRemover.html": { + "href": "api/Hi.Machining.FreeformRemover.html", + "title": "Class FreeformRemover | HiAPI-C# 2025", + "summary": "Class FreeformRemover Namespace Hi.Machining Assembly HiMech.dll Represents a freeform cutting tool that can be used in machining operations. This cutter type supports complex geometries for both the noble (upper) part and the shaper (cutting) part. public class FreeformRemover : ICutter, IGetSweptable, IVolumeRemover, IAnchoredDisplayee, IDisplayee, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache, INameNote Inheritance object FreeformRemover Implements ICutter IGetSweptable IVolumeRemover IAnchoredDisplayee IDisplayee ITopo IGetAsmb IGetAnchor IGetTopoIndex IGetAnchoredDisplayeeList IGetFletchBuckle IMakeXmlSource IAbstractNote IAnchoredCollidableStem IAnchoredCollidableNode IAnchoredCollidableBased IExpandToBox3d IDuplicate IDisposable IClearCache INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) CutterUtil.GetCutterBodyCoolingArea_mm2(ICutter) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks The FreeformRemover class provides functionality for: Managing complex cutting tool geometries Supporting both spinning and non-spinning cutting operations Handling collision detection and display Managing tool assembly and anchoring Supporting XML serialization and deserialization Constructors FreeformRemover() Initializes a new instance. public FreeformRemover() Remarks This constructor initializes the cutter with default settings and creates the necessary anchors and topology bricks for both the noble and shaper parts. FreeformRemover(XElement, string, string, params object[]) Initializes a new instance from XML data. public FreeformRemover(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement The XML element containing the cutter data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path for resolving references. res object[] Additional resources for initialization. Properties AbstractNote Gets a brief description of the cutter, including its height. public string AbstractNote { get; } Property Value string Remarks The abstract note includes the cutter type and its height dimension, formatted as \"Freeform-H{height}\". CollidableName Gets the name used for collision detection purposes. public string CollidableName { get; } Property Value string CutterTip Gets the cutter tip anchor point. On the same location of GeomAnchor. public Anchor CutterTip { get; } Property Value Anchor Remarks The cutter tip represents the reference point for the cutting edge or surface. This point is used for positioning and orientation calculations during machining operations. GeomAnchor StrutGeom and ShaperGeom locate on this anchor. On the same location of CutterTip. public Anchor GeomAnchor { get; } Property Value Anchor GeomToHolderBranch public Branch GeomToHolderBranch { get; } Property Value Branch GeomToHolderTransformer public ITransformer GeomToHolderTransformer { get; set; } Property Value ITransformer IsSpinningCutter Gets or sets a value indicating whether this is a spinning cutting tool. public bool IsSpinningCutter { get; set; } Property Value bool Remarks This property affects how the cutter interacts with the workpiece during machining operations. Spinning cutters typically perform rotary cutting operations, while non-spinning cutters may be used for other types of machining. KeepHolderBuckleOnTop public bool KeepHolderBuckleOnTop { get; set; } Property Value bool Name Name. public string Name { get; set; } Property Value string Note Note. public string Note { get; set; } Property Value string ShaperGeom Gets or sets the shaper (cutting) part geometry of the cutter. public IGetStl ShaperGeom { get; set; } Property Value IGetStl Remarks The shaper geometry represents the cutting portion of the tool that directly interacts with the workpiece during machining operations. ShaperTopoBrick Gets the topology brick representing the shaper (cutting) part of the cutter. public ITopoBrick ShaperTopoBrick { get; } Property Value ITopoBrick StrutGeom Gets or sets the strut (upper) part geometry of the cutter. public IGetStl StrutGeom { get; set; } Property Value IGetStl Remarks The noble geometry represents the non-cutting portion of the tool, typically including the tool holder and shank. This geometry is important for collision checking and visualization. StrutTopoBrick Gets the topology brick representing the upper (noble) part of the cutter. public ITopoBrick StrutTopoBrick { get; } Property Value ITopoBrick XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears all cached data associated with the cutter. public void ClearCache() Remarks This includes clearing the cached sweptable and solid representations of both the noble and shaper parts of the cutter. Display(Bind) Displays the cutter using the provided binding context. public void Display(Bind bind) Parameters bind Bind The binding context for display operations. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. Duplicate(params object[]) Creates a deep copy of the current instance. public object Duplicate(params object[] res) Parameters res object[] Additional resources for duplication. Returns object A new instance with copied geometry data. ExpandToBox3d(Box3d) Expands the given bounding box to include the cutter's geometry. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand. GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredCollidables() Gets the list of anchored collidable nodes contained by this stem. public List GetAnchoredCollidables() Returns List A list of anchored collidable nodes. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetShaperDisplayee() Gets the shaper displayee for visualization purposes. public IAnchoredDisplayee GetShaperDisplayee() Returns IAnchoredDisplayee An IAnchoredDisplayee representing the shaper (cutting) part of the cutter. Remarks This method creates a display representation of the shaper geometry, which can be either the raw geometry if it implements IDisplayee, or the topology brick representation. GetStrutAnchoredDisplayee() Gets the noble (upper) part displayee for visualization purposes. public AnchoredDisplayee GetStrutAnchoredDisplayee() Returns AnchoredDisplayee An AnchoredDisplayee representing the noble part of the cutter with modified display properties. Remarks This method creates a display representation of the noble geometry with slightly darker coloring to distinguish it from the shaper part during visualization. GetSweptable(double) Gets the sweptable representation of the cutter for swept volume calculations. public Sweptable GetSweptable(double fractionTolerance) Parameters fractionTolerance double The tolerance value for swept volume calculations. Returns Sweptable A Sweptable object representing the cutter's swept volume, or null if the shaper geometry is not available. Remarks The sweptable representation is cached for performance. Use ClearCache to reset the cached data. 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." }, "api/Hi.Machining.ICutter.html": { "href": "api/Hi.Machining.ICutter.html", "title": "Interface ICutter | HiAPI-C# 2025", - "summary": "Interface ICutter Namespace Hi.Machining Assembly HiMech.dll Interface of cutter. public interface ICutter : IGetSweptable, IVolumeRemover, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache Inherited Members IGetSweptable.GetSweptable(double) IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IDisplayee.Display(Bind) IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetFletchBuckle.GetFletchBuckle() IMakeXmlSource.MakeXmlSource(string, string) IAbstractNote.AbstractNote IAnchoredCollidableStem.GetAnchoredCollidables() IAnchoredCollidableBased.CollidableName IAnchoredCollidableBased.GetAnchoredCollidableNode() IExpandToBox3d.ExpandToBox3d(Box3d) IDuplicate.Duplicate(params object[]) IDisposable.Dispose() IClearCache.ClearCache() Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) CutterUtil.GetCutterBodyCoolingArea_mm2(ICutter) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties CutterTip Gets the anchor point representing the tip of the cutter. Anchor CutterTip { get; } Property Value Anchor The anchor point at the cutter tip, or null if the shaper topology brick is not available. Remarks The cutter tip is the reference point for the cutting tool, typically located at the end of the shaper part. This point is used for positioning and orientation calculations during machining operations. IsSpinningCutter Is cutter spining when machining. bool IsSpinningCutter { get; } Property Value bool Is cutter spining when machining. ShaperTopoBrick cutable part of cutter. the part cut the workpiece if overlapped. ITopoBrick ShaperTopoBrick { get; } Property Value ITopoBrick UpperBeamTopoBrick uncutable part of cutter. the part triggers collision to workpiece if overlapped. ITopoBrick UpperBeamTopoBrick { get; } Property Value ITopoBrick" + "summary": "Interface ICutter Namespace Hi.Machining Assembly HiMech.dll Interface of cutter. public interface ICutter : IGetSweptable, IVolumeRemover, IAnchoredDisplayee, IDisplayee, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IExpandToBox3d, IDuplicate, IDisposable, IClearCache, INameNote Inherited Members IGetSweptable.GetSweptable(double) IDisplayee.Display(Bind) IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetFletchBuckle.GetFletchBuckle() IMakeXmlSource.MakeXmlSource(string, string, bool) IAbstractNote.AbstractNote IAnchoredCollidableStem.GetAnchoredCollidables() IAnchoredCollidableBased.CollidableName IAnchoredCollidableBased.GetAnchoredCollidableNode() IExpandToBox3d.ExpandToBox3d(Box3d) IDuplicate.Duplicate(params object[]) IDisposable.Dispose() IClearCache.ClearCache() INameNote.Name INameNote.Note Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) CutterUtil.GetCutterBodyCoolingArea_mm2(ICutter) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties CutterThemeColor public static Vec3d CutterThemeColor { get; } Property Value Vec3d CutterTip Gets the anchor point representing the tip of the cutter. Anchor CutterTip { get; } Property Value Anchor The anchor point at the cutter tip, or null if the shaper topology brick is not available. Remarks The cutter tip is the reference point for the cutting tool, typically located at the end of the shaper part. This point is used for positioning and orientation calculations during machining operations. IsSpinningCutter Is cutter spining when machining. bool IsSpinningCutter { get; } Property Value bool Is cutter spining when machining. ShankThemeColor public static Vec3d ShankThemeColor { get; } Property Value Vec3d ShaperTopoBrick cutable part of cutter. the part cut the workpiece if overlapped. ITopoBrick ShaperTopoBrick { get; } Property Value ITopoBrick StrutTopoBrick uncutable part of cutter. the part triggers collision to workpiece if overlapped. ITopoBrick StrutTopoBrick { get; } Property Value ITopoBrick" }, "api/Hi.Machining.ICutterAnchorable.html": { "href": "api/Hi.Machining.ICutterAnchorable.html", @@ -1702,7 +1747,7 @@ "api/Hi.Machining.IMachiningTool.html": { "href": "api/Hi.Machining.IMachiningTool.html", "title": "Interface IMachiningTool | HiAPI-C# 2025", - "summary": "Interface IMachiningTool Namespace Hi.Machining Assembly HiMech.dll Interface for machining tools that combine a holder and a cutter. public interface IMachiningTool : ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache Inherited Members IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetFletchBuckle.GetFletchBuckle() IMakeXmlSource.MakeXmlSource(string, string) IAbstractNote.AbstractNote IDuplicate.Duplicate(params object[]) IClearCache.ClearCache() Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MillingToolUtil.GetFluteNum(IMachiningTool) MillingToolUtil.GetFullH(IMachiningTool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties Cutter Gets the cutting tool. ICutter Cutter { get; } Property Value ICutter ExposedCutterBendingPara_umdN Gets the exposed cutter bending parameter in micrometers per Newton. double ExposedCutterBendingPara_umdN { get; } Property Value double ExposedCutterHeight_mm Gets or sets the exposed cutter height in millimeters. double ExposedCutterHeight_mm { get; set; } Property Value double ExposedCutterZDeflectionPara_umdN Gets the exposed cutter Z-axis deflection parameter in micrometers per Newton. double ExposedCutterZDeflectionPara_umdN { get; } Property Value double Holder Gets the tool holder. IHolder Holder { get; } Property Value IHolder Note Gets or sets the note for this machining tool. string Note { get; set; } Property Value string SpindleBuckleToToolTipLength Gets the length from spindle buckle to tool tip in millimeters. double SpindleBuckleToToolTipLength { get; } Property Value double ToolTip Gets the tool tip anchor point. Anchor ToolTip { get; } Property Value Anchor" + "summary": "Interface IMachiningTool Namespace Hi.Machining Assembly HiMech.dll Interface for machining tools that combine a holder and a cutter. public interface IMachiningTool : IDisplayee, IExpandToBox3d, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache, IGetFluteNum Inherited Members IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetFletchBuckle.GetFletchBuckle() IMakeXmlSource.MakeXmlSource(string, string, bool) IAbstractNote.AbstractNote IDuplicate.Duplicate(params object[]) IClearCache.ClearCache() IGetFluteNum.GetFluteNum() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MillingToolUtil.GetFullH(IMachiningTool) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties Cutter Gets the cutting tool. ICutter Cutter { get; } Property Value ICutter ExposedCutterBendingPara_umdN Gets the exposed cutter bending parameter in micrometers per Newton. double ExposedCutterBendingPara_umdN { get; } Property Value double ExposedCutterHeight_mm Gets or sets the exposed cutter height in millimeters. double ExposedCutterHeight_mm { get; set; } Property Value double ExposedCutterZDeflectionPara_umdN Gets the exposed cutter Z-axis deflection parameter in micrometers per Newton. double ExposedCutterZDeflectionPara_umdN { get; } Property Value double Holder Gets the tool holder. IHolder Holder { get; } Property Value IHolder Note Gets or sets the note for this machining tool. string Note { get; set; } Property Value string SpindleBuckleToToolTipLength Gets the length from spindle buckle to tool tip in millimeters. double SpindleBuckleToToolTipLength { get; } Property Value double ToolTip Gets the tool tip anchor point. Anchor ToolTip { get; } Property Value Anchor" }, "api/Hi.Machining.IVolumeRemover.html": { "href": "api/Hi.Machining.IVolumeRemover.html", @@ -1722,22 +1767,22 @@ "api/Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html": { "href": "api/Hi.Machining.MachiningEquipmentUtils.IMachiningEquipment.html", "title": "Interface IMachiningEquipment | HiAPI-C# 2025", - "summary": "Interface IMachiningEquipment Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Machining equipment. public interface IMachiningEquipment : IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetMachiningChain, IGetSolidMachiningChain Inherited Members IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IMakeXmlSource.MakeXmlSource(string, string) IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetProgramCl.GetProgramCl() IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IGetMachiningChain.GetMachiningChain() IGetSolidMachiningChain.GetSolidMachiningChain() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(IMachiningEquipment) MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment) MachiningEquipmentUtil.RunByStep(IMachiningEquipment, INcStep0, MachiningToolHouse) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties Fixture Fixture of workpiece. Fixture Fixture { get; set; } Property Value Fixture MachiningTool Milling tool. IMachiningTool MachiningTool { get; set; } Property Value IMachiningTool TableToComp Component transformation from table. ITransformer TableToComp { get; set; } Property Value ITransformer Workpiece Workpiece. Workpiece Workpiece { get; set; } Property Value Workpiece" + "summary": "Interface IMachiningEquipment Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Machining equipment. public interface IMachiningEquipment : IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetMachiningChain Inherited Members IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IMakeXmlSource.MakeXmlSource(string, string, bool) IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetProgramCl.GetProgramCl() IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() IGetMachiningChain.GetMachiningChain() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(IMachiningEquipment) MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment) MachiningEquipmentUtil.RunByStep(IMachiningEquipment, INcStep0, MachiningToolHouse) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties Fixture Fixture of workpiece. Fixture Fixture { get; set; } Property Value Fixture MachiningTool Milling tool. IMachiningTool MachiningTool { get; set; } Property Value IMachiningTool TableToComp Component transformation from table. ITransformer TableToComp { get; set; } Property Value ITransformer Workpiece Workpiece. Workpiece Workpiece { get; set; } Property Value Workpiece" }, "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html": { "href": "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipment.html", "title": "Class MachiningEquipment | HiAPI-C# 2025", - "summary": "Class MachiningEquipment Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Machining Equipment. Include the machining chain, workpiece, tool and fixture, etc.. public class MachiningEquipment : IMachiningEquipment, IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetMachiningChain, IGetSolidMachiningChain, IGetMachiningEquipment Inheritance object MachiningEquipment Implements IMachiningEquipment IDisplayee IExpandToBox3d IMakeXmlSource IGetAnchoredDisplayeeList IGetProgramCl IGetAsmb IGetTopoIndex IGetRootAnchor IGetMachiningChain IGetSolidMachiningChain IGetMachiningEquipment Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(IMachiningEquipment) MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment) MachiningEquipmentUtil.RunByStep(IMachiningEquipment, INcStep0, MachiningToolHouse) 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) Constructors MachiningEquipment() Ctor. public MachiningEquipment() MachiningEquipment(XElement, string, string) Initializes a new instance of the MachiningEquipment class from XML data. public MachiningEquipment(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing the equipment configuration. baseDirectory string The base directory for resolving relative file paths. relFile string The relative file path for XML serialization. Properties Asmb Asmb of the entire equipment. public Asmb Asmb { get; } Property Value Asmb BackgroundTemperature_C Gets or sets the background temperature in Celsius. This is a convenience property that converts between Celsius and Kelvin. public double BackgroundTemperature_C { get; set; } Property Value double BackgroundTemperature_K Gets or sets the background temperature in Kelvin. This represents the ambient temperature of the machining environment. public double BackgroundTemperature_K { get; set; } Property Value double CoolantHeatCondition Gets or sets the coolant heat condition settings. This includes coolant temperature and heat transfer coefficients. public CoolantHeatCondition CoolantHeatCondition { get; set; } Property Value CoolantHeatCondition Fixture Fixture. public Fixture Fixture { get; set; } Property Value Fixture MachiningTool Milling tool. public IMachiningTool MachiningTool { get; set; } Property Value IMachiningTool SolidMachiningChain Body of the equipment. public ISolidMachiningChain SolidMachiningChain { get; set; } Property Value ISolidMachiningChain SolidMachiningChainFile Gets or sets the file path of the solid machining chain. This is used for XML serialization and file management. public string SolidMachiningChainFile { get; set; } Property Value string SpindleCapability Gets or sets the spindle capability configuration. This defines the operational capabilities and limits of the spindle. public SpindleCapability SpindleCapability { get; set; } Property Value SpindleCapability SpindleCapabilityFile Gets or sets the file path of the spindle capability configuration. This is used for XML serialization and file management. public string SpindleCapabilityFile { get; set; } Property Value string TableToComp Transformer of the branch from table buckle to workpiece side buckle. Note that the workpiece side buckle links to Fixture if fixture exist; otherwise, it links to Workpiece if workpiece exist. If Workpiece either Fixture do not exist, this property makes no effect. public ITransformer TableToComp { get; set; } Property Value ITransformer Workpiece Workpiece. public Workpiece Workpiece { get; set; } Property Value Workpiece XName Name for XML IO. public static string XName { get; } Property Value string Methods Detect(bool) Performs collision detection. public MechCollisionResult Detect(bool addFluteAndWorkpieceDetection) Parameters addFluteAndWorkpieceDetection bool Whether to include flute and workpiece in detection. Returns MechCollisionResult Significant collision result. Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetMachiningChain() Gets the machining chain instance. public IMachiningChain GetMachiningChain() Returns IMachiningChain The machining chain instance. GetMillingEquipment() Get MachiningEquipment. public MachiningEquipment GetMillingEquipment() Returns MachiningEquipment MachiningEquipment GetProgramCl() Get CL (Cutter Location). Where Point is tool tip position; Normal is tool orientation. public DVec3d GetProgramCl() Returns DVec3d CL GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolidMachiningChain() Get ISolidMachiningChain. public ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain ISolidMachiningChain GetToolTipXyzOnProgramZero() Get tool tip xyz from workpiece geom anchor. public Vec3d GetToolTipXyzOnProgramZero() Returns Vec3d if no MachiningTool or no Workpiece equiping, return null; otherwise, return the XYZ from workpiece geomanchor to tool tip. GetTransformFromRootToProgramZero() Gets the transform matrix from the root coordinate system to the program zero coordinate system. public Mat4d GetTransformFromRootToProgramZero() Returns Mat4d A 4x4 transformation matrix representing the coordinate system transformation. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state PrepareCollidableItems() Prepares all collidable items for collision detection. This method should be called before performing collision detection. public void PrepareCollidableItems() ResetCollisionFlags() Resets all collision flags to their default states. This should be called after collision detection is complete. public void ResetCollisionFlags() Tooling(int, MachiningToolHouse) Set MachiningTool by toolId and toolHouse. public void Tooling(int toolId, MachiningToolHouse toolHouse) Parameters toolId int toolHouse MachiningToolHouse Exceptions ToolNotFoundException Throw If toolId does not exist on toolHouse. Events MachiningChainChanged Event that is raised when the machining chain is changed. Provides both the previous and new chain values. public event Action> MachiningChainChanged Event Type Action> WorkpieceChanged Event that is raised when the workpiece is changed. public event Action> WorkpieceChanged Event Type Action> Remarks This event is triggered whenever the workpiece property is modified. Subscribers can use this event to respond to changes in the workpiece configuration, such as updating visualizations or recalculating machining parameters. The event provides both the previous and new workpiece values through a SeqPair." + "summary": "Class MachiningEquipment Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Machining Equipment. Include the machining chain, workpiece, tool and fixture, etc.. public class MachiningEquipment : IMachiningEquipment, IDisplayee, IExpandToBox3d, IMakeXmlSource, IGetAnchoredDisplayeeList, IGetProgramCl, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetMachiningChain, IGetMachiningEquipment Inheritance object MachiningEquipment Implements IMachiningEquipment IDisplayee IExpandToBox3d IMakeXmlSource IGetAnchoredDisplayeeList IGetProgramCl IGetAsmb IGetAnchor IGetTopoIndex IGetMachiningChain IGetMachiningEquipment Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) MachiningEquipmentUtil.GetMcXyz_AttacherAtProgramZero(IMachiningEquipment) MachiningEquipmentUtil.GetMcXyz_AttacherAtTableBuckleZero(IMachiningEquipment) MachiningEquipmentUtil.RunByStep(IMachiningEquipment, INcStep0, MachiningToolHouse) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MachiningEquipment() Ctor. public MachiningEquipment() MachiningEquipment(XElement, string, string) Initializes a new instance of the MachiningEquipment class from XML data. public MachiningEquipment(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing the equipment configuration. baseDirectory string The base directory for resolving relative file paths. relFile string The relative file path for XML serialization. Properties Asmb Asmb of the entire equipment. public Asmb Asmb { get; } Property Value Asmb BackgroundTemperature_C Gets or sets the background temperature in Celsius. This is a convenience property that converts between Celsius and Kelvin. public double BackgroundTemperature_C { get; set; } Property Value double BackgroundTemperature_K Gets or sets the background temperature in Kelvin. This represents the ambient temperature of the machining environment. public double BackgroundTemperature_K { get; set; } Property Value double CoolantHeatCondition Gets or sets the coolant heat condition settings. This includes coolant temperature and heat transfer coefficients. public CoolantHeatCondition CoolantHeatCondition { get; set; } Property Value CoolantHeatCondition Fixture Fixture. public Fixture Fixture { get; set; } Property Value Fixture MachiningChain Body of the equipment. 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 MachiningTool Milling tool. public IMachiningTool MachiningTool { get; set; } Property Value IMachiningTool SpindleCapability Gets or sets the spindle capability configuration. This defines the operational capabilities and limits of the spindle. public SpindleCapability SpindleCapability { get; set; } Property Value SpindleCapability SpindleCapabilityFile Gets or sets the file path of the spindle capability configuration. This is used for XML serialization and file management. public string SpindleCapabilityFile { get; set; } Property Value string TableToComp Transformer of the branch from table buckle to workpiece side buckle. Note that the workpiece side buckle links to Fixture if fixture exist; otherwise, it links to Workpiece if workpiece exist. If Workpiece either Fixture do not exist, this property makes no effect. public ITransformer TableToComp { get; set; } Property Value ITransformer Workpiece Workpiece. public Workpiece Workpiece { get; set; } Property Value Workpiece XName Name for XML IO. public static string XName { get; } Property Value string Methods Detect(bool) Performs collision detection. public MechCollisionResult Detect(bool addFluteAndWorkpieceDetection) Parameters addFluteAndWorkpieceDetection bool Whether to include flute and workpiece in detection. Returns MechCollisionResult Significant collision result. Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetMachiningChain() Gets the machining chain instance. public IMachiningChain GetMachiningChain() Returns IMachiningChain The machining chain instance. GetMillingEquipment() Get MachiningEquipment. public MachiningEquipment GetMillingEquipment() Returns MachiningEquipment MachiningEquipment GetProgramCl() Get CL (Cutter Location). Where Point is tool tip position; Normal is tool orientation. public DVec3d GetProgramCl() Returns DVec3d CL GetToolTipXyzOnProgramZero() Get tool tip xyz from workpiece geom anchor. public Vec3d GetToolTipXyzOnProgramZero() Returns Vec3d if no MachiningTool or no Workpiece equiping, return null; otherwise, return the XYZ from workpiece geomanchor to tool tip. GetTransformFromRootToProgramZero() Gets the transform matrix from the root coordinate system to the program zero coordinate system. public Mat4d GetTransformFromRootToProgramZero() Returns Mat4d A 4x4 transformation matrix representing the coordinate system transformation. 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. PrepareCollidableItems() Prepares all collidable items for collision detection. This method should be called before performing collision detection. public void PrepareCollidableItems() ResetCollisionFlags() Resets all collision flags to their default states. This should be called after collision detection is complete. public void ResetCollisionFlags() Tooling(int, MachiningToolHouse) Set MachiningTool by toolId and toolHouse. public void Tooling(int toolId, MachiningToolHouse toolHouse) Parameters toolId int toolHouse MachiningToolHouse Exceptions ToolNotFoundException Throw If toolId does not exist on toolHouse. Events MachiningChainChanged Event that is raised when the machining chain is changed. Provides both the previous and new chain values. public event Action> MachiningChainChanged Event Type Action> WorkpieceChanged Event that is raised when the workpiece is changed. public event Action> WorkpieceChanged Event Type Action> Remarks This event is triggered whenever the workpiece property is modified. Subscribers can use this event to respond to changes in the workpiece configuration, such as updating visualizations or recalculating machining parameters. The event provides both the previous and new workpiece values through a SeqPair." }, "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html": { "href": "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndex.html", "title": "Class MachiningEquipmentCollisionIndex | HiAPI-C# 2025", - "summary": "Class MachiningEquipmentCollisionIndex Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Represents a collision index for machining equipment components. This class manages collision detection between different parts of the machining equipment. public class MachiningEquipmentCollisionIndex : ICollisionIndex, IGetCollidable, IMakeXmlSource Inheritance object MachiningEquipmentCollisionIndex Implements ICollisionIndex IGetCollidable IMakeXmlSource Inherited Members object.Equals(object, object) 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) Constructors MachiningEquipmentCollisionIndex(MachiningEquipment, string) Initializes a new instance of the MachiningEquipmentCollisionIndex class with the specified equipment and key. public MachiningEquipmentCollisionIndex(MachiningEquipment equipment, string key) Parameters equipment MachiningEquipment The machining equipment to associate with this collision index. key string The key identifying the component in the collision system. MachiningEquipmentCollisionIndex(string) Initializes a new instance of the MachiningEquipmentCollisionIndex class with the specified key. public MachiningEquipmentCollisionIndex(string key) Parameters key string The key identifying the component in the collision system. MachiningEquipmentCollisionIndex(XElement, IGetMachiningEquipment) Initializes a new instance of the MachiningEquipmentCollisionIndex class from XML data. public MachiningEquipmentCollisionIndex(XElement src, IGetMachiningEquipment equipment) Parameters src XElement The XML element containing the collision index configuration. equipment IGetMachiningEquipment The equipment provider interface. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties Anchor Gets the anchor point for the component identified by this index. public Anchor Anchor { get; } Property Value Anchor Remarks The anchor point returned depends on the component key: Workpiece: Geometry anchor Fixture: Table buckle ToolHolder: Root anchor of the holder CutterShank: Root anchor of the upper beam topo brick CutterFlute: Root anchor of the shaper topo brick Other: Machine tool component anchor Equipment Gets or sets the machining equipment associated with this collision index. When set, updates the component anchor and collidable based on the equipment's solid machining chain. public IMachiningEquipment Equipment { get; set; } Property Value IMachiningEquipment Key Gets the key identifying the component in the collision system. public string Key { get; } Property Value string Methods 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. GetCollidable() Gets the collidable object for the component identified by this index. public ICollidable GetCollidable() Returns ICollidable The collidable object representing the component's geometry. The type of collidable returned depends on the component key: Workpiece: Runtime geometry Fixture: Solid collidable ToolHolder: Cylindroid or freeform holder solid CutterShank: Upper beam topo brick solid CutterFlute: Shaper topo brick solid Other: Machine tool component collidable GetHashCode() Gets a hash code for the current object. public override int GetHashCode() Returns int A hash code for the current object. MakeXmlSource(string, string) Creates an XML representation of this collision index. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths. relFile string The relative file path for XML serialization. Returns XElement An XML element containing the collision index data." + "summary": "Class MachiningEquipmentCollisionIndex Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Represents a collision index for machining equipment components. This class manages collision detection between different parts of the machining equipment. public class MachiningEquipmentCollisionIndex : ICollisionIndex, IGetCollidable, IMakeXmlSource, IToXElement Inheritance object MachiningEquipmentCollisionIndex Implements ICollisionIndex IGetCollidable IMakeXmlSource IToXElement Inherited Members object.Equals(object, object) 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) Constructors MachiningEquipmentCollisionIndex(MachiningEquipment, string) Initializes a new instance of the MachiningEquipmentCollisionIndex class with the specified equipment and key. public MachiningEquipmentCollisionIndex(MachiningEquipment equipment, string key) Parameters equipment MachiningEquipment The machining equipment to associate with this collision index. key string The key identifying the component in the collision system. MachiningEquipmentCollisionIndex(string) Initializes a new instance of the MachiningEquipmentCollisionIndex class with the specified key. public MachiningEquipmentCollisionIndex(string key) Parameters key string The key identifying the component in the collision system. MachiningEquipmentCollisionIndex(XElement, IGetMachiningEquipment) Initializes a new instance of the MachiningEquipmentCollisionIndex class from XML data. public MachiningEquipmentCollisionIndex(XElement src, IGetMachiningEquipment equipment) Parameters src XElement The XML element containing the collision index configuration. equipment IGetMachiningEquipment The equipment provider interface. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties Anchor Gets the anchor point for the component identified by this index. public Anchor Anchor { get; } Property Value Anchor Remarks The anchor point returned depends on the component key: Workpiece: Geometry anchor Fixture: Geometry anchor ToolHolder: Root anchor of the holder CutterShank: Root anchor of the upper beam topo brick CutterFlute: Root anchor of the shaper topo brick Other: Machine tool component anchor Equipment Gets or sets the machining equipment associated with this collision index. When set, updates the component anchor and collidable based on the equipment's solid machining chain. public IMachiningEquipment Equipment { get; set; } Property Value IMachiningEquipment Key Gets the key identifying the component in the collision system. public string Key { get; } Property Value string Methods 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. GetCollidable() Gets the collidable object for the component identified by this index. public ICollidable GetCollidable() Returns ICollidable The collidable object representing the component's geometry. The type of collidable returned depends on the component key: Workpiece: Runtime geometry Fixture: Solid collidable ToolHolder: Cylindroid or freeform holder solid CutterShank: Upper beam topo brick solid CutterFlute: Shaper topo brick solid Other: Machine tool component collidable GetHashCode() Gets a hash code for the current object. 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html": { "href": "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentCollisionIndexPairsSource.html", "title": "Class MachiningEquipmentCollisionIndexPairsSource | HiAPI-C# 2025", - "summary": "Class MachiningEquipmentCollisionIndexPairsSource Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Source of CollisionIndexPair. The adjacent solids will not be added to the CollisionIndexPairs. public class MachiningEquipmentCollisionIndexPairsSource : ICollisionIndexPairsSource, IGetCollisionIndexPairs, IMakeXmlSource Inheritance object MachiningEquipmentCollisionIndexPairsSource Implements ICollisionIndexPairsSource IGetCollisionIndexPairs IMakeXmlSource 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) Constructors MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain, HashSet) Initializes a new instance of the MachiningEquipmentCollisionIndexPairsSource class with a specified machining chain and excluded pairs. public MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain src, HashSet excludedPairs) Parameters src ISolidMachiningChain The solid machining chain to build collision pairs from. excludedPairs HashSet The set of collision pairs to exclude from collision detection. Remarks This constructor builds the default collision index pairs from the provided machining chain and removes the specified excluded pairs from consideration. MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain, string) Initializes a new instance of the MachiningEquipmentCollisionIndexPairsSource class with a specified machining chain and excluded pairs string. public MachiningEquipmentCollisionIndexPairsSource(ISolidMachiningChain src, string excludedPairsString = \"\") Parameters src ISolidMachiningChain The solid machining chain to build collision pairs from. excludedPairsString string A string representation of collision pairs to exclude, in the format \"[Key1][Key2];[Key3][Key4]\". Remarks This constructor builds the default collision index pairs from the provided machining chain and removes the pairs specified in the excludedPairsString from consideration. MachiningEquipmentCollisionIndexPairsSource(XElement, IGetSolidMachiningChain) Initializes a new instance of the MachiningEquipmentCollisionIndexPairsSource class from XML data. public MachiningEquipmentCollisionIndexPairsSource(XElement src, IGetSolidMachiningChain res) Parameters src XElement The XML element containing the collision index pairs configuration. res IGetSolidMachiningChain The solid machining chain reference used to build default index pairs. Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Methods GetCollisionIndexPairs() Gets a collection of collision index pairs for collision detection. public IEnumerable GetCollisionIndexPairs() Returns IEnumerable A collection of CollisionIndexPair objects. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class MachiningEquipmentCollisionIndexPairsSource Namespace Hi.Machining.MachiningEquipmentUtils Assembly HiMech.dll Source of CollisionIndexPair. The adjacent solids will not be added to the CollisionIndexPairs. public class MachiningEquipmentCollisionIndexPairsSource : ICollisionIndexPairsSource, IGetCollisionIndexPairs, IMakeXmlSource Inheritance object MachiningEquipmentCollisionIndexPairsSource Implements ICollisionIndexPairsSource IGetCollisionIndexPairs IMakeXmlSource 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) Constructors MachiningEquipmentCollisionIndexPairsSource(IMachiningChain, HashSet) Initializes a new instance of the MachiningEquipmentCollisionIndexPairsSource class with a specified machining chain and excluded pairs. public MachiningEquipmentCollisionIndexPairsSource(IMachiningChain src, HashSet excludedPairs) Parameters src IMachiningChain The solid machining chain to build collision pairs from. excludedPairs HashSet The set of collision pairs to exclude from collision detection. Remarks This constructor builds the default collision index pairs from the provided machining chain and removes the specified excluded pairs from consideration. MachiningEquipmentCollisionIndexPairsSource(IMachiningChain, string) Initializes a new instance of the MachiningEquipmentCollisionIndexPairsSource class with a specified machining chain and excluded pairs string. public MachiningEquipmentCollisionIndexPairsSource(IMachiningChain src, string excludedPairsString = \"\") Parameters src IMachiningChain The solid machining chain to build collision pairs from. excludedPairsString string A string representation of collision pairs to exclude, in the format \"[Key1][Key2];[Key3][Key4]\". Remarks This constructor builds the default collision index pairs from the provided machining chain and removes the pairs specified in the excludedPairsString from consideration. MachiningEquipmentCollisionIndexPairsSource(XElement, IGetMachiningChain) Initializes a new instance of the MachiningEquipmentCollisionIndexPairsSource class from XML data. public MachiningEquipmentCollisionIndexPairsSource(XElement src, IGetMachiningChain res) Parameters src XElement The XML element containing the collision index pairs configuration. res IGetMachiningChain The solid machining chain reference used to build default index pairs. Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Methods GetCollisionIndexPairs() Gets a collection of collision index pairs for collision detection. public IEnumerable GetCollisionIndexPairs() Returns IEnumerable A collection of CollisionIndexPair objects. 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." }, "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html": { "href": "api/Hi.Machining.MachiningEquipmentUtils.MachiningEquipmentUtil.html", @@ -1752,7 +1797,7 @@ "api/Hi.Machining.MachiningToolHouse.html": { "href": "api/Hi.Machining.MachiningToolHouse.html", "title": "Class MachiningToolHouse | HiAPI-C# 2025", - "summary": "Class MachiningToolHouse Namespace Hi.Machining Assembly HiMech.dll Tool House. public class MachiningToolHouse : Dictionary, IDictionary, ICollection>, IReadOnlyDictionary, IReadOnlyCollection>, IEnumerable>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IMakeXmlSource Inheritance object Dictionary MachiningToolHouse Implements IDictionary ICollection> IReadOnlyDictionary IReadOnlyCollection> IEnumerable> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable IMakeXmlSource Inherited Members Dictionary.Add(int, IMachiningTool) Dictionary.Clear() Dictionary.ContainsKey(int) Dictionary.ContainsValue(IMachiningTool) Dictionary.EnsureCapacity(int) Dictionary.GetAlternateLookup() Dictionary.GetEnumerator() Dictionary.OnDeserialization(object) Dictionary.Remove(int) Dictionary.Remove(int, out IMachiningTool) Dictionary.TrimExcess() Dictionary.TrimExcess(int) Dictionary.TryAdd(int, IMachiningTool) Dictionary.TryGetAlternateLookup(out Dictionary.AlternateLookup) Dictionary.TryGetValue(int, out IMachiningTool) Dictionary.Comparer Dictionary.Count Dictionary.Capacity Dictionary.this[int] Dictionary.Keys Dictionary.Values 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) DictionaryUtil.Retrieve(Dictionary, K, out V, bool) DictionaryUtil.TryGetValueByKeys(IDictionary, IEnumerable, out TValue) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MachiningToolHouse() Ctor. public MachiningToolHouse() MachiningToolHouse(XElement, string, string) Ctor. public MachiningToolHouse(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths relFile string Relative file path Properties XName Name for XML IO. public static string XName { get; } Property Value string Methods CreateStickMillingTool() Create a new Tool for UI. The tool ID is 1 if no tool existed; otherwise, the tool ID is the max tool ID plus 1. public KeyValuePair CreateStickMillingTool() Returns KeyValuePair the generated tool id and the generated tool MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetToolId(int, IMachiningTool) the function Typically used if the tool has already in the tool house. public void SetToolId(int toolId, IMachiningTool millingTool) Parameters toolId int millingTool IMachiningTool Exceptions ArgumentException throw if toolId has already existed." + "summary": "Class MachiningToolHouse Namespace Hi.Machining Assembly HiMech.dll Tool House. public class MachiningToolHouse : Dictionary, IDictionary, ICollection>, IReadOnlyDictionary, IReadOnlyCollection>, IEnumerable>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IMakeXmlSource Inheritance object Dictionary MachiningToolHouse Implements IDictionary ICollection> IReadOnlyDictionary IReadOnlyCollection> IEnumerable> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable IMakeXmlSource Inherited Members Dictionary.Add(int, IMachiningTool) Dictionary.Clear() Dictionary.ContainsKey(int) Dictionary.ContainsValue(IMachiningTool) Dictionary.EnsureCapacity(int) Dictionary.GetAlternateLookup() Dictionary.GetEnumerator() Dictionary.OnDeserialization(object) Dictionary.Remove(int) Dictionary.Remove(int, out IMachiningTool) Dictionary.TrimExcess() Dictionary.TrimExcess(int) Dictionary.TryAdd(int, IMachiningTool) Dictionary.TryGetAlternateLookup(out Dictionary.AlternateLookup) Dictionary.TryGetValue(int, out IMachiningTool) Dictionary.Comparer Dictionary.Count Dictionary.Capacity Dictionary.this[int] Dictionary.Keys Dictionary.Values 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) DictionaryUtil.Retrieve(Dictionary, K, out V, bool) DictionaryUtil.TryGetValueByKeys(IDictionary, IEnumerable, out TValue) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MachiningToolHouse() Ctor. public MachiningToolHouse() MachiningToolHouse(XElement, string, string) Ctor. public MachiningToolHouse(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths relFile string Relative file path Properties XName Name for XML IO. public static string XName { get; } Property Value string Methods CreateStickMillingTool() Create a new Tool for UI. The tool ID is 1 if no tool existed; otherwise, the tool ID is the max tool ID plus 1. public KeyValuePair CreateStickMillingTool() Returns KeyValuePair the generated tool id and the generated tool 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. SetToolId(int, IMachiningTool) the function Typically used if the tool has already in the tool house. public void SetToolId(int toolId, IMachiningTool millingTool) Parameters toolId int millingTool IMachiningTool Exceptions ArgumentException throw if toolId has already existed." }, "api/Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.html": { "href": "api/Hi.Machining.MachiningVolumeRemovalProc.StepMotionSnapshot.html", @@ -1802,7 +1847,7 @@ "api/Hi.Machining.html": { "href": "api/Hi.Machining.html", "title": "Namespace Hi.Machining | HiAPI-C# 2025", - "summary": "Namespace Hi.Machining Classes FreeformCutter Represents a freeform cutting tool that can be used in machining operations. This cutter type supports complex geometries for both the noble (upper) part and the shaper (cutting) part. MachiningToolHouse Tool House. MachiningVolumeRemovalProc Handles the machining volume removal process and related operations. MachiningVolumeRemovalProc.StepMotionSnapshot Represents a snapshot of the machining motion state. MatInterpolationKit Provides functionality for interpolating between two transformation matrices. MatRelationUtil Utility methods for determining relationships between matrices. MotionUtil Cutter location utility. Sweptable Sweptable geometry. SweptableUtil Util for Sweptable. ToolNotFoundException Exception thrown when a tool with the specified ID is not found. Interfaces ICutter Interface of cutter. ICutterAnchorable IGetAnchor of cutter. IGetSweptable Interface of Get Sweptable. IMachiningTool Interface for machining tools that combine a holder and a cutter. IVolumeRemover Only inherit from IGetInitStickConvex and IGetSweptable. Enums MatRelation Defines the relationship between two matrices." + "summary": "Namespace Hi.Machining Classes FreeformRemover Represents a freeform cutting tool that can be used in machining operations. This cutter type supports complex geometries for both the noble (upper) part and the shaper (cutting) part. MachiningToolHouse Tool House. MachiningVolumeRemovalProc Handles the machining volume removal process and related operations. MachiningVolumeRemovalProc.StepMotionSnapshot Represents a snapshot of the machining motion state. MatInterpolationKit Provides functionality for interpolating between two transformation matrices. MatRelationUtil Utility methods for determining relationships between matrices. MotionUtil Cutter location utility. Sweptable Sweptable geometry. SweptableUtil Util for Sweptable. ToolNotFoundException Exception thrown when a tool with the specified ID is not found. Interfaces ICutter Interface of cutter. ICutterAnchorable IGetAnchor of cutter. IGetSweptable Interface of Get Sweptable. IMachiningTool Interface for machining tools that combine a holder and a cutter. IVolumeRemover Only inherit from IGetInitStickConvex and IGetSweptable. Enums MatRelation Defines the relationship between two matrices." }, "api/Hi.MachiningProcs.ConfigStepFunc.html": { "href": "api/Hi.MachiningProcs.ConfigStepFunc.html", @@ -1812,7 +1857,22 @@ "api/Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html": { "href": "api/Hi.MachiningProcs.DynamicMachiningProjectDisplayee.html", "title": "Class DynamicMachiningProjectDisplayee | HiAPI-C# 2025", - "summary": "Class DynamicMachiningProjectDisplayee Namespace Hi.MachiningProcs Assembly HiNc.dll Provides display capabilities for a milling course. public class DynamicMachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetRootAnchor Inheritance object DynamicMachiningProjectDisplayee Implements IDisplayee IExpandToBox3d IGetRootAnchor 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) Constructors DynamicMachiningProjectDisplayee(Func) Initializes a new instance of the DynamicMachiningProjectDisplayee class with default settings. public DynamicMachiningProjectDisplayee(Func machiningProjectHost) Parameters machiningProjectHost Func Function that returns the host milling course DynamicMachiningProjectDisplayee(Func, BitArray, Action) Initializes a new instance of the DynamicMachiningProjectDisplayee class. public DynamicMachiningProjectDisplayee(Func machiningProjectHost, BitArray renderingFlagBitArray, Action setRenderingFlagFunc) Parameters machiningProjectHost Func Function that returns the host milling course renderingFlagBitArray BitArray Initial rendering flag bit array setRenderingFlagFunc Action Function that sets the rendering flags Properties MachiningProject Gets the current milling course from the host function. public MachiningProject MachiningProject { get; } Property Value MachiningProject RenderingFlagBitArray Gets or sets the bit array that controls which elements are rendered. public BitArray RenderingFlagBitArray { get; set; } Property Value BitArray Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetRootAnchor() Gets the root anchor for the display hierarchy based on current rendering flags. public Anchor GetRootAnchor() Returns Anchor The root anchor to use for rendering" + "summary": "Class DynamicMachiningProjectDisplayee Namespace Hi.MachiningProcs Assembly HiNc.dll Provides display capabilities for a milling course. public class DynamicMachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex Inheritance object DynamicMachiningProjectDisplayee Implements IDisplayee IExpandToBox3d IGetAnchor IGetTopoIndex Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors DynamicMachiningProjectDisplayee(Func) Initializes a new instance of the DynamicMachiningProjectDisplayee class with default settings. public DynamicMachiningProjectDisplayee(Func machiningProjectHost) Parameters machiningProjectHost Func Function that returns the host milling course DynamicMachiningProjectDisplayee(Func, BitArray, Action) Initializes a new instance of the DynamicMachiningProjectDisplayee class. public DynamicMachiningProjectDisplayee(Func machiningProjectHost, BitArray renderingFlagBitArray, Action setRenderingFlagFunc) Parameters machiningProjectHost Func Function that returns the host milling course renderingFlagBitArray BitArray Initial rendering flag bit array setRenderingFlagFunc Action Function that sets the rendering flags Properties MachiningProject Gets the current milling course from the host function. public MachiningProject MachiningProject { get; } Property Value MachiningProject RenderingFlagBitArray Gets or sets the bit array that controls which elements are rendered. public BitArray RenderingFlagBitArray { get; set; } Property Value BitArray Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Gets the root anchor for the display hierarchy based on current rendering flags. public Anchor GetAnchor() Returns Anchor The root anchor to use for rendering" + }, + "api/Hi.MachiningProcs.IMachiningProjectGetter.html": { + "href": "api/Hi.MachiningProcs.IMachiningProjectGetter.html", + "title": "Interface IMachiningProjectGetter | HiAPI-C# 2025", + "summary": "Interface IMachiningProjectGetter Namespace Hi.MachiningProcs Assembly HiNc.dll public interface IMachiningProjectGetter 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) Methods GetMachiningProject() MachiningProject GetMachiningProject() Returns MachiningProject" + }, + "api/Hi.MachiningProcs.IMachiningProjectHost.html": { + "href": "api/Hi.MachiningProcs.IMachiningProjectHost.html", + "title": "Interface IMachiningProjectHost | HiAPI-C# 2025", + "summary": "Interface IMachiningProjectHost Namespace Hi.MachiningProcs Assembly HiNc.dll public interface IMachiningProjectHost 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) Properties MachiningProject MachiningProject MachiningProject { get; set; } Property Value MachiningProject" + }, + "api/Hi.MachiningProcs.IPathedMachiningProjectHost.html": { + "href": "api/Hi.MachiningProcs.IPathedMachiningProjectHost.html", + "title": "Interface IPathedMachiningProjectHost | HiAPI-C# 2025", + "summary": "Interface IPathedMachiningProjectHost Namespace Hi.MachiningProcs Assembly HiNc.dll public interface IPathedMachiningProjectHost : IMachiningProjectHost Inherited Members IMachiningProjectHost.MachiningProject 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) Properties MachiningProjectPath string MachiningProjectPath { get; set; } Property Value string" }, "api/Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html": { "href": "api/Hi.MachiningProcs.MachiningActRunner.MachiningStepBuiltDelegate.html", @@ -1822,12 +1882,7 @@ "api/Hi.MachiningProcs.MachiningActRunner.html": { "href": "api/Hi.MachiningProcs.MachiningActRunner.html", "title": "Class MachiningActRunner | HiAPI-C# 2025", - "summary": "Class MachiningActRunner Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a runner for machining actions that manages milling steps, tool paths, and collision detection. public class MachiningActRunner : IDisposable Inheritance object MachiningActRunner Implements 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) Constructors MachiningActRunner(SessionMessageHost, MongoClient, IMongoCollection, IMongoCollection, Action, ICsScriptApi, MillingActRunnerConfig) Initializes a new instance of the MachiningActRunner class. public MachiningActRunner(SessionMessageHost messageHost, MongoClient mongoClient, IMongoCollection millingStepLuggageCollection, IMongoCollection substractionSplicDbCollection, Action resetMillingStepLuggageDbAction, ICsScriptApi shellApi, MillingActRunnerConfig config = null) Parameters messageHost SessionMessageHost The milling message host. mongoClient MongoClient The MongoDB client. millingStepLuggageCollection IMongoCollection The MongoDB collection for milling step luggage. substractionSplicDbCollection IMongoCollection The MongoDB collection for subtraction slices. resetMillingStepLuggageDbAction Action Action to reset the milling step luggage database. shellApi ICsScriptApi The C# script API for the milling session. config MillingActRunnerConfig Optional configuration for the milling act runner. Properties ActStateRunner Gets the act state runner. This property is provided as a member value getter and should not be modified. public ActStateRunner ActStateRunner { get; } Property Value ActStateRunner ClStrip Gets the cutter location strip. public ClStrip ClStrip { get; } Property Value ClStrip EnableCollisionDetection Gets or sets whether collision detection is enabled. public bool EnableCollisionDetection { get; set; } Property Value bool EnableSweeping Gets whether sweeping is enabled based on the motion resolution type. public bool EnableSweeping { get; } Property Value bool EnableWearEffect Gets or sets whether to enable coating wear effects. Note: This function is not fully prepared yet. Only affects further wear by the wear coefficient of inner material. public bool EnableWearEffect { get; set; } Property Value bool GrpcPostStepAction Gets or sets the action to be performed after each step for GRPC service. This is for internal use only. public static Action GrpcPostStepAction { get; set; } Property Value Action MachiningEquipment Gets or sets the machining equipment. public MachiningEquipment MachiningEquipment { get; set; } Property Value MachiningEquipment MachiningMotionResolution Gets or sets the machining motion resolution. public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution MachiningToolHouse Gets or sets the machining tool house. public MachiningToolHouse MachiningToolHouse { get; set; } Property Value MachiningToolHouse MachiningVolumeRemovalProc Gets the machining volume removal processor. public MachiningVolumeRemovalProc MachiningVolumeRemovalProc { get; } Property Value MachiningVolumeRemovalProc MillingActRunnerConfig Gets or sets the runner configuration. public MillingActRunnerConfig MillingActRunnerConfig { get; set; } Property Value MillingActRunnerConfig SessionMessageHost Gets or sets the milling message host. public SessionMessageHost SessionMessageHost { get; set; } Property Value SessionMessageHost ShellApi Gets the C# script API for the milling session. public ICsScriptApi ShellApi { get; } Property Value ICsScriptApi StepPreferredCubeWidth Gets or sets the preferred cube width for steps. public double StepPreferredCubeWidth { get; set; } Property Value double Methods AdjustAptCutterStlResolutionByNcResolutionAndWorkpieceResolution() Adjusts the APT cutter STL resolution based on NC resolution and workpiece resolution. public void AdjustAptCutterStlResolutionByNcResolutionAndWorkpieceResolution() Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Disposes of the resources used by the MachiningActRunner. protected virtual void Dispose(bool disposing) Parameters disposing bool True to release both managed and unmanaged resources; false to release only unmanaged resources. ExpandToActMcStep(IAct) Expands an act into machine control steps. public IEnumerable ExpandToActMcStep(IAct act) Parameters act IAct The act to expand. Returns IEnumerable A sequence of machine control steps. GetMillingActRunner() Gets the current milling act runner instance. public MachiningActRunner GetMillingActRunner() Returns MachiningActRunner The current milling act runner instance. ProcAct(IAct, ISourceCommand, MachiningSession, CancellationToken, IMachiningStepHost) Processes an act with the given parameters. public IEnumerable ProcAct(IAct act, ISourceCommand sourceCommand, MachiningSession millingSession, CancellationToken cancellationToken, IMachiningStepHost host) Parameters act IAct The act to process. sourceCommand ISourceCommand The source command. millingSession MachiningSession The milling session. cancellationToken CancellationToken The cancellation token. host IMachiningStepHost The milling step host. Returns IEnumerable A sequence of processed objects. ResetMillingStepLuggageDb() Resets the milling step luggage database. public void ResetMillingStepLuggageDb() ResetStateAndClStrip() Resets the state and cutter location strip. public void ResetStateAndClStrip() WaitAll() Waits for all pending operations to complete. public void WaitAll() Events MachiningStepBuilt event to configure steps. The first parameter is the previous step; the second parameter is the current step. The previous step is null if no previous step exists. public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt Event Type MachiningActRunner.MachiningStepBuiltDelegate UiPostStepAction Event raised after each step for UI updates. This is for internal use only. public event Action UiPostStepAction Event Type Action" - }, - "api/Hi.MachiningProcs.MachiningMessage.html": { - "href": "api/Hi.MachiningProcs.MachiningMessage.html", - "title": "Class MachiningMessage | HiAPI-C# 2025", - "summary": "Class MachiningMessage Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a message in the machining process that can contain various types of data such as source commands, machining steps, exceptions, and tagged messages. public class MachiningMessage Inheritance object MachiningMessage Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors MachiningMessage(int, object) Initializes a new instance of the MachiningMessage class. public MachiningMessage(int index, object src) Parameters index int The index of the message. src object The source data. Properties ClStripPos Gets or sets the cutter location strip position. gets null if the Data is not ClStripPos. public ClStripPos ClStripPos { get; set; } Property Value ClStripPos Data Gets or sets the data contained in the message. public object Data { get; set; } Property Value object Exception Gets or sets the exception. gets null if the Data is not Exception. public Exception Exception { get; set; } Property Value Exception Index Gets or sets the index of the message. The UI name is 'Serial.'. public int Index { get; set; } Property Value int InstantSourceCommand Gets the source command, either directly or from the associated milling step. gets null if both Hi.MachiningProcs.MachiningMessage.DirectInstantSourceCommand and the SourceCommand from ClStripPos's State are null. public ISourceCommand InstantSourceCommand { get; } Property Value ISourceCommand MachiningStep Gets the milling step from the cutter location strip position. gets null if ClStripPos is null or its State is not a MachiningStep. public MachiningStep MachiningStep { get; } Property Value MachiningStep Message Gets the message text from either the multi-tag message or exception. gets null if both MultiTagMessage and Exception are null, or if MultiTagMessage.Message is null. public string Message { get; } Property Value string MessageOrNcText Gets the message text or NC code text. gets null if all sources (InstantSourceCommand, MultiTagMessage, Exception, and Data) are null or cannot provide text. public string MessageOrNcText { get; } Property Value string MessageRoleText Gets the message type text for UI display. public string MessageRoleText { get; } Property Value string MultiTagMessage Gets or sets the multi-tag message. gets null if the Data is not MultiTagMessage. public MultiTagMessage MultiTagMessage { get; set; } Property Value MultiTagMessage Methods ToString() Returns a string representation of the message data. public override string ToString() Returns string A string representation of the message data." + "summary": "Class MachiningActRunner Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a runner for machining actions that manages milling steps, tool paths, and collision detection. public class MachiningActRunner : IDisposable Inheritance object MachiningActRunner Implements 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) Constructors MachiningActRunner(SessionMessageHost, MongoClient, IMongoCollection, IMongoCollection, Action, ICsScriptApi, MillingActRunnerConfig) Initializes a new instance of the MachiningActRunner class. public MachiningActRunner(SessionMessageHost messageHost, MongoClient mongoClient, IMongoCollection millingStepLuggageCollection, IMongoCollection substractionSplicDbCollection, Action resetMillingStepLuggageDbAction, ICsScriptApi shellApi, MillingActRunnerConfig config = null) Parameters messageHost SessionMessageHost The milling message host. mongoClient MongoClient The MongoDB client. millingStepLuggageCollection IMongoCollection The MongoDB collection for milling step luggage. substractionSplicDbCollection IMongoCollection The MongoDB collection for subtraction slices. resetMillingStepLuggageDbAction Action Action to reset the milling step luggage database. shellApi ICsScriptApi The C# script API for the milling session. config MillingActRunnerConfig Optional configuration for the milling act runner. Properties ActStateRunner Gets the act state runner. This property is provided as a member value getter and should not be modified. public ActStateRunner ActStateRunner { get; } Property Value ActStateRunner ClStrip Gets the cutter location strip. public ClStrip ClStrip { get; } Property Value ClStrip EnableCollisionDetection Gets or sets whether collision detection is enabled. public bool EnableCollisionDetection { get; set; } Property Value bool EnablePhysics Gets or sets whether milling force evaluation is enabled. This is a runtime configuration and is not managed in XML IO. public bool EnablePhysics { get; set; } Property Value bool EnableSweeping Gets whether sweeping is enabled based on the motion resolution type. public bool EnableSweeping { get; } Property Value bool EnableWearEffect Gets or sets whether to enable coating wear effects. Note: This function is not fully prepared yet. Only affects further wear by the wear coefficient of inner material. public bool EnableWearEffect { get; set; } Property Value bool GrpcPostStepAction Gets or sets the action to be performed after each step for GRPC service. This is for internal use only. public static Action GrpcPostStepAction { get; set; } Property Value Action MachiningEquipment Gets or sets the machining equipment. public MachiningEquipment MachiningEquipment { get; set; } Property Value MachiningEquipment MachiningMotionResolution Gets or sets the machining motion resolution. public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution MachiningToolHouse Gets or sets the machining tool house. public MachiningToolHouse MachiningToolHouse { get; set; } Property Value MachiningToolHouse MachiningVolumeRemovalProc Gets the machining volume removal processor. public MachiningVolumeRemovalProc MachiningVolumeRemovalProc { get; } Property Value MachiningVolumeRemovalProc MillingActRunnerConfig Gets or sets the runner configuration. public MillingActRunnerConfig MillingActRunnerConfig { get; set; } Property Value MillingActRunnerConfig SessionMessageHost Gets or sets the milling message host. public SessionMessageHost SessionMessageHost { get; set; } Property Value SessionMessageHost ShellApi Gets the C# script API for the milling session. public ICsScriptApi ShellApi { get; } Property Value ICsScriptApi StepPreferredCubeWidth Gets or sets the preferred cube width for steps. public double StepPreferredCubeWidth { get; set; } Property Value double XyzabcChain public IXyzabcChain XyzabcChain { get; } Property Value IXyzabcChain Methods AdjustAptCutterStlResolutionByNcResolutionAndWorkpieceResolution() Adjusts the APT cutter STL resolution based on NC resolution and workpiece resolution. public void AdjustAptCutterStlResolutionByNcResolutionAndWorkpieceResolution() Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Disposes of the resources used by the MachiningActRunner. protected virtual void Dispose(bool disposing) Parameters disposing bool True to release both managed and unmanaged resources; false to release only unmanaged resources. ExpandToActMcStep(IAct) Expands an act into machine control steps. public IEnumerable ExpandToActMcStep(IAct act) Parameters act IAct The act to expand. Returns IEnumerable A sequence of machine control steps. GetMillingActRunner() Gets the current milling act runner instance. public MachiningActRunner GetMillingActRunner() Returns MachiningActRunner The current milling act runner instance. ProcAct(IAct, MachiningSession, IMachiningStepHost, ISourceCommand, CancellationToken) Processes an act with the given parameters. public IEnumerable ProcAct(IAct act, MachiningSession millingSession, IMachiningStepHost host, ISourceCommand sourceCommand, CancellationToken cancellationToken) Parameters act IAct The act to process. millingSession MachiningSession The milling session. host IMachiningStepHost The milling step host. sourceCommand ISourceCommand The source command. cancellationToken CancellationToken The cancellation token. Returns IEnumerable A sequence of processed objects. ResetMillingStepLuggageDb() Resets the milling step luggage database. public void ResetMillingStepLuggageDb() ResetStateAndClStrip() Resets the state and cutter location strip. public void ResetStateAndClStrip() WaitAll() Waits for all pending operations to complete. public void WaitAll() Events MachiningStepBuilt event to configure steps. The first parameter is the previous step; the second parameter is the current step. The previous step is null if no previous step exists. public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt Event Type MachiningActRunner.MachiningStepBuiltDelegate UiPostStepAction Event raised after each step for UI updates. This is for internal use only. public event Action UiPostStepAction Event Type Action" }, "api/Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html": { "href": "api/Hi.MachiningProcs.MachiningParallelProc.StepTaskBundle.html", @@ -1847,12 +1902,12 @@ "api/Hi.MachiningProcs.MachiningProject.html": { "href": "api/Hi.MachiningProcs.MachiningProject.html", "title": "Class MachiningProject | HiAPI-C# 2025", - "summary": "Class MachiningProject Namespace Hi.MachiningProcs Assembly HiNc.dll Represents a milling project that manages the execution, simulation, and analysis of NC programs. public class MachiningProject : IDisposable, IMachiningStepHost, IGetMachiningEquipment, IMakeXmlSource Inheritance object MachiningProject Implements IDisposable IMachiningStepHost IGetMachiningEquipment IMakeXmlSource 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) Constructors MachiningProject(string) Initializes a new instance of the MachiningProject class with the specified directory. Uses the default MongoDB connection. public MachiningProject(string baseDirectory) Parameters baseDirectory string Base directory for file operations MachiningProject(string, MongoClient) Initializes a new instance of the MachiningProject class with the specified directory and MongoDB client. public MachiningProject(string baseDirectory, MongoClient mongoClient) Parameters baseDirectory string Base directory for file operations mongoClient MongoClient MongoDB client instance MachiningProject(XElement, string) Initializes a new instance of the MachiningProject class from XML data using MongoDB. public MachiningProject(XElement src, string baseDirectory) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths MachiningProject(XElement, string, MongoClient) Initializes a new instance of the MachiningProject class from XML data. public MachiningProject(XElement src, string baseDirectory, MongoClient mongoClient) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths mongoClient MongoClient MongoDB client instance Properties ApiVersion Gets the API version from the entry assembly. public static Version ApiVersion { get; } Property Value Version BaseDirectory Gets the base directory where project files are located. public string BaseDirectory { get; } Property Value string BoundSelectorHost Gets the bound selector host for managing selection boundaries. public BoundSelectorHost BoundSelectorHost { get; } Property Value BoundSelectorHost 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 DispCacheMb Gets or sets the display cache size in megabytes. public static long DispCacheMb { get; set; } Property Value long 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 EnablePauseOnCollision Gets or sets whether to pause simulation when a collision is detected. Only effective when collision detection is enabled. public bool EnablePauseOnCollision { get; set; } Property Value bool Global global variable for ShellApi. 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 KeyToAccessDictionary Gets the dictionary mapping property keys to their access methods. public ConcurrentDictionary KeyToAccessDictionary { get; } Property Value ConcurrentDictionary MachiningActRunner Gets the machining act runner responsible for executing machining operations. public MachiningActRunner MachiningActRunner { get; } Property Value MachiningActRunner MachiningEquipment Gets or sets the machining equipment used for milling. Updates related components when changed. public MachiningEquipment MachiningEquipment { get; set; } Property Value MachiningEquipment MachiningSession Gets or sets the current machining session. public MachiningSession MachiningSession { get; set; } Property Value MachiningSession MachiningToolHouse Gets or sets the milling tool house containing available tools. 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 MillingActRunnerConfig Gets or sets the configuration for the milling act runner. public MillingActRunnerConfig MillingActRunnerConfig { get; set; } Property Value MillingActRunnerConfig MillingGuide Gets or sets the milling guide containing visualization and analysis configurations. public MillingGuide MillingGuide { get; set; } Property Value MillingGuide 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 PlayerCommand Gets the command to execute when playing the machining project. public IShellCommand PlayerCommand { get; } Property Value IShellCommand Progress Gets the progress reporting mechanism for long-running operations. public Progress Progress { get; } Property Value Progress SessionMessageHost Gets the message host for displaying messages, warnings, and errors. public SessionMessageHost SessionMessageHost { get; } Property Value SessionMessageHost ShellApi Gets the shell API for interacting with this machining process. public ShellApi ShellApi { get; } Property Value ShellApi TimeMapping Gets or sets the time mapping for synchronizing different time-based data streams. Creates a new time mapping if one doesn't exist. public TimeMapping TimeMapping { get; set; } Property Value TimeMapping Workpiece Gets or sets the workpiece to be machined. Ensures proper initialization of workpiece properties. public Workpiece Workpiece { get; set; } Property Value Workpiece XName Name for XML IO. public static string XName { get; } Property Value string Methods BeginSession() Initiate a simulation session. Clear the state from previous session (if existed). public void BeginSession() 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 GetMillingEquipment() Get MachiningEquipment. public MachiningEquipment GetMillingEquipment() Returns MachiningEquipment MachiningEquipment LoadFile(string) Loads a machining project from the specified file path. public static MachiningProject LoadFile(string projectFilePath) Parameters projectFilePath string Path to the project file to load Returns MachiningProject A new machining project instance loaded from the file MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state 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 rootDirectory, string relNcFilePath) Parameters rootDirectory string Root directory for resolving relative paths relNcFilePath string Relative path to the NC file ReTrainMillingPara(SampleFlag, double, string, CancellationToken) Train Milling Parameter. public void ReTrainMillingPara(SampleFlag sampleFlags, double outlierRatio, string dstRelFile, CancellationToken cancellationToken) Parameters sampleFlags SampleFlag outlierRatio double dstRelFile string cancellationToken CancellationToken RefreshDrawing() Refreshes the visual display of the milling course. public void RefreshDrawing() ResetRuntime() Reset the runtime states including: runtime geometry, collision flags, machine tool position, CL strips, message buffer and etc.. public void ResetRuntime() RunNc(string, string) Runs NC commands from raw text. public IEnumerable RunNc(string ncText, string fileNameAlternative = \"--\") Parameters ncText string The NC command text to execute fileNameAlternative string Alternative name to associate with the NC program Returns IEnumerable An enumerable of actions to be executed RunNcFile(string, string) Runs an NC file from the specified path. public IEnumerable RunNcFile(string rootDirectory, string relNcFilePath) Parameters rootDirectory string Root directory for resolving relative paths relNcFilePath string Relative path to the NC file Returns IEnumerable An enumerable of actions to be executed RunNcFile(string, string, CancellationToken) Runs an NC file from the specified path with cancellation support. public IEnumerable RunNcFile(string rootDirectory, string relNcFilePath, CancellationToken cancellationToken) Parameters rootDirectory string Root directory for resolving relative paths. If the value is null, BaseDirectory substitudes the value. relNcFilePath string Relative path to the NC file cancellationToken CancellationToken Token to monitor for cancellation requests Returns IEnumerable An enumerable of actions to be executed RunRawNcLines(string, IEnumerable, CancellationToken) Runs NC commands from raw text lines. public IEnumerable RunRawNcLines(string relNcFilePath, IEnumerable lines, CancellationToken cancellationToken) Parameters relNcFilePath string Name to associate with the NC program lines IEnumerable The NC command lines to execute cancellationToken CancellationToken Token to monitor for cancellation requests Returns IEnumerable An enumerable of actions to be executed ShowMessageBoard(string, string, BootstrapTheme) Shows a message board with the specified title, message, and theme. public void ShowMessageBoard(string title, string message, BootstrapTheme bootstrapThemeColor) Parameters title string The title of the message board message string The message to display bootstrapThemeColor BootstrapTheme The theme color for the message board TrainMillingPara(SampleFlag, bool, double, string, CancellationToken) Train Milling Parameter. public void TrainMillingPara(SampleFlag sampleFlags, bool enableFzOnlyDuringDrilling, double outlierRatio, string dstRelFile, CancellationToken cancellationToken) Parameters sampleFlags SampleFlag enableFzOnlyDuringDrilling bool outlierRatio double dstRelFile string cancellationToken CancellationToken UpdateIdealMillingToolOffsetTableByToolHouse() Updates the ideal milling tool offset table based on the current tool house configuration. public void UpdateIdealMillingToolOffsetTableByToolHouse() WriteShotFile(TimeSpan, string) Writes time-based shot data to a file with the specified sampling period. public void WriteShotFile(TimeSpan samplingPeriod, string relFileTemplate = \"Output/[NcName].shot.csv\") Parameters samplingPeriod TimeSpan The time period between samples relFileTemplate string Template for the output file path, can include [NcName] placeholder WriteStepFile(string) Writes step-based data to a file. public void WriteStepFile(string relFileTemplate = \"Output/[NcName].step.csv\") Parameters relFileTemplate string Template for the output file path, can include [NcName] placeholder Events OnRanNcBlock Event triggered after an NC block is executed. public event Action OnRanNcBlock Event Type Action OnShownMessageBoard Event that is triggered when a message board is shown. public event ShowMessageBoardDelegate OnShownMessageBoard Event Type ShowMessageBoardDelegate OnUpdatedInspectingQuantityFunc Event triggered when the inspecting quantity function is updated. public event Action OnUpdatedInspectingQuantityFunc Event Type Action" + "summary": "Class MachiningProject Namespace Hi.MachiningProcs Assembly HiNc.dll Represents a milling project that manages the execution, simulation, and analysis of NC programs. public class MachiningProject : IDisposable, IMachiningStepHost, IGetMachiningEquipment, IMakeXmlSource, IMachiningProjectGetter Inheritance object MachiningProject Implements IDisposable IMachiningStepHost IGetMachiningEquipment IMakeXmlSource IMachiningProjectGetter 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) Constructors MachiningProject(string) Initializes a new instance of the MachiningProject class with the specified directory. Uses the default MongoDB connection. public MachiningProject(string baseDirectory) Parameters baseDirectory string Base directory for file operations MachiningProject(string, MongoClient) Initializes a new instance of the MachiningProject class with the specified directory and MongoDB client. public MachiningProject(string baseDirectory, MongoClient mongoClient) Parameters baseDirectory string Base directory for file operations mongoClient MongoClient MongoDB client instance MachiningProject(XElement, string) Initializes a new instance of the MachiningProject class from XML data using MongoDB. public MachiningProject(XElement src, string baseDirectory) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths MachiningProject(XElement, string, MongoClient) Initializes a new instance of the MachiningProject class from XML data. public MachiningProject(XElement src, string baseDirectory, MongoClient mongoClient) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths mongoClient MongoClient MongoDB client instance Properties ApiVersion Gets the API version from the entry assembly. public static Version ApiVersion { get; } Property Value Version BaseDirectory Gets the base directory where project files are located. public string BaseDirectory { get; } Property Value string BoundSelectorHost Gets the bound selector host for managing selection boundaries. public BoundSelectorHost BoundSelectorHost { get; } Property Value BoundSelectorHost ClStrip Gets the cutter location strip. 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 DispCacheMb Gets or sets the display cache size in megabytes. public static long DispCacheMb { get; set; } Property Value long 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 Enable Pause On Failure Detected. Only take effect if the EnableCollisionDetection or EnableStrokeLimitCheck is enabled. public bool EnablePauseOnFailure { get; set; } Property Value bool EnableStrokeLimitCheck public bool EnableStrokeLimitCheck { get; set; } Property Value bool Global global variable for RuntimeController. 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 MachiningActRunner Gets the machining act runner responsible for executing machining operations. public MachiningActRunner MachiningActRunner { get; } Property Value MachiningActRunner MachiningEquipment Gets or sets the machining equipment used for milling. Updates related components when changed. public MachiningEquipment MachiningEquipment { get; set; } Property Value MachiningEquipment MachiningSession Gets or sets the current machining session. public MachiningSession MachiningSession { get; set; } Property Value MachiningSession MachiningToolHouse Gets or sets the milling tool house containing available tools. 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 MillingActRunnerConfig Gets or sets the configuration for the milling act runner. public MillingActRunnerConfig MillingActRunnerConfig { get; set; } Property Value MillingActRunnerConfig MillingGuide Gets or sets the milling guide containing visualization and analysis configurations. public MillingGuide MillingGuide { get; set; } Property Value MillingGuide MillingStepLuggageReader Gets the reader for accessing milling step luggage data. public ParallelBulkReader MillingStepLuggageReader { get; } Property Value ParallelBulkReader NcEnv public NcEnv NcEnv { get; } Property Value NcEnv NcOptOptionDictionary public Dictionary NcOptOptionDictionary { get; set; } Property Value Dictionary 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 PlayerCommand Gets the command to execute when playing the machining project. public IShellCommand PlayerCommand { get; set; } Property Value IShellCommand Progress Gets the progress reporting mechanism for long-running operations. public Progress Progress { get; } Property Value Progress RuntimeController Gets the shell API for interacting with this machining process. public RuntimeController RuntimeController { get; } Property Value RuntimeController 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. Creates a new time mapping if one doesn't exist. public TimeMapping TimeMapping { get; set; } Property Value TimeMapping Workpiece Gets or sets the workpiece to be machined. Ensures proper initialization of workpiece properties. public Workpiece Workpiece { get; set; } Property Value Workpiece XName Name for XML IO. public static string XName { get; } Property Value string Methods Act(IAct, ISourceCommand, CancellationToken?) public void Act(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null) Parameters act IAct sourceCommand ISourceCommand cancellationToken CancellationToken? BeginSession() Initiate a simulation session. Clear the state from previous session (if existed). public void BeginSession() 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 GetMachiningProject() public MachiningProject GetMachiningProject() Returns MachiningProject GetMillingEquipment() Get MachiningEquipment. public MachiningEquipment GetMillingEquipment() Returns MachiningEquipment MachiningEquipment LoadFile(string) Loads a machining project from the specified file path. public static MachiningProject LoadFile(string projectFilePath) Parameters projectFilePath string Path to the project file to load Returns MachiningProject A new machining project instance loaded from the file 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. 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 rootDirectory, string relNcFilePath) Parameters rootDirectory string Root directory for resolving relative paths relNcFilePath string Relative path to the NC file ProcAct(IAct, ISourceCommand, CancellationToken?) public IEnumerable ProcAct(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null) Parameters act IAct sourceCommand ISourceCommand cancellationToken CancellationToken? Returns IEnumerable ReTrainMillingPara(SampleFlag, double, string, CancellationToken) Train Milling Parameter. public void ReTrainMillingPara(SampleFlag sampleFlags, double outlierRatio, string dstRelFile, CancellationToken cancellationToken) Parameters sampleFlags SampleFlag outlierRatio double dstRelFile string cancellationToken CancellationToken RefreshDrawing() Refreshes the visual display of the milling course. public void RefreshDrawing() ResetRuntime() Reset the runtime states including: runtime geometry, collision flags, machine tool position, CL strips, message buffer and etc.. public void ResetRuntime() RunNc(string, string) Runs NC commands from raw text. public IEnumerable RunNc(string ncText, string fileNameAlternative = \"--\") Parameters ncText string The NC command text to execute fileNameAlternative string Alternative name to associate with the NC program Returns IEnumerable An enumerable of actions to be executed RunNcFile(string, string) Runs an NC file from the specified path. public IEnumerable RunNcFile(string rootDirectory, string relNcFilePath) Parameters rootDirectory string Root directory for resolving relative paths relNcFilePath string Relative path to the NC file Returns IEnumerable An enumerable of actions to be executed RunNcFile(string, string, CancellationToken) Runs an NC file from the specified path with cancellation support. public IEnumerable RunNcFile(string rootDirectory, string relNcFilePath, CancellationToken cancellationToken) Parameters rootDirectory string Root directory for resolving relative paths. If the value is null, BaseDirectory substitudes the value. relNcFilePath string Relative path to the NC file cancellationToken CancellationToken Token to monitor for cancellation requests Returns IEnumerable An enumerable of actions to be executed RunRawNcLines(string, IEnumerable, CancellationToken) Runs NC commands from raw text lines. public IEnumerable RunRawNcLines(string relNcFilePath, IEnumerable lines, CancellationToken cancellationToken) Parameters relNcFilePath string Name to associate with the NC program lines IEnumerable The NC command lines to execute cancellationToken CancellationToken Token to monitor for cancellation requests Returns IEnumerable An enumerable of actions to be executed ShowMessageBoard(string, string, BootstrapTheme) Shows a message board with the specified title, message, and theme. public void ShowMessageBoard(string title, string message, BootstrapTheme bootstrapThemeColor) Parameters title string The title of the message board message string The message to display bootstrapThemeColor BootstrapTheme The theme color for the message board TrainMillingPara(SampleFlag, bool, double, string, CancellationToken) Train Milling Parameter. public void TrainMillingPara(SampleFlag sampleFlags, bool enableFzOnlyDuringDrilling, double outlierRatio, string dstRelFile, CancellationToken cancellationToken) Parameters sampleFlags SampleFlag enableFzOnlyDuringDrilling bool outlierRatio double dstRelFile string cancellationToken CancellationToken UpdateIdealMillingToolOffsetTableByToolHouse() Updates the ideal milling tool offset table based on the current tool house configuration. public void UpdateIdealMillingToolOffsetTableByToolHouse() WriteShotFile(TimeSpan, string) Writes time-based shot data to a file with the specified sampling period. public void WriteShotFile(TimeSpan samplingPeriod, string relFileTemplate = \"Output/[NcName].shot.csv\") Parameters samplingPeriod TimeSpan The time period between samples relFileTemplate string Template for the output file path, can include [NcName] placeholder WriteStepFile(string) Writes step-based data to a file. public void WriteStepFile(string relFileTemplate = \"Output/[NcName].step.csv\") Parameters relFileTemplate string Template for the output file path, can include [NcName] placeholder Events OnRanNcBlock Event triggered after an NC block is executed. public event Action OnRanNcBlock Event Type Action OnShownMessageBoard Event that is triggered when a message board is shown. public event ShowMessageBoardDelegate OnShownMessageBoard Event Type ShowMessageBoardDelegate OnUpdatedInspectingQuantityFunc Event triggered when the inspecting quantity function is updated. public event Action OnUpdatedInspectingQuantityFunc Event Type Action" }, "api/Hi.MachiningProcs.MachiningProjectDisplayee.html": { "href": "api/Hi.MachiningProcs.MachiningProjectDisplayee.html", "title": "Class MachiningProjectDisplayee | HiAPI-C# 2025", - "summary": "Class MachiningProjectDisplayee Namespace Hi.MachiningProcs Assembly HiNc.dll Represents a displayable wrapper for a machining project. public class MachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetRootAnchor Inheritance object MachiningProjectDisplayee Implements IDisplayee IExpandToBox3d IGetRootAnchor 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) Constructors MachiningProjectDisplayee(MachiningProject) Initializes a new instance of the MachiningProjectDisplayee class with default rendering flags. public MachiningProjectDisplayee(MachiningProject machiningProject) Parameters machiningProject MachiningProject The machining project to display. MachiningProjectDisplayee(MachiningProject, BitArray) Initializes a new instance of the MachiningProjectDisplayee class. public MachiningProjectDisplayee(MachiningProject machiningProject, BitArray renderingFlagBitArray) Parameters machiningProject MachiningProject renderingFlagBitArray BitArray Properties MachiningProject Gets the current milling course from the host function. public MachiningProject MachiningProject { get; set; } Property Value MachiningProject RenderingFlagBitArray Gets or sets the bit array that controls which elements are rendered. public BitArray RenderingFlagBitArray { get; set; } Property Value BitArray Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor." + "summary": "Class MachiningProjectDisplayee Namespace Hi.MachiningProcs Assembly HiNc.dll Represents a displayable wrapper for a machining project. public class MachiningProjectDisplayee : IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex Inheritance object MachiningProjectDisplayee Implements IDisplayee IExpandToBox3d IGetAnchor IGetTopoIndex Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MachiningProjectDisplayee(MachiningProject) Initializes a new instance of the MachiningProjectDisplayee class with default rendering flags. public MachiningProjectDisplayee(MachiningProject machiningProject) Parameters machiningProject MachiningProject The machining project to display. MachiningProjectDisplayee(MachiningProject, BitArray) Initializes a new instance of the MachiningProjectDisplayee class. public MachiningProjectDisplayee(MachiningProject machiningProject, BitArray renderingFlagBitArray) Parameters machiningProject MachiningProject renderingFlagBitArray BitArray Properties HeidenhainCoordinateEntryDisplayee public HeidenhainCoordinateEntryDisplayee HeidenhainCoordinateEntryDisplayee { get; } Property Value HeidenhainCoordinateEntryDisplayee IsoCoordinateEntryDisplayee public IsoCoordinateEntryDisplayee IsoCoordinateEntryDisplayee { get; } Property Value IsoCoordinateEntryDisplayee MachiningProject Gets the current milling course from the host function. public MachiningProject MachiningProject { get; set; } Property Value MachiningProject RenderingFlagBitArray Gets or sets the bit array that controls which elements are rendered. public BitArray RenderingFlagBitArray { get; set; } Property Value BitArray Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor" }, "api/Hi.MachiningProcs.MachiningSession.html": { "href": "api/Hi.MachiningProcs.MachiningSession.html", @@ -1862,7 +1917,7 @@ "api/Hi.MachiningProcs.MillingActRunnerConfig.html": { "href": "api/Hi.MachiningProcs.MillingActRunnerConfig.html", "title": "Class MillingActRunnerConfig | HiAPI-C# 2025", - "summary": "Class MillingActRunnerConfig Namespace Hi.MachiningProcs Assembly HiMech.dll Represents the configuration for a milling act runner. Provides settings for physics simulation, evaluation, and temperature control. public class MillingActRunnerConfig : IMakeXmlSource Inheritance object MillingActRunnerConfig Implements IMakeXmlSource 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) Constructors MillingActRunnerConfig() Initializes a new instance of the MillingActRunnerConfig class. public MillingActRunnerConfig() MillingActRunnerConfig(XElement, string) Initializes a new instance of the MillingActRunnerConfig class from XML. public MillingActRunnerConfig(XElement src, string baseDirectory) Parameters src XElement The source XML element. baseDirectory string The base directory for resolving relative paths. Properties EnableAdvancedPhysics Gets or sets whether advanced physics simulation is enabled. public bool EnableAdvancedPhysics { get; set; } Property Value bool EnableDeflectionTransformation Gets or sets whether deflection transformation is enabled. Note: This feature is pending testing. public bool EnableDeflectionTransformation { get; set; } Property Value bool EnableExternalEvaluation Gets or sets whether external evaluation is enabled. public bool EnableExternalEvaluation { get; set; } Property Value bool EnableMillingForceEvaluation Gets or sets whether milling force evaluation is enabled. This is a runtime configuration and is not managed in XML IO. public bool EnableMillingForceEvaluation { get; set; } Property Value bool InitSpindleTemperature_C Gets or sets the initial spindle temperature in Celsius. public double InitSpindleTemperature_C { get; set; } Property Value double InitSpindleTemperature_K Gets or sets the initial spindle temperature in Kelvin. The temperature is initialized when a working session is restarted or a new session is started. public double InitSpindleTemperature_K { get; set; } Property Value double XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) Creates an XML representation of the configuration. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Returns XElement An XML element containing the configuration." + "summary": "Class MillingActRunnerConfig Namespace Hi.MachiningProcs Assembly HiMech.dll Represents the configuration for a milling act runner. Provides settings for physics simulation, evaluation, and temperature control. public class MillingActRunnerConfig : IMakeXmlSource Inheritance object MillingActRunnerConfig Implements IMakeXmlSource 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) Constructors MillingActRunnerConfig() Initializes a new instance of the MillingActRunnerConfig class. public MillingActRunnerConfig() MillingActRunnerConfig(XElement, string) Initializes a new instance of the MillingActRunnerConfig class from XML. public MillingActRunnerConfig(XElement src, string baseDirectory) Parameters src XElement The source XML element. baseDirectory string The base directory for resolving relative paths. Properties EnableAdvancedPhysics Gets or sets whether advanced physics simulation is enabled. public bool EnableAdvancedPhysics { get; set; } Property Value bool EnableDeflectionTransformation Gets or sets whether deflection transformation is enabled. Note: This feature is pending testing. public bool EnableDeflectionTransformation { get; set; } Property Value bool EnableExternalEvaluation Gets or sets whether external evaluation is enabled. public bool EnableExternalEvaluation { get; set; } Property Value bool InitSpindleTemperature_C Gets or sets the initial spindle temperature in Celsius. public double InitSpindleTemperature_C { get; set; } Property Value double InitSpindleTemperature_K Gets or sets the initial spindle temperature in Kelvin. The temperature is initialized when a working session is restarted or a new session is started. public double InitSpindleTemperature_K { get; set; } Property Value double XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.MachiningProcs.MillingUtil.html": { "href": "api/Hi.MachiningProcs.MillingUtil.html", @@ -1872,32 +1927,92 @@ "api/Hi.MachiningProcs.RenderingFlag.html": { "href": "api/Hi.MachiningProcs.RenderingFlag.html", "title": "Enum RenderingFlag | HiAPI-C# 2025", - "summary": "Enum RenderingFlag Namespace Hi.MachiningProcs Assembly HiNc.dll Flags that control which elements are rendered in the visualization. [Flags] public enum RenderingFlag Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields ClStrip = 1 Cutter location strip rendering flag. ColorScaleBar = ClStrip | DimensionBar Color scale bar rendering flag. DimensionBar = WorkpieceGeom | Fixture Dimension bar rendering flag. Fixture = 4 Fixture rendering flag. Mech = ClStrip | Fixture Mechanical components rendering flag. This flag covers the flags WorkpieceGeom, Tool and Fixture. Tool = ClStrip | WorkpieceGeom Tool rendering flag. WorkpieceGeom = 2 Workpiece geometry rendering flag." + "summary": "Enum RenderingFlag Namespace Hi.MachiningProcs Assembly HiNc.dll Flags that control which elements are rendered in the visualization. public enum RenderingFlag Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields ClStrip = 1 Cutter location strip rendering flag. ColorScaleBar = 10 Color scale bar rendering flag. Category: Foreground. DimensionBar = 9 Dimension bar rendering flag. Category: Foreground. Dummy = 0 Fixture = 4 Fixture rendering flag. Category: Solid. HeidenhainCoordinate = 8 Heidenhain Coordinate rendering flag. Category: Anchor (Coordinate Mark). IsoCoordinate = 7 Iso Coordinate rendering flag. Category: Anchor (Coordinate Mark). Mech = 5 Mechanical components rendering flag. This flag covers the flags WorkpieceGeom, Tool and Fixture. Category: Solid. ProgramZero = 6 Program Zero rendering flag. Category: Anchor (Coordinate Mark). Tool = 3 Tool rendering flag. Category: Solid. WorkpieceGeom = 2 Workpiece geometry rendering flag. Category: Solid." }, - "api/Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch.html": { - "href": "api/Hi.MachiningProcs.SessionMessageHost.AlwaysStableTorch.html", - "title": "Class SessionMessageHost.AlwaysStableTorch | HiAPI-C# 2025", - "summary": "Class SessionMessageHost.AlwaysStableTorch Namespace Hi.MachiningProcs Assembly HiMech.dll A disposable class that manages the stable index state. public class SessionMessageHost.AlwaysStableTorch : IDisposable Inheritance object SessionMessageHost.AlwaysStableTorch Implements 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) Constructors AlwaysStableTorch(SessionMessageHost, bool) Initializes a new instance of the SessionMessageHost.AlwaysStableTorch class. public AlwaysStableTorch(SessionMessageHost host, bool isAlwaysStable) Parameters host SessionMessageHost The message host. isAlwaysStable bool Whether the index should always be stable. Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Disposes of the resources used by the SessionMessageHost.AlwaysStableTorch. protected virtual void Dispose(bool disposing) Parameters disposing bool True to release both managed and unmanaged resources; false to release only unmanaged resources." + "api/Hi.MachiningProcs.RuntimeController.html": { + "href": "api/Hi.MachiningProcs.RuntimeController.html", + "title": "Class RuntimeController | HiAPI-C# 2025", + "summary": "Class RuntimeController Namespace Hi.MachiningProcs Assembly HiNc.dll Provides a C# scripting API for controlling and manipulating the milling course. Allows for runtime control of milling operations, geometry manipulation, and data analysis. [ApiController] [Route(\"api/[controller]/[action]\")] public class RuntimeController : ControllerBase, ICsScriptApi Inheritance object ControllerBase RuntimeController Implements ICsScriptApi Inherited Members ControllerBase.StatusCode(int) ControllerBase.StatusCode(int, object) ControllerBase.Content(string) ControllerBase.Content(string, string) ControllerBase.Content(string, string, Encoding) ControllerBase.Content(string, MediaTypeHeaderValue) ControllerBase.NoContent() ControllerBase.Ok() ControllerBase.Ok(object) ControllerBase.Redirect(string) ControllerBase.RedirectPermanent(string) ControllerBase.RedirectPreserveMethod(string) ControllerBase.RedirectPermanentPreserveMethod(string) ControllerBase.LocalRedirect(string) ControllerBase.LocalRedirectPermanent(string) ControllerBase.LocalRedirectPreserveMethod(string) ControllerBase.LocalRedirectPermanentPreserveMethod(string) ControllerBase.RedirectToAction() ControllerBase.RedirectToAction(string) ControllerBase.RedirectToAction(string, object) ControllerBase.RedirectToAction(string, string) ControllerBase.RedirectToAction(string, string, object) ControllerBase.RedirectToAction(string, string, string) ControllerBase.RedirectToAction(string, string, object, string) ControllerBase.RedirectToActionPreserveMethod(string, string, object, string) ControllerBase.RedirectToActionPermanent(string) ControllerBase.RedirectToActionPermanent(string, object) ControllerBase.RedirectToActionPermanent(string, string) ControllerBase.RedirectToActionPermanent(string, string, string) ControllerBase.RedirectToActionPermanent(string, string, object) ControllerBase.RedirectToActionPermanent(string, string, object, string) ControllerBase.RedirectToActionPermanentPreserveMethod(string, string, object, string) ControllerBase.RedirectToRoute(string) ControllerBase.RedirectToRoute(object) ControllerBase.RedirectToRoute(string, object) ControllerBase.RedirectToRoute(string, string) ControllerBase.RedirectToRoute(string, object, string) ControllerBase.RedirectToRoutePreserveMethod(string, object, string) ControllerBase.RedirectToRoutePermanent(string) ControllerBase.RedirectToRoutePermanent(object) ControllerBase.RedirectToRoutePermanent(string, object) ControllerBase.RedirectToRoutePermanent(string, string) ControllerBase.RedirectToRoutePermanent(string, object, string) ControllerBase.RedirectToRoutePermanentPreserveMethod(string, object, string) ControllerBase.RedirectToPage(string) ControllerBase.RedirectToPage(string, object) ControllerBase.RedirectToPage(string, string) ControllerBase.RedirectToPage(string, string, object) ControllerBase.RedirectToPage(string, string, string) ControllerBase.RedirectToPage(string, string, object, string) ControllerBase.RedirectToPagePermanent(string) ControllerBase.RedirectToPagePermanent(string, object) ControllerBase.RedirectToPagePermanent(string, string) ControllerBase.RedirectToPagePermanent(string, string, string) ControllerBase.RedirectToPagePermanent(string, string, object, string) ControllerBase.RedirectToPagePreserveMethod(string, string, object, string) ControllerBase.RedirectToPagePermanentPreserveMethod(string, string, object, string) ControllerBase.File(byte[], string) ControllerBase.File(byte[], string, bool) ControllerBase.File(byte[], string, string) ControllerBase.File(byte[], string, string, bool) ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(Stream, string) ControllerBase.File(Stream, string, bool) ControllerBase.File(Stream, string, string) ControllerBase.File(Stream, string, string, bool) ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(string, string) ControllerBase.File(string, string, bool) ControllerBase.File(string, string, string) ControllerBase.File(string, string, string, bool) ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.PhysicalFile(string, string) ControllerBase.PhysicalFile(string, string, bool) ControllerBase.PhysicalFile(string, string, string) ControllerBase.PhysicalFile(string, string, string, bool) ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.Unauthorized() ControllerBase.Unauthorized(object) ControllerBase.NotFound() ControllerBase.NotFound(object) ControllerBase.BadRequest() ControllerBase.BadRequest(object) ControllerBase.BadRequest(ModelStateDictionary) ControllerBase.UnprocessableEntity() ControllerBase.UnprocessableEntity(object) ControllerBase.UnprocessableEntity(ModelStateDictionary) ControllerBase.Conflict() ControllerBase.Conflict(object) ControllerBase.Conflict(ModelStateDictionary) ControllerBase.Problem(string, string, int?, string, string) ControllerBase.Problem(string, string, int?, string, string, IDictionary) ControllerBase.ValidationProblem(ValidationProblemDetails) ControllerBase.ValidationProblem(ModelStateDictionary) ControllerBase.ValidationProblem() ControllerBase.ValidationProblem(string, string, int?, string, string, ModelStateDictionary) ControllerBase.ValidationProblem(string, string, int?, string, string, ModelStateDictionary, IDictionary) ControllerBase.Created() ControllerBase.Created(string, object) ControllerBase.Created(Uri, object) ControllerBase.CreatedAtAction(string, object) ControllerBase.CreatedAtAction(string, object, object) ControllerBase.CreatedAtAction(string, string, object, object) ControllerBase.CreatedAtRoute(string, object) ControllerBase.CreatedAtRoute(object, object) ControllerBase.CreatedAtRoute(string, object, object) ControllerBase.Accepted() ControllerBase.Accepted(object) ControllerBase.Accepted(Uri) ControllerBase.Accepted(string) ControllerBase.Accepted(string, object) ControllerBase.Accepted(Uri, object) ControllerBase.AcceptedAtAction(string) ControllerBase.AcceptedAtAction(string, string) ControllerBase.AcceptedAtAction(string, object) ControllerBase.AcceptedAtAction(string, string, object) ControllerBase.AcceptedAtAction(string, object, object) ControllerBase.AcceptedAtAction(string, string, object, object) ControllerBase.AcceptedAtRoute(object) ControllerBase.AcceptedAtRoute(string) ControllerBase.AcceptedAtRoute(string, object) ControllerBase.AcceptedAtRoute(object, object) ControllerBase.AcceptedAtRoute(string, object, object) ControllerBase.Challenge() ControllerBase.Challenge(params string[]) ControllerBase.Challenge(AuthenticationProperties) ControllerBase.Challenge(AuthenticationProperties, params string[]) ControllerBase.Forbid() ControllerBase.Forbid(params string[]) ControllerBase.Forbid(AuthenticationProperties) ControllerBase.Forbid(AuthenticationProperties, params string[]) ControllerBase.SignIn(ClaimsPrincipal) ControllerBase.SignIn(ClaimsPrincipal, string) ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties) ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties, string) ControllerBase.SignOut() ControllerBase.SignOut(AuthenticationProperties) ControllerBase.SignOut(params string[]) ControllerBase.SignOut(AuthenticationProperties, params string[]) ControllerBase.TryUpdateModelAsync(TModel) ControllerBase.TryUpdateModelAsync(TModel, string) ControllerBase.TryUpdateModelAsync(TModel, string, IValueProvider) ControllerBase.TryUpdateModelAsync(TModel, string, params Expression>[]) ControllerBase.TryUpdateModelAsync(TModel, string, Func) ControllerBase.TryUpdateModelAsync(TModel, string, IValueProvider, params Expression>[]) ControllerBase.TryUpdateModelAsync(TModel, string, IValueProvider, Func) ControllerBase.TryUpdateModelAsync(object, Type, string) ControllerBase.TryUpdateModelAsync(object, Type, string, IValueProvider, Func) ControllerBase.TryValidateModel(object) ControllerBase.TryValidateModel(object, string) ControllerBase.HttpContext ControllerBase.Request ControllerBase.Response ControllerBase.RouteData ControllerBase.ModelState ControllerBase.ControllerContext ControllerBase.MetadataProvider ControllerBase.ModelBinderFactory ControllerBase.Url ControllerBase.ObjectValidator ControllerBase.ProblemDetailsFactory ControllerBase.User ControllerBase.Empty 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) Constructors RuntimeController(IMachiningProjectGetter) Initializes a new instance. public RuntimeController(IMachiningProjectGetter machiningProjectGetter) Parameters machiningProjectGetter IMachiningProjectGetter Properties DiffVisualRadius_mm Gets or sets the visual radius in millimeters for difference visualization. Controls the radius used for highlighting differences between workpiece states. [JsAce] public double DiffVisualRadius_mm { get; set; } Property Value double DispCacheMb Gets or sets the display cache size in megabytes. public long DispCacheMb { get; set; } Property Value long DispCache_Mb Gets or sets the display cache size in megabytes. [JsAce] public long DispCache_Mb { get; set; } Property Value long EnableAutoMapOnSelectionEnd Gets or sets whether to automatically map selections when they end. [JsAce] public bool EnableAutoMapOnSelectionEnd { get; set; } Property Value bool EnableCollisionDetection Gets or sets whether collision detection is enabled. [JsAce(DocContentHtml = \"Enable Collision Detection.\")] public bool EnableCollisionDetection { get; set; } Property Value bool EnablePauseOnCollision Obsoleted. Gets or sets whether to pause execution when a collision is detected. This property only has an effect if collision detection is enabled. public bool EnablePauseOnCollision { get; set; } Property Value bool EnablePauseOnFailure [JsAce(DocContentHtml = \"Enable Pause On Failure.\")] public bool EnablePauseOnFailure { get; set; } Property Value bool EnablePhysics Gets or sets whether milling force evaluation is enabled. [JsAce(DocContentHtml = \"Enable milling force evaluation.\")] public bool EnablePhysics { get; set; } Property Value bool EnableWearEffect Gets or sets whether tool wear effects are enabled in simulation. [JsAce] public bool EnableWearEffect { get; set; } Property Value bool FeedPerCycle Gets a new feed per cycle machining motion resolution instance. [JsAce] public FeedPerCycleMachiningMotionResolution FeedPerCycle { get; } Property Value FeedPerCycleMachiningMotionResolution FeedPerTooth Gets a new feed per tooth machining motion resolution instance. [JsAce] public FeedPerToothMachiningMotionResolution FeedPerTooth { get; } Property Value FeedPerToothMachiningMotionResolution Global Global variables. [JsAce(\"Global[$1key]\")] public Dictionary Global { get; } Property Value Dictionary InitSpindleTemperature_C Gets or sets the initial spindle temperature in degrees Celsius. [JsAce(DocContentHtml = \"Spindle Temperature on initialization.\")] public double InitSpindleTemperature_C { get; set; } Property Value double JsAceCompletionProfileJsonArray Internal used. public static JsonArray JsAceCompletionProfileJsonArray { get; } Property Value JsonArray MachiningMotionResolution Gets or sets the machining motion resolution. [JsAce] public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution MachiningResolution Gets or sets the machining resolution in millimeters. For legacy compatable. [JsAce] [Obsolete] public double MachiningResolution { get; set; } Property Value double MachiningResolution_mm Gets or sets the machining resolution in millimeters. [JsAce] public double MachiningResolution_mm { get; set; } Property Value double MachiningSession public MachiningSession MachiningSession { get; } Property Value MachiningSession MapTask Task tracking the status of mapping operations. public Task MapTask { get; set; } Property Value Task MillingForceCycleDivisionNum Gets or sets the number of divisions per cycle for milling force calculation. This property should be set before milling force evaluation if TrainMillingPara(SampleFlag, string, double) is intended to be used. [JsAce] public static int MillingForceCycleDivisionNum { get; set; } Property Value int NcOptOption [JsAce] public NcOptOption NcOptOption { get; set; } Property Value NcOptOption OptEnableDepthCompensation Enables or disables depth compensation during optimization. [JsAce] public bool OptEnableDepthCompensation { get; set; } Property Value bool OptEnableFeedrate Gets or sets whether to enable feed rate optimization in NC optimization. [JsAce] public bool OptEnableFeedrate { get; set; } Property Value bool OptEnableForwardCompensation Enables or disables forward compensation during optimization. [JsAce] public bool OptEnableForwardCompensation { get; set; } Property Value bool OptEnableInterpolation Enables or disables reinterpolation for optimization. [JsAce] public bool OptEnableInterpolation { get; set; } Property Value bool OptEnableSideCompensation Enables or disables side compensation during optimization. [JsAce] public bool OptEnableSideCompensation { get; set; } Property Value bool OptExtendedPostDistance_mm Gets or sets the extended post-distance in millimeters for NC optimization. This is the distance after the current segment that will be considered for optimization. [JsAce] public double OptExtendedPostDistance_mm { get; set; } Property Value double OptExtendedPreDistance_mm Gets or sets the extended pre-distance in millimeters for NC optimization. This is the distance before the current segment that will be considered for optimization. [JsAce] public double OptExtendedPreDistance_mm { get; set; } Property Value double OptMaxAcceleration_mmds2 Maximum acceleration in mm/s² during optimization. Only takes effect on reinterpolated section. [JsAce(DocContentHtml = \"Only take effect on reinterpolated section.\")] public double OptMaxAcceleration_mmds2 { get; set; } Property Value double OptMaxFeedrate_mmdmin Maximum feed rate in mm/min for cutting movements during optimization. [JsAce] public double OptMaxFeedrate_mmdmin { get; set; } Property Value double OptMaxJerk_mmds3 Maximum jerk in mm/s³ during optimization. Only takes effect on reinterpolated section. [JsAce(DocContentHtml = \"Only take effect on reinterpolated section.\")] public double OptMaxJerk_mmds3 { get; set; } Property Value double OptMinFeedrate_mmdmin Minimum feed rate in mm/min for cutting movements during optimization. [JsAce] public double OptMinFeedrate_mmdmin { get; set; } Property Value double OptPreferedForce_N Preferred force in N for optimization. [JsAce] public double OptPreferedForce_N { get; set; } Property Value double OptRapidFeed_mmdmin Rapid feed rate in mm/min for non-cutting movements during optimization. [JsAce] public double OptRapidFeed_mmdmin { get; set; } Property Value double OptSpindlePowerSafetyFactor Safety factor for spindle power during optimization. [JsAce] public double OptSpindlePowerSafetyFactor { get; set; } Property Value double OptSpindleTorqueSafetyFactor Safety factor for spindle torque during optimization. [JsAce] public double OptSpindleTorqueSafetyFactor { get; set; } Property Value double ParaTemplateDimension [JsAce] public int ParaTemplateDimension { get; set; } Property Value int ScriptOptions ScriptOptions. public ScriptOptions ScriptOptions { get; set; } Property Value ScriptOptions StepCount Gets the total number of milling steps. [JsAce] public int StepCount { get; } Property Value int Methods AddTimeDataByFile(string, string, double, double) Adds time-based data from a file to the time mapping dictionary with specified time bounds in seconds. [JsAce(\"AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)\")] [NonAction] public bool AddTimeDataByFile(string key, string relFile, double beginTime, double endTime) Parameters key string Key to identify the data relFile string Relative path to the data file beginTime double Beginning time in seconds endTime double Ending time in seconds Returns bool True if the data was successfully added, false otherwise AddTimeDataByFile(string, string, string, string) Adds time-based data from a file to the time mapping dictionary with specified time bounds. [JsAce(\"AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)\")] [HttpPost] public bool AddTimeDataByFile(string key, string relFile, string beginTimeText, string endTimeText) Parameters key string Key to identify the data relFile string Relative path to the data file beginTimeText string Beginning time as text (seconds or TimeSpan format) endTimeText string Ending time as text (seconds or TimeSpan format) Returns bool True if the data was successfully added, false otherwise AppendMessagesToFile(string, params string[]) Appends messages to a file, optionally filtered by tags. [JsAce(\"AppendMessagesToFile(\\\"dstRelFile\\\",flags)\")] [HttpPost] public void AppendMessagesToFile(string dstRelFile, params string[] flags) Parameters dstRelFile string Destination relative file path flags string[] Optional flags to filter messages by tags BeginPreserve() Begin Preserve section in optimzation process. [JsAce(\"BeginPreserve()\")] [HttpPost] public void BeginPreserve() BeginSelection(string, AnchorMode, IStepShift) Begin mark on current line. milling step() has not triggered yet. [NonAction] public void BeginSelection(string key, AnchorMode anchorMode = AnchorMode.LineBegin, IStepShift shift = null) Parameters key string Identifier key for the selection anchorMode AnchorMode Mode for anchoring the beginning of selection shift IStepShift Step shift to apply BeginSession() [HttpPost] public void BeginSession() ClearTimeMappingData() Clears all time mapping data. [JsAce] [HttpPost] public void ClearTimeMappingData() Diff(double) Performs a difference analysis on the workpiece geometry to detect variations. [JsAce(\"Diff($1detectionRadius_mm)\")] [HttpPost] public void Diff(double detectionRadius_mm) Parameters detectionRadius_mm double Radius for detecting differences EndPreserve() End Preserve section in optimzation process. [JsAce(\"EndPreserve()\")] [HttpPost] public void EndPreserve() EndSelection(string, AnchorMode, IStepShift) End mark on current line for selection. [NonAction] public void EndSelection(string key, AnchorMode anchorMode = AnchorMode.LineEnd, IStepShift shift = null) Parameters key string Identifier key for the selection anchorMode AnchorMode Mode for anchoring the end of selection shift IStepShift Step shift to apply EndSession() [HttpPost] public void EndSession() ErrorMessage(string) Displays an error message in the message host. [JsAce(\"ErrorMessage($1message)\")] [HttpPost] public void ErrorMessage(string message) Parameters message string The error message to display FixedPace(double, double) Creates a fixed machining motion resolution with specified parameters. [JsAce(\"FixedPace($1linearResolution_mm, $2rotaryResolution_deg)\")] [NonAction] public FixedMachiningMotionResolution FixedPace(double linearResolution_mm, double rotaryResolution_deg) Parameters linearResolution_mm double Linear resolution in millimeters rotaryResolution_deg double Rotary resolution in degrees Returns FixedMachiningMotionResolution A new fixed machining motion resolution instance GetMillingStep(int) Retrieves a milling step at the specified index. [JsAce(Snippet = \"GetMillingStep($1\\\"stepIndex\\\")\")] [NonAction] public MachiningStep GetMillingStep(int stepIndex) Parameters stepIndex int Index of the milling step to retrieve Returns MachiningStep The milling step at the specified index GetStickMachiningToolObservationHeight_mm(int) Gets the observation height in millimeters for the specified stick machining tool. [JsAce(\"GetStickMachiningToolObservationHeight_mm($1toolId)\")] public double GetStickMachiningToolObservationHeight_mm(int toolId) Parameters toolId int The ID of the tool Returns double The observation height in millimeters GetUniformContourTrayShiftAngle_deg(int) Gets the shift angle in degrees for the uniform contour tray of the specified tool. [JsAce(\"GetUniformContourTrayShiftAngle_deg($1toolId)\")] [HttpGet] public double GetUniformContourTrayShiftAngle_deg(int toolId) Parameters toolId int The ID of the tool Returns double The shift angle in degrees LineSelection(string, AnchorMode, IStepShift, AnchorMode, IStepShift) Create a line selection from begin to end mark. [NonAction] public void LineSelection(string key, AnchorMode beginAnchorMode = AnchorMode.LineBegin, IStepShift beginShift = null, AnchorMode endAnchorMode = AnchorMode.LineEnd, IStepShift endShift = null) Parameters key string Identifier key for the selection beginAnchorMode AnchorMode Mode for anchoring the beginning of selection beginShift IStepShift Step shift to apply at beginning endAnchorMode AnchorMode Mode for anchoring the end of selection endShift IStepShift Step shift to apply at end Map(string, FileTimeSection, CycleSamplingMode?) Maps selection data to time section. [HttpPost] public Task Map(string key, FileTimeSection fileTimeSection = null, StepTimeShotUtil.CycleSamplingMode? cycleSamplingMode = CycleSamplingMode.SpindleCycle) Parameters key string Identifier key for the selection fileTimeSection FileTimeSection File time section, or null to use the one associated with the key cycleSamplingMode StepTimeShotUtil.CycleSamplingMode? Cycle sampling mode Returns Task Task representing the asynchronous mapping operation Message(string) Displays a message in the message host. [JsAce(\"Message($1message)\")] [HttpPost] public void Message(string message) Parameters message string The message to display OptimizeToFiles(string) Optimizes NC files and saves results using the specified file template. [JsAce(Snippet = \"OptimizeToFiles(\\\"Output/Opt-[NcName]\\\")\", DocContentHtml = \"Optimize To Files by substitude template keywoard \\\"[NcName]\\\"\")] [HttpPost] public void OptimizeToFiles(string relFileTemplate = \"Output/Opt-[NcName]\") Parameters relFileTemplate string Template for output file path, can include [NcName] placeholder Pace() Controls the pace of machining operations during execution. [JsAce(\"Pace();\")] [HttpPost] public void Pace() Pause() Pause Player [JsAce(DocContentHtml = \"Pause Player\")] public void Pause() PlayAct(IAct, ISourceCommand, CancellationToken?) [JsAce] [NonAction] public void PlayAct(IAct act, ISourceCommand sourceCommand = null, CancellationToken? cancellationToken = null) Parameters act IAct sourceCommand ISourceCommand cancellationToken CancellationToken? PlayClTeleport(double, double, double, double, double, double) [JsAce] [HttpPost] public void PlayClTeleport(double x, double y, double z, double i, double j, double k) Parameters x double y double z double i double j double k double PlayNc(string, string) Plays NC code directly from a string, executing each action and pacing between them. [JsAce(Snippet = \"PlayNc($1\\\"ncCommand\\\",$2\\\"\\\"(Direct Command)\\\"\\\");\", DocContentHtml = \"Play NC. second parameter is the file name alternative shows in the log.\")] [HttpPost] public void PlayNc(string ncText, string fileNameAlternative = \"--\") Parameters ncText string NC code as a string fileNameAlternative string Alternative name to display in logs PlayNcFile(string) Plays an NC file with the specified relative path. [JsAce(\"PlayNcFile($1\\\"ncFile\\\");\")] [HttpPost] public void PlayNcFile(string relNcFilePath) Parameters relNcFilePath string Relative path to the NC file PlayToolingTeleport(int) [JsAce] [HttpPost] public void PlayToolingTeleport(int toolId) Parameters toolId int Preserve() Preserve one line NC code in optimzation process. [JsAce(\"Preserve()\")] [HttpPost] public void Preserve() ProgressMessage(string) Displays a progress message in the message host. [JsAce(\"ProgressMessage($1message)\")] [HttpPost] public void ProgressMessage(string message) Parameters message string The progress message to display ReTrainMillingPara(SampleFlag, string, double) Re-trains milling parameters using the specified sample flag. [JsAce(\"ReTrainMillingPara(Fx|Fy|Fz, $1dstFile)\")] [HttpPost] public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2) Parameters sampleFlag SampleFlag Sample flag indicating which components to train dstRelFile string Destination relative file path outlierRatio double Outlier ratio for data filtering ReadCsvByTimeInterpolation(string) Reads a CSV file and performs time-based interpolation to map data to milling steps. [JsAce(Snippet = \"ReadCsvByTimeInterpolation($1\\\"csvFile\\\")\")] public void ReadCsvByTimeInterpolation(string csvFile) Parameters csvFile string Path to the CSV file relative to the base directory ReadRuntimeGeom(string) Reads runtime geometry from a file. [JsAce(\"ReadRuntimeGeom($1\\\"srcFile\\\")\")] [HttpPost] public void ReadRuntimeGeom(string relFile) Parameters relFile string Relative path to the input file RegisterStepVariable(string, string, string, string, Func) Registers a step variable for tracking during execution. [JsAce(Snippet = \"RegisterStepVariable(\\\"$1key\\\",\\\"$2name\\\",\\\"$3unit\\\",\\\"$4formatString\\\",\\\"$5variableFunc\\\")\", DocContentHtml = \"

          Register Step Variable.

          \\\"unit\\\" is nullable

          \\\"formatString\\\" is nullable

          \")] [NonAction] public void RegisterStepVariable(string key, string name, string unit, string formatString, Func variableFunc = null) Parameters key string Unique key to identify the variable name string Human-readable name of the variable unit string Physical unit of the variable (can be null) formatString string Format string for displaying the variable (can be null) variableFunc Func Function to compute the variable value from a milling step (can be null) RemoveFlyPiece() Removes any disconnected or “flying” pieces from the workpiece geometry. [JsAce] [HttpPost] public void RemoveFlyPiece() Reset() Reset Player [JsAce(DocContentHtml = \"Reset Player\")] public void Reset() ResetRuntime() Clears internal buffers. [JsAce] [HttpPost] public void ResetRuntime() RunNc(string, string) Runs NC code directly from a string. [JsAce(Snippet = \"RunNc($1\\\"ncCommand\\\",$2\\\"\\\"(Direct Command)\\\"\\\");\", DocContentHtml = \"Run NC. second parameter is the file name alternative shows in the log.\")] [NonAction] public IEnumerable RunNc(string ncText, string fileNameAlternative = \"--\") Parameters ncText string NC code as a string fileNameAlternative string Alternative name to display in logs Returns IEnumerable Enumerable sequence of actions to be executed RunNcFile(string) Runs an NC file with the specified relative path. [JsAce(\"RunNcFile($1\\\"ncFile\\\");\")] [NonAction] public IEnumerable RunNcFile(string relNcFilePath) Parameters relNcFilePath string Relative path to the NC file Returns IEnumerable Enumerable sequence of actions to be executed SetNcResolutionFeedPerCycle() Sets NC resolution to feed per cycle mode. [HttpPost] public void SetNcResolutionFeedPerCycle() SetNcResolutionFeedPerTooth() Sets NC resolution to feed per tooth mode. [HttpPost] public void SetNcResolutionFeedPerTooth() SetNcResolutionFixed(double, double) Sets NC resolution to fixed mode with specified resolution values. [HttpPost] public void SetNcResolutionFixed(double linearResolution_mm, double rotaryResolution_deg) Parameters linearResolution_mm double Linear resolution in millimeters. rotaryResolution_deg double Rotary resolution in degrees. SetStickMachiningToolObservationHeight_mm(int, double) Sets the observation height in millimeters for the specified stick machining tool. [JsAce(\"SetStickMachiningToolObservationHeight_mm($1toolId,$2height_mm)\")] public void SetStickMachiningToolObservationHeight_mm(int toolId, double height) Parameters toolId int The ID of the tool height double The observation height in millimeters to set SetUniformContourTrayShiftAngle_deg(int, double) Sets the shift angle in degrees for the uniform contour tray of the specified tool. [JsAce(\"SetUniformContourTrayShiftAngle_deg($1toolId,$2angle_deg)\")] [HttpPost] public void SetUniformContourTrayShiftAngle_deg(int toolId, double angle_deg) Parameters toolId int The ID of the tool angle_deg double The shift angle in degrees to set ShiftDistance_mm(double) Creates a distance shift object representing the specified distance in millimeters. [NonAction] public DistanceShift ShiftDistance_mm(double distanceShift_mm) Parameters distanceShift_mm double Distance shift in millimeters Returns DistanceShift Distance shift object ShiftTime_s(double) Creates a time shift object representing the specified time in seconds. [NonAction] public TimeShift ShiftTime_s(double seconds) Parameters seconds double Time in seconds Returns TimeShift Time shift object TrainMillingPara(SampleFlag, string, double) Trains milling parameters using the specified sample flag. [JsAce(\"TrainMillingPara(Fx|Fy|Fz, $1dstFile)\")] [HttpPost] public void TrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2) Parameters sampleFlag SampleFlag Sample flag indicating which components to train dstRelFile string Destination relative file path outlierRatio double Outlier ratio for data filtering WarningMessage(string) Displays a warning message in the message host. [JsAce(\"WarningMessage($1message)\")] [HttpPost] public void WarningMessage(string message) Parameters message string The warning message to display WriteRuntimeGeom(string) Writes the current runtime geometry to a file. [JsAce(\"WriteRuntimeGeom($1\\\"dstFile\\\")\")] [HttpPost] public void WriteRuntimeGeom(string relFile) Parameters relFile string Relative path to the output file WriteRuntimeGeomToStl(string, double) Writes the current runtime geometry to an STL file. [JsAce(\"WriteRuntimeGeomToStl($1\\\"dstFile\\\",$2resolution_mm)\")] [HttpPost] public void WriteRuntimeGeomToStl(string relFile, double resolution_mm = 0) Parameters relFile string Relative path to the output STL file resolution_mm double Resolution in millimeters (0 for default) WriteShotFiles(double, string) Writes time-series data to shot files with the specified resolution period (alternative parameter order). public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate) Parameters resolutionPeroid_ms double Resolution period in milliseconds relFileTemplate string Template for output file path, can include [NcName] placeholder WriteShotFiles(string, double) Writes time-series data to shot files with the specified resolution period. [JsAce(Snippet = \"WriteShotFiles(\\\"Output/[NcName].shot.csv\\\",resolutionPeroid_ms)\", DocContentHtml = \"Write time series data by resolutionPeroid_ms\")] [HttpPost] public void WriteShotFiles(string relFileTemplate = \"Output/[NcName].shot.csv\", double resolutionPeroid_ms = 1) Parameters relFileTemplate string Template for output file path, can include [NcName] placeholder resolutionPeroid_ms double Resolution period in milliseconds WriteStepFiles(string) Writes step-series data to files with the specified file template. [JsAce(Snippet = \"WriteStepFiles(\\\"Output/[NcName].step.csv\\\")\", DocContentHtml = \"Write step series data.\")] [HttpPost] public void WriteStepFiles(string relFileTemplate = \"Output/[NcName].step.csv\") Parameters relFileTemplate string Template for output file path, can include [NcName] placeholder Events MachiningStepBuilt Gets or sets the action to configure steps during execution. [JsAce(Snippet = \"MachiningStepBuilt+=($1preStep,$2curStep)=>{$3Command};\", DocContentHtml = \"Runtime Step Configuration action. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.\")] public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt Event Type MachiningActRunner.MachiningStepBuiltDelegate MachiningStepSelected Event that is triggered when a milling step is selected. [JsAce(Snippet = \"MachiningStepSelected+=($1millingStep)=>{$2Command};\")] public event Action MachiningStepSelected Event Type Action" + }, + "api/Hi.MachiningProcs.SessionMessage.html": { + "href": "api/Hi.MachiningProcs.SessionMessage.html", + "title": "Class SessionMessage | HiAPI-C# 2025", + "summary": "Class SessionMessage Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a message in the machining process that can contain various types of data such as source commands, machining steps, exceptions, and tagged messages. public class SessionMessage Inheritance object SessionMessage Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors SessionMessage(int, object) Initializes a new instance of the SessionMessage class. public SessionMessage(int index, object src) Parameters index int The index of the message. src object The source data. Properties ClStripPos Gets or sets the cutter location strip position. gets null if the Data is not ClStripPos. public ClStripPos ClStripPos { get; set; } Property Value ClStripPos Data Gets or sets the data contained in the message. public object Data { get; set; } Property Value object DirectInstantSourceCommand Gets or sets the direct source command from the data. gets null if the Data is not ISourceCommand. public ISourceCommand DirectInstantSourceCommand { get; set; } Property Value ISourceCommand Exception Gets or sets the exception. gets null if the Data is not Exception. public Exception Exception { get; set; } Property Value Exception Index Gets or sets the index of the message. The UI name is 'Serial.'. [Present(\"Message Index\", \"M.I.\", PhysicsUnit.None, \"G\")] public int Index { get; set; } Property Value int InstantSourceCommand Gets the source command, either directly or from the associated milling step. gets null if both DirectInstantSourceCommand and the SourceCommand from ClStripPos's State are null. public ISourceCommand InstantSourceCommand { get; } Property Value ISourceCommand MachiningStep Gets the milling step from the cutter location strip position. gets null if ClStripPos is null or its State is not a MachiningStep. public MachiningStep MachiningStep { get; } Property Value MachiningStep Message Gets the message text from either the multi-tag message or exception. gets null if both MultiTagMessage and Exception are null, or if MultiTagMessage.Message is null. [Present(\"Message\", \"Msg\", PhysicsUnit.None, \"G\")] public string Message { get; } Property Value string MessageOrNcText Gets the message text or NC code text. gets null if all sources (InstantSourceCommand, MultiTagMessage, Exception, and Data) are null or cannot provide text. [Present(\"Message/NC\", \"Msg/NC\", PhysicsUnit.None, \"G\")] public string MessageOrNcText { get; } Property Value string MessageRoleText Gets the message type text for UI display. [Present(\"Role\", \"Role\", PhysicsUnit.None, \"G\")] public string MessageRoleText { get; } Property Value string MultiTagMessage Gets or sets the multi-tag message. gets null if the Data is not MultiTagMessage. public MultiTagMessage MultiTagMessage { get; set; } Property Value MultiTagMessage Tags Gets the tags associated with the message. public HashSet Tags { get; } Property Value HashSet Remarks Different from MultiTagMessage.Tags, the Tags here includes the infomation of the Data. Methods ToString() Returns a string representation of the message data. public override string ToString() Returns string A string representation of the message data." + }, + "api/Hi.MachiningProcs.SessionMessageHost.FilterFlag.html": { + "href": "api/Hi.MachiningProcs.SessionMessageHost.FilterFlag.html", + "title": "Enum SessionMessageHost.FilterFlag | HiAPI-C# 2025", + "summary": "Enum SessionMessageHost.FilterFlag Namespace Hi.MachiningProcs Assembly HiMech.dll [Flags] public enum SessionMessageHost.FilterFlag Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields Error = 8 NC = 2 Progress = 4 Step = 1" }, "api/Hi.MachiningProcs.SessionMessageHost.html": { "href": "api/Hi.MachiningProcs.SessionMessageHost.html", "title": "Class SessionMessageHost | HiAPI-C# 2025", - "summary": "Class SessionMessageHost Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a host for managing milling messages with thread-safe operations and stable index tracking. public class SessionMessageHost : IMessageHost Inheritance object SessionMessageHost Implements IMessageHost 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) Properties IsStableIndexAlwaysAtEnd Gets or sets whether the stable index should always be at the end of the collection. public bool IsStableIndexAlwaysAtEnd { get; set; } Property Value bool MessageCollection Gets or sets the thread-safe collection of milling messages. The getter is for readonly. Do not edit the collection directly. public SynList MessageCollection { get; } Property Value SynList StableIndex Gets or sets the stable index. No other data will be inserted before this index. The term stable means it is thread safe to access range from 0 to StableIndex(exclusive). public int StableIndex { get; } Property Value int Methods Add(object) Adds a new entry to the message collection. public object Add(object entry) Parameters entry object The entry to add. Returns object The added milling message. Clear() Clears all messages from the collection. public void Clear() GenAlwaysStableTorch(bool) Generates a new SessionMessageHost.AlwaysStableTorch instance. public SessionMessageHost.AlwaysStableTorch GenAlwaysStableTorch(bool isStableIndexAlwaysAtEnd) Parameters isStableIndexAlwaysAtEnd bool Whether the index should always be stable. Returns SessionMessageHost.AlwaysStableTorch A new SessionMessageHost.AlwaysStableTorch instance. GetSourceCommand(MachiningMessage) Retrieves the source command associated with the specified machining message. public ISourceCommand GetSourceCommand(MachiningMessage machiningMessage) Parameters machiningMessage MachiningMessage The machining message to find the source command for. Returns ISourceCommand The source command that generated the message, or null if not found. PopAlwaysStable() Pops the previous stable index state. public void PopAlwaysStable() PushAlwaysStable(bool) Pushes the current stable index state and sets a new state. public void PushAlwaysStable(bool isStableIndexAlwaysAtEnd) Parameters isStableIndexAlwaysAtEnd bool The new stable index state. SetStableIndexToEnd() Sets the StableIndex to the end of the collection. public void SetStableIndexToEnd() Events CollectionCleared Event raised when the collection is cleared. public event Action CollectionCleared Event Type Action CollectionItemAdded Event raised when a new milling message is added to the collection. public event Action CollectionItemAdded Event Type Action CollectionItemChanged Event raised when a collection item is changed. public event Action CollectionItemChanged Event Type Action" + "summary": "Class SessionMessageHost Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a host for managing milling messages with thread-safe operations and stable index tracking. public class SessionMessageHost : IMessageKit Inheritance object SessionMessageHost Implements IMessageKit 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) Properties MessageCollection Gets or sets the thread-safe collection of milling messages. The getter is for readonly. Do not edit the collection directly. public SynList MessageCollection { get; } Property Value SynList StableIndex Gets or sets the stable index. No other data will be inserted before this index. The term stable means it is thread safe to access range from 0 to StableIndex(exclusive). public int StableIndex { get; } Property Value int Methods Add(object) Adds a new entry to the message collection. public object Add(object entry) Parameters entry object The entry to add. Returns object The added milling message. Clear() Clears all messages from the collection. public void Clear() GetFliteredList(FilterFlag, string) public List GetFliteredList(SessionMessageHost.FilterFlag flags, string filterText) Parameters flags SessionMessageHost.FilterFlag filterText string Returns List GetSourceCommand(SessionMessage) Retrieves the source command associated with the specified machining message. public ISourceCommand GetSourceCommand(SessionMessage machiningMessage) Parameters machiningMessage SessionMessage The machining message to find the source command for. Returns ISourceCommand The source command that generated the message, or null if not found. SetStableIndexToEnd() Sets the StableIndex to the end of the collection. public void SetStableIndexToEnd() Events CollectionCleared Event raised when the collection is cleared. public event Action CollectionCleared Event Type Action CollectionItemAdded Event raised when a new milling message is added to the collection. public event Action CollectionItemAdded Event Type Action CollectionItemChanged Event raised when a collection item is changed. public event Action CollectionItemChanged Event Type Action" }, "api/Hi.MachiningProcs.SessionMessagePack.html": { "href": "api/Hi.MachiningProcs.SessionMessagePack.html", "title": "Class SessionMessagePack | HiAPI-C# 2025", - "summary": "Class SessionMessagePack Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a package containing a machining message and its associated context. public class SessionMessagePack Inheritance object SessionMessagePack 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) Properties Host Gets the host that contains this message pack. public SessionMessageHost Host { get; } Property Value SessionMessageHost Index Gets the index of the message in the collection. public int Index { get; } Property Value int MachiningMessage Gets the machining message contained in this pack. public MachiningMessage MachiningMessage { get; } Property Value MachiningMessage Message Gets the message text. public string Message { get; } Property Value string SourceCommand Gets the source command that generated this message. public ISourceCommand SourceCommand { get; } Property Value ISourceCommand Tags Gets the tags associated with the message. public HashSet Tags { get; } Property Value HashSet" + "summary": "Class SessionMessagePack Namespace Hi.MachiningProcs Assembly HiMech.dll Represents a package containing a machining message and its associated context. public class SessionMessagePack Inheritance object SessionMessagePack 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) Constructors SessionMessagePack(SessionMessageHost, SessionMessage) Initializes a new instance of the SessionMessagePack class. public SessionMessagePack(SessionMessageHost host, SessionMessage msg) Parameters host SessionMessageHost The session message host. msg SessionMessage The machining message. Properties Host Gets the host that contains this message pack. public SessionMessageHost Host { get; } Property Value SessionMessageHost Index Gets the index of the message in the collection. public int Index { get; } Property Value int Message Gets the message text. public string Message { get; } Property Value string SessionMessage Gets the machining message contained in this pack. public SessionMessage SessionMessage { get; } Property Value SessionMessage SourceCommand Gets the source command that generated this message. public ISourceCommand SourceCommand { get; } Property Value ISourceCommand Tags Gets the tags associated with the message. public HashSet Tags { get; } Property Value HashSet" }, - "api/Hi.MachiningProcs.ShellApi.html": { - "href": "api/Hi.MachiningProcs.ShellApi.html", - "title": "Class ShellApi | HiAPI-C# 2025", - "summary": "Class ShellApi Namespace Hi.MachiningProcs Assembly HiNc.dll Provides a C# scripting API for controlling and manipulating the milling course. Allows for runtime control of milling operations, geometry manipulation, and data analysis. public class ShellApi : ICsScriptApi Inheritance object ShellApi Implements ICsScriptApi 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) Constructors ShellApi(MachiningProject) Initializes a new instance of the ShellApi class. public ShellApi(MachiningProject machiningProject) Parameters machiningProject MachiningProject The milling course this API will interact with Properties DiffVisualRadius_mm Gets or sets the visual radius in millimeters for difference visualization. Controls the radius used for highlighting differences between workpiece states. [JsAce] public double DiffVisualRadius_mm { get; set; } Property Value double DispCacheMb Gets or sets the display cache size in megabytes. public long DispCacheMb { get; set; } Property Value long DispCache_Mb Gets or sets the display cache size in megabytes. [JsAce] public long DispCache_Mb { get; set; } Property Value long EnableAutoMapOnSelectionEnd Gets or sets whether to automatically map selections when they end. [JsAce] public bool EnableAutoMapOnSelectionEnd { get; set; } Property Value bool EnableCollisionDetection Gets or sets whether collision detection is enabled. [JsAce(DocContentHtml = \"Enable Collision Detection.\")] public bool EnableCollisionDetection { get; set; } Property Value bool EnableMillingForceEvaluation Gets or sets whether milling force evaluation is enabled. [JsAce(DocContentHtml = \"Enable Milling Force Evaluation.\")] public bool EnableMillingForceEvaluation { get; set; } Property Value bool EnablePauseOnCollision Gets or sets whether to pause execution when a collision is detected. This property only has an effect if collision detection is enabled. [JsAce(DocContentHtml = \"Enable Pause On Collision. This property works only if Collision Detection is enabled.\")] public bool EnablePauseOnCollision { get; set; } Property Value bool EnableWearEffect Gets or sets whether tool wear effects are enabled in simulation. [JsAce] public bool EnableWearEffect { get; set; } Property Value bool FeedPerCycle Gets a new feed per cycle machining motion resolution instance. [JsAce] public FeedPerCycleMachiningMotionResolution FeedPerCycle { get; } Property Value FeedPerCycleMachiningMotionResolution FeedPerTooth Gets a new feed per tooth machining motion resolution instance. [JsAce] public FeedPerToothMachiningMotionResolution FeedPerTooth { get; } Property Value FeedPerToothMachiningMotionResolution Global Global variables. [JsAce(\"Global[$1key]\")] public Dictionary Global { get; } Property Value Dictionary InitSpindleTemperature_C Gets or sets the initial spindle temperature in degrees Celsius. [JsAce(DocContentHtml = \"Spindle Temperature on initialization.\")] public double InitSpindleTemperature_C { get; set; } Property Value double JsAceCompletionProfileJsonArray Internal used. public static JsonArray JsAceCompletionProfileJsonArray { get; } Property Value JsonArray MachiningMotionResolution Gets or sets the machining motion resolution. [JsAce] public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution MachiningResolution Gets or sets the machining resolution in millimeters. For legacy compatable. [JsAce] [Obsolete] public double MachiningResolution { get; set; } Property Value double MachiningResolution_mm Gets or sets the machining resolution in millimeters. [JsAce] public double MachiningResolution_mm { get; set; } Property Value double MachiningSession public MachiningSession MachiningSession { get; } Property Value MachiningSession MapTask Task tracking the status of mapping operations. public Task MapTask { get; set; } Property Value Task MillingForceCycleDivisionNum Gets or sets the number of divisions per cycle for milling force calculation. This property should be set before milling force evaluation if TrainMillingPara(SampleFlag, string, double) is intended to be used. [JsAce] public static int MillingForceCycleDivisionNum { get; set; } Property Value int OptEnableDepthCompensation Enables or disables depth compensation during optimization. [JsAce] public bool OptEnableDepthCompensation { get; set; } Property Value bool OptEnableFeedrate Gets or sets whether to enable feed rate optimization in NC optimization. [JsAce] public bool OptEnableFeedrate { get; set; } Property Value bool OptEnableForwardCompensation Enables or disables forward compensation during optimization. [JsAce] public bool OptEnableForwardCompensation { get; set; } Property Value bool OptEnableInterpolation Enables or disables reinterpolation for optimization. [JsAce] public bool OptEnableInterpolation { get; set; } Property Value bool OptEnableSideCompensation Enables or disables side compensation during optimization. [JsAce] public bool OptEnableSideCompensation { get; set; } Property Value bool OptExtendedPostDistance_mm Gets or sets the extended post-distance in millimeters for NC optimization. This is the distance after the current segment that will be considered for optimization. [JsAce] public double OptExtendedPostDistance_mm { get; set; } Property Value double OptExtendedPreDistance_mm Gets or sets the extended pre-distance in millimeters for NC optimization. This is the distance before the current segment that will be considered for optimization. [JsAce] public double OptExtendedPreDistance_mm { get; set; } Property Value double OptMaxAcceleration_mmds2 Maximum acceleration in mm/s² during optimization. Only takes effect on reinterpolated section. [JsAce(DocContentHtml = \"Only take effect on reinterpolated section.\")] public double OptMaxAcceleration_mmds2 { get; set; } Property Value double OptMaxFeedrate_mmdmin Maximum feed rate in mm/min for cutting movements during optimization. [JsAce] public double OptMaxFeedrate_mmdmin { get; set; } Property Value double OptMaxJerk_mmds3 Maximum jerk in mm/s³ during optimization. Only takes effect on reinterpolated section. [JsAce(DocContentHtml = \"Only take effect on reinterpolated section.\")] public double OptMaxJerk_mmds3 { get; set; } Property Value double OptMinFeedrate_mmdmin Minimum feed rate in mm/min for cutting movements during optimization. [JsAce] public double OptMinFeedrate_mmdmin { get; set; } Property Value double OptPreferedForce_N Preferred force in N for optimization. [JsAce] public double OptPreferedForce_N { get; set; } Property Value double OptRapidFeed_mmdmin Rapid feed rate in mm/min for non-cutting movements during optimization. [JsAce] public double OptRapidFeed_mmdmin { get; set; } Property Value double OptSpindlePowerSafetyFactor Safety factor for spindle power during optimization. [JsAce] public double OptSpindlePowerSafetyFactor { get; set; } Property Value double OptSpindleTorqueSafetyFactor Safety factor for spindle torque during optimization. [JsAce] public double OptSpindleTorqueSafetyFactor { get; set; } Property Value double ScriptOptions ScriptOptions. public ScriptOptions ScriptOptions { get; set; } Property Value ScriptOptions StepCount Gets the total number of milling steps. [JsAce] public int StepCount { get; } Property Value int Methods AddTimeDataByFile(string, string, double, double) Adds time-based data from a file to the time mapping dictionary with specified time bounds in seconds. [JsAce(\"AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)\")] public bool AddTimeDataByFile(string key, string relFile, double beginTime, double endTime) Parameters key string Key to identify the data relFile string Relative path to the data file beginTime double Beginning time in seconds endTime double Ending time in seconds Returns bool True if the data was successfully added, false otherwise AddTimeDataByFile(string, string, string, string) Adds time-based data from a file to the time mapping dictionary with specified time bounds. [JsAce(\"AddTimeDataByFile($1key, $2relFile, $3beginTime, $4endTime)\")] public bool AddTimeDataByFile(string key, string relFile, string beginTimeText, string endTimeText) Parameters key string Key to identify the data relFile string Relative path to the data file beginTimeText string Beginning time as text (seconds or TimeSpan format) endTimeText string Ending time as text (seconds or TimeSpan format) Returns bool True if the data was successfully added, false otherwise AppendMessagesToFile(string, params string[]) Appends messages to a file, optionally filtered by tags. [JsAce(\"AppendMessagesToFile(\\\"dstRelFile\\\",flags)\")] public void AppendMessagesToFile(string dstRelFile, params string[] flags) Parameters dstRelFile string Destination relative file path flags string[] Optional flags to filter messages by tags BeginPreserve() Begin Preserve section in optimzation process. [JsAce(\"BeginPreserve()\")] public void BeginPreserve() BeginSelection(string, BoundAnchorMode, IStepShift) Begin mark on current line. milling step() has not triggered yet. public void BeginSelection(string key, BoundAnchorMode anchorMode = BoundAnchorMode.LineBegin, IStepShift shift = null) Parameters key string Identifier key for the selection anchorMode BoundAnchorMode Mode for anchoring the beginning of selection shift IStepShift Step shift to apply ClearTimeMappingData() Clears all time mapping data. [JsAce] public void ClearTimeMappingData() Diff(double) Performs a difference analysis on the workpiece geometry to detect variations. [JsAce(\"Diff($1detectionRadius_mm)\")] public void Diff(double detectionRadius_mm) Parameters detectionRadius_mm double Radius for detecting differences EndPreserve() End Preserve section in optimzation process. [JsAce(\"EndPreserve()\")] public void EndPreserve() EndSelection(string, BoundAnchorMode, IStepShift) End mark on current line for selection. public void EndSelection(string key, BoundAnchorMode anchorMode = BoundAnchorMode.LineEnd, IStepShift shift = null) Parameters key string Identifier key for the selection anchorMode BoundAnchorMode Mode for anchoring the end of selection shift IStepShift Step shift to apply ErrorMessage(string) Displays an error message in the message host. [JsAce(\"ErrorMessage($1message)\")] public void ErrorMessage(string message) Parameters message string The error message to display FixedPace(double, double) Creates a fixed machining motion resolution with specified parameters. [JsAce(\"FixedPace($1linearResolution_mm, $2rotaryResolution_deg)\")] public FixedMachiningMotionResolution FixedPace(double linearResolution_mm, double rotaryResolution_deg) Parameters linearResolution_mm double Linear resolution in millimeters rotaryResolution_deg double Rotary resolution in degrees Returns FixedMachiningMotionResolution A new fixed machining motion resolution instance GetMillingStep(int) Retrieves a milling step at the specified index. [JsAce(Snippet = \"GetMillingStep($1\\\"stepIndex\\\")\")] public MachiningStep GetMillingStep(int stepIndex) Parameters stepIndex int Index of the milling step to retrieve Returns MachiningStep The milling step at the specified index GetStickMachiningToolObservationHeight_mm(int) Gets the observation height in millimeters for the specified stick machining tool. [JsAce(\"GetStickMachiningToolObservationHeight_mm($1toolId)\")] public double GetStickMachiningToolObservationHeight_mm(int toolId) Parameters toolId int The ID of the tool Returns double The observation height in millimeters GetUniformContourTrayShiftAngle_deg(int) Gets the shift angle in degrees for the uniform contour tray of the specified tool. [JsAce(\"GetUniformContourTrayShiftAngle_deg($1toolId)\")] public double GetUniformContourTrayShiftAngle_deg(int toolId) Parameters toolId int The ID of the tool Returns double The shift angle in degrees LineSelection(string, BoundAnchorMode, IStepShift, BoundAnchorMode, IStepShift) Create a line selection from begin to end mark. public void LineSelection(string key, BoundAnchorMode beginAnchorMode = BoundAnchorMode.LineBegin, IStepShift beginShift = null, BoundAnchorMode endAnchorMode = BoundAnchorMode.LineEnd, IStepShift endShift = null) Parameters key string Identifier key for the selection beginAnchorMode BoundAnchorMode Mode for anchoring the beginning of selection beginShift IStepShift Step shift to apply at beginning endAnchorMode BoundAnchorMode Mode for anchoring the end of selection endShift IStepShift Step shift to apply at end Map(string, FileTimeSection, CycleSamplingMode?) Maps selection data to time section. public Task Map(string key, FileTimeSection fileTimeSection = null, StepTimeShotUtil.CycleSamplingMode? cycleSamplingMode = CycleSamplingMode.SpindleCycle) Parameters key string Identifier key for the selection fileTimeSection FileTimeSection File time section, or null to use the one associated with the key cycleSamplingMode StepTimeShotUtil.CycleSamplingMode? Cycle sampling mode Returns Task Task representing the asynchronous mapping operation Message(string) Displays a message in the message host. [JsAce(\"Message($1message)\")] public void Message(string message) Parameters message string The message to display OptimizeToFiles(string) Optimizes NC files and saves results using the specified file template. [JsAce(Snippet = \"OptimizeToFiles(\\\"Output/Opt-[NcName]\\\")\", DocContentHtml = \"Optimize To Files by substitude template keywoard \\\"[NcName]\\\"\")] public void OptimizeToFiles(string relFileTemplate = \"Output/Opt-[NcName]\") Parameters relFileTemplate string Template for output file path, can include [NcName] placeholder Pace() Controls the pace of machining operations during execution. [JsAce(\"Pace();\")] public void Pace() Pause() Pause Player [JsAce(DocContentHtml = \"Pause Player\")] public void Pause() PlayNc(string, string) Plays NC code directly from a string, executing each action and pacing between them. [JsAce(Snippet = \"PlayNc($1\\\"ncCommand\\\",$2\\\"\\\"(Direct Command)\\\"\\\");\", DocContentHtml = \"Play NC. second parameter is the file name alternative shows in the log.\")] public void PlayNc(string ncText, string fileNameAlternative = \"--\") Parameters ncText string NC code as a string fileNameAlternative string Alternative name to display in logs PlayNcFile(string) Plays an NC file with the specified relative path. [JsAce(\"PlayNcFile($1\\\"ncFile\\\");\")] public void PlayNcFile(string relNcFilePath) Parameters relNcFilePath string Relative path to the NC file Preserve() Preserve one line NC code in optimzation process. [JsAce(\"Preserve()\")] public void Preserve() ProgressMessage(string) Displays a progress message in the message host. [JsAce(\"ProgressMessage($1message)\")] public void ProgressMessage(string message) Parameters message string The progress message to display ReTrainMillingPara(SampleFlag, string, double) Re-trains milling parameters using the specified sample flag. [JsAce(\"ReTrainMillingPara(Fx|Fy|Fz, $1dstFile)\")] public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2) Parameters sampleFlag SampleFlag Sample flag indicating which components to train dstRelFile string Destination relative file path outlierRatio double Outlier ratio for data filtering ReadCsvByTimeInterpolation(string) Reads a CSV file and performs time-based interpolation to map data to milling steps. [JsAce(Snippet = \"ReadCsvByTimeInterpolation($1\\\"csvFile\\\")\")] public void ReadCsvByTimeInterpolation(string csvFile) Parameters csvFile string Path to the CSV file relative to the base directory ReadRuntimeGeom(string) Reads runtime geometry from a file. [JsAce(\"ReadRuntimeGeom($1\\\"srcFile\\\")\")] public void ReadRuntimeGeom(string relFile) Parameters relFile string Relative path to the input file RegisterStepVariable(string, string, string, string, Func) Registers a step variable for tracking during execution. [JsAce(Snippet = \"RegisterStepVariable(\\\"$1key\\\",\\\"$2name\\\",\\\"$3unit\\\",\\\"$4formatString\\\",\\\"$5variableFunc\\\")\", DocContentHtml = \"

          Register Step Variable.

          \\\"unit\\\" is nullable

          \\\"formatString\\\" is nullable

          \")] public void RegisterStepVariable(string key, string name, string unit, string formatString, Func variableFunc = null) Parameters key string Unique key to identify the variable name string Human-readable name of the variable unit string Physical unit of the variable (can be null) formatString string Format string for displaying the variable (can be null) variableFunc Func Function to compute the variable value from a milling step (can be null) RemoveFlyPiece() Removes any disconnected or “flying” pieces from the workpiece geometry. [JsAce] public void RemoveFlyPiece() Reset() Reset Player [JsAce(DocContentHtml = \"Reset Player\")] public void Reset() ResetRuntime() Clears internal buffers. [JsAce] public void ResetRuntime() RunNc(string, string) Runs NC code directly from a string. [JsAce(Snippet = \"RunNc($1\\\"ncCommand\\\",$2\\\"\\\"(Direct Command)\\\"\\\");\", DocContentHtml = \"Run NC. second parameter is the file name alternative shows in the log.\")] public IEnumerable RunNc(string ncText, string fileNameAlternative = \"--\") Parameters ncText string NC code as a string fileNameAlternative string Alternative name to display in logs Returns IEnumerable Enumerable sequence of actions to be executed RunNcFile(string) Runs an NC file with the specified relative path. [JsAce(\"RunNcFile($1\\\"ncFile\\\");\")] public IEnumerable RunNcFile(string relNcFilePath) Parameters relNcFilePath string Relative path to the NC file Returns IEnumerable Enumerable sequence of actions to be executed SetNcResolutionFeedPerCycle() Sets NC resolution to feed per cycle mode. public void SetNcResolutionFeedPerCycle() SetNcResolutionFeedPerTooth() Sets NC resolution to feed per tooth mode. public void SetNcResolutionFeedPerTooth() SetNcResolutionFixed(double, double) Sets NC resolution to fixed mode with specified resolution values. public void SetNcResolutionFixed(double linearResolution_mm, double rotaryResolution_deg) Parameters linearResolution_mm double Linear resolution in millimeters. rotaryResolution_deg double Rotary resolution in degrees. SetStickMachiningToolObservationHeight_mm(int, double) Sets the observation height in millimeters for the specified stick machining tool. [JsAce(\"SetStickMachiningToolObservationHeight_mm($1toolId,$2height_mm)\")] public void SetStickMachiningToolObservationHeight_mm(int toolId, double height) Parameters toolId int The ID of the tool height double The observation height in millimeters to set SetUniformContourTrayShiftAngle_deg(int, double) Sets the shift angle in degrees for the uniform contour tray of the specified tool. [JsAce(\"SetUniformContourTrayShiftAngle_deg($1toolId,$2angle_deg)\")] public void SetUniformContourTrayShiftAngle_deg(int toolId, double angle_deg) Parameters toolId int The ID of the tool angle_deg double The shift angle in degrees to set ShiftDistance_mm(double) Creates a distance shift object representing the specified distance in millimeters. public DistanceShift ShiftDistance_mm(double distanceShift_mm) Parameters distanceShift_mm double Distance shift in millimeters Returns DistanceShift Distance shift object ShiftTime_s(double) Creates a time shift object representing the specified time in seconds. public TimeShift ShiftTime_s(double seconds) Parameters seconds double Time in seconds Returns TimeShift Time shift object TrainMillingPara(SampleFlag, string, double) Trains milling parameters using the specified sample flag. [JsAce(\"TrainMillingPara(Fx|Fy|Fz, $1dstFile)\")] public void TrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double outlierRatio = 2) Parameters sampleFlag SampleFlag Sample flag indicating which components to train dstRelFile string Destination relative file path outlierRatio double Outlier ratio for data filtering WarningMessage(string) Displays a warning message in the message host. [JsAce(\"WarningMessage($1message)\")] public void WarningMessage(string message) Parameters message string The warning message to display WriteRuntimeGeom(string) Writes the current runtime geometry to a file. [JsAce(\"WriteRuntimeGeom($1\\\"dstFile\\\")\")] public void WriteRuntimeGeom(string relFile) Parameters relFile string Relative path to the output file WriteRuntimeGeomToStl(string, double) Writes the current runtime geometry to an STL file. [JsAce(\"WriteRuntimeGeomToStl($1\\\"dstFile\\\",$2resolution_mm)\")] public void WriteRuntimeGeomToStl(string relFile, double resolution_mm = 0) Parameters relFile string Relative path to the output STL file resolution_mm double Resolution in millimeters (0 for default) WriteShotFiles(double, string) Writes time-series data to shot files with the specified resolution period (alternative parameter order). public void WriteShotFiles(double resolutionPeroid_ms, string relFileTemplate) Parameters resolutionPeroid_ms double Resolution period in milliseconds relFileTemplate string Template for output file path, can include [NcName] placeholder WriteShotFiles(string, double) Writes time-series data to shot files with the specified resolution period. [JsAce(Snippet = \"WriteShotFiles(\\\"Output/[NcName].shot.csv\\\",resolutionPeroid_ms)\", DocContentHtml = \"Write time series data by resolutionPeroid_ms\")] public void WriteShotFiles(string relFileTemplate = \"Output/[NcName].shot.csv\", double resolutionPeroid_ms = 1) Parameters relFileTemplate string Template for output file path, can include [NcName] placeholder resolutionPeroid_ms double Resolution period in milliseconds WriteStepFiles(string) Writes step-series data to files with the specified file template. [JsAce(Snippet = \"WriteStepFiles(\\\"Output/[NcName].step.csv\\\")\", DocContentHtml = \"Write step series data.\")] public void WriteStepFiles(string relFileTemplate = \"Output/[NcName].step.csv\") Parameters relFileTemplate string Template for output file path, can include [NcName] placeholder Events MachiningStepBuilt Gets or sets the action to configure steps during execution. [JsAce(Snippet = \"MachiningStepBuilt+=($1preStep,$2curStep)=>{$3Command};\", DocContentHtml = \"Runtime Step Configuration action. preStep is the Previous Milling Step; curStep is the Current Milling Step. preStep is null if no previous step existed.\")] public event MachiningActRunner.MachiningStepBuiltDelegate MachiningStepBuilt Event Type MachiningActRunner.MachiningStepBuiltDelegate MillingStepSelected Event that is triggered when a milling step is selected. [JsAce(Snippet = \"MillingStepSelected+=($1millingStep)=>{$2Command};\")] public event Action MillingStepSelected Event Type Action" + "api/Hi.MachiningProcs.SetupController.html": { + "href": "api/Hi.MachiningProcs.SetupController.html", + "title": "Class SetupController | HiAPI-C# 2025", + "summary": "Class SetupController Namespace Hi.MachiningProcs Assembly HiNc.dll [ApiController] [Route(\"api/[controller]/[action]\")] public class SetupController : ControllerBase Inheritance object ControllerBase SetupController Inherited Members ControllerBase.StatusCode(int) ControllerBase.StatusCode(int, object) ControllerBase.Content(string) ControllerBase.Content(string, string) ControllerBase.Content(string, string, Encoding) ControllerBase.Content(string, MediaTypeHeaderValue) ControllerBase.NoContent() ControllerBase.Ok() ControllerBase.Ok(object) ControllerBase.Redirect(string) ControllerBase.RedirectPermanent(string) ControllerBase.RedirectPreserveMethod(string) ControllerBase.RedirectPermanentPreserveMethod(string) ControllerBase.LocalRedirect(string) ControllerBase.LocalRedirectPermanent(string) ControllerBase.LocalRedirectPreserveMethod(string) ControllerBase.LocalRedirectPermanentPreserveMethod(string) ControllerBase.RedirectToAction() ControllerBase.RedirectToAction(string) ControllerBase.RedirectToAction(string, object) ControllerBase.RedirectToAction(string, string) ControllerBase.RedirectToAction(string, string, object) ControllerBase.RedirectToAction(string, string, string) ControllerBase.RedirectToAction(string, string, object, string) ControllerBase.RedirectToActionPreserveMethod(string, string, object, string) ControllerBase.RedirectToActionPermanent(string) ControllerBase.RedirectToActionPermanent(string, object) ControllerBase.RedirectToActionPermanent(string, string) ControllerBase.RedirectToActionPermanent(string, string, string) ControllerBase.RedirectToActionPermanent(string, string, object) ControllerBase.RedirectToActionPermanent(string, string, object, string) ControllerBase.RedirectToActionPermanentPreserveMethod(string, string, object, string) ControllerBase.RedirectToRoute(string) ControllerBase.RedirectToRoute(object) ControllerBase.RedirectToRoute(string, object) ControllerBase.RedirectToRoute(string, string) ControllerBase.RedirectToRoute(string, object, string) ControllerBase.RedirectToRoutePreserveMethod(string, object, string) ControllerBase.RedirectToRoutePermanent(string) ControllerBase.RedirectToRoutePermanent(object) ControllerBase.RedirectToRoutePermanent(string, object) ControllerBase.RedirectToRoutePermanent(string, string) ControllerBase.RedirectToRoutePermanent(string, object, string) ControllerBase.RedirectToRoutePermanentPreserveMethod(string, object, string) ControllerBase.RedirectToPage(string) ControllerBase.RedirectToPage(string, object) ControllerBase.RedirectToPage(string, string) ControllerBase.RedirectToPage(string, string, object) ControllerBase.RedirectToPage(string, string, string) ControllerBase.RedirectToPage(string, string, object, string) ControllerBase.RedirectToPagePermanent(string) ControllerBase.RedirectToPagePermanent(string, object) ControllerBase.RedirectToPagePermanent(string, string) ControllerBase.RedirectToPagePermanent(string, string, string) ControllerBase.RedirectToPagePermanent(string, string, object, string) ControllerBase.RedirectToPagePreserveMethod(string, string, object, string) ControllerBase.RedirectToPagePermanentPreserveMethod(string, string, object, string) ControllerBase.File(byte[], string) ControllerBase.File(byte[], string, bool) ControllerBase.File(byte[], string, string) ControllerBase.File(byte[], string, string, bool) ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(Stream, string) ControllerBase.File(Stream, string, bool) ControllerBase.File(Stream, string, string) ControllerBase.File(Stream, string, string, bool) ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(string, string) ControllerBase.File(string, string, bool) ControllerBase.File(string, string, string) ControllerBase.File(string, string, string, bool) ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.PhysicalFile(string, string) ControllerBase.PhysicalFile(string, string, bool) ControllerBase.PhysicalFile(string, string, string) ControllerBase.PhysicalFile(string, string, string, bool) ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue) ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool) ControllerBase.Unauthorized() ControllerBase.Unauthorized(object) ControllerBase.NotFound() ControllerBase.NotFound(object) ControllerBase.BadRequest() ControllerBase.BadRequest(object) ControllerBase.BadRequest(ModelStateDictionary) ControllerBase.UnprocessableEntity() ControllerBase.UnprocessableEntity(object) ControllerBase.UnprocessableEntity(ModelStateDictionary) ControllerBase.Conflict() ControllerBase.Conflict(object) ControllerBase.Conflict(ModelStateDictionary) ControllerBase.Problem(string, string, int?, string, string) ControllerBase.Problem(string, string, int?, string, string, IDictionary) ControllerBase.ValidationProblem(ValidationProblemDetails) ControllerBase.ValidationProblem(ModelStateDictionary) ControllerBase.ValidationProblem() ControllerBase.ValidationProblem(string, string, int?, string, string, ModelStateDictionary) ControllerBase.ValidationProblem(string, string, int?, string, string, ModelStateDictionary, IDictionary) ControllerBase.Created() ControllerBase.Created(string, object) ControllerBase.Created(Uri, object) ControllerBase.CreatedAtAction(string, object) ControllerBase.CreatedAtAction(string, object, object) ControllerBase.CreatedAtAction(string, string, object, object) ControllerBase.CreatedAtRoute(string, object) ControllerBase.CreatedAtRoute(object, object) ControllerBase.CreatedAtRoute(string, object, object) ControllerBase.Accepted() ControllerBase.Accepted(object) ControllerBase.Accepted(Uri) ControllerBase.Accepted(string) ControllerBase.Accepted(string, object) ControllerBase.Accepted(Uri, object) ControllerBase.AcceptedAtAction(string) ControllerBase.AcceptedAtAction(string, string) ControllerBase.AcceptedAtAction(string, object) ControllerBase.AcceptedAtAction(string, string, object) ControllerBase.AcceptedAtAction(string, object, object) ControllerBase.AcceptedAtAction(string, string, object, object) ControllerBase.AcceptedAtRoute(object) ControllerBase.AcceptedAtRoute(string) ControllerBase.AcceptedAtRoute(string, object) ControllerBase.AcceptedAtRoute(object, object) ControllerBase.AcceptedAtRoute(string, object, object) ControllerBase.Challenge() ControllerBase.Challenge(params string[]) ControllerBase.Challenge(AuthenticationProperties) ControllerBase.Challenge(AuthenticationProperties, params string[]) ControllerBase.Forbid() ControllerBase.Forbid(params string[]) ControllerBase.Forbid(AuthenticationProperties) ControllerBase.Forbid(AuthenticationProperties, params string[]) ControllerBase.SignIn(ClaimsPrincipal) ControllerBase.SignIn(ClaimsPrincipal, string) ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties) ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties, string) ControllerBase.SignOut() ControllerBase.SignOut(AuthenticationProperties) ControllerBase.SignOut(params string[]) ControllerBase.SignOut(AuthenticationProperties, params string[]) ControllerBase.TryUpdateModelAsync(TModel) ControllerBase.TryUpdateModelAsync(TModel, string) ControllerBase.TryUpdateModelAsync(TModel, string, IValueProvider) ControllerBase.TryUpdateModelAsync(TModel, string, params Expression>[]) ControllerBase.TryUpdateModelAsync(TModel, string, Func) ControllerBase.TryUpdateModelAsync(TModel, string, IValueProvider, params Expression>[]) ControllerBase.TryUpdateModelAsync(TModel, string, IValueProvider, Func) ControllerBase.TryUpdateModelAsync(object, Type, string) ControllerBase.TryUpdateModelAsync(object, Type, string, IValueProvider, Func) ControllerBase.TryValidateModel(object) ControllerBase.TryValidateModel(object, string) ControllerBase.HttpContext ControllerBase.Request ControllerBase.Response ControllerBase.RouteData ControllerBase.ModelState ControllerBase.ControllerContext ControllerBase.MetadataProvider ControllerBase.ModelBinderFactory ControllerBase.Url ControllerBase.ObjectValidator ControllerBase.ProblemDetailsFactory ControllerBase.User ControllerBase.Empty 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) Constructors SetupController(IPathedMachiningProjectHost) public SetupController(IPathedMachiningProjectHost pathedMachiningProjectHost) Parameters pathedMachiningProjectHost IPathedMachiningProjectHost Properties InitResolution_mm InitResolution_mm. public double InitResolution_mm { get; set; } Property Value double Methods ApplyClMillingDevice() [HttpPost] public void ApplyClMillingDevice() LoadFixture(string) [HttpPost] public void LoadFixture(string fixtureXmlFilePath) Parameters fixtureXmlFilePath string LoadProject(string) [HttpPost] public void LoadProject(string filePath) Parameters filePath string SaveProject() [HttpPost] public void SaveProject()" }, "api/Hi.MachiningProcs.html": { "href": "api/Hi.MachiningProcs.html", "title": "Namespace Hi.MachiningProcs | HiAPI-C# 2025", - "summary": "Namespace Hi.MachiningProcs Classes DynamicMachiningProjectDisplayee Provides display capabilities for a milling course. MachiningActRunner Represents a runner for machining actions that manages milling steps, tool paths, and collision detection. MachiningMessage Represents a message in the machining process that can contain various types of data such as source commands, machining steps, exceptions, and tagged messages. MachiningParallelProc Represents a parallel processing system for milling operations that manages various tasks such as sweeping, subtraction, force calculation, and physics simulation. MachiningParallelProc.StepTaskBundle Represents a bundle of tasks related to a milling step. MachiningParallelProc.SubstractionResult Represents the result of a subtraction operation. MachiningProject Represents a milling project that manages the execution, simulation, and analysis of NC programs. MachiningProjectDisplayee Represents a displayable wrapper for a machining project. MachiningSession Represents a machining session that manages the execution and optimization of machining operations. Provides functionality for controlling the machining process, handling optimization options, and managing session state. MillingActRunnerConfig Represents the configuration for a milling act runner. Provides settings for physics simulation, evaluation, and temperature control. MillingUtil Provides utility methods for milling calculations and operations. SessionMessageHost Represents a host for managing milling messages with thread-safe operations and stable index tracking. SessionMessageHost.AlwaysStableTorch A disposable class that manages the stable index state. SessionMessagePack Represents a package containing a machining message and its associated context. ShellApi Provides a C# scripting API for controlling and manipulating the milling course. Allows for runtime control of milling operations, geometry manipulation, and data analysis. Enums RenderingFlag Flags that control which elements are rendered in the visualization. Delegates ConfigStepFunc Delegate for configuring a milling step with additional arguments. MachiningActRunner.MachiningStepBuiltDelegate Delegate for configuring a step with previous and current step information." + "summary": "Namespace Hi.MachiningProcs Classes DynamicMachiningProjectDisplayee Provides display capabilities for a milling course. MachiningActRunner Represents a runner for machining actions that manages milling steps, tool paths, and collision detection. MachiningParallelProc Represents a parallel processing system for milling operations that manages various tasks such as sweeping, subtraction, force calculation, and physics simulation. MachiningParallelProc.StepTaskBundle Represents a bundle of tasks related to a milling step. MachiningParallelProc.SubstractionResult Represents the result of a subtraction operation. MachiningProject Represents a milling project that manages the execution, simulation, and analysis of NC programs. MachiningProjectDisplayee Represents a displayable wrapper for a machining project. MachiningSession Represents a machining session that manages the execution and optimization of machining operations. Provides functionality for controlling the machining process, handling optimization options, and managing session state. MillingActRunnerConfig Represents the configuration for a milling act runner. Provides settings for physics simulation, evaluation, and temperature control. MillingUtil Provides utility methods for milling calculations and operations. RuntimeController Provides a C# scripting API for controlling and manipulating the milling course. Allows for runtime control of milling operations, geometry manipulation, and data analysis. SessionMessage Represents a message in the machining process that can contain various types of data such as source commands, machining steps, exceptions, and tagged messages. SessionMessageHost Represents a host for managing milling messages with thread-safe operations and stable index tracking. SessionMessagePack Represents a package containing a machining message and its associated context. SetupController Interfaces IMachiningProjectGetter IMachiningProjectHost IPathedMachiningProjectHost Enums RenderingFlag Flags that control which elements are rendered in the visualization. SessionMessageHost.FilterFlag Delegates ConfigStepFunc Delegate for configuring a milling step with additional arguments. MachiningActRunner.MachiningStepBuiltDelegate Delegate for configuring a step with previous and current step information." + }, + "api/Hi.MachiningSteps.IGetSourceCommand.html": { + "href": "api/Hi.MachiningSteps.IGetSourceCommand.html", + "title": "Interface IGetSourceCommand | HiAPI-C# 2025", + "summary": "Interface IGetSourceCommand Namespace Hi.MachiningSteps Assembly HiMech.dll Defines an interface for retrieving source command information. public interface IGetSourceCommand 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) Methods GetSourceCommand() Gets the source command associated with this instance. ISourceCommand GetSourceCommand() Returns ISourceCommand The source command object." + }, + "api/Hi.MachiningSteps.IMachiningStepHost.html": { + "href": "api/Hi.MachiningSteps.IMachiningStepHost.html", + "title": "Interface IMachiningStepHost | HiAPI-C# 2025", + "summary": "Interface IMachiningStepHost Namespace Hi.MachiningSteps Assembly HiMech.dll Represents a host interface for milling steps that provides access to milling equipment and related resources. public interface IMachiningStepHost : IGetMachiningEquipment Inherited Members IGetMachiningEquipment.GetMillingEquipment() 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) Properties DictionaryColorGuide Gets the color guide for dictionary-based coloring. DictionaryColorGuide DictionaryColorGuide { get; } Property Value DictionaryColorGuide MachiningEquipment Gets the milling equipment used for machining operations. MachiningEquipment MachiningEquipment { get; } Property Value MachiningEquipment MachiningToolHouse Gets the tool house containing milling tools. MachiningToolHouse MachiningToolHouse { get; } Property Value MachiningToolHouse MillingStepLuggageReader Gets the parallel bulk reader for milling step luggage data. ParallelBulkReader MillingStepLuggageReader { get; } Property Value ParallelBulkReader TimeMapping Gets the time mapping for synchronization. TimeMapping TimeMapping { get; } Property Value TimeMapping" + }, + "api/Hi.MachiningSteps.ISourceCommand.html": { + "href": "api/Hi.MachiningSteps.ISourceCommand.html", + "title": "Interface ISourceCommand | HiAPI-C# 2025", + "summary": "Interface ISourceCommand Namespace Hi.MachiningSteps Assembly HiMech.dll Represents a source command interface that provides access to file line information and command flags. public interface ISourceCommand : IFileLine, IFileLineIndex, IGetIndexedFileLine, IGetFileLineIndex, IGetSourceCommand Inherited Members IFileLine.FilePath IFileLine.Line IFileLineIndex.FileIndex IFileLineIndex.LineIndex IGetIndexedFileLine.GetIndexedFileLine() IGetFileLineIndex.GetFileLineIndex() IGetSourceCommand.GetSourceCommand() 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) Properties FlagsText Gets the text representation of command flags. [Present(\"NC Flag\", \"NC Flag\", PhysicsUnit.None, \"G\")] string FlagsText { get; } Property Value string" + }, + "api/Hi.MachiningSteps.MachineMotionStep.html": { + "href": "api/Hi.MachiningSteps.MachineMotionStep.html", + "title": "Class MachineMotionStep | HiAPI-C# 2025", + "summary": "Class MachineMotionStep Namespace Hi.MachiningSteps Assembly HiMech.dll MachiningStep has spindle information. Note that the spindle information is only for milling behavior. public class MachineMotionStep : IGetFeedrate, IGetSpindleSpeed Inheritance object MachineMotionStep Implements IGetFeedrate IGetSpindleSpeed Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors MachineMotionStep(MachineMotionStep) Initializes a new instance of the MachineMotionStep class by copying from another instance. public MachineMotionStep(MachineMotionStep src) Parameters src MachineMotionStep The source machining step to copy from. MachineMotionStep(TimeSpan, TimeSpan, double, double[], double, double, SpindleDirection, int, Mat4d, Mat4d, SeqPair) Initializes a new instance of the MachineMotionStep class with specified parameters. public MachineMotionStep(TimeSpan stepDuration, TimeSpan accumulatedTime, double beginSpindleAngle_rad, double[] mcValues, double feedrate_mmds, double spindleSpeed_radds, SpindleDirection spindleDirection, int toolId, Mat4d programZeroToWorkpieceGeomToMat4d, Mat4d workpieceGeomToProgramZeroMat4d, SeqPair seqOnWorkpieceGeomCoordinate) Parameters stepDuration TimeSpan The duration of this step. accumulatedTime TimeSpan The accumulated time up to this step. beginSpindleAngle_rad double The initial spindle angle in radians. mcValues double[] The machine coordinate values. feedrate_mmds double The feed rate in millimeters per second. spindleSpeed_radds double The spindle speed in radians per second. spindleDirection SpindleDirection The direction of spindle rotation. toolId int The ID of the tool being used. programZeroToWorkpieceGeomToMat4d Mat4d The transformation matrix from program zero to workpiece geometry. workpieceGeomToProgramZeroMat4d Mat4d The transformation matrix from workpiece geometry to program zero. seqOnWorkpieceGeomCoordinate SeqPair The sequence of transformations on workpiece geometry coordinate. Properties AccumulatedTime The work time at the end of the step. public TimeSpan AccumulatedTime { get; set; } Property Value TimeSpan BeginSpindleAngle_deg Begin spindle rotation angle. in deg; public double BeginSpindleAngle_deg { get; set; } Property Value double BeginSpindleAngle_rad Begin spindle rotation angle. in rad; public double BeginSpindleAngle_rad { get; set; } Property Value double CdnTransformProgramToToolRunning Gets the transformation matrix from program to tool running coordinate. public Mat4d CdnTransformProgramToToolRunning { get; } Property Value Mat4d CdnTransformProgramToWorkpieceGeom Gets the transformation matrix from program zero to workpiece geometry. public Mat4d CdnTransformProgramToWorkpieceGeom { get; } Property Value Mat4d CdnTransformToolRunningToProgram Gets the transformation matrix from tool running to program coordinate. public Mat4d CdnTransformToolRunningToProgram { get; } Property Value Mat4d CdnTransformToolRunningToWorkpieceGeom Tool running coordinate to workpiece geom coordinate. public Mat4d CdnTransformToolRunningToWorkpieceGeom { get; } Property Value Mat4d CdnTransformWorkpieceGeomToProgram Gets the transformation matrix from workpiece geometry to program zero. public Mat4d CdnTransformWorkpieceGeomToProgram { get; } Property Value Mat4d CdnTransformWorkpieceGeomToToolRunning Gets the transformation matrix from workpiece geometry to tool running coordinate. public Mat4d CdnTransformWorkpieceGeomToToolRunning { get; } Property Value Mat4d CyclePeriod Gets the cycle period as a TimeSpan. public TimeSpan CyclePeriod { get; } Property Value TimeSpan CyclePeriod_s Gets the cycle period in seconds. public double CyclePeriod_s { get; } Property Value double EndSpindleAngle_deg Gets the end spindle angle in degrees. public double EndSpindleAngle_deg { get; } Property Value double EndSpindleAngle_rad Gets the end spindle angle in radians. public double EndSpindleAngle_rad { get; } Property Value double FeedPerCycle_mm Gets the feed per cycle in millimeters. public double FeedPerCycle_mm { get; } Property Value double Feedrate_mmds Gets or sets the feed rate in millimeters per second. public double Feedrate_mmds { get; set; } Property Value double GeomCl Gets the current position in workpiece geometry coordinate. public DVec3d GeomCl { get; } Property Value DVec3d McValues Machine coordinate values. public double[] McValues { get; set; } Property Value double[] MoveOnProgramCoordinate_mm Gets the movement vector in program coordinate in millimeters. public Vec3d MoveOnProgramCoordinate_mm { get; } Property Value Vec3d MoveOnWorkpieceGeomCoordinate_mm Gets the movement vector in workpiece geometry coordinate in millimeters. public Vec3d MoveOnWorkpieceGeomCoordinate_mm { get; } Property Value Vec3d MovingDirectionOnWorkpieceGeomCoordinate Gets the movement direction vector in workpiece geometry coordinate. public Vec3d MovingDirectionOnWorkpieceGeomCoordinate { get; } Property Value Vec3d MovingLength_mm Gets the length of movement in millimeters. public double MovingLength_mm { get; } Property Value double PassedSpindleAngle_deg For milling behavior only. public double PassedSpindleAngle_deg { get; } Property Value double PassedSpindleAngle_rad For milling behavior only. public double PassedSpindleAngle_rad { get; } Property Value double ProgramCl Gets the current position in program coordinate. public DVec3d ProgramCl { get; } Property Value DVec3d ProgramToWorkpieceGeomMat4d Gets or sets the transformation matrix from program zero to workpiece geometry. public Mat4d ProgramToWorkpieceGeomMat4d { get; set; } Property Value Mat4d SeqOnToolRunningCoordinate Gets the sequence of transformations on tool running coordinate. public SeqPair SeqOnToolRunningCoordinate { get; } Property Value SeqPair SeqOnWorkpieceGeomCoordinate Gets or sets the sequence of transformations on workpiece geometry coordinate. public SeqPair SeqOnWorkpieceGeomCoordinate { get; set; } Property Value SeqPair SpindleDirection Gets or sets the direction of spindle rotation. public SpindleDirection SpindleDirection { get; set; } Property Value SpindleDirection SpindleSpeed_cycleds Gets the spindle speed in cycles per second. public double SpindleSpeed_cycleds { get; } Property Value double SpindleSpeed_radds For milling behavior only. public double SpindleSpeed_radds { get; set; } Property Value double SpindleSpeed_rpm Gets the spindle speed in revolutions per minute. public double SpindleSpeed_rpm { get; } Property Value double StepBeginTime The work time at the begin of the step. public TimeSpan StepBeginTime { get; } Property Value TimeSpan StepDuration Gets or sets the duration of this step. public TimeSpan StepDuration { get; set; } Property Value TimeSpan ToolId Gets or sets the ID of the tool being used. public int ToolId { get; set; } Property Value int WorkpieceGeomToProgramMat4d Gets or sets the transformation matrix from workpiece geometry to program zero. public Mat4d WorkpieceGeomToProgramMat4d { get; set; } Property Value Mat4d Methods GetFeedPerTooth_mm(IMachiningTool) Gets the feed per tooth in millimeters. public double GetFeedPerTooth_mm(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The feed per tooth in millimeters. GetFeedrate_mmds() Gets the program feedrate in millimeters per second. public double GetFeedrate_mmds() Returns double Feedrate in mm/s GetMachiningTool(MachiningToolHouse) Gets the machining tool from the tool house. public IMachiningTool GetMachiningTool(MachiningToolHouse toolHouse) Parameters toolHouse MachiningToolHouse The machining tool house. Returns IMachiningTool The machining tool. GetProgramSideCuspHeight_mm(IMachiningTool) Gets the program side cusp height in millimeters. public double GetProgramSideCuspHeight_mm(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The program side cusp height in millimeters. GetSideCuspList_mm(IMachiningTool) Gets the list of side cusp heights in millimeters. public List GetSideCuspList_mm(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns List The list of side cusp heights in millimeters. GetSideCuspPhaseInterval_rad(IMachiningTool) Gets the side cusp phase interval in radians. public double GetSideCuspPhaseInterval_rad(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The side cusp phase interval in radians. GetSpindleDirection() Gets the spindle rotation direction. public SpindleDirection GetSpindleDirection() Returns SpindleDirection The spindle direction (clockwise, counterclockwise, or stopped) GetSpindleSpeed_radds() Gets the spindle speed in radians per second. public double GetSpindleSpeed_radds() Returns double Spindle speed in rad/s GetToothArcDuration_s(IMachiningTool) Gets the duration of a single tooth arc in seconds. public double GetToothArcDuration_s(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The duration of a single tooth arc in seconds. GetToothSeqOnToolRunningCoordinate(IMachiningTool) Gets the sequence of transformations for a single tooth on tool running coordinate. public SeqPair GetToothSeqOnToolRunningCoordinate(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns SeqPair The sequence of transformations for a single tooth. ToString() Returns a string representation of this machining step. public override string ToString() Returns string A string representation of this machining step." + }, + "api/Hi.MachiningSteps.MachiningStep.html": { + "href": "api/Hi.MachiningSteps.MachiningStep.html", + "title": "Class MachiningStep | HiAPI-C# 2025", + "summary": "Class MachiningStep Namespace Hi.MachiningSteps Assembly HiMech.dll public class MachiningStep : IGetSourceCommand, IFlexDictionaryHost, IGetFeedrate, IGetSpindleSpeed, IGetRgbWithPriority Inheritance object MachiningStep Implements IGetSourceCommand IFlexDictionaryHost IGetFeedrate IGetSpindleSpeed IGetRgbWithPriority 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) FlexDictionaryUtil.CallFlexDictionary(IFlexDictionaryHost) FlexDictionaryUtil.GetFlexDictionaryBytes(IFlexDictionaryHost, IntegerKeyDictionaryConverter) FlexDictionaryUtil.WriteFlexDictionary(IFlexDictionaryHost, BinaryWriter, IntegerKeyDictionaryConverter) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MachiningStep(IMachiningStepHost, int, ISourceCommand, MachineMotionStep, MillingPhysicsStep) Initializes a new instance of the MillingStep class. public MachiningStep(IMachiningStepHost host, int stepIndex, ISourceCommand sourceCommand, MachineMotionStep machiningStep, MillingPhysicsStep millingPhysicsStep) Parameters host IMachiningStepHost The host of the milling step. stepIndex int The index of the step. sourceCommand ISourceCommand The source command. machiningStep MachineMotionStep The machining step. millingPhysicsStep MillingPhysicsStep The milling physics step. Properties AccumulatedCraterWear_um Gets the accumulated crater wear in micrometers [Present(\"Accumulated Crater Wear\", \"A.C.Wear\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedCraterWear_um { get; } Property Value double AccumulatedFlankWearDepth_um Gets the accumulated flank wear depth in micrometers [Present(\"Accumulated Flank Wear Depth\", \"A.F.Wear.Depth\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedFlankWearDepth_um { get; } Property Value double AccumulatedFlankWearWidth_um Gets the accumulated flank wear width in micrometers [Present(\"Accumulated Flank Wear Width\", \"A.F.Wear.Width\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedFlankWearWidth_um { get; } Property Value double AccumulatedSpindleEnergyConsumption_kWh Gets the accumulated spindle energy consumption in kilowatt-hours [Present(\"Accumulated Spindle Energy Consumption\", null, PhysicsUnit.kWh, \"G6\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedSpindleEnergyConsumption_kWh { get; } Property Value double AccumulatedTime Gets the accumulated time. [Present(\"Time\", null, PhysicsUnit.None, \"G\")] [JsAce(ClassExt = \"MachiningStep\")] public TimeSpan AccumulatedTime { get; } Property Value TimeSpan AvgAbsMomentAboutSensorVec3d_Nm Gets the average absolute moment about sensor vector in Newton-meters [Present(\"Avg Abs Moment To Tool About Sensor\", \"Avg-Abs-M-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgAbsMomentAboutSensorVec3d_Nm { get; } Property Value Vec3d AvgAbsMomentXAboutSensorOnSpindleRotationCoordinate_Nm Gets the average absolute moment X about sensor on spindle rotation coordinate in Newton-meters [Present(\"Avg Abs Moment X To Tool About Sensor On Spindle Rotation Coordinate\", \"AvgAbsMx-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsMomentXAboutSensorOnSpindleRotationCoordinate_Nm { get; } Property Value double? AvgAbsMomentXAboutToolTipOnSpindleRotationCoordinate_Nm Gets the average absolute moment X about tool tip on spindle rotation coordinate in Newton-meters [Present(\"Avg Abs Moment X To Tool About Tool Tip On Spindle Rotation Coordinate\", \"AvgAbsMx-ToTool-Tip-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AvgAbsMomentXAboutToolTipOnSpindleRotationCoordinate_Nm { get; } Property Value double AvgAbsTorqueByMapping_Nm Gets the average absolute torque by mapping in Newton-meters [Present(\"Avg Abs Torque By Mapping\", \"AvgAbsTorque-Map\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorqueByMapping_Nm { get; } Property Value double? AvgAbsTorqueErrorRatioWithMapping numerator is sim value minus mapping value; denominator is the mapping value. [Present(\"Avg Torque Error Ratio by Mapping\", \"Torque-Err-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorqueErrorRatioWithMapping { get; } Property Value double? AvgAbsTorqueSignedErrorRelationWithMapping The sign is from sim value minus mapping value. the quantity is Math.Sqrt(err.Square() / Math.Abs(sim * mapping)) [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorqueSignedErrorRelationWithMapping { get; } Property Value double? AvgAbsTorque_Nm AvgAbsTorqueOnSpindleRotationCoordinate [Present(\"Avg Abs Torque\", \"AvgAbsTorque\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorque_Nm { get; } Property Value double? AvgForceToToolOnToolRunningCoordinate_N Gets the average force to tool on tool running coordinate in N. [Present(\"AvgForceToToolOnToolRunningCoordinate\", \"AvgForce-ToTool-TR\", PhysicsUnit.N, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgForceToToolOnToolRunningCoordinate_N { get; } Property Value Vec3d AvgForceXToToolOnToolRunningCoordinate_N Gets the average force X to tool on tool running coordinate in N. [JsAce(ClassExt = \"MachiningStep\")] public double? AvgForceXToToolOnToolRunningCoordinate_N { get; } Property Value double? AvgForceYToToolOnToolRunningCoordinate_N Gets the average force Y to tool on tool running coordinate in N. [JsAce(ClassExt = \"MachiningStep\")] public double? AvgForceYToToolOnToolRunningCoordinate_N { get; } Property Value double? AvgForceZToToolOnToolRunningCoordinate_N Gets the average force Z to tool on tool running coordinate in N. [JsAce(ClassExt = \"MachiningStep\")] public double? AvgForceZToToolOnToolRunningCoordinate_N { get; } Property Value double? AvgMomentAboutSensor_Nm Gets the average moment about sensor in Newton-meters [Present(\"Avg Moment To Tool About Sensor\", \"AvgM-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentAboutSensor_Nm { get; } Property Value double? AvgMomentAboutToolTipOnProgramCoordinate_Nm Gets the average moment about tool tip on program coordinate in Newton-meters [Present(\"Avg Moment To Tool About Tool Tip On Workpiece Program Coordinate\", \"AvgAbsM-ToTool-Tip-W\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgMomentAboutToolTipOnProgramCoordinate_Nm { get; } Property Value Vec3d AvgMomentAboutToolTipOnToolRunningCoordinate_Nm Gets the average moment about tool tip on tool running coordinate in Newton-meters [Present(\"Avg Moment To Tool About Tool Tip On Tool Running Coordinate\", \"AvgAbsM-ToTool-Tip-TR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgMomentAboutToolTipOnToolRunningCoordinate_Nm { get; } Property Value Vec3d AvgMomentAboutToolTip_Nm Gets the average moment about tool tip in Newton-meters [Present(\"Avg Moment To Tool About ToolTip\", \"AvgM-ToTool-Tip-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentAboutToolTip_Nm { get; } Property Value double? AvgMomentXyAboutObservationPoint_Nm Gets the average moment XY about observation point in Newton-meters [Present(\"Avg Moment XY To Tool About Sensor\", \"AvgM-ToTool-Sensor.XY\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXyAboutObservationPoint_Nm { get; } Property Value double? AvgMomentXyByMapping_Nm Gets the average moment XY by mapping in Newton-meters [Present(\"Avg Moment XY By Mapping\", \"AvgM-Map.XY\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXyByMapping_Nm { get; } Property Value double? AvgMomentXyErrorRatioWithMapping Gets the average moment XY error ratio with mapping. Numerator is sim value minus mapping value; denominator is the mapping value. [Present(\"Avg Moment XY Error Ratio by Mapping\", \"M-XY-Err-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXyErrorRatioWithMapping { get; } Property Value double? AvgMomentXySignedErrorRelationWithMapping The sign is from sim value minus mapping value. the quantity is Math.Sqrt(err.Square() / Math.Abs(sim * mapping)) [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXySignedErrorRelationWithMapping { get; } Property Value double? BeginSpindleAngle_deg Gets the beginning spindle angle in degrees. [Present(\"Beginning Spindle Angle Shift\", \"Spd. Ang. Shift\", PhysicsUnit.deg, \"F2\")] [JsAce(ClassExt = \"MachiningStep\")] public double BeginSpindleAngle_deg { get; } Property Value double ChipMass_g Gets the chip mass in grams. [JsAce(ClassExt = \"MachiningStep\")] public double? ChipMass_g { get; } Property Value double? ChipMass_mg Gets the chip mass in milligrams. [Present(\"Chip Mass\", null, PhysicsUnit.mg, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipMass_mg { get; } Property Value double? ChipTemperature_C Gets the chip temperature in Celsius [Present(\"Chip Temperature\", \"Chip T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipTemperature_C { get; } Property Value double? ChipThickness_mm Gets the chip thickness in mm. [Present(\"Chip Thickness\", null, PhysicsUnit.mm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipThickness_mm { get; } Property Value double? ChipThickness_um Gets the chip thickness in micrometers public double? ChipThickness_um { get; } Property Value double? ChipVolume_mm3 Gets the chip volume in mm³. [Present(\"Chip Volume\", null, PhysicsUnit.mm3, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipVolume_mm3 { get; } Property Value double? Cl Gets the cutter location. [Present(\"Cutter Location\", \"CL\", PhysicsUnit.mm, \"F5\")] public DVec3d Cl { get; } Property Value DVec3d CutterBodyTemperature_C Gets the cutter body temperature in Celsius [Present(\"Cutter Body Temperature\", \"Ct. Body T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? CutterBodyTemperature_C { get; } Property Value double? CutterDermisTemperature_C Gets the cutter dermis temperature in Celsius [Present(\"Cutter Dermis Temperature\", \"Ct. Dermis T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? CutterDermisTemperature_C { get; } Property Value double? CuttingDepth_mm Gets the cutting depth in mm. [Present(\"Cutting Depth\", \"ap\", PhysicsUnit.mm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double CuttingDepth_mm { get; } Property Value double CuttingSpeed_mmds Gets the cutting speed in mm/s. [Present(\"Cutting Speed\", \"Vc\", PhysicsUnit.mmds, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double? CuttingSpeed_mmds { get; } Property Value double? CuttingWidth_mm Gets the cutting width in mm. [Present(\"Cutting Width\", \"ae\", PhysicsUnit.mm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double CuttingWidth_mm { get; } Property Value double DeltaTipDeflectionOnToolRunningCoordinate_um Gets the delta tip deflection on tool running coordinate in micrometers [Present(\"Delta Tip Deflection On Tool Running Coordinate\", \"Dlt.Df.-Tip-TR\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d DeltaTipDeflectionOnToolRunningCoordinate_um { get; } Property Value Vec3d FeedPerCycle_mm Gets the feed per cycle in mm. [Present(\"Feed per Cycle\", \"frc\", PhysicsUnit.mm, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double FeedPerCycle_mm { get; } Property Value double FeedPerTooth_mm Gets the feed per tooth in mm. [Present(\"Feed per Tooth\", \"frt\", PhysicsUnit.mm, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double FeedPerTooth_mm { get; } Property Value double Feedrate_mmdmin Gets the feedrate in mm/min. [Present(\"Feedrate\", \"F\", PhysicsUnit.mmdmin, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double Feedrate_mmdmin { get; } Property Value double Feedrate in mm/s FileNo Gets the file number. [Present] [JsAce(ClassExt = \"MachiningStep\")] public int? FileNo { get; } Property Value int? FilePath Gets the file path. [Present] [JsAce(ClassExt = \"MachiningStep\")] public string FilePath { get; } Property Value string FlagsText Gets the flags text. [Present] [JsAce(ClassExt = \"MachiningStep\")] public string FlagsText { get; } Property Value string FlexDictionary Gets or sets the flexible dictionary. public Dictionary FlexDictionary { get; set; } Property Value Dictionary FrictionPower_W friction power to workpiece per cycle. the unit is watt. [JsAce(ClassExt = \"MachiningStep\")] public double? FrictionPower_W { get; } Property Value double? Host Gets or sets the host of the milling step. public IMachiningStepHost Host { get; set; } Property Value IMachiningStepHost InfInsistentSpindlePowerRatio Gets the infinite insistent spindle power ratio [Present(\"Continue Spindle Power Ratio\", \"Cont.Spd.Pow.R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? InfInsistentSpindlePowerRatio { get; } Property Value double? InfInsistentSpindleTorqueRatio Gets the infinite insistent spindle torque ratio [Present(\"Continue Spindle Torque Ratio\", \"Cont.Spd.Torque-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? InfInsistentSpindleTorqueRatio { get; } Property Value double? InstantCraterWear_um Gets the instant crater wear in micrometers [Present(\"Instant Crater Wear\", \"I.C.Wear\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? InstantCraterWear_um { get; } Property Value double? IsTouched Gets whether the step is touched. [Present(\"Is Touched\", null, PhysicsUnit.None, \"G\")] [JsAce(ClassExt = \"MachiningStep\")] public bool IsTouched { get; } Property Value bool this[string] Gets or sets a value in the flexible dictionary by key. public object this[string key] { get; set; } Parameters key string The key to look up. Property Value object The value associated with the key, or null if not found. LineNo Gets the line number. [Present] [JsAce(ClassExt = \"MachiningStep\")] public int? LineNo { get; } Property Value int? LineText Gets the line text. [Present] [JsAce(ClassExt = \"MachiningStep\")] public string LineText { get; } Property Value string MachineMotionStep Gets or sets the machining step. public MachineMotionStep MachineMotionStep { get; set; } Property Value MachineMotionStep MachiningTool Gets the machining tool used for this milling step. public IMachiningTool MachiningTool { get; } Property Value IMachiningTool MaxAbsForce_N Max absolute force at the rotation cycle. [Present(\"Max Absolute Force\", \"Max Abs F.\", PhysicsUnit.N, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? MaxAbsForce_N { get; } Property Value double? MaxBottomEdgeDeflectionOnToolRunningCoordinate_mm Gets the maximum bottom edge deflection on tool running coordinate in millimeters [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MaxBottomEdgeDeflectionOnToolRunningCoordinate_mm { get; } Property Value Vec3d MaxForceOnToolRunningCoordinate_N Gets the maximum force on tool running coordinate in N. public Vec3d MaxForceOnToolRunningCoordinate_N { get; } Property Value Vec3d MaxMomentAboutSensor_Nm Gets the maximum moment about sensor in Newton-meters [Present(\"Max Moment To Tool About Sensor\", \"MaxM-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double MaxMomentAboutSensor_Nm { get; } Property Value double MaxMomentAboutToolTip_Nm Gets the maximum moment about tool tip in Newton-meters [Present(\"Max Moment To Tool About ToolTip\", \"MaxM-ToTool-Tip-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double MaxMomentAboutToolTip_Nm { get; } Property Value double MaxSpindlePowerRatio Gets the maximum spindle power ratio [Present(\"Max Spindle Power Ratio\", \"Max.Spd.Pow.R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? MaxSpindlePowerRatio { get; } Property Value double? MaxSpindleTorqueRatio Gets the maximum spindle torque ratio [Present(\"Max Spindle Torque Ratio\", \"Max.Spd.Torque-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? MaxSpindleTorqueRatio { get; } Property Value double? MaxTipDeflectionOnToolRunningCoordinate_mm Gets the maximum tip deflection on tool running coordinate in millimeters [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MaxTipDeflectionOnToolRunningCoordinate_mm { get; } Property Value Vec3d MaxTipDeflectionOnToolRunningCoordinate_um Gets the maximum tip deflection on tool running coordinate in micrometers [Present(\"Max Tip Deflection On Tool Running Coordinate\", \"Max.Df.-Tip-TR\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MaxTipDeflectionOnToolRunningCoordinate_um { get; } Property Value Vec3d MillingPhysicsStep Gets or sets the milling physics step. public MillingPhysicsStep MillingPhysicsStep { get; set; } Property Value MillingPhysicsStep MillingStepLuggage Get luggage by sequencing loading performance optimization. public MillingStepLuggage MillingStepLuggage { get; } Property Value MillingStepLuggage MoveOnProgramCoordinate Gets the move on program coordinate. [Present(\"Move On Workpiece Program Coordinate\", \"Move-W\", PhysicsUnit.mm, \"F4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MoveOnProgramCoordinate { get; } Property Value Vec3d MovingLength_mm Gets the moving length in mm. [Present(\"Move Length\", \"Move Len.\", PhysicsUnit.mm, \"F4\")] [JsAce(ClassExt = \"MachiningStep\")] public double MovingLength_mm { get; } Property Value double Mrr_mm3ds Gets the material removal rate in mm³/s. [Present(\"MRR\", null, PhysicsUnit.mm3ds, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double Mrr_mm3ds { get; } Property Value double ProgramSideCusp_um Gets the program side cusp in micrometers. Side cusp without deformation. The value is count by feed per tooth and the tool radius. [Present(\"Program Side Cusp\", null, PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double ProgramSideCusp_um { get; } Property Value double ReCutDepth_um Gets or sets the recut depth in micrometers. [Present(\"Re-Cut Depth on Bottom Edge on Tool Running Coordinate\", \"Re-Cut Depth\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double ReCutDepth_um { get; } Property Value double SideCuspList_um Gets the list of side cusps in micrometers. [JsAce(ClassExt = \"MachiningStep\")] public List SideCuspList_um { get; } Property Value List SourceCommand Gets or sets the source command. public ISourceCommand SourceCommand { get; set; } Property Value ISourceCommand SpindleCyclePeriod_s Gets the spindle cycle period in seconds. [Present(\"Spindle Cycle Period\", null, PhysicsUnit.sec, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleCyclePeriod_s { get; } Property Value double SpindleInputPower_W Gets the input spindle power in Watts. [Present(\"Spindle Input Power\", null, PhysicsUnit.watt, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleInputPower_W { get; } Property Value double Input spindle power in Watts. SpindleOutputPower_W Spindle power. Watt. Axial Power Taken By Workpiece. [Present(\"Spindle Output Power\", null, PhysicsUnit.watt, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleOutputPower_W { get; } Property Value double SpindleSpeed_rpm Gets the spindle speed in RPM. [Present(\"Spindle Speed\", \"S\", PhysicsUnit.rpm, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleSpeed_rpm { get; } Property Value double Spindle speed in rad/s SpindleTemperature_C Gets the spindle temperature in Celsius [Present(\"Spindle Temperature\", \"Spd.Temp.\", PhysicsUnit.C, \"G2\")] [JsAce(ClassExt = \"MachiningStep\")] public double? SpindleTemperature_C { get; } Property Value double? SpindleWorkingTemperatureRatio Gets the spindle working temperature ratio [Present(\"Spindle Working Temperature Ratio\", \"Spd.Temp.R.\", PhysicsUnit.None, \"G2\")] [JsAce(ClassExt = \"MachiningStep\")] public double? SpindleWorkingTemperatureRatio { get; } Property Value double? StepDuration Gets the step duration. [Present(\"Step Duration\", null, PhysicsUnit.sec, \"ss\\\\.ffffff\")] [JsAce(ClassExt = \"MachiningStep\")] public TimeSpan StepDuration { get; } Property Value TimeSpan StepIndex Gets the index of the step. [Key] [DatabaseGenerated(DatabaseGeneratedOption.None)] [Present(\"Step Index\", \"S.I.\", PhysicsUnit.None, \"G\")] public int StepIndex { get; } Property Value int ThermalStress_MPa Gets the thermal stress in MPa [Present(\"Thermal Stress\", \"Th. S.\", PhysicsUnit.MPa, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ThermalStress_MPa { get; } Property Value double? ThermalYieldRatio Gets the thermal yield ratio [Present(\"Thermal Yield Ratio\", \"Th. Yield R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ThermalYieldRatio { get; } Property Value double? TipDeflectionsOnToolRunningCoordinate_um Gets the tip deflections on tool running coordinate in micrometers [JsAce(ClassExt = \"MachiningStep\")] public List TipDeflectionsOnToolRunningCoordinate_um { get; } Property Value List ToolId Gets the tool ID. [Present(\"Tool ID\", \"T\", PhysicsUnit.None, \"G\")] [JsAce(ClassExt = \"MachiningStep\")] public int ToolId { get; } Property Value int ToothArcDuration_s Gets the tooth arc duration in seconds. [Present(\"Tooth Arc Duration\", null, PhysicsUnit.sec, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double ToothArcDuration_s { get; } Property Value double ToothSeqOnToolRunningCoordinate Gets the sequence pair of transformation matrices representing tooth positions on the tool running coordinate system. public SeqPair ToothSeqOnToolRunningCoordinate { get; } Property Value SeqPair WorkpieceDermisTemperature_C Gets the workpiece dermis temperature in Celsius [Present(\"Workpiece Dermis Temperature\", \"W. Dermis T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? WorkpieceDermisTemperature_C { get; } Property Value double? WorkpiecePlasticDepth_um Gets the workpiece plastic depth in micrometers [Present(\"Workpiece Plastic Deformation Depth\", \"W.P.Depth\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double WorkpiecePlasticDepth_um { get; } Property Value double YieldingStressRatio Gets the yielding stress ratio [Present(\"Yielding Stress Ratio\", \"Y-Stress-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? YieldingStressRatio { get; } Property Value double? Methods GetCutterDermisAvgTemperature_C(double) Gets the average cutter dermis temperature in Celsius at the specified depth. [JsAce(ClassExt = \"MachiningStep\")] public double GetCutterDermisAvgTemperature_C(double depth_mm) Parameters depth_mm double The depth in millimeters Returns double Average temperature in Celsius GetCutterDermisTemperature_C(double) Gets the cutter dermis temperature in Celsius at the specified depth. [JsAce(ClassExt = \"MachiningStep\")] public double GetCutterDermisTemperature_C(double depth_mm) Parameters depth_mm double The depth in millimeters Returns double Temperature in Celsius GetFeedrate_mmds() Gets the program feedrate in millimeters per second. public double GetFeedrate_mmds() Returns double Feedrate in mm/s GetKeyToQuantityNativeDictionary(IMachiningChain) Internal use. public static ConcurrentDictionary> GetKeyToQuantityNativeDictionary(IMachiningChain machiningChain) Parameters machiningChain IMachiningChain Returns ConcurrentDictionary> GetMcValue(IMachiningChain, string) Gets the MC value for the specified tag in the machining chain. public double? GetMcValue(IMachiningChain chain, string tag) Parameters chain IMachiningChain The machining chain. tag string The tag to look up. Returns double? The MC value for the specified tag. GetMcValue(int) Gets the MC value at the specified index. [JsAce(ClassExt = \"MachiningStep\")] public double? GetMcValue(int index) Parameters index int The index to look up. Returns double? The MC value at the specified index. GetRgbWithPriority(out Vec3d, out double) Gets the RGB color and priority for the milling step. public void GetRgbWithPriority(out Vec3d rgb, out double priority) Parameters rgb Vec3d The RGB color vector. priority double The priority value. GetSourceCommand() Gets the source command associated with this instance. public ISourceCommand GetSourceCommand() Returns ISourceCommand The source command object. GetSpindleDirection() Gets the spindle direction for this milling step. public SpindleDirection GetSpindleDirection() Returns SpindleDirection GetSpindleSpeed_radds() Gets the spindle speed in radians per second. public double GetSpindleSpeed_radds() Returns double Spindle speed in rad/s" + }, + "api/Hi.MachiningSteps.MachiningStepUtil.html": { + "href": "api/Hi.MachiningSteps.MachiningStepUtil.html", + "title": "Class MachiningStepUtil | HiAPI-C# 2025", + "summary": "Class MachiningStepUtil Namespace Hi.MachiningSteps Assembly HiMech.dll Utility class for milling step related constants and helper methods. public static class MachiningStepUtil Inheritance object MachiningStepUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties MachiningStepDbName Gets the database name for milling steps. public static string MachiningStepDbName { get; } Property Value string MillingStepLuggageCollectionName Gets the collection name for milling step luggage. public static string MillingStepLuggageCollectionName { get; } Property Value string" + }, + "api/Hi.MachiningSteps.PresentAccess.html": { + "href": "api/Hi.MachiningSteps.PresentAccess.html", + "title": "Class PresentAccess | HiAPI-C# 2025", + "summary": "Class PresentAccess Namespace Hi.MachiningSteps Assembly HiMech.dll public class PresentAccess Inheritance object PresentAccess 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) Constructors PresentAccess(PresentAttribute, Func) public PresentAccess(PresentAttribute present, Func getFunc) Parameters present PresentAttribute getFunc Func Properties GetValueFunc public Func GetValueFunc { get; set; } Property Value Func Present public PresentAttribute Present { get; set; } Property Value PresentAttribute" + }, + "api/Hi.MachiningSteps.PresentAttribute.html": { + "href": "api/Hi.MachiningSteps.PresentAttribute.html", + "title": "Class PresentAttribute | HiAPI-C# 2025", + "summary": "Class PresentAttribute Namespace Hi.MachiningSteps Assembly HiMech.dll Attribute for presenting property information with localization support. public class PresentAttribute : Attribute Inheritance object Attribute PresentAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) 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) Constructors PresentAttribute() Initializes a new instance of the PresentAttribute class. public PresentAttribute() PresentAttribute(PresentAttribute) Initializes a new instance of the PresentAttribute class by copying from another instance. public PresentAttribute(PresentAttribute src) Parameters src PresentAttribute The source attribute to copy from. PresentAttribute(string, string, PhysicsUnit, string) Initializes a new instance of the PresentAttribute class with specified parameters. public PresentAttribute(string name, string shortName, PhysicsUnit unit, string dataFormatString) Parameters name string The display name of the property. shortName string The short name of the property. unit PhysicsUnit The physics unit of the property. dataFormatString string The format string for displaying the property value. Properties DataFormatString Gets or sets the format string for displaying the property value. public string DataFormatString { get; set; } Property Value string Name Gets or sets the display name of the property. public string Name { get; set; } Property Value string ShortName Gets or sets the short name of the property. public string ShortName { get; set; } Property Value string TailUnitString Gets the unit string with parentheses for display purposes. public string TailUnitString { get; } Property Value string Unit Gets or sets the physics unit of the property. public PhysicsUnit Unit { get; set; } Property Value PhysicsUnit Methods GetPresentName(StringLocalizer) Gets the localized presentation name with unit string. public string GetPresentName(StringLocalizer loc) Parameters loc StringLocalizer The string localizer. Returns string The localized name with unit string. GetPresentName(IStringLocalizer) Gets the localized presentation name with unit string. public string GetPresentName(IStringLocalizer loc) Parameters loc IStringLocalizer The string localizer. Returns string The localized name with unit string." + }, + "api/Hi.MachiningSteps.PropertyAccess-1.html": { + "href": "api/Hi.MachiningSteps.PropertyAccess-1.html", + "title": "Class PropertyAccess | HiAPI-C# 2025", + "summary": "Class PropertyAccess Namespace Hi.MachiningSteps Assembly HiMech.dll Provides access to properties of a milling step with presentation information. public class PropertyAccess where TData : class Type Parameters TData Inheritance object PropertyAccess 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) Constructors PropertyAccess(PresentAttribute, Func) Initializes a new instance for numeric properties. public PropertyAccess(PresentAttribute presentAttribute, Func getQuantityFunc) Parameters presentAttribute PresentAttribute The presentation attribute for the property. getQuantityFunc Func The function to retrieve the numeric value. PropertyAccess(PresentAttribute, Func) Initializes a new instance for non-numeric properties. public PropertyAccess(PresentAttribute presentAttribute, Func getNonQuantityFunc) Parameters presentAttribute PresentAttribute The presentation attribute for the property. getNonQuantityFunc Func The function to retrieve the non-numeric value. Properties GetNonQuantityFunc Gets or sets the function to retrieve a non-numeric value from a milling step. public Func GetNonQuantityFunc { get; set; } Property Value Func GetQuantityFunc Gets or sets the function to retrieve a numeric value from a milling step. public Func GetQuantityFunc { get; set; } Property Value Func PresentAttribute Gets or sets the presentation attribute for the property. public PresentAttribute PresentAttribute { get; set; } Property Value PresentAttribute Methods GetValue(TData) Gets the value of the property for the specified milling step. public object GetValue(TData step) Parameters step TData The milling step to get the property value from. Returns object The property value, or null if neither function is set. GetValueText(object) Gets the formatted text representation of the specified value. public string GetValueText(object v) Parameters v object The value to format. Returns string The formatted text representation of the value. GetValueText(TData) Gets the formatted text representation of the property value for the specified milling step. public string GetValueText(TData step) Parameters step TData The milling step to get the property value from. Returns string The formatted text representation of the property value." + }, + "api/Hi.MachiningSteps.html": { + "href": "api/Hi.MachiningSteps.html", + "title": "Namespace Hi.MachiningSteps | HiAPI-C# 2025", + "summary": "Namespace Hi.MachiningSteps Classes MachineMotionStep MachiningStep has spindle information. Note that the spindle information is only for milling behavior. MachiningStep MachiningStepUtil Utility class for milling step related constants and helper methods. PresentAccess PresentAttribute Attribute for presenting property information with localization support. PropertyAccess Provides access to properties of a milling step with presentation information. Interfaces IGetSourceCommand Defines an interface for retrieving source command information. IMachiningStepHost Represents a host interface for milling steps that provides access to milling equipment and related resources. ISourceCommand Represents a source command interface that provides access to file line information and command flags." }, "api/Hi.Mapping.CsvNcStep.StepInterpoationMode.html": { "href": "api/Hi.Mapping.CsvNcStep.StepInterpoationMode.html", @@ -1907,7 +2022,7 @@ "api/Hi.Mapping.CsvNcStep.html": { "href": "api/Hi.Mapping.CsvNcStep.html", "title": "Class CsvNcStep | HiAPI-C# 2025", - "summary": "Class CsvNcStep Namespace Hi.Mapping Assembly HiMech.dll Represents a numerical control step loaded from a CSV file, with support for interpolation and arithmetic operations. public class CsvNcStep : IGetFileLineIndex, IAdditionOperators, IMultiplyOperators Inheritance object CsvNcStep Implements IGetFileLineIndex IAdditionOperators IMultiplyOperators 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) Constructors CsvNcStep(FileLineIndex, TimeSpan, DVec3d, List) Initializes a new instance of the CsvNcStep class with the specified parameters. public CsvNcStep(FileLineIndex fileLineIndex, TimeSpan time, DVec3d mcXyzabc, List doubleFlexList) Parameters fileLineIndex FileLineIndex The file and line index information. time TimeSpan The time value for this step. mcXyzabc DVec3d The machine coordinates for this step. doubleFlexList List The list of additional double values. Properties DoubleFlexList Gets or sets the list of additional double values associated with this step. public List DoubleFlexList { get; set; } Property Value List FileLineIndex Gets or sets the file and line index information. public FileLineIndex FileLineIndex { get; set; } Property Value FileLineIndex FileNoTitle Gets or sets the column title for file number in the CSV. public static string FileNoTitle { get; set; } Property Value string LineNoTitle Gets or sets the column title for line number in the CSV. public static string LineNoTitle { get; set; } Property Value string McTitle Gets or sets the column title for machine coordinates in the CSV. public static string McTitle { get; set; } Property Value string McXyzabc Gets the machine coordinates (XYZ and ABC) for this step. public DVec3d McXyzabc { get; } Property Value DVec3d Time Gets or sets the time value for this step. public TimeSpan Time { get; set; } Property Value TimeSpan TimeTagTitle Gets or sets the column title for time in the CSV. public static string TimeTagTitle { get; set; } Property Value string Methods BuildByFile(ClStrip, string, string, IMessageHost, StepInterpoationMode) Builds a collection of CsvNcStep instances from a CSV file. public static void BuildByFile(ClStrip clStrip, string baseDirectory, string relPath, IMessageHost messageHost, CsvNcStep.StepInterpoationMode stepInterpoationMode) Parameters clStrip ClStrip The cutter location strip to populate. baseDirectory string The base directory for the file path. relPath string The relative path to the CSV file. messageHost IMessageHost The message host for logging. stepInterpoationMode CsvNcStep.StepInterpoationMode The interpolation mode to use. GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex Operators operator +(CsvNcStep, CsvNcStep) Adds two CsvNcStep instances together. public static CsvNcStep operator +(CsvNcStep left, CsvNcStep right) Parameters left CsvNcStep The first CsvNcStep instance. right CsvNcStep The second CsvNcStep instance. Returns CsvNcStep A new CsvNcStep instance with values that are the sum of the two input instances. operator *(CsvNcStep, double) Multiplies a CsvNcStep instance by a scalar value. public static CsvNcStep operator *(CsvNcStep src, double scale) Parameters src CsvNcStep The CsvNcStep instance to multiply. scale double The scalar value to multiply by. Returns CsvNcStep A new CsvNcStep instance with values scaled by the specified factor." + "summary": "Class CsvNcStep Namespace Hi.Mapping Assembly HiMech.dll Represents a numerical control step loaded from a CSV file, with support for interpolation and arithmetic operations. public class CsvNcStep : IGetFileLineIndex, IAdditionOperators, IMultiplyOperators Inheritance object CsvNcStep Implements IGetFileLineIndex IAdditionOperators IMultiplyOperators 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) Constructors CsvNcStep(FileLineIndex, TimeSpan, DVec3d, List) Initializes a new instance of the CsvNcStep class with the specified parameters. public CsvNcStep(FileLineIndex fileLineIndex, TimeSpan time, DVec3d mcXyzabc, List doubleFlexList) Parameters fileLineIndex FileLineIndex The file and line index information. time TimeSpan The time value for this step. mcXyzabc DVec3d The machine coordinates for this step. doubleFlexList List The list of additional double values. Properties DoubleFlexList Gets or sets the list of additional double values associated with this step. public List DoubleFlexList { get; set; } Property Value List FileLineIndex Gets or sets the file and line index information. public FileLineIndex FileLineIndex { get; set; } Property Value FileLineIndex FileNoTitle Gets or sets the column title for file number in the CSV. public static string FileNoTitle { get; set; } Property Value string LineNoTitle Gets or sets the column title for line number in the CSV. public static string LineNoTitle { get; set; } Property Value string McTitle Gets or sets the column title for machine coordinates in the CSV. public static string McTitle { get; set; } Property Value string McXyzabc Gets the machine coordinates (XYZ and ABC) for this step. public DVec3d McXyzabc { get; } Property Value DVec3d Time Gets or sets the time value for this step. public TimeSpan Time { get; set; } Property Value TimeSpan TimeTagTitle Gets or sets the column title for time in the CSV. public static string TimeTagTitle { get; set; } Property Value string Methods BuildByFile(ClStrip, string, string, IMessageKit, StepInterpoationMode) Builds a collection of CsvNcStep instances from a CSV file. public static void BuildByFile(ClStrip clStrip, string baseDirectory, string relPath, IMessageKit messageHost, CsvNcStep.StepInterpoationMode stepInterpoationMode) Parameters clStrip ClStrip The cutter location strip to populate. baseDirectory string The base directory for the file path. relPath string The relative path to the CSV file. messageHost IMessageKit The message host for logging. stepInterpoationMode CsvNcStep.StepInterpoationMode The interpolation mode to use. GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex Operators operator +(CsvNcStep, CsvNcStep) Adds two CsvNcStep instances together. public static CsvNcStep operator +(CsvNcStep left, CsvNcStep right) Parameters left CsvNcStep The first CsvNcStep instance. right CsvNcStep The second CsvNcStep instance. Returns CsvNcStep A new CsvNcStep instance with values that are the sum of the two input instances. operator *(CsvNcStep, double) Multiplies a CsvNcStep instance by a scalar value. public static CsvNcStep operator *(CsvNcStep src, double scale) Parameters src CsvNcStep The CsvNcStep instance to multiply. scale double The scalar value to multiply by. Returns CsvNcStep A new CsvNcStep instance with values scaled by the specified factor." }, "api/Hi.Mapping.FileToTimeShotMapping.html": { "href": "api/Hi.Mapping.FileToTimeShotMapping.html", @@ -1952,7 +2067,7 @@ "api/Hi.Mapping.TimeMapping.html": { "href": "api/Hi.Mapping.TimeMapping.html", "title": "Class TimeMapping | HiAPI-C# 2025", - "summary": "Class TimeMapping Namespace Hi.Mapping Assembly HiMech.dll Provides mapping between machining steps and time-based measurements (shots), with support for XML serialization and asynchronous loading of measurement data. public class TimeMapping : IMakeXmlSource, IDisposable Inheritance object TimeMapping Implements IMakeXmlSource 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) Constructors TimeMapping(ClStrip, MachiningToolHouse, string) Initializes a new instance of the TimeMapping class with the specified CL strip and tool house. public TimeMapping(ClStrip clStrip, MachiningToolHouse millingToolHouse, string baseDirectory) Parameters clStrip ClStrip The cutter location strip containing the machining steps. millingToolHouse MachiningToolHouse The machining tool house containing available tools. baseDirectory string The base directory for file paths. TimeMapping(XElement, string) Initializes a new instance of the TimeMapping class from XML data. public TimeMapping(XElement src, string baseDirectory) Parameters src XElement The XML element containing the mapping data. baseDirectory string The base directory for resolving relative file paths. Remarks This constructor supports legacy XML formats and automatically converts them to the current format. Legacy formats include: NcMapping with MarkIdToFileTimeSection element Entries with MarkID attributes Properties BaseDirectory Gets or sets the base directory for resolving file paths. All relative file paths in the mapping are resolved against this directory. public string BaseDirectory { get; set; } Property Value string ClStrip Gets or sets the cutter location strip containing the machining steps. This is used as a reference for mapping time shots to machining steps. public ClStrip ClStrip { get; set; } Property Value ClStrip KeyToRelFileTimeSectionDictionary Gets or sets the dictionary mapping keys to file time sections. Each entry maps a unique identifier to a file time section that specifies which portion of a measurement file corresponds to a particular machining operation. public Dictionary KeyToRelFileTimeSectionDictionary { get; set; } Property Value Dictionary LineReaded Gets or sets the callback action that is invoked when a line is read from a measurement file. This can be used to track progress during file loading operations. public Action LineReaded { get; set; } Property Value Action Remarks The parameter passed to the action is the current line number being read. MillingToolHouse Gets or sets the machining tool house containing available tools. This is used to determine tool-specific parameters during mapping. public MachiningToolHouse MillingToolHouse { get; set; } Property Value MachiningToolHouse RelFileToTimeShotListDictionary Gets or sets the cache of time shot lists loaded from files. This is a thread-safe dictionary that maps file paths to tasks that load and parse the files. The cache prevents multiple reads of the same file and enables concurrent access. public ConcurrentDictionary>> RelFileToTimeShotListDictionary { get; set; } Property Value ConcurrentDictionary>> StepToTimeShotListDictionary Gets a concurrent dictionary mapping step indices to their corresponding time shot lists. This dictionary is populated during the mapping process. public ConcurrentDictionary> StepToTimeShotListDictionary { get; } Property Value ConcurrentDictionary> XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string Remarks This name is used as the root element when serializing TimeMapping instances to XML. It matches the class name to maintain consistency between code and XML representation. Methods CallTimeShotByRelFile(string, CancellationToken?) Retrieves time shots from a file, using cached results if available. public List CallTimeShotByRelFile(string relFile, CancellationToken? cancellationToken = null) Parameters relFile string The relative path to the file containing time shots. cancellationToken CancellationToken? Optional token to cancel the loading operation. Returns List A list of time shots from the file. The results are cached for subsequent calls. If the file is already being loaded by another thread, waits for that operation to complete. Remarks This method is thread-safe and ensures each file is only read once, even with concurrent access. Any exceptions during file reading are captured and can be inspected through the task's exception property. Clear() Clears all mappings and data, including the key-to-file time section dictionary. public void Clear() ClearCache() Clears the cache of loaded time shot data, including file-to-time shot list and step-to-time shot list dictionaries. public void ClearCache() 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 GetShots(int) Gets the time shots associated with a specific step index. public List GetShots(int stepIndex) Parameters stepIndex int The index of the step to get shots for. Returns List A list of time shots associated with the specified step, or null if no shots are found. LoadTimeShotFiles(CancellationToken?) Loads all time shot files referenced in the KeyToFileTimeSectionMapping. public void LoadTimeShotFiles(CancellationToken? cancellationToken = null) Parameters cancellationToken CancellationToken? Optional cancellation token to cancel the operation. MakeXmlSource(string, string) Creates an XML representation of the time mapping data. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for creating relative file paths. relFile string The relative file path (not used in current implementation). Returns XElement An XML element containing the complete time mapping data. Remarks The XML structure includes: A root TimeMapping element An Entrys element containing Entry elements Each Entry has a Key attribute and FileTimeSection child element Map(Range, FileTimeSection, CycleSamplingMode, CancellationToken?) Maps the specified step section to time shots using the provided file time section and cycle sampling mode. This method is thread-safe and can be called concurrently. public void Map(Range stepSection, FileTimeSection relFileTimeSection, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, CancellationToken? cancellationToken = null) Parameters stepSection Range The range of step indices to process. relFileTimeSection FileTimeSection The file time section containing file path and time range. cycleSamplingMode StepTimeShotUtil.CycleSamplingMode The cycle sampling mode to use. cancellationToken CancellationToken? Optional cancellation token to cancel the operation. WaitMapping() Waits for all mapping operations to complete. This method blocks until all concurrent mapping tasks have finished. public void WaitMapping()" + "summary": "Class TimeMapping Namespace Hi.Mapping Assembly HiMech.dll Provides mapping between machining steps and time-based measurements (shots), with support for XML serialization and asynchronous loading of measurement data. public class TimeMapping : IMakeXmlSource, IDisposable Inheritance object TimeMapping Implements IMakeXmlSource 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) Constructors TimeMapping(ClStrip, MachiningToolHouse, string) Initializes a new instance of the TimeMapping class with the specified CL strip and tool house. public TimeMapping(ClStrip clStrip, MachiningToolHouse millingToolHouse, string baseDirectory) Parameters clStrip ClStrip The cutter location strip containing the machining steps. millingToolHouse MachiningToolHouse The machining tool house containing available tools. baseDirectory string The base directory for file paths. TimeMapping(XElement, string) Initializes a new instance of the TimeMapping class from XML data. public TimeMapping(XElement src, string baseDirectory) Parameters src XElement The XML element containing the mapping data. baseDirectory string The base directory for resolving relative file paths. Remarks This constructor supports legacy XML formats and automatically converts them to the current format. Legacy formats include: NcMapping with MarkIdToFileTimeSection element Entries with MarkID attributes Properties BaseDirectory Gets or sets the base directory for resolving file paths. All relative file paths in the mapping are resolved against this directory. public string BaseDirectory { get; set; } Property Value string ClStrip Gets or sets the cutter location strip containing the machining steps. This is used as a reference for mapping time shots to machining steps. public ClStrip ClStrip { get; set; } Property Value ClStrip KeyToRelFileTimeSectionDictionary Gets or sets the dictionary mapping keys to file time sections. Each entry maps a unique identifier to a file time section that specifies which portion of a measurement file corresponds to a particular machining operation. public Dictionary KeyToRelFileTimeSectionDictionary { get; set; } Property Value Dictionary LineReaded Gets or sets the callback action that is invoked when a line is read from a measurement file. This can be used to track progress during file loading operations. public Action LineReaded { get; set; } Property Value Action Remarks The parameter passed to the action is the current line number being read. MillingToolHouse Gets or sets the machining tool house containing available tools. This is used to determine tool-specific parameters during mapping. public MachiningToolHouse MillingToolHouse { get; set; } Property Value MachiningToolHouse RelFileToTimeShotListDictionary Gets or sets the cache of time shot lists loaded from files. This is a thread-safe dictionary that maps file paths to tasks that load and parse the files. The cache prevents multiple reads of the same file and enables concurrent access. public ConcurrentDictionary>> RelFileToTimeShotListDictionary { get; set; } Property Value ConcurrentDictionary>> StepToTimeShotListDictionary Gets a concurrent dictionary mapping step indices to their corresponding time shot lists. This dictionary is populated during the mapping process. public ConcurrentDictionary> StepToTimeShotListDictionary { get; } Property Value ConcurrentDictionary> XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string Remarks This name is used as the root element when serializing TimeMapping instances to XML. It matches the class name to maintain consistency between code and XML representation. Methods CallTimeShotByRelFile(string, CancellationToken?) Retrieves time shots from a file, using cached results if available. public List CallTimeShotByRelFile(string relFile, CancellationToken? cancellationToken = null) Parameters relFile string The relative path to the file containing time shots. cancellationToken CancellationToken? Optional token to cancel the loading operation. Returns List A list of time shots from the file. The results are cached for subsequent calls. If the file is already being loaded by another thread, waits for that operation to complete. Remarks This method is thread-safe and ensures each file is only read once, even with concurrent access. Any exceptions during file reading are captured and can be inspected through the task's exception property. Clear() Clears all mappings and data, including the key-to-file time section dictionary. public void Clear() ClearCache() Clears the cache of loaded time shot data, including file-to-time shot list and step-to-time shot list dictionaries. public void ClearCache() 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 GetShots(int) Gets the time shots associated with a specific step index. public List GetShots(int stepIndex) Parameters stepIndex int The index of the step to get shots for. Returns List A list of time shots associated with the specified step, or null if no shots are found. LoadTimeShotFiles(CancellationToken?) Loads all time shot files referenced in the KeyToFileTimeSectionMapping. public void LoadTimeShotFiles(CancellationToken? cancellationToken = null) Parameters cancellationToken CancellationToken? Optional cancellation token to cancel the operation. MakeXmlSource(string, string, bool) Creates an XML representation of the time mapping data. relFile is not used in current implementation. 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 containing the complete time mapping data. Remarks The XML structure includes: A root TimeMapping element An Entrys element containing Entry elements Each Entry has a Key attribute and FileTimeSection child element Map(Range, FileTimeSection, CycleSamplingMode, CancellationToken?) Maps the specified step section to time shots using the provided file time section and cycle sampling mode. This method is thread-safe and can be called concurrently. public void Map(Range stepSection, FileTimeSection relFileTimeSection, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, CancellationToken? cancellationToken = null) Parameters stepSection Range The range of step indices to process. relFileTimeSection FileTimeSection The file time section containing file path and time range. cycleSamplingMode StepTimeShotUtil.CycleSamplingMode The cycle sampling mode to use. cancellationToken CancellationToken? Optional cancellation token to cancel the operation. WaitMapping() Waits for all mapping operations to complete. This method blocks until all concurrent mapping tasks have finished. public void WaitMapping()" }, "api/Hi.Mapping.html": { "href": "api/Hi.Mapping.html", @@ -1967,7 +2082,7 @@ "api/Hi.Mappings.FileTimeSection.html": { "href": "api/Hi.Mappings.FileTimeSection.html", "title": "Class FileTimeSection | HiAPI-C# 2025", - "summary": "Class FileTimeSection Namespace Hi.Mappings Assembly HiGeom.dll Represents a section of a file defined by a time range. public class FileTimeSection : IMakeXmlSource Inheritance object FileTimeSection Implements IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) 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) Constructors FileTimeSection() Initializes a new instance of the FileTimeSection class. public FileTimeSection() FileTimeSection(string, Range) Initializes a new instance of the FileTimeSection class with a file and time range. public FileTimeSection(string file, Range range) Parameters file string The file path. range Range The time range. FileTimeSection(string, TimeSpan, TimeSpan) Initializes a new instance of the FileTimeSection class with a file and begin/end times. public FileTimeSection(string file, TimeSpan beginTime, TimeSpan endTime) Parameters file string The file path. beginTime TimeSpan The begin time. endTime TimeSpan The end time. FileTimeSection(XElement) Initializes a new instance of the FileTimeSection class from XML. public FileTimeSection(XElement src) Parameters src XElement The XML element containing the file time section data. Properties BeginTime Gets or sets the begin time as a TimeSpan. public TimeSpan BeginTime { get; set; } Property Value TimeSpan BeginTime_s Gets or sets the begin time in seconds. public double BeginTime_s { get; set; } Property Value double Duration_s Gets the duration in seconds. public double Duration_s { get; } Property Value double EndTime Gets or sets the end time as a TimeSpan. public TimeSpan EndTime { get; set; } Property Value TimeSpan EndTime_s Gets or sets the end time in seconds. public double EndTime_s { get; set; } Property Value double File Gets or sets the file path. public string File { get; set; } Property Value string PrimaryTimeOption Gets or sets the primary time option for XML serialization. public FileTimeSection.TimeOption PrimaryTimeOption { get; set; } Property Value FileTimeSection.TimeOption TimeRange Gets or sets the time range. public Range TimeRange { get; set; } Property Value Range XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class FileTimeSection Namespace Hi.Mappings Assembly HiGeom.dll Represents a section of a file defined by a time range. public class FileTimeSection : IMakeXmlSource Inheritance object FileTimeSection Implements IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods XmlUtil.MakeXmlSourceFile(IMakeXmlSource, string, bool) XmlUtil.MakeXmlSourceWithRebaseFile(IMakeXmlSource, string, string, bool) XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string) 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) Constructors FileTimeSection() Initializes a new instance of the FileTimeSection class. public FileTimeSection() FileTimeSection(string, Range) Initializes a new instance of the FileTimeSection class with a file and time range. public FileTimeSection(string file, Range range) Parameters file string The file path. range Range The time range. FileTimeSection(string, TimeSpan, TimeSpan) Initializes a new instance of the FileTimeSection class with a file and begin/end times. public FileTimeSection(string file, TimeSpan beginTime, TimeSpan endTime) Parameters file string The file path. beginTime TimeSpan The begin time. endTime TimeSpan The end time. FileTimeSection(XElement) Initializes a new instance of the FileTimeSection class from XML. public FileTimeSection(XElement src) Parameters src XElement The XML element containing the file time section data. Properties BeginTime Gets or sets the begin time as a TimeSpan. public TimeSpan BeginTime { get; set; } Property Value TimeSpan BeginTime_s Gets or sets the begin time in seconds. public double BeginTime_s { get; set; } Property Value double Duration_s Gets the duration in seconds. public double Duration_s { get; } Property Value double EndTime Gets or sets the end time as a TimeSpan. public TimeSpan EndTime { get; set; } Property Value TimeSpan EndTime_s Gets or sets the end time in seconds. public double EndTime_s { get; set; } Property Value double File Gets or sets the file path. public string File { get; set; } Property Value string PrimaryTimeOption Gets or sets the primary time option for XML serialization. public FileTimeSection.TimeOption PrimaryTimeOption { get; set; } Property Value FileTimeSection.TimeOption TimeRange Gets or sets the time range. public Range TimeRange { get; set; } Property Value Range XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.Mappings.html": { "href": "api/Hi.Mappings.html", @@ -1977,7 +2092,7 @@ "api/Hi.Mech.GeneralMechanism.html": { "href": "api/Hi.Mech.GeneralMechanism.html", "title": "Class GeneralMechanism | HiAPI-C# 2025", - "summary": "Class GeneralMechanism Namespace Hi.Mech Assembly HiMech.dll General Mechanism. public class GeneralMechanism : IMakeXmlSource, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetAnchorToSolidDictionary Inheritance object GeneralMechanism Implements IMakeXmlSource ITopoDisplayee IGetAsmb IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IGetAnchoredDisplayeeList IGetAnchorToSolidDictionary Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) 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 The XML IO is according to self-contained principle. Constructors GeneralMechanism() Initializes a new instance of the GeneralMechanism class. public GeneralMechanism() GeneralMechanism(XElement, string) Initializes a new instance of the GeneralMechanism class from XML. public GeneralMechanism(XElement src, string baseDirectory) Parameters src XElement The XML element containing the mechanism data. baseDirectory string The base directory for resolving relative file paths. Properties AnchorToSolid Gets the dictionary mapping anchors to their corresponding solids. public Dictionary AnchorToSolid { get; } Property Value Dictionary Asmb Gets the assembly containing the mechanism components. public Asmb Asmb { get; } Property Value Asmb Root Gets the root anchor of the mechanism. public Anchor Root { get; } Property Value Anchor XName Name for XML IO. public static string XName { get; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class GeneralMechanism Namespace Hi.Mech Assembly HiMech.dll General Mechanism. public class GeneralMechanism : IMakeXmlSource, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IGetAnchorToSolidDictionary, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d Inheritance object GeneralMechanism Implements IMakeXmlSource ITopo IGetAsmb IGetAnchoredDisplayeeList IGetAnchorToSolidDictionary IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks The XML IO is according to self-contained principle. Constructors GeneralMechanism() Initializes a new instance of the GeneralMechanism class. public GeneralMechanism() GeneralMechanism(XElement, string) Initializes a new instance of the GeneralMechanism class from XML. public GeneralMechanism(XElement src, string baseDirectory) Parameters src XElement The XML element containing the mechanism data. baseDirectory string The base directory for resolving relative file paths. Properties AnchorToSolid Gets the dictionary mapping anchors to their corresponding solids. public Dictionary AnchorToSolid { get; } Property Value Dictionary Asmb Gets the assembly containing the mechanism components. public Asmb Asmb { get; } Property Value Asmb Root Gets the root anchor of the mechanism. public Anchor Root { get; } Property Value Anchor XName Name for XML IO. public static string XName { get; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. 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." }, "api/Hi.Mech.IGetAnchorToSolidDictionary.html": { "href": "api/Hi.Mech.IGetAnchorToSolidDictionary.html", @@ -1992,12 +2107,12 @@ "api/Hi.Mech.IMachiningChain.html": { "href": "api/Hi.Mech.IMachiningChain.html", "title": "Interface IMachiningChain | HiAPI-C# 2025", - "summary": "Interface IMachiningChain Namespace Hi.Mech Assembly HiMech.dll Represents a machining chain with two ends, connecting a tool and a workpiece. public interface IMachiningChain : IGetAsmb, IGetTopoIndex, IGetRootAnchor Inherited Members IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties McCodes Gets the machine coordinate code sequence for decoding the MC array. string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] Methods GetTableBuckle() Gets the table buckle anchor point. IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point." + "summary": "Interface IMachiningChain Namespace Hi.Mech Assembly HiMech.dll Represents a machining chain with two ends, connecting a tool and a workpiece. public interface IMachiningChain : IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary Inherited Members IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() IMakeXmlSource.MakeXmlSource(string, string, bool) IGetAnchorToSolidDictionary.GetAnchorToSolidDictionary() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties McCodes Gets the machine coordinate code sequence for decoding the MC array. string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] Methods GetTableBuckle() Gets the table buckle anchor point. IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point." }, "api/Hi.Mech.IMachiningChainSource.html": { "href": "api/Hi.Mech.IMachiningChainSource.html", "title": "Interface IMachiningChainSource | HiAPI-C# 2025", - "summary": "Interface IMachiningChainSource Namespace Hi.Mech Assembly HiMech.dll Provides XML serialization/deserialization capabilities for IMachiningChain objects. public interface IMachiningChainSource : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string) 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) Methods GetMachiningChain() Gets the machining chain instance. IMachiningChain GetMachiningChain() Returns IMachiningChain The machining chain instance." + "summary": "Interface IMachiningChainSource Namespace Hi.Mech Assembly HiMech.dll Provides XML serialization/deserialization capabilities for IMachiningChain objects. public interface IMachiningChainSource : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Methods GetMachiningChain() Gets the machining chain instance. IMachiningChain GetMachiningChain() Returns IMachiningChain The machining chain instance." }, "api/Hi.Mech.MachiningChainUtil.html": { "href": "api/Hi.Mech.MachiningChainUtil.html", @@ -2007,32 +2122,32 @@ "api/Hi.Mech.Topo.Anchor.html": { "href": "api/Hi.Mech.Topo.Anchor.html", "title": "Class Anchor | HiAPI-C# 2025", - "summary": "Class Anchor Namespace Hi.Mech.Topo Assembly HiMech.dll A coordinate system using in kinematic chain. public class Anchor : IGetAnchor, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d Inheritance object Anchor Implements IGetAnchor IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Anchor() Ctor. public Anchor() Anchor(Asmb) Ctor. public Anchor(Asmb asmb) Parameters asmb Asmb add this to asmb.ChildAncs Anchor(Asmb, string) Ctor. public Anchor(Asmb asmb, string name) Parameters asmb Asmb add this to asmb.ChildAncs name string Name Properties BranchMap Gets the branch map. ‘this’ anchor locates on Fletch . public Dictionary BranchMap { get; } Property Value Dictionary The branch map. BranchMapInv Gets the branch map. ‘this’ anchor locates on Arrow . public Dictionary BranchMapInv { get; } Property Value Dictionary The branch map. Guid GUID. public Guid Guid { get; } Property Value Guid IndexXName The XML element name used for indexing anchors. public static string IndexXName { get; } Property Value string IndexXml Get XML for indexing. Only the Guid takes effect when reading. public XElement IndexXml { get; } Property Value XElement The XML contains Name and Guid. Name Name. public string Name { get; set; } Property Value string Methods Detach() Detach all related Branch. public void Detach() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public virtual void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. public Anchor GetAnchor() Returns Anchor key anchor GetByIndexXml(XElement, Dictionary) Gets an anchor from its XML index representation using a GUID-to-Anchor dictionary. public static Anchor GetByIndexXml(XElement src, Dictionary guidToAncDictionary) Parameters src XElement The source XML element containing the anchor index information. guidToAncDictionary Dictionary Dictionary mapping GUIDs to Anchor objects. Returns Anchor The anchor object corresponding to the XML index. GetClusterAnchors() Gets all the linked anchors by Branch. public HashSet GetClusterAnchors() Returns HashSet GetMat4d(IGetAnchor) Get transform matrix from this to tail. public Mat4d GetMat4d(IGetAnchor tail) Parameters tail IGetAnchor tail Returns Mat4d transform matrix GetMat4dMap() Gets the mat4d map in GetClusterAnchors() public Dictionary GetMat4dMap() Returns Dictionary GetNeighborAnchorList() Get neighbor anchors. public List GetNeighborAnchorList() Returns List neighbor anchors GetNeighborAnchorSet() Get neighbor anchors. public HashSet GetNeighborAnchorSet() Returns HashSet neighbor anchors GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class Anchor Namespace Hi.Mech.Topo Assembly HiMech.dll A coordinate system using in kinematic chain. public class Anchor : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d Inheritance object Anchor Implements IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors Anchor() Ctor. public Anchor() Anchor(Asmb) Ctor. public Anchor(Asmb asmb) Parameters asmb Asmb add this to asmb.ChildAncs Anchor(Asmb, string) Ctor. public Anchor(Asmb asmb, string name) Parameters asmb Asmb add this to asmb.ChildAncs name string Name Properties BranchMap Gets the branch map. ‘this’ anchor locates on Fletch . public Dictionary BranchMap { get; } Property Value Dictionary The branch map. BranchMapInv Gets the branch map. ‘this’ anchor locates on Arrow . public Dictionary BranchMapInv { get; } Property Value Dictionary The branch map. Guid GUID. public Guid Guid { get; } Property Value Guid IndexXName The XML element name used for indexing anchors. public static string IndexXName { get; } Property Value string IndexXml Get XML for indexing. Only the Guid takes effect when reading. public XElement IndexXml { get; } Property Value XElement The XML contains Name and Guid. Name Name. public string Name { get; set; } Property Value string Methods Detach() Detach all related Branch. public void Detach() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public virtual void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetByIndexXml(XElement, Dictionary) Gets an anchor from its XML index representation using a GUID-to-Anchor dictionary. public static Anchor GetByIndexXml(XElement src, Dictionary guidToAncDictionary) Parameters src XElement The source XML element containing the anchor index information. guidToAncDictionary Dictionary Dictionary mapping GUIDs to Anchor objects. Returns Anchor The anchor object corresponding to the XML index. GetClusterAnchors() Gets all the linked anchors by Branch. public HashSet GetClusterAnchors() Returns HashSet GetMat4d(IGetAnchor) Get transform matrix from this to tail. public Mat4d GetMat4d(IGetAnchor tail) Parameters tail IGetAnchor tail Returns Mat4d transform matrix GetMat4dMap() Gets the mat4d map in GetClusterAnchors() public Dictionary GetMat4dMap() Returns Dictionary GetNeighborAnchorList() Get neighbor anchors. public List GetNeighborAnchorList() Returns List neighbor anchors GetNeighborAnchorSet() Get neighbor anchors. public HashSet GetNeighborAnchorSet() Returns HashSet neighbor anchors ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.Mech.Topo.AnchorFuncSource.html": { "href": "api/Hi.Mech.Topo.AnchorFuncSource.html", "title": "Class AnchorFuncSource | HiAPI-C# 2025", - "summary": "Class AnchorFuncSource Namespace Hi.Mech.Topo Assembly HiMech.dll Provides an anchor through a function delegate. public class AnchorFuncSource : IGetAnchor, IGetTopoIndex Inheritance object AnchorFuncSource Implements IGetAnchor IGetTopoIndex 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) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors AnchorFuncSource() Initializes a new instance of the AnchorFuncSource class. public AnchorFuncSource() AnchorFuncSource(Func) Initializes a new instance of the AnchorFuncSource class with the specified anchor function. public AnchorFuncSource(Func anchorFunc) Parameters anchorFunc Func The function that returns an anchor. Properties AnchorFunc Gets or sets the function that returns an anchor. public Func AnchorFunc { get; set; } Property Value Func Methods GetAnchor() Get key anchor. public Anchor GetAnchor() Returns Anchor key anchor" + "summary": "Class AnchorFuncSource Namespace Hi.Mech.Topo Assembly HiMech.dll Provides an anchor through a function delegate. public class AnchorFuncSource : IGetAnchor, IGetTopoIndex Inheritance object AnchorFuncSource Implements IGetAnchor IGetTopoIndex 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) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors AnchorFuncSource() Initializes a new instance of the AnchorFuncSource class. public AnchorFuncSource() AnchorFuncSource(Func) Initializes a new instance of the AnchorFuncSource class with the specified anchor function. public AnchorFuncSource(Func anchorFunc) Parameters anchorFunc Func The function that returns an anchor. Properties AnchorFunc Gets or sets the function that returns an anchor. public Func AnchorFunc { get; set; } Property Value Func Methods GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor" }, "api/Hi.Mech.Topo.AnchoredBoxable.html": { "href": "api/Hi.Mech.Topo.AnchoredBoxable.html", "title": "Class AnchoredBoxable | HiAPI-C# 2025", - "summary": "Class AnchoredBoxable Namespace Hi.Mech.Topo Assembly HiMech.dll Represents an object that is both anchored to a root point and can expand to a 3D box. public class AnchoredBoxable : IGetRootAnchor, IExpandToBox3d Inheritance object AnchoredBoxable Implements IGetRootAnchor IExpandToBox3d 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) Constructors AnchoredBoxable() Initializes a new instance of the AnchoredBoxable class. public AnchoredBoxable() AnchoredBoxable(IGetRootAnchor, IExpandToBox3d) Initializes a new instance of the AnchoredBoxable class with the specified anchor and boxable object. public AnchoredBoxable(IGetRootAnchor anchor, IExpandToBox3d boxable) Parameters anchor IGetRootAnchor The object that provides the root anchor. boxable IExpandToBox3d The object that can expand to a 3D box. Properties Anchor Gets or sets the anchor point. public Anchor Anchor { get; set; } Property Value Anchor Boxable Gets or sets the boxable object that can expand to a 3D box. public IExpandToBox3d Boxable { get; set; } Property Value IExpandToBox3d Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor." + "summary": "Class AnchoredBoxable Namespace Hi.Mech.Topo Assembly HiMech.dll Represents an object that is both anchored to a root point and can expand to a 3D box. public class AnchoredBoxable : IGetAnchor, IGetTopoIndex, IExpandToBox3d Inheritance object AnchoredBoxable Implements IGetAnchor IGetTopoIndex IExpandToBox3d 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) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors AnchoredBoxable() Initializes a new instance of the AnchoredBoxable class. public AnchoredBoxable() AnchoredBoxable(IGetAnchor, IExpandToBox3d) Initializes a new instance of the AnchoredBoxable class with the specified anchor and boxable object. public AnchoredBoxable(IGetAnchor anchor, IExpandToBox3d boxable) Parameters anchor IGetAnchor The object that provides the root anchor. boxable IExpandToBox3d The object that can expand to a 3D box. Properties Anchor Gets or sets the anchor point. public Anchor Anchor { get; set; } Property Value Anchor Boxable Gets or sets the boxable object that can expand to a 3D box. public IExpandToBox3d Boxable { get; set; } Property Value IExpandToBox3d Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor" }, "api/Hi.Mech.Topo.AnchoredDisplayee.html": { "href": "api/Hi.Mech.Topo.AnchoredDisplayee.html", "title": "Class AnchoredDisplayee | HiAPI-C# 2025", - "summary": "Class AnchoredDisplayee Namespace Hi.Mech.Topo Assembly HiMech.dll Represents a displayable object that is anchored to a specific point in a topology. public class AnchoredDisplayee : IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d Inheritance object AnchoredDisplayee Implements IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d 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) Constructors AnchoredDisplayee() Initializes a new instance of the AnchoredDisplayee class. public AnchoredDisplayee() AnchoredDisplayee(IGetAnchor, IDisplayee) Initializes a new instance of the AnchoredDisplayee class with the specified anchor and displayee. public AnchoredDisplayee(IGetAnchor anchor, IDisplayee displayee) Parameters anchor IGetAnchor The object that provides the anchor. displayee IDisplayee The displayable object. Properties AnchorSource Gets or sets the source of the anchor. public IGetAnchor AnchorSource { get; set; } Property Value IGetAnchor Displayee Gets or sets the displayable object. public IDisplayee Displayee { get; set; } Property Value IDisplayee Methods Display(Bind) Displays this object using the specified binding. public void Display(Bind bind) Parameters bind Bind The binding to use for display. ExpandToBox3d(Box3d) Expands the specified box to include this object. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand. GetAnchor() public Anchor GetAnchor() Returns Anchor GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor." + "summary": "Class AnchoredDisplayee Namespace Hi.Mech.Topo Assembly HiMech.dll Represents a displayable object that is anchored to a specific point in a topology. public class AnchoredDisplayee : IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IGetAnchor, IGetTopoIndex Inheritance object AnchoredDisplayee Implements IAnchoredDisplayee IDisplayee IExpandToBox3d IGetAnchor IGetTopoIndex Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors AnchoredDisplayee() Initializes a new instance of the AnchoredDisplayee class. public AnchoredDisplayee() AnchoredDisplayee(IGetAnchor, IDisplayee) Initializes a new instance of the AnchoredDisplayee class with the specified anchor and displayee. public AnchoredDisplayee(IGetAnchor anchor, IDisplayee displayee) Parameters anchor IGetAnchor The object that provides the anchor. displayee IDisplayee The displayable object. Properties AnchorSource Gets or sets the source of the anchor. public IGetAnchor AnchorSource { get; set; } Property Value IGetAnchor Displayee Gets or sets the displayable object. public IDisplayee Displayee { get; set; } Property Value IDisplayee Methods Display(Bind) Displays this object using the specified binding. public void Display(Bind bind) Parameters bind Bind The binding to use for display. ExpandToBox3d(Box3d) Expands the specified box to include this object. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand. GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor" }, "api/Hi.Mech.Topo.Asmb.html": { "href": "api/Hi.Mech.Topo.Asmb.html", "title": "Class Asmb | HiAPI-C# 2025", - "summary": "Class Asmb Namespace Hi.Mech.Topo Assembly HiMech.dll Collection of Anchor and Asmb. public class Asmb : IGetAsmb, IGetTopoIndex, IDisposable Inheritance object Asmb Implements IGetAsmb IGetTopoIndex IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors Asmb() Ctor. public Asmb() Asmb(Asmb) Ctor. public Asmb(Asmb parent) Parameters parent Asmb parent Asmb(Asmb, string) Ctor. public Asmb(Asmb parent, string name) Parameters parent Asmb parent name string Name Asmb(string) Ctor. public Asmb(string name) Parameters name string Name Properties ChildAncs Gets the collection of child anchors in this assembly. public ThreadSafeSet ChildAncs { get; } Property Value ThreadSafeSet ChildAsmbs Gets the collection of child assemblies in this assembly. public ThreadSafeSet ChildAsmbs { get; } Property Value ThreadSafeSet Guid GUID. public Guid Guid { get; } Property Value Guid Name Name. public string Name { get; set; } Property Value string XName Gets the XML name for the assembly. public static string XName { get; } Property Value string Methods AllEnterReadLock() Enters read locks for all thread-safe collections in the assembly. public void AllEnterReadLock() AllExitReadLock() Exits read locks for all thread-safe collections in the assembly. public void AllExitReadLock() CallAsmb(XElement, string, Dictionary, Dictionary, Dictionary) Get asmb by the asmbXml. If the members of the target asmb do not exist on asmbs or ancs, the members will be generated; otherwise, the existed members are applied. public static Asmb CallAsmb(XElement asmbXml, string baseDirectory, Dictionary asmbs = null, Dictionary ancs = null, Dictionary brns = null) Parameters asmbXml XElement xml of asmb baseDirectory string Base directory path for resolving relative paths asmbs Dictionary existed asmb map ancs Dictionary existed anc map brns Dictionary existed branch map Returns Asmb asmb Display(Bind, Anchor, params IGetRootAnchor[]) Display displayees according to the GetAnchor(). The fixed anchor is root. If the element of displayees is not IDisplayee or null Anchor, the element will be ignored. public void Display(Bind bind, Anchor root, params IGetRootAnchor[] displayees) Parameters bind Bind bind root Anchor fixed anchor displayees IGetRootAnchor[] element to be rendered Display(Bind, Dictionary, params IGetRootAnchor[]) Display the displayees according to map. If displayees is null, do nothing. public static void Display(Bind bind, Dictionary map, params IGetRootAnchor[] displayees) Parameters bind Bind bind map Dictionary anchor to transformation map displayees IGetRootAnchor[] displayees 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 ExpandToBox3d(Box3d, Anchor, params IGetRootAnchor[]) Expands a bounding box to include the assembly. public void ExpandToBox3d(Box3d dst, Anchor root, params IGetRootAnchor[] displayees) Parameters dst Box3d The bounding box to expand. root Anchor The root anchor for the calculation. displayees IGetRootAnchor[] The displayable objects to include in the calculation. GetAnchorByGuid(string, bool) Finds an anchor in the assembly hierarchy by its GUID. public Anchor GetAnchorByGuid(string guid, bool enableThreadSafe = true) Parameters guid string The GUID of the anchor to find. enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns Anchor The anchor with the specified GUID, or null if not found. GetAnchorChain(Anchor, Anchor) Gets a chain of anchors from the head to the tail. public List GetAnchorChain(Anchor head, Anchor tail) Parameters head Anchor The starting anchor of the chain. tail Anchor The ending anchor of the chain. Returns List A list of anchors representing the chain, or an empty list if no chain exists. GetAnchoredDisplayeeList(Dictionary) Gets a list of anchored displayable objects based on the provided anchor-to-solid mapping. public List GetAnchoredDisplayeeList(Dictionary anchorToSolidDictionary) Parameters anchorToSolidDictionary Dictionary Dictionary mapping anchors to their corresponding solids. Returns List A list of anchored displayable objects. GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetAsmbDraw(Anchor) Gets an assembly drawing for visualization. public AsmbDraw GetAsmbDraw(Anchor root) Parameters root Anchor The root anchor for the drawing. Returns AsmbDraw An assembly drawing object. GetBox3d(Anchor, params IGetRootAnchor[]) Gets a bounding box for the assembly. public Box3d GetBox3d(Anchor root, params IGetRootAnchor[] displayees) Parameters root Anchor The root anchor for the calculation. displayees IGetRootAnchor[] The displayable objects to include in the calculation. Returns Box3d A 3D bounding box containing the assembly. GetBranchByGuid(string, bool) Finds a branch in the assembly hierarchy by its GUID. public Branch GetBranchByGuid(string guid, bool enableThreadSafe = true) Parameters guid string The GUID of the branch to find. enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns Branch The branch with the specified GUID, or null if not found. GetBranchChain(IGetAnchor, IGetAnchor) Gets a chain of branches with their directions from the head anchor to the tail anchor. public List GetBranchChain(IGetAnchor head, IGetAnchor tail) Parameters head IGetAnchor The starting anchor of the chain. tail IGetAnchor The ending anchor of the chain. Returns List A list of direction-branch pairs representing the chain, or an empty list if no chain exists. GetBranchsXml(IGetAnchor, string) Gets the XML representation of all branches in the assembly starting from the specified root. public XElement GetBranchsXml(IGetAnchor root, string baseDirectory) Parameters root IGetAnchor The root anchor to start from. If null, uses the first descendant anchor. baseDirectory string The base directory for file references. Returns XElement An XML element containing all branches in the assembly. GetDescendantAnchorSet(bool) Generate an anchor set from all descendant anchors. public HashSet GetDescendantAnchorSet(bool enableThreadSafe = true) Parameters enableThreadSafe bool Returns HashSet descendant anchor set GetDescendantAnchors(bool) Gets a list of all descendant anchors in the assembly hierarchy. public List GetDescendantAnchors(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns List A list of all descendant anchors. GetDescendantAsmbSet(bool) Gets a set of all descendant assemblies in the assembly hierarchy. public HashSet GetDescendantAsmbSet(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns HashSet A set of all descendant assemblies. GetDescendantAsmbs(bool) Gets a list of all descendant assemblies in the assembly hierarchy. public List GetDescendantAsmbs(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns List A list of all descendant assemblies. GetDescendingName(Anchor) Gets the descending name path for an anchor, combining assembly names with dashes. public string GetDescendingName(Anchor anc) Parameters anc Anchor The anchor to get the descending name for. Returns string The full descending name path, or null if the anchor is not found in the assembly hierarchy. GetDescendingName(Asmb) Gets the descending name path for a child assembly, combining assembly names with dashes. public string GetDescendingName(Asmb asmb) Parameters asmb Asmb The assembly to get the descending name for. Returns string The full descending name path, or null if the assembly is not found in the hierarchy. GetHierarchyString() Gets a string representation of the assembly hierarchy. public string GetHierarchyString() Returns string A string describing the assembly hierarchy. GetInnerBranchSet(bool) Gets a set of branches that are internal to this assembly. A branch is considered internal if both its endpoints are anchors within this assembly. public HashSet GetInnerBranchSet(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns HashSet A set of internal branches. GetMat4d(IGetAnchor, IGetAnchor) Gets the transformation matrix between two anchors in the assembly. public Mat4d GetMat4d(IGetAnchor root, IGetAnchor tail) Parameters root IGetAnchor The source anchor for the transformation. tail IGetAnchor The target anchor for the transformation. Returns Mat4d The 4x4 transformation matrix from root to tail. GetMat4dMap(IGetAnchor) Gets a mapping of anchors to their transformation matrices relative to the root anchor. public Dictionary GetMat4dMap(IGetAnchor root) Parameters root IGetAnchor The root anchor to calculate transformations from. Returns Dictionary A dictionary mapping anchors to their transformation matrices. GetMat4dMapWithBlocks(IGetAnchor, params Anchor[]) Gets a mapping of anchors to their transformation matrices relative to the root anchor, excluding specified blocked anchors. public Dictionary GetMat4dMapWithBlocks(IGetAnchor root, params Anchor[] blockeds) Parameters root IGetAnchor The root anchor to calculate transformations from. blockeds Anchor[] Array of anchors to exclude from the calculation. Returns Dictionary A dictionary mapping anchors to their transformation matrices. ShowMat4dMap(Dictionary) Show mat map in text on console. public static void ShowMat4dMap(Dictionary map) Parameters map Dictionary ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToXElement(IGetAnchor, string) Converts the assembly to an XML element. public XElement ToXElement(IGetAnchor root, string baseDirectory) Parameters root IGetAnchor The root anchor for the conversion. baseDirectory string The base directory for file references. Returns XElement An XML element representing the assembly. ToXElement(string) Converts the assembly to an XML element. public XElement ToXElement(string baseDirectory) Parameters baseDirectory string The base directory for file references. Returns XElement An XML element representing the assembly." + "summary": "Class Asmb Namespace Hi.Mech.Topo Assembly HiMech.dll Collection of Anchor and Asmb. public class Asmb : IGetAsmb, IGetTopoIndex, IDisposable Inheritance object Asmb Implements IGetAsmb IGetTopoIndex IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors Asmb() Ctor. public Asmb() Asmb(Asmb) Ctor. public Asmb(Asmb parent) Parameters parent Asmb parent Asmb(Asmb, string) Ctor. public Asmb(Asmb parent, string name) Parameters parent Asmb parent name string Name Asmb(string) Ctor. public Asmb(string name) Parameters name string Name Properties ChildAncs Gets the collection of child anchors in this assembly. public ThreadSafeSet ChildAncs { get; } Property Value ThreadSafeSet ChildAsmbs Gets the collection of child assemblies in this assembly. public ThreadSafeSet ChildAsmbs { get; } Property Value ThreadSafeSet Guid GUID. public Guid Guid { get; } Property Value Guid Name Name. public string Name { get; set; } Property Value string XName Gets the XML name for the assembly. public static string XName { get; } Property Value string Methods AllEnterReadLock() Enters read locks for all thread-safe collections in the assembly. public void AllEnterReadLock() AllExitReadLock() Exits read locks for all thread-safe collections in the assembly. public void AllExitReadLock() CallAsmb(XElement, string, Dictionary, Dictionary, Dictionary) Get asmb by the asmbXml. If the members of the target asmb do not exist on asmbs or ancs, the members will be generated; otherwise, the existed members are applied. public static Asmb CallAsmb(XElement asmbXml, string baseDirectory, Dictionary asmbs = null, Dictionary ancs = null, Dictionary brns = null) Parameters asmbXml XElement xml of asmb baseDirectory string Base directory path for resolving relative paths asmbs Dictionary existed asmb map ancs Dictionary existed anc map brns Dictionary existed branch map Returns Asmb asmb Display(Bind, Anchor, params IGetAnchor[]) Display displayees according to the GetAnchor(). The fixed anchor is root. If the element of displayees is not IDisplayee or null Anchor, the element will be ignored. public void Display(Bind bind, Anchor root, params IGetAnchor[] displayees) Parameters bind Bind bind root Anchor fixed anchor displayees IGetAnchor[] element to be rendered Display(Bind, Dictionary, params IGetAnchor[]) Display the displayees according to map. If displayees is null, do nothing. public static void Display(Bind bind, Dictionary map, params IGetAnchor[] displayees) Parameters bind Bind bind map Dictionary anchor to transformation map displayees IGetAnchor[] displayees 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 ExpandToBox3d(Box3d, Anchor, params IGetAnchor[]) Expands a bounding box to include the assembly. public void ExpandToBox3d(Box3d dst, Anchor root, params IGetAnchor[] displayees) Parameters dst Box3d The bounding box to expand. root Anchor The root anchor for the calculation. displayees IGetAnchor[] The displayable objects to include in the calculation. GetAnchorByGuid(string, bool) Finds an anchor in the assembly hierarchy by its GUID. public Anchor GetAnchorByGuid(string guid, bool enableThreadSafe = true) Parameters guid string The GUID of the anchor to find. enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns Anchor The anchor with the specified GUID, or null if not found. GetAnchorChain(Anchor, Anchor) Gets a chain of anchors from the head to the tail. public List GetAnchorChain(Anchor head, Anchor tail) Parameters head Anchor The starting anchor of the chain. tail Anchor The ending anchor of the chain. Returns List A list of anchors representing the chain, or an empty list if no chain exists. GetAnchoredDisplayeeList(Dictionary) Gets a list of anchored displayable objects based on the provided anchor-to-solid mapping. public List GetAnchoredDisplayeeList(Dictionary anchorToSolidDictionary) Parameters anchorToSolidDictionary Dictionary Dictionary mapping anchors to their corresponding solids. Returns List A list of anchored displayable objects. GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetAsmbDraw(Anchor) Gets an assembly drawing for visualization. public AsmbDraw GetAsmbDraw(Anchor root) Parameters root Anchor The root anchor for the drawing. Returns AsmbDraw An assembly drawing object. GetBox3d(Anchor, params IGetAnchor[]) Gets a bounding box for the assembly. public Box3d GetBox3d(Anchor root, params IGetAnchor[] displayees) Parameters root Anchor The root anchor for the calculation. displayees IGetAnchor[] The displayable objects to include in the calculation. Returns Box3d A 3D bounding box containing the assembly. GetBranchByGuid(string, bool) Finds a branch in the assembly hierarchy by its GUID. public Branch GetBranchByGuid(string guid, bool enableThreadSafe = true) Parameters guid string The GUID of the branch to find. enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns Branch The branch with the specified GUID, or null if not found. GetBranchChain(IGetAnchor, IGetAnchor) Gets a chain of branches with their directions from the head anchor to the tail anchor. public List GetBranchChain(IGetAnchor head, IGetAnchor tail) Parameters head IGetAnchor The starting anchor of the chain. tail IGetAnchor The ending anchor of the chain. Returns List A list of direction-branch pairs representing the chain, or an empty list if no chain exists. GetBranchsXml(IGetAnchor, string) Gets the XML representation of all branches in the assembly starting from the specified root. public XElement GetBranchsXml(IGetAnchor root, string baseDirectory) Parameters root IGetAnchor The root anchor to start from. If null, uses the first descendant anchor. baseDirectory string The base directory for file references. Returns XElement An XML element containing all branches in the assembly. GetDescendantAnchorSet(bool) Generate an anchor set from all descendant anchors. public HashSet GetDescendantAnchorSet(bool enableThreadSafe = true) Parameters enableThreadSafe bool Returns HashSet descendant anchor set GetDescendantAnchors(bool) Gets a list of all descendant anchors in the assembly hierarchy. public List GetDescendantAnchors(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns List A list of all descendant anchors. GetDescendantAsmbSet(bool) Gets a set of all descendant assemblies in the assembly hierarchy. public HashSet GetDescendantAsmbSet(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns HashSet A set of all descendant assemblies. GetDescendantAsmbs(bool) Gets a list of all descendant assemblies in the assembly hierarchy. public List GetDescendantAsmbs(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns List A list of all descendant assemblies. GetDescendingName(Anchor) Gets the descending name path for an anchor, combining assembly names with dashes. public string GetDescendingName(Anchor anc) Parameters anc Anchor The anchor to get the descending name for. Returns string The full descending name path, or null if the anchor is not found in the assembly hierarchy. GetDescendingName(Asmb) Gets the descending name path for a child assembly, combining assembly names with dashes. public string GetDescendingName(Asmb asmb) Parameters asmb Asmb The assembly to get the descending name for. Returns string The full descending name path, or null if the assembly is not found in the hierarchy. GetHierarchyString() Gets a string representation of the assembly hierarchy. public string GetHierarchyString() Returns string A string describing the assembly hierarchy. GetInnerBranchSet(bool) Gets a set of branches that are internal to this assembly. A branch is considered internal if both its endpoints are anchors within this assembly. public HashSet GetInnerBranchSet(bool enableThreadSafe = true) Parameters enableThreadSafe bool If true, uses thread-safe operations for accessing collections. Returns HashSet A set of internal branches. GetMat4d(IGetAnchor, IGetAnchor) Gets the transformation matrix between two anchors in the assembly. public Mat4d GetMat4d(IGetAnchor root, IGetAnchor tail) Parameters root IGetAnchor The source anchor for the transformation. tail IGetAnchor The target anchor for the transformation. Returns Mat4d The 4x4 transformation matrix from root to tail. GetMat4dMap(IGetAnchor) Gets a mapping of anchors to their transformation matrices relative to the root anchor. public Dictionary GetMat4dMap(IGetAnchor root) Parameters root IGetAnchor The root anchor to calculate transformations from. Returns Dictionary A dictionary mapping anchors to their transformation matrices. GetMat4dMapWithBlocks(IGetAnchor, params Anchor[]) Gets a mapping of anchors to their transformation matrices relative to the root anchor, excluding specified blocked anchors. public Dictionary GetMat4dMapWithBlocks(IGetAnchor root, params Anchor[] blockeds) Parameters root IGetAnchor The root anchor to calculate transformations from. blockeds Anchor[] Array of anchors to exclude from the calculation. Returns Dictionary A dictionary mapping anchors to their transformation matrices. ShowMat4dMap(Dictionary) Show mat map in text on console. public static void ShowMat4dMap(Dictionary map) Parameters map Dictionary ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToXElement(IGetAnchor, string) Converts the assembly to an XML element. public XElement ToXElement(IGetAnchor root, string baseDirectory) Parameters root IGetAnchor The root anchor for the conversion. baseDirectory string The base directory for file references. Returns XElement An XML element representing the assembly. ToXElement(string) Converts the assembly to an XML element. public XElement ToXElement(string baseDirectory) Parameters baseDirectory string The base directory for file references. Returns XElement An XML element representing the assembly." }, "api/Hi.Mech.Topo.AsmbDraw.html": { "href": "api/Hi.Mech.Topo.AsmbDraw.html", "title": "Class AsmbDraw | HiAPI-C# 2025", - "summary": "Class AsmbDraw Namespace Hi.Mech.Topo Assembly HiMech.dll Render all Anchors of the Asmb in form of CoordinateDrawing. public class AsmbDraw : IDisplayee, IExpandToBox3d Inheritance object AsmbDraw Implements IDisplayee IExpandToBox3d 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) Constructors AsmbDraw(Asmb, Anchor) Ctor. public AsmbDraw(Asmb asmb, Anchor root) Parameters asmb Asmb asmb root Anchor fixed anchor Properties Asmb Asmb. public Asmb Asmb { get; set; } Property Value Asmb Root Fixed anchor. public Anchor Root { get; set; } Property Value Anchor Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class AsmbDraw Namespace Hi.Mech.Topo Assembly HiMech.dll Render all Anchors of the Asmb in form of CoordinateDrawing. public class AsmbDraw : IDisplayee, IExpandToBox3d Inheritance object AsmbDraw Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors AsmbDraw(Asmb, Anchor) Ctor. public AsmbDraw(Asmb asmb, Anchor root) Parameters asmb Asmb asmb root Anchor fixed anchor Properties Asmb Asmb. public Asmb Asmb { get; set; } Property Value Asmb Root Fixed anchor. public Anchor Root { get; set; } Property Value Anchor Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Mech.Topo.Branch.html": { "href": "api/Hi.Mech.Topo.Branch.html", @@ -2052,42 +2167,42 @@ "api/Hi.Mech.Topo.DynamicFreeform.html": { "href": "api/Hi.Mech.Topo.DynamicFreeform.html", "title": "Class DynamicFreeform | HiAPI-C# 2025", - "summary": "Class DynamicFreeform Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic Freeform transformer. public class DynamicFreeform : IDynamicTransformer, ITransformer, IMakeXmlSource Inheritance object DynamicFreeform Implements IDynamicTransformer ITransformer IMakeXmlSource 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) Constructors DynamicFreeform(Mat4d) Ctor. public DynamicFreeform(Mat4d mat) Parameters mat Mat4d transform matrix DynamicFreeform(Mat4d, Mat4d) Ctor. public DynamicFreeform(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix DynamicFreeform(XElement) Ctor. public DynamicFreeform(XElement src) Parameters src XElement XML Properties XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetMat(Mat4d) public void SetMat(Mat4d mat) Parameters mat Mat4d SetMat(Mat4d, Mat4d) Set transform matrix. public void SetMat(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix" + "summary": "Class DynamicFreeform Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic Freeform transformer. public class DynamicFreeform : IDynamicTransformer, ITransformer, IMakeXmlSource Inheritance object DynamicFreeform Implements IDynamicTransformer ITransformer IMakeXmlSource 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) Constructors DynamicFreeform(Mat4d) Ctor. public DynamicFreeform(Mat4d mat) Parameters mat Mat4d transform matrix DynamicFreeform(Mat4d, Mat4d) Ctor. public DynamicFreeform(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix DynamicFreeform(XElement) Ctor. public DynamicFreeform(XElement src) Parameters src XElement XML Properties XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. SetMat(Mat4d) public void SetMat(Mat4d mat) Parameters mat Mat4d SetMat(Mat4d, Mat4d) Set transform matrix. public void SetMat(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix" }, "api/Hi.Mech.Topo.DynamicRotation.html": { "href": "api/Hi.Mech.Topo.DynamicRotation.html", "title": "Class DynamicRotation | HiAPI-C# 2025", - "summary": "Class DynamicRotation Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic rotate transformer. public class DynamicRotation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object DynamicRotation Implements IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource IGetInverseTransformer Derived NcRotation 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) Constructors DynamicRotation() Ctor. public DynamicRotation() DynamicRotation(Vec3d, double, Vec3d) Ctor. public DynamicRotation(Vec3d axis, double angle_rad = 0, Vec3d pivot = null) Parameters axis Vec3d Axis angle_rad double Angle_rad pivot Vec3d Pivot DynamicRotation(XElement) Ctor. public DynamicRotation(XElement src) Parameters src XElement XML Properties Angle_deg Rotation angle in degree. public double Angle_deg { get; set; } Property Value double Angle_rad Rotation angle in radian. public double Angle_rad { get; set; } Property Value double Axis Rotation axis. public Vec3d Axis { get; set; } Property Value Vec3d Pivot pivot public Vec3d Pivot { get; set; } Property Value Vec3d Step Gets or sets the step. public double Step { get; set; } Property Value double The step. XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public virtual ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Set(DynamicRotation) Copy from src. public void Set(DynamicRotation src) Parameters src DynamicRotation src" + "summary": "Class DynamicRotation Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic rotate transformer. public class DynamicRotation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object DynamicRotation Implements IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource IGetInverseTransformer Derived NcRotation 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) Constructors DynamicRotation() Ctor. public DynamicRotation() DynamicRotation(Vec3d, double, Vec3d) Ctor. public DynamicRotation(Vec3d axis, double angle_rad = 0, Vec3d pivot = null) Parameters axis Vec3d Axis angle_rad double Angle_rad pivot Vec3d Pivot DynamicRotation(XElement) Ctor. public DynamicRotation(XElement src) Parameters src XElement XML Properties Angle_deg Rotation angle in degree. public double Angle_deg { get; set; } Property Value double Angle_rad Rotation angle in radian. public double Angle_rad { get; set; } Property Value double Axis Rotation axis. public Vec3d Axis { get; set; } Property Value Vec3d Pivot pivot public Vec3d Pivot { get; set; } Property Value Vec3d Step Gets or sets the step. public double Step { get; set; } Property Value double The step. XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public virtual ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. Set(DynamicRotation) Copy from src. public void Set(DynamicRotation src) Parameters src DynamicRotation src" }, "api/Hi.Mech.Topo.DynamicTranslation.html": { "href": "api/Hi.Mech.Topo.DynamicTranslation.html", "title": "Class DynamicTranslation | HiAPI-C# 2025", - "summary": "Class DynamicTranslation Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic translate transformer public class DynamicTranslation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object DynamicTranslation Implements IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource IGetInverseTransformer Derived NcTranslation 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) Constructors DynamicTranslation() Ctor. public DynamicTranslation() DynamicTranslation(Vec3d, double) Ctor. public DynamicTranslation(Vec3d axis, double len = 0) Parameters axis Vec3d Translation axis len double length DynamicTranslation(XElement) Ctor. public DynamicTranslation(XElement src) Parameters src XElement XML Properties Axis Translation Axis. public Vec3d Axis { get; set; } Property Value Vec3d Len Length. public double Len { get; set; } Property Value double Step Gets or sets the step. public double Step { get; set; } Property Value double The step. XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public virtual ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Set(DynamicTranslation) Copy from src. public void Set(DynamicTranslation src) Parameters src DynamicTranslation src" + "summary": "Class DynamicTranslation Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic translate transformer public class DynamicTranslation : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object DynamicTranslation Implements IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource IGetInverseTransformer Derived NcTranslation 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) Constructors DynamicTranslation() Ctor. public DynamicTranslation() DynamicTranslation(Vec3d, double) Ctor. public DynamicTranslation(Vec3d axis, double len = 0) Parameters axis Vec3d Translation axis len double length DynamicTranslation(XElement) Ctor. public DynamicTranslation(XElement src) Parameters src XElement XML Properties Axis Translation Axis. public Vec3d Axis { get; set; } Property Value Vec3d Len Length. public double Len { get; set; } Property Value double Step Gets or sets the step. public double Step { get; set; } Property Value double The step. XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public virtual ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. Set(DynamicTranslation) Copy from src. public void Set(DynamicTranslation src) Parameters src DynamicTranslation src" }, "api/Hi.Mech.Topo.GeneralTransform.html": { "href": "api/Hi.Mech.Topo.GeneralTransform.html", "title": "Class GeneralTransform | HiAPI-C# 2025", - "summary": "Class GeneralTransform Namespace Hi.Mech.Topo Assembly HiMech.dll Represents a general transformation that combines scaling, rotation, and translation. public class GeneralTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object GeneralTransform Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors GeneralTransform() Initializes a new instance of the GeneralTransform class. public GeneralTransform() GeneralTransform(Mat4d) Initializes a new instance of the GeneralTransform class from a 4x4 transformation matrix. public GeneralTransform(Mat4d mat) Parameters mat Mat4d The transformation matrix. GeneralTransform(double, StaticRotation, StaticTranslation) Initializes a new instance of the GeneralTransform class with specified scale, rotation, and translation. public GeneralTransform(double scale, StaticRotation rotation, StaticTranslation translation) Parameters scale double The scaling factor. rotation StaticRotation The rotation transformation. translation StaticTranslation The translation transformation. GeneralTransform(XElement) Ctor. public GeneralTransform(XElement src) Parameters src XElement XML Properties Rotation 2th transform. public StaticRotation Rotation { get; } Property Value StaticRotation Scale 1th transform. public double Scale { get; set; } Property Value double Translation 3th transform. public StaticTranslation Translation { get; } Property Value StaticTranslation XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class GeneralTransform Namespace Hi.Mech.Topo Assembly HiMech.dll Represents a general transformation that combines scaling, rotation, and translation. public class GeneralTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object GeneralTransform Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors GeneralTransform() Initializes a new instance of the GeneralTransform class. public GeneralTransform() GeneralTransform(Mat4d) Initializes a new instance of the GeneralTransform class from a 4x4 transformation matrix. public GeneralTransform(Mat4d mat) Parameters mat Mat4d The transformation matrix. GeneralTransform(double, StaticRotation, StaticTranslation) Initializes a new instance of the GeneralTransform class with specified scale, rotation, and translation. public GeneralTransform(double scale, StaticRotation rotation, StaticTranslation translation) Parameters scale double The scaling factor. rotation StaticRotation The rotation transformation. translation StaticTranslation The translation transformation. GeneralTransform(XElement) Ctor. public GeneralTransform(XElement src) Parameters src XElement XML Properties Rotation 2th transform. public StaticRotation Rotation { get; } Property Value StaticRotation Scale 1th transform. public double Scale { get; set; } Property Value double Translation 3th transform. public StaticTranslation Translation { get; } Property Value StaticTranslation XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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." }, "api/Hi.Mech.Topo.IAnchoredDisplayee.html": { "href": "api/Hi.Mech.Topo.IAnchoredDisplayee.html", "title": "Interface IAnchoredDisplayee | HiAPI-C# 2025", - "summary": "Interface IAnchoredDisplayee Namespace Hi.Mech.Topo Assembly HiMech.dll Interface for objects that can be displayed and are anchored to a root point in a topology. public interface IAnchoredDisplayee : IGetRootAnchor, IDisplayee, IExpandToBox3d Inherited Members IGetRootAnchor.GetRootAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) 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)" + "summary": "Interface IAnchoredDisplayee Namespace Hi.Mech.Topo Assembly HiMech.dll Interface for objects that can be displayed and are anchored to a root point in a topology. public interface IAnchoredDisplayee : IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d Inherited Members IGetAnchor.GetAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object)" }, "api/Hi.Mech.Topo.IDynamicRegular.html": { "href": "api/Hi.Mech.Topo.IDynamicRegular.html", "title": "Interface IDynamicRegular | HiAPI-C# 2025", - "summary": "Interface IDynamicRegular Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic Regular Transformer public interface IDynamicRegular : IDynamicTransformer, ITransformer, IMakeXmlSource Inherited Members ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string) 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) Properties Step Gets or sets the step. double Step { get; set; } Property Value double The step." + "summary": "Interface IDynamicRegular Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic Regular Transformer public interface IDynamicRegular : IDynamicTransformer, ITransformer, IMakeXmlSource Inherited Members ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Properties Step Gets or sets the step. double Step { get; set; } Property Value double The step." }, "api/Hi.Mech.Topo.IDynamicTransformer.html": { "href": "api/Hi.Mech.Topo.IDynamicTransformer.html", "title": "Interface IDynamicTransformer | HiAPI-C# 2025", - "summary": "Interface IDynamicTransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic Transformer. public interface IDynamicTransformer : ITransformer, IMakeXmlSource Inherited Members ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string) 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)" + "summary": "Interface IDynamicTransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Dynamic Transformer. public interface IDynamicTransformer : ITransformer, IMakeXmlSource Inherited Members ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string, bool) 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)" }, "api/Hi.Mech.Topo.IGetAnchor.html": { "href": "api/Hi.Mech.Topo.IGetAnchor.html", "title": "Interface IGetAnchor | HiAPI-C# 2025", - "summary": "Interface IGetAnchor Namespace Hi.Mech.Topo Assembly HiMech.dll Interface to get the key Anchor. public interface IGetAnchor : IGetTopoIndex Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods GetAnchor() Get key anchor. Anchor GetAnchor() Returns Anchor key anchor" + "summary": "Interface IGetAnchor Namespace Hi.Mech.Topo Assembly HiMech.dll Interface to get the key Anchor. public interface IGetAnchor : IGetTopoIndex Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods GetAnchor() Get key anchor. (i.e. root anchor) Anchor GetAnchor() Returns Anchor key anchor" }, "api/Hi.Mech.Topo.IGetAnchoredDisplayeeList.html": { "href": "api/Hi.Mech.Topo.IGetAnchoredDisplayeeList.html", @@ -2099,11 +2214,6 @@ "title": "Interface IGetAsmb | HiAPI-C# 2025", "summary": "Interface IGetAsmb Namespace Hi.Mech.Topo Assembly HiMech.dll Interface of Getting a key Asmb. public interface IGetAsmb : IGetTopoIndex 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) Methods GetAsmb() Gets the key asmb. Asmb GetAsmb() Returns Asmb The key asmb." }, - "api/Hi.Mech.Topo.IGetBuckleAnchorList.html": { - "href": "api/Hi.Mech.Topo.IGetBuckleAnchorList.html", - "title": "Interface IGetBuckleAnchorList | HiAPI-C# 2025", - "summary": "Interface IGetBuckleAnchorList Namespace Hi.Mech.Topo Assembly HiMech.dll Interface of GetBuckleAnchorList(). public interface IGetBuckleAnchorList 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) Methods GetBuckleAnchorList() Get buckle anchors. List GetBuckleAnchorList() Returns List buckle anchors" - }, "api/Hi.Mech.Topo.IGetFletchBuckle.html": { "href": "api/Hi.Mech.Topo.IGetFletchBuckle.html", "title": "Interface IGetFletchBuckle | HiAPI-C# 2025", @@ -2114,11 +2224,6 @@ "title": "Interface IGetInverseTransformer | HiAPI-C# 2025", "summary": "Interface IGetInverseTransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Interface for objects that can provide their inverse transformer. public interface IGetInverseTransformer 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) Methods GetInverseTransformer() Gets the inverse transformer of this transformer. ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer." }, - "api/Hi.Mech.Topo.IGetRootAnchor.html": { - "href": "api/Hi.Mech.Topo.IGetRootAnchor.html", - "title": "Interface IGetRootAnchor | HiAPI-C# 2025", - "summary": "Interface IGetRootAnchor Namespace Hi.Mech.Topo Assembly HiMech.dll Interface of GetRootAnchor(). public interface IGetRootAnchor 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) Methods GetRootAnchor() Get root anchor. Anchor GetRootAnchor() Returns Anchor root anchor." - }, "api/Hi.Mech.Topo.IGetTopoIndex.html": { "href": "api/Hi.Mech.Topo.IGetTopoIndex.html", "title": "Interface IGetTopoIndex | HiAPI-C# 2025", @@ -2127,12 +2232,22 @@ "api/Hi.Mech.Topo.IStaticTransformer.html": { "href": "api/Hi.Mech.Topo.IStaticTransformer.html", "title": "Interface IStaticTransformer | HiAPI-C# 2025", - "summary": "Interface IStaticTransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Static Transformer public interface IStaticTransformer : ITransformer, IMakeXmlSource Inherited Members ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string) 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)" + "summary": "Interface IStaticTransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Static Transformer public interface IStaticTransformer : ITransformer, IMakeXmlSource Inherited Members ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string, bool) 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)" + }, + "api/Hi.Mech.Topo.ITopo.html": { + "href": "api/Hi.Mech.Topo.ITopo.html", + "title": "Interface ITopo | HiAPI-C# 2025", + "summary": "Interface ITopo Namespace Hi.Mech.Topo Assembly HiMech.dll Defines an interface for displaying topological elements that combines assembly, anchoring, and display capabilities. public interface ITopo : IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList Inherited Members IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() Extension Methods TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object)" + }, + "api/Hi.Mech.Topo.ITopoDisplayee.html": { + "href": "api/Hi.Mech.Topo.ITopoDisplayee.html", + "title": "Interface ITopoDisplayee | HiAPI-C# 2025", + "summary": "Interface ITopoDisplayee Namespace Hi.Mech.Topo Assembly HiMech.dll public interface ITopoDisplayee : ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d Inherited Members IGetAsmb.GetAsmb() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetAnchor.GetAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) 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)" }, "api/Hi.Mech.Topo.ITransformer.html": { "href": "api/Hi.Mech.Topo.ITransformer.html", "title": "Interface ITransformer | HiAPI-C# 2025", - "summary": "Interface ITransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Interface of single transform matrix manipulation. public interface ITransformer : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string) 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) Methods Clone() Clones this instance. ITransformer Clone() Returns ITransformer clone GetMat() Gets the transform matrix. Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. Mat4d GetMatInv() Returns Mat4d The inverse transform matrix." + "summary": "Interface ITransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Interface of single transform matrix manipulation. public interface ITransformer : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Methods Clone() Clones this instance. ITransformer Clone() Returns ITransformer clone GetMat() Gets the transform matrix. Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. Mat4d GetMatInv() Returns Mat4d The inverse transform matrix." }, "api/Hi.Mech.Topo.ITransformerProperty.html": { "href": "api/Hi.Mech.Topo.ITransformerProperty.html", @@ -2142,27 +2257,37 @@ "api/Hi.Mech.Topo.NoTransform.html": { "href": "api/Hi.Mech.Topo.NoTransform.html", "title": "Class NoTransform | HiAPI-C# 2025", - "summary": "Class NoTransform Namespace Hi.Mech.Topo Assembly HiMech.dll Static Identity Transformer. public class NoTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object NoTransform Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors NoTransform() Ctor. public NoTransform() NoTransform(XElement) Ctor. public NoTransform(XElement src) Parameters src XElement XML Properties XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class NoTransform Namespace Hi.Mech.Topo Assembly HiMech.dll Static Identity Transformer. public class NoTransform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object NoTransform Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors NoTransform() Ctor. public NoTransform() NoTransform(XElement) Ctor. public NoTransform(XElement src) Parameters src XElement XML Properties XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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." }, "api/Hi.Mech.Topo.StackTransformer.html": { "href": "api/Hi.Mech.Topo.StackTransformer.html", "title": "Class StackTransformer | HiAPI-C# 2025", - "summary": "Class StackTransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Represents a transformer that maintains a stack of transformations. public class StackTransformer : ITransformer, IMakeXmlSource, IDisposable Inheritance object StackTransformer Implements ITransformer IMakeXmlSource 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) Constructors StackTransformer() Initializes a new instance of the StackTransformer class. public StackTransformer() StackTransformer(params ITransformer[]) Initializes a new instance of the StackTransformer class with the specified transformers. public StackTransformer(params ITransformer[] transformers) Parameters transformers ITransformer[] A variable-length array of transformers to add to the stack. StackTransformer(XElement, string) Initializes a new instance of the StackTransformer class from XML data. public StackTransformer(XElement src, string baseDirectory) Parameters src XElement The XML element containing the transformer stack configuration. baseDirectory string The base directory for resolving relative paths. Properties Count Gets the number of transformers in the stack. public int Count { get; } Property Value int XName Static name. public static string XName { get; } Property Value string Methods Clear() Removes all transformers from the stack. public void Clear() Clone() Creates a deep copy of this transformer stack. public ITransformer Clone() Returns ITransformer A new StackTransformer instance with cloned transformers. Remarks The children ITransformer on stack are all cloned. Dispose() Releases all resources used by the StackTransformer. public void Dispose() Dispose(bool) Releases the unmanaged resources used by the StackTransformer and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. GetMat() Gets the combined transformation matrix of all transformers in the stack. public Mat4d GetMat() Returns Mat4d The combined 4x4 transformation matrix. Remarks The transformations are applied in order from bottom to top of the stack. GetMatInv() Gets the inverse of the combined transformation matrix of all transformers in the stack. public Mat4d GetMatInv() Returns Mat4d The inverse of the combined 4x4 transformation matrix. Remarks The inverse transformations are applied in reverse order (top to bottom of the stack). If forward mats is ABCD, then the inv-mats: DinvCinvBinvAinv. GetStack() Get the copied transformer stack. public List GetStack() Returns List copied stack MakeXmlSource(string, string) Creates an XML representation of this transformer stack. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths. relFile string The relative file path for XML serialization. Returns XElement An XML element containing the transformer stack configuration. Peek() Returns the transformer at the top of the stack without removing it. public ITransformer Peek() Returns ITransformer The transformer at the top of the stack, or null if the stack is empty. Pop() Removes and returns the transformer at the top of the stack. public ITransformer Pop() Returns ITransformer The transformer at the top of the stack, or null if the stack is empty. Push(ITransformer) Pushes a transformer onto the stack. public void Push(ITransformer transformer) Parameters transformer ITransformer The transformer to push." + "summary": "Class StackTransformer Namespace Hi.Mech.Topo Assembly HiMech.dll Represents a transformer that maintains a stack of transformations. public class StackTransformer : ITransformer, IMakeXmlSource, IDisposable Inheritance object StackTransformer Implements ITransformer IMakeXmlSource 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) Constructors StackTransformer() Initializes a new instance of the StackTransformer class. public StackTransformer() StackTransformer(params ITransformer[]) Initializes a new instance of the StackTransformer class with the specified transformers. public StackTransformer(params ITransformer[] transformers) Parameters transformers ITransformer[] A variable-length array of transformers to add to the stack. StackTransformer(XElement, string) Initializes a new instance of the StackTransformer class from XML data. public StackTransformer(XElement src, string baseDirectory) Parameters src XElement The XML element containing the transformer stack configuration. baseDirectory string The base directory for resolving relative paths. Properties Count Gets the number of transformers in the stack. public int Count { get; } Property Value int XName Static name. public static string XName { get; } Property Value string Methods Clear() Removes all transformers from the stack. public void Clear() Clone() Creates a deep copy of this transformer stack. public ITransformer Clone() Returns ITransformer A new StackTransformer instance with cloned transformers. Remarks The children ITransformer on stack are all cloned. Dispose() Releases all resources used by the StackTransformer. public void Dispose() Dispose(bool) Releases the unmanaged resources used by the StackTransformer and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. GetMat() Gets the combined transformation matrix of all transformers in the stack. public Mat4d GetMat() Returns Mat4d The combined 4x4 transformation matrix. Remarks The transformations are applied in order from bottom to top of the stack. GetMatInv() Gets the inverse of the combined transformation matrix of all transformers in the stack. public Mat4d GetMatInv() Returns Mat4d The inverse of the combined 4x4 transformation matrix. Remarks The inverse transformations are applied in reverse order (top to bottom of the stack). If forward mats is ABCD, then the inv-mats: DinvCinvBinvAinv. GetStack() Get the copied transformer stack. public List GetStack() Returns List copied stack MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. Peek() Returns the transformer at the top of the stack without removing it. public ITransformer Peek() Returns ITransformer The transformer at the top of the stack, or null if the stack is empty. Pop() Removes and returns the transformer at the top of the stack. public ITransformer Pop() Returns ITransformer The transformer at the top of the stack, or null if the stack is empty. Push(ITransformer) Pushes a transformer onto the stack. public void Push(ITransformer transformer) Parameters transformer ITransformer The transformer to push." }, "api/Hi.Mech.Topo.StaticFreeform.html": { "href": "api/Hi.Mech.Topo.StaticFreeform.html", "title": "Class StaticFreeform | HiAPI-C# 2025", - "summary": "Class StaticFreeform Namespace Hi.Mech.Topo Assembly HiMech.dll Static Freeform transformer. public class StaticFreeform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object StaticFreeform Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors StaticFreeform() Ctor. public StaticFreeform() StaticFreeform(Mat4d) Ctor. public StaticFreeform(Mat4d mat) Parameters mat Mat4d transform matrix StaticFreeform(Mat4d, Mat4d) Ctor. public StaticFreeform(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix StaticFreeform(XElement) Ctor. public StaticFreeform(XElement src) Parameters src XElement XML Properties XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetMat(Mat4d) public void SetMat(Mat4d mat) Parameters mat Mat4d SetMat(Mat4d, Mat4d) Set transform matrix. public void SetMat(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix" + "summary": "Class StaticFreeform Namespace Hi.Mech.Topo Assembly HiMech.dll Static Freeform transformer. public class StaticFreeform : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object StaticFreeform Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors StaticFreeform() Ctor. public StaticFreeform() StaticFreeform(Mat4d) Ctor. public StaticFreeform(Mat4d mat) Parameters mat Mat4d transform matrix StaticFreeform(Mat4d, Mat4d) Ctor. public StaticFreeform(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix StaticFreeform(XElement) Ctor. public StaticFreeform(XElement src) Parameters src XElement XML Properties XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. SetMat(Mat4d) public void SetMat(Mat4d mat) Parameters mat Mat4d SetMat(Mat4d, Mat4d) Set transform matrix. public void SetMat(Mat4d mat, Mat4d matInv) Parameters mat Mat4d transform matrix matInv Mat4d inversed transform matrix" }, "api/Hi.Mech.Topo.StaticRotation.html": { "href": "api/Hi.Mech.Topo.StaticRotation.html", "title": "Class StaticRotation | HiAPI-C# 2025", - "summary": "Class StaticRotation Namespace Hi.Mech.Topo Assembly HiMech.dll Static Rotation. public class StaticRotation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object StaticRotation Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors StaticRotation() Initializes a new instance of the StaticRotation class. public StaticRotation() StaticRotation(Vec3d, double) Ctor. public StaticRotation(Vec3d axis, double angle_rad) Parameters axis Vec3d Axis angle_rad double Angle_rad StaticRotation(Vec3d, double, Vec3d) Ctor. public StaticRotation(Vec3d axis, double angle_rad, Vec3d pivot) Parameters axis Vec3d angle_rad double pivot Vec3d StaticRotation(XElement) Initializes a new instance of the StaticRotation class from XML data. public StaticRotation(XElement src) Parameters src XElement The XML element containing the rotation data. Properties Angle_deg Gets or sets the rotation angle in degrees. public double Angle_deg { get; set; } Property Value double Angle_rad Gets or sets the rotation angle in radians. public double Angle_rad { get; set; } Property Value double Axis Gets or sets the rotation axis. public Vec3d Axis { get; set; } Property Value Vec3d Pivot Gets or sets the pivot point for the rotation. public Vec3d Pivot { get; set; } Property Value Vec3d XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets a new transformer that represents the inverse of this rotation. public ITransformer GetInverseTransformer() Returns ITransformer An inverse transformer instance. GetMat() Gets the transformation matrix representing this rotation. public Mat4d GetMat() Returns Mat4d A 4x4 transformation matrix. GetMatInv() Gets the inverse transformation matrix of this rotation. public Mat4d GetMatInv() Returns Mat4d A 4x4 inverse transformation matrix. MakeXmlSource(string, string) Creates an XML element representing this rotation. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for relative paths. relFile string The relative file path. Returns XElement An XML element containing the rotation data." + "summary": "Class StaticRotation Namespace Hi.Mech.Topo Assembly HiMech.dll Static Rotation. public class StaticRotation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object StaticRotation Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer 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) Constructors StaticRotation() Initializes a new instance of the StaticRotation class. public StaticRotation() StaticRotation(Vec3d, double) Ctor. public StaticRotation(Vec3d axis, double angle_rad) Parameters axis Vec3d Axis angle_rad double Angle_rad StaticRotation(Vec3d, double, Vec3d) Ctor. public StaticRotation(Vec3d axis, double angle_rad, Vec3d pivot) Parameters axis Vec3d angle_rad double pivot Vec3d StaticRotation(XElement) Initializes a new instance of the StaticRotation class from XML data. public StaticRotation(XElement src) Parameters src XElement The XML element containing the rotation data. Properties Angle_deg Gets or sets the rotation angle in degrees. public double Angle_deg { get; set; } Property Value double Angle_rad Gets or sets the rotation angle in radians. public double Angle_rad { get; set; } Property Value double Axis Gets or sets the rotation axis. public Vec3d Axis { get; set; } Property Value Vec3d Pivot Gets or sets the pivot point for the rotation. public Vec3d Pivot { get; set; } Property Value Vec3d XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets a new transformer that represents the inverse of this rotation. public ITransformer GetInverseTransformer() Returns ITransformer An inverse transformer instance. GetMat() Gets the transformation matrix representing this rotation. public Mat4d GetMat() Returns Mat4d A 4x4 transformation matrix. GetMatInv() Gets the inverse transformation matrix of this rotation. public Mat4d GetMatInv() Returns Mat4d A 4x4 inverse transformation matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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." }, "api/Hi.Mech.Topo.StaticTranslation.html": { "href": "api/Hi.Mech.Topo.StaticTranslation.html", "title": "Class StaticTranslation | HiAPI-C# 2025", - "summary": "Class StaticTranslation Namespace Hi.Mech.Topo Assembly HiMech.dll Static Translate. public class StaticTranslation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object StaticTranslation Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors StaticTranslation() Ctor. public StaticTranslation() StaticTranslation(Vec3d) Ctor. public StaticTranslation(Vec3d trans) Parameters trans Vec3d translation StaticTranslation(double, double, double) Ctor. public StaticTranslation(double x, double y, double z) Parameters x double translation x y double translation y z double translation z StaticTranslation(XElement) Ctor. public StaticTranslation(XElement src) Parameters src XElement XML Properties Trans Translation. public Vec3d Trans { get; set; } Property Value Vec3d XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Set(StaticTranslation) Copy from src. public void Set(StaticTranslation src) Parameters src StaticTranslation src ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class StaticTranslation Namespace Hi.Mech.Topo Assembly HiMech.dll Static Translate. public class StaticTranslation : IStaticTransformer, ITransformer, IMakeXmlSource, IGetInverseTransformer Inheritance object StaticTranslation Implements IStaticTransformer ITransformer IMakeXmlSource IGetInverseTransformer Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors StaticTranslation() Ctor. public StaticTranslation() StaticTranslation(Vec3d) Ctor. public StaticTranslation(Vec3d trans) Parameters trans Vec3d translation StaticTranslation(double, double, double) Ctor. public StaticTranslation(double x, double y, double z) Parameters x double translation x y double translation y z double translation z StaticTranslation(XElement) Ctor. public StaticTranslation(XElement src) Parameters src XElement XML Properties Trans Translation. public Vec3d Trans { get; set; } Property Value Vec3d XName Static name. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public ITransformer Clone() Returns ITransformer clone GetInverseTransformer() Gets the inverse transformer of this transformer. public ITransformer GetInverseTransformer() Returns ITransformer The inverse transformer. GetMat() Gets the transform matrix. public Mat4d GetMat() Returns Mat4d The transform matrix. GetMatInv() Gets the inverse transform matrix. public Mat4d GetMatInv() Returns Mat4d The inverse transform matrix. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. Set(StaticTranslation) Copy from src. public void Set(StaticTranslation src) Parameters src StaticTranslation src ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + }, + "api/Hi.Mech.Topo.TopoDisplayee.html": { + "href": "api/Hi.Mech.Topo.TopoDisplayee.html", + "title": "Class TopoDisplayee | HiAPI-C# 2025", + "summary": "Class TopoDisplayee Namespace Hi.Mech.Topo Assembly HiMech.dll Implements a displayable topological element that manages a collection of anchored displayees within an assembly. public class TopoDisplayee : ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList Inheritance object TopoDisplayee Implements ITopo IGetAsmb IGetAnchor IGetTopoIndex IGetAnchoredDisplayeeList Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) 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) Constructors TopoDisplayee(Anchor, Asmb, params IAnchoredDisplayee[]) Initializes a new instance of the TopoDisplayee class with the specified root anchor, assembly, and displayees. public TopoDisplayee(Anchor rootAnchor, Asmb asmb, params IAnchoredDisplayee[] displayees) Parameters rootAnchor Anchor The root anchor for the topological displayee. asmb Asmb The assembly associated with the topological displayee. displayees IAnchoredDisplayee[] The array of anchored displayees to be managed. Properties AnchoredDisplayeeList Gets or sets the list of anchored displayees managed by this instance. public List AnchoredDisplayeeList { get; set; } Property Value List Asmb Gets or sets the assembly associated with this topological displayee. public Asmb Asmb { get; set; } Property Value Asmb RootAnchor Gets or sets the root anchor for this topological displayee. public Anchor RootAnchor { get; set; } Property Value Anchor Methods Display(Bind) public void Display(Bind bind) Parameters bind Bind ExpandToBox3d(Box3d) public void ExpandToBox3d(Box3d dst) Parameters dst Box3d GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb." + }, + "api/Hi.Mech.Topo.TopoDisplayeeUtil.html": { + "href": "api/Hi.Mech.Topo.TopoDisplayeeUtil.html", + "title": "Class TopoDisplayeeUtil | HiAPI-C# 2025", + "summary": "Class TopoDisplayeeUtil Namespace Hi.Mech.Topo Assembly HiMech.dll Provides utility methods for displaying and manipulating topological displayees. public static class TopoDisplayeeUtil Inheritance object TopoDisplayeeUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Display(ITopo, Bind) Displays the topological displayee using the specified bind context. public static void Display(this ITopo src, Bind bind) Parameters src ITopo The topological displayee to display. bind Bind The bind context used for displaying. ExpandToBox3d(ITopo, Box3d) Expands the bounding box to include the topological displayee's geometry. public static void ExpandToBox3d(this ITopo src, Box3d dst) Parameters src ITopo The topological displayee whose geometry should be included. dst Box3d The bounding box to expand." }, "api/Hi.Mech.Topo.TopoReflection.html": { "href": "api/Hi.Mech.Topo.TopoReflection.html", @@ -2182,7 +2307,7 @@ "api/Hi.Mech.Topo.html": { "href": "api/Hi.Mech.Topo.html", "title": "Namespace Hi.Mech.Topo | HiAPI-C# 2025", - "summary": "Namespace Hi.Mech.Topo Classes Anchor A coordinate system using in kinematic chain. AnchorFuncSource Provides an anchor through a function delegate. AnchoredBoxable Represents an object that is both anchored to a root point and can expand to a 3D box. AnchoredDisplayee Represents a displayable object that is anchored to a specific point in a topology. Asmb Collection of Anchor and Asmb. AsmbDraw Render all Anchors of the Asmb in form of CoordinateDrawing. Branch The linkage between two Anchor objects. DirectionBranchPack A data pack contains Branch and a boolean isForward. DirectionBranchPackUtil Utility of topology. DynamicFreeform Dynamic Freeform transformer. DynamicRotation Dynamic rotate transformer. DynamicTranslation Dynamic translate transformer GeneralTransform Represents a general transformation that combines scaling, rotation, and translation. NoTransform Static Identity Transformer. StackTransformer Represents a transformer that maintains a stack of transformations. StaticFreeform Static Freeform transformer. StaticRotation Static Rotation. StaticTranslation Static Translate. TopoReflection Clone Asmb and provide map between source topology and cloned topology. TopoUtil Utility of handling Anchor. TransformerUtil Utility for ITransformer Interfaces IAnchoredDisplayee Interface for objects that can be displayed and are anchored to a root point in a topology. IDynamicRegular Dynamic Regular Transformer IDynamicTransformer Dynamic Transformer. IGetAnchor Interface to get the key Anchor. IGetAnchoredDisplayeeList Interface for getting a list of anchored displayable objects. IGetAsmb Interface of Getting a key Asmb. IGetBuckleAnchorList Interface of GetBuckleAnchorList(). IGetFletchBuckle Interface of GetFletchBuckle(). IGetInverseTransformer Interface for objects that can provide their inverse transformer. IGetRootAnchor Interface of GetRootAnchor(). IGetTopoIndex interface of IGetAnchor or IGetAsmb. IStaticTransformer Static Transformer ITransformer Interface of single transform matrix manipulation. ITransformerProperty Interface for objects that have a transformer property." + "summary": "Namespace Hi.Mech.Topo Classes Anchor A coordinate system using in kinematic chain. AnchorFuncSource Provides an anchor through a function delegate. AnchoredBoxable Represents an object that is both anchored to a root point and can expand to a 3D box. AnchoredDisplayee Represents a displayable object that is anchored to a specific point in a topology. Asmb Collection of Anchor and Asmb. AsmbDraw Render all Anchors of the Asmb in form of CoordinateDrawing. Branch The linkage between two Anchor objects. DirectionBranchPack A data pack contains Branch and a boolean isForward. DirectionBranchPackUtil Utility of topology. DynamicFreeform Dynamic Freeform transformer. DynamicRotation Dynamic rotate transformer. DynamicTranslation Dynamic translate transformer GeneralTransform Represents a general transformation that combines scaling, rotation, and translation. NoTransform Static Identity Transformer. StackTransformer Represents a transformer that maintains a stack of transformations. StaticFreeform Static Freeform transformer. StaticRotation Static Rotation. StaticTranslation Static Translate. TopoDisplayee Implements a displayable topological element that manages a collection of anchored displayees within an assembly. TopoDisplayeeUtil Provides utility methods for displaying and manipulating topological displayees. TopoReflection Clone Asmb and provide map between source topology and cloned topology. TopoUtil Utility of handling Anchor. TransformerUtil Utility for ITransformer Interfaces IAnchoredDisplayee Interface for objects that can be displayed and are anchored to a root point in a topology. IDynamicRegular Dynamic Regular Transformer IDynamicTransformer Dynamic Transformer. IGetAnchor Interface to get the key Anchor. IGetAnchoredDisplayeeList Interface for getting a list of anchored displayable objects. IGetAsmb Interface of Getting a key Asmb. IGetFletchBuckle Interface of GetFletchBuckle(). IGetInverseTransformer Interface for objects that can provide their inverse transformer. IGetTopoIndex interface of IGetAnchor or IGetAsmb. IStaticTransformer Static Transformer ITopo Defines an interface for displaying topological elements that combines assembly, anchoring, and display capabilities. ITopoDisplayee ITransformer Interface of single transform matrix manipulation. ITransformerProperty Interface for objects that have a transformer property." }, "api/Hi.Mech.html": { "href": "api/Hi.Mech.html", @@ -2192,37 +2317,37 @@ "api/Hi.Milling.Apts.AptDerivative.html": { "href": "api/Hi.Milling.Apts.AptDerivative.html", "title": "Class AptDerivative | HiAPI-C# 2025", - "summary": "Class AptDerivative Namespace Hi.Milling.Apts Assembly HiCbtr.dll Apt derivative. public class AptDerivative : IExpandToBox3d, IGetZrContour Inheritance object AptDerivative Implements IExpandToBox3d IGetZrContour 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) Constructors AptDerivative(GeneralApt) Ctor. public AptDerivative(GeneralApt apt) Parameters apt GeneralApt apt Properties Apt Gets the general APT. public GeneralApt Apt { get; } Property Value GeneralApt CosAlpha Gets the cosine of Alpha angle. public double CosAlpha { get; } Property Value double CosBeta Gets the cosine of Beta angle. public double CosBeta { get; } Property Value double Mr Gets the radial coordinate of point M. public double Mr { get; } Property Value double Mz Gets the Z-coordinate of point M. public double Mz { get; } Property Value double Nr Gets the radial coordinate of point N. public double Nr { get; } Property Value double Nz Gets the Z-coordinate of point N. public double Nz { get; } Property Value double SinAlpha Gets the sine of Alpha angle. public double SinAlpha { get; } Property Value double SinBeta Gets the sine of Beta angle. public double SinBeta { get; } Property Value double TanAlpha Gets the tangent of Alpha angle. public double TanAlpha { get; } Property Value double TanBeta Gets the tangent of Beta angle. public double TanBeta { get; } Property Value double Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenStl(int, int) Generate shank stl. public Stl GenStl(int latitudeNum = 8, int longitudeNum = 24) Parameters latitudeNum int latitude number longitudeNum int longitude number Returns Stl shank stl GetNormal(double, double) Get Normal Vector by height and angle. public Vec3d GetNormal(double z, double rad) Parameters z double height rad double x-axis is begin; z-axis is principle Returns Vec3d GetPairZrList(int) Gets a list of Z-R pairs that define the tool profile. public List GetPairZrList(int latitudeNum = 8) Parameters latitudeNum int The number of latitude divisions for the profile. Returns List A list of Z-R coordinate pairs defining the tool profile. GetRadius(double) Get Radius by z. public double GetRadius(double z) Parameters z double z Returns double radius at z GetZrContour(double) Gets Z-R contour data as a list of PairZr objects. The Z values should generally be ordered from smallest to largest. public IList GetZrContour(double latitudeAngleResolution_rad) Parameters latitudeAngleResolution_rad double Resolution of latitude angle in radians Returns IList Z-R contour data as a list of PairZr objects" + "summary": "Class AptDerivative Namespace Hi.Milling.Apts Assembly HiCbtr.dll Apt derivative. public class AptDerivative : IExpandToBox3d, IGetZrContour, IGenStl Inheritance object AptDerivative Implements IExpandToBox3d IGetZrContour IGenStl 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) Constructors AptDerivative(GeneralApt) Ctor. public AptDerivative(GeneralApt apt) Parameters apt GeneralApt apt Properties Apt Gets the general APT. public GeneralApt Apt { get; } Property Value GeneralApt CosAlpha Gets the cosine of Alpha angle. public double CosAlpha { get; } Property Value double CosBeta Gets the cosine of Beta angle. public double CosBeta { get; } Property Value double DefaultPolarResolution2d public static IPolarResolution2d DefaultPolarResolution2d { get; set; } Property Value IPolarResolution2d Mr Gets the radial coordinate of point M. public double Mr { get; } Property Value double Mz Gets the Z-coordinate of point M. public double Mz { get; } Property Value double Nr Gets the radial coordinate of point N. public double Nr { get; } Property Value double Nz Gets the Z-coordinate of point N. public double Nz { get; } Property Value double SinAlpha Gets the sine of Alpha angle. public double SinAlpha { get; } Property Value double SinBeta Gets the sine of Beta angle. public double SinBeta { get; } Property Value double TanAlpha Gets the tangent of Alpha angle. public double TanAlpha { get; } Property Value double TanBeta Gets the tangent of Beta angle. public double TanBeta { get; } Property Value double Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetNormal(double, double) Get Normal Vector by height and angle. public Vec3d GetNormal(double z, double rad) Parameters z double height rad double x-axis is begin; z-axis is principle Returns Vec3d GetRadius(double) Get Radius by z. public double GetRadius(double z) Parameters z double z Returns double radius at z GetZrContour(double) Gets Z-R contour data as a list of PairZr objects. The Z values should generally be ordered from smallest to largest. public IList GetZrContour(double latitudeAngleResolution_rad) Parameters latitudeAngleResolution_rad double Resolution of latitude angle in radians Returns IList Z-R contour data as a list of PairZr objects" }, "api/Hi.Milling.Apts.BallApt.html": { "href": "api/Hi.Milling.Apts.BallApt.html", "title": "Class BallApt | HiAPI-C# 2025", - "summary": "Class BallApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Ball End Apt. public class BallApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate Inheritance object BallApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate 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) Constructors BallApt() Ctor. public BallApt() BallApt(XElement) Ctor. public BallApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class BallApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Ball End Apt. public class BallApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IToXElement Inheritance object BallApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IToXElement 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) Constructors BallApt() Ctor. public BallApt() BallApt(XElement) Ctor. public BallApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Milling.Apts.BullNoseApt.html": { "href": "api/Hi.Milling.Apts.BullNoseApt.html", "title": "Class BullNoseApt | HiAPI-C# 2025", - "summary": "Class BullNoseApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Bull Nose End APT. public class BullNoseApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc Inheritance object BullNoseApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptRc 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) Constructors BullNoseApt() Ctor. public BullNoseApt() BullNoseApt(XElement) Ctor. public BullNoseApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double Rc_mm Round corner radius. public double Rc_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class BullNoseApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Bull Nose End APT. public class BullNoseApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc, IToXElement Inheritance object BullNoseApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptRc IToXElement 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) Constructors BullNoseApt() Ctor. public BullNoseApt() BullNoseApt(XElement) Ctor. public BullNoseApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double Rc_mm Round corner radius. public double Rc_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Milling.Apts.ColumnApt.html": { "href": "api/Hi.Milling.Apts.ColumnApt.html", "title": "Class ColumnApt | HiAPI-C# 2025", - "summary": "Class ColumnApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Column End APT. The composition is identical to the BullNoseApt. However, the nose radius is generally smaller than the BullNoseApt. public class ColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc Inheritance object ColumnApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptRc 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) Constructors ColumnApt() Ctor. public ColumnApt() ColumnApt(XElement) Ctor. public ColumnApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double Rc_mm Round corner radius. public double Rc_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ColumnApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Column End APT. The composition is identical to the BullNoseApt. However, the nose radius is generally smaller than the BullNoseApt. public class ColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRc, IToXElement Inheritance object ColumnApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptRc IToXElement 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) Constructors ColumnApt() Ctor. public ColumnApt() ColumnApt(XElement) Ctor. public ColumnApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double Rc_mm Round corner radius. public double Rc_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Milling.Apts.ConeApt.html": { "href": "api/Hi.Milling.Apts.ConeApt.html", "title": "Class ConeApt | HiAPI-C# 2025", - "summary": "Class ConeApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Cone End APT. public class ConeApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptAlpha Inheritance object ConeApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptAlpha 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) Constructors ConeApt() Ctor. public ConeApt() ConeApt(XElement) Ctor. public ConeApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Alpha_deg Alpha angle in degree. public double Alpha_deg { get; set; } Property Value double Alpha_rad Alpha angle in radian. public double Alpha_rad { get; set; } Property Value double Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ConeApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Cone End APT. public class ConeApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptAlpha, IToXElement Inheritance object ConeApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptAlpha IToXElement 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) Constructors ConeApt() Ctor. public ConeApt() ConeApt(XElement) Ctor. public ConeApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Alpha_deg Alpha angle in degree. public double Alpha_deg { get; set; } Property Value double Alpha_rad Alpha angle in radian. public double Alpha_rad { get; set; } Property Value double Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Milling.Apts.ExactColumnApt.html": { "href": "api/Hi.Milling.Apts.ExactColumnApt.html", "title": "Class ExactColumnApt | HiAPI-C# 2025", - "summary": "Class ExactColumnApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Column End APT. public class ExactColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate Inheritance object ExactColumnApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate 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) Constructors ExactColumnApt() Ctor. public ExactColumnApt() ExactColumnApt(XElement) Ctor. public ExactColumnApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ExactColumnApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Column End APT. public class ExactColumnApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IToXElement Inheritance object ExactColumnApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IToXElement 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) Constructors ExactColumnApt() Ctor. public ExactColumnApt() ExactColumnApt(XElement) Ctor. public ExactColumnApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Flute Height. public double FluteHeight_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Milling.Apts.GeneralApt.html": { "href": "api/Hi.Milling.Apts.GeneralApt.html", "title": "Class GeneralApt | HiAPI-C# 2025", - "summary": "Class GeneralApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll APT standard milling cutter geometry. public class GeneralApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IEquatable, IAptRc, IAptRr, IAptRz, IAptAlpha, IAptBeta, IGetZrContour Inheritance object GeneralApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IEquatable IAptRc IAptRr IAptRz IAptAlpha IAptBeta IGetZrContour 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeneralApt() Ctor. public GeneralApt() GeneralApt(GeneralApt) Copy ctor. public GeneralApt(GeneralApt src) Parameters src GeneralApt src GeneralApt(double, double, double, double, double, double, double) Ctor. public GeneralApt(double D, double R0, double Rr, double Rz, double alpha_rad, double beta_rad, double fluteH) Parameters D double see Diameter_mm R0 double see Rc_mm Rr double see Rr_mm Rz double see Rz_mm alpha_rad double see Alpha_rad beta_rad double see Beta_rad fluteH double see FluteHeight_mm GeneralApt(XElement) Ctor. public GeneralApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Alpha_deg Alpha_rad in degree. public double Alpha_deg { get; set; } Property Value double Alpha_rad The angle between horizontal plane and the cone surface of the cutter tip. The angle is downside the cutter round (if exists). If the cutter is cylindrical mill, the angle is 0. The unit is radian. public double Alpha_rad { get; set; } Property Value double AptDerivative Gets the APT derivative object, creating it if it doesn't exist. public AptDerivative AptDerivative { get; } Property Value AptDerivative Beta_deg Beta_rad in degree. public double Beta_deg { get; set; } Property Value double Beta_rad The angle between stick axis and the side plane of cutter. The angle is upside the cutter round (if exists). The unit is radian. public double Beta_rad { get; set; } Property Value double Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Full Height. public double FluteHeight_mm { get; set; } Property Value double Rc_mm Round radius. public double Rc_mm { get; set; } Property Value double Rr_mm Distance between round center to the stick axis. public double Rr_mm { get; set; } Property Value double Rz_mm Center between the tip to the round center. public double Rz_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache of APT derivative. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object Equals(GeneralApt) Indicates whether the current object is equal to another object of the same type. public bool Equals(GeneralApt src) Parameters src GeneralApt Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenStl(int, int) Generate shank stl. public Stl GenStl(int latitudeNum = 8, int longtitudeNum = 24) Parameters latitudeNum int latitude number longtitudeNum int longtitude number Returns Stl shank stl GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetZrContour(double) Gets Z-R contour data as a list of PairZr objects. The Z values should generally be ordered from smallest to largest. public IList GetZrContour(double latitudeAngleResolution_rad) Parameters latitudeAngleResolution_rad double Resolution of latitude angle in radians Returns IList Z-R contour data as a list of PairZr objects MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class GeneralApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll APT standard milling cutter geometry. public class GeneralApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IEquatable, IAptRc, IAptRr, IAptRz, IAptAlpha, IAptBeta, IGetZrContour, IToXElement, IGenStl, IClearCache Inheritance object GeneralApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IEquatable IAptRc IAptRr IAptRz IAptAlpha IAptBeta IGetZrContour IToXElement IGenStl IClearCache 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeneralApt() Ctor. public GeneralApt() GeneralApt(GeneralApt) Copy ctor. public GeneralApt(GeneralApt src) Parameters src GeneralApt src GeneralApt(double, double, double, double, double, double, double) Ctor. public GeneralApt(double D, double R0, double Rr, double Rz, double alpha_rad, double beta_rad, double fluteH) Parameters D double see Diameter_mm R0 double see Rc_mm Rr double see Rr_mm Rz double see Rz_mm alpha_rad double see Alpha_rad beta_rad double see Beta_rad fluteH double see FluteHeight_mm GeneralApt(XElement) Ctor. public GeneralApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Alpha_deg Alpha_rad in degree. public double Alpha_deg { get; set; } Property Value double Alpha_rad The angle between horizontal plane and the cone surface of the cutter tip. The angle is downside the cutter round (if exists). If the cutter is cylindrical mill, the angle is 0. The unit is radian. public double Alpha_rad { get; set; } Property Value double AptDerivative Gets the APT derivative object, creating it if it doesn't exist. public AptDerivative AptDerivative { get; } Property Value AptDerivative Beta_deg Beta_rad in degree. public double Beta_deg { get; set; } Property Value double Beta_rad The angle between stick axis and the side plane of cutter. The angle is upside the cutter round (if exists). The unit is radian. public double Beta_rad { get; set; } Property Value double Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Full Height. public double FluteHeight_mm { get; set; } Property Value double Rc_mm Round radius. public double Rc_mm { get; set; } Property Value double Rr_mm Distance between round center to the stick axis. public double Rr_mm { get; set; } Property Value double Rz_mm Center between the tip to the round center. public double Rz_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache of APT derivative. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object Equals(GeneralApt) Indicates whether the current object is equal to another object of the same type. public bool Equals(GeneralApt src) Parameters src GeneralApt Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d polarResolution) Parameters polarResolution IPolarResolution2d Returns Stl newly created Stl GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetZrContour(double) Gets Z-R contour data as a list of PairZr objects. The Z values should generally be ordered from smallest to largest. public IList GetZrContour(double latitudeAngleResolution_rad) Parameters latitudeAngleResolution_rad double Resolution of latitude angle in radians Returns IList Z-R contour data as a list of PairZr objects 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Milling.Apts.IAptAlpha.html": { "href": "api/Hi.Milling.Apts.IAptAlpha.html", @@ -2232,7 +2357,7 @@ "api/Hi.Milling.Apts.IAptBased.html": { "href": "api/Hi.Milling.Apts.IAptBased.html", "title": "Interface IAptBased | HiAPI-C# 2025", - "summary": "Interface IAptBased Namespace Hi.Milling.Apts Assembly HiCbtr.dll Interface for APT-based objects. public interface IAptBased : IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate Inherited Members IGetGeneralApt.GetGeneralApt() IAbstractNote.AbstractNote IExpandToBox3d.ExpandToBox3d(Box3d) IMakeXmlSource.MakeXmlSource(string, string) IDuplicate.Duplicate(params object[]) 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) Properties Diameter_mm Diameter in mm. double Diameter_mm { get; set; } Property Value double FluteHeight_mm Height of flute. double FluteHeight_mm { get; set; } Property Value double Methods ClearCache() Clears the internal cache. void ClearCache()" + "summary": "Interface IAptBased Namespace Hi.Milling.Apts Assembly HiCbtr.dll Interface for APT-based objects. public interface IAptBased : IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate Inherited Members IGetGeneralApt.GetGeneralApt() IAbstractNote.AbstractNote IExpandToBox3d.ExpandToBox3d(Box3d) IMakeXmlSource.MakeXmlSource(string, string, bool) IDuplicate.Duplicate(params object[]) 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) Properties Diameter_mm Diameter in mm. double Diameter_mm { get; set; } Property Value double FluteHeight_mm Height of flute. double FluteHeight_mm { get; set; } Property Value double" }, "api/Hi.Milling.Apts.IAptBeta.html": { "href": "api/Hi.Milling.Apts.IAptBeta.html", @@ -2267,7 +2392,7 @@ "api/Hi.Milling.Apts.TaperApt.html": { "href": "api/Hi.Milling.Apts.TaperApt.html", "title": "Class TaperApt | HiAPI-C# 2025", - "summary": "Class TaperApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Taper End APT. public class TaperApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRz, IAptAlpha, IAptBeta Inheritance object TaperApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptRz IAptAlpha IAptBeta 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) Constructors TaperApt() Ctor. public TaperApt() TaperApt(XElement) Ctor. public TaperApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Alpha_deg Alpha_rad in degree. public double Alpha_deg { get; set; } Property Value double Alpha_rad The angle between horizontal plane and the cone surface of the cutter tip. The angle is downside the cutter round (if exists). If the cutter is cylindrical mill, the angle is 0. The unit is radian. public double Alpha_rad { get; set; } Property Value double Beta_deg Beta_rad in degree. public double Beta_deg { get; set; } Property Value double Beta_rad The angle between stick axis and the side plane of cutter. The angle is upside the cutter round (if exists). The unit is radian. public double Beta_rad { get; set; } Property Value double Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Height of flute. public double FluteHeight_mm { get; set; } Property Value double Rz_mm Center between the tip to the round center. public double Rz_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears the internal cache. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class TaperApt Namespace Hi.Milling.Apts Assembly HiCbtr.dll Taper End APT. public class TaperApt : IAptBased, IGetGeneralApt, IAbstractNote, IGetDiameter, IGetFluteHeight, IExpandToBox3d, IMakeXmlSource, IDuplicate, IAptRz, IAptAlpha, IAptBeta, IToXElement Inheritance object TaperApt Implements IAptBased IGetGeneralApt IAbstractNote IGetDiameter IGetFluteHeight IExpandToBox3d IMakeXmlSource IDuplicate IAptRz IAptAlpha IAptBeta IToXElement 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) Constructors TaperApt() Ctor. public TaperApt() TaperApt(XElement) Ctor. public TaperApt(XElement src) Parameters src XElement XML Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Alpha_deg Alpha_rad in degree. public double Alpha_deg { get; set; } Property Value double Alpha_rad The angle between horizontal plane and the cone surface of the cutter tip. The angle is downside the cutter round (if exists). If the cutter is cylindrical mill, the angle is 0. The unit is radian. public double Alpha_rad { get; set; } Property Value double Beta_deg Beta_rad in degree. public double Beta_deg { get; set; } Property Value double Beta_rad The angle between stick axis and the side plane of cutter. The angle is upside the cutter round (if exists). The unit is radian. public double Beta_rad { get; set; } Property Value double Diameter_mm Diameter. public double Diameter_mm { get; set; } Property Value double FluteHeight_mm Height of flute. public double FluteHeight_mm { get; set; } Property Value double Rz_mm Center between the tip to the round center. public double Rz_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetGeneralApt() Get Apt. public GeneralApt GetGeneralApt() Returns GeneralApt Apt 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Milling.Apts.apt_t.html": { "href": "api/Hi.Milling.Apts.apt_t.html", @@ -2282,17 +2407,17 @@ "api/Hi.Milling.Cutters.AptProfile.html": { "href": "api/Hi.Milling.Cutters.AptProfile.html", "title": "Class AptProfile | HiAPI-C# 2025", - "summary": "Class AptProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. This profile uses APT definitions to describe the cutter geometry. Internal Use Only public class AptProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IGetSelectionName, IGetInitStickConvex, IVolumeRemover, IDisposable, IUpdateByContent, IClearCache Inheritance object AptProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetStl IGetZrList IDuplicate IGetSelectionName IGetInitStickConvex IVolumeRemover IDisposable IUpdateByContent IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors AptProfile(MillingCutter) Initializes a new instance of the AptProfile class. public AptProfile(MillingCutter host) Parameters host MillingCutter The milling cutter that hosts this profile. AptProfile(MillingCutter, IAptBased) Initializes a new instance of the AptProfile class. public AptProfile(MillingCutter host, IAptBased apt) Parameters host MillingCutter The milling cutter that hosts this profile. apt IAptBased The APT-based object. AptProfile(XElement, string, MillingCutter) Initializes a new instance of the AptProfile class. public AptProfile(XElement src, string baseDirectory, MillingCutter host) Parameters src XElement XML element containing the profile configuration. baseDirectory string The base directory for resolving relative paths. host MillingCutter The milling cutter that hosts this profile. Properties AbstractNote Gets the abstract note from the APT definition. Internal Use Only public string AbstractNote { get; } Property Value string Apt Gets or sets the APT-based definition for the profile. Internal Use Only public IAptBased Apt { get; set; } Property Value IAptBased Host Gets or sets the associated milling cutter. Internal Use Only public MillingCutter Host { get; set; } Property Value MillingCutter XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears all cached data. Internal Use Only public void ClearCache() Dispose() Disposes of all resources. Internal Use Only public void Dispose() Dispose(bool) Disposes of unmanaged resources. Internal Use Only protected virtual void Dispose(bool disposing) Parameters disposing bool True if disposing, false if finalizing Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetInitStickConvex() Gets the initial stick convex representation of the profile. Internal Use Only public InitStickConvex GetInitStickConvex() Returns InitStickConvex The initial stick convex representation GetSelectionName() Gets the display name for selection. Internal Use Only public string GetSelectionName() Returns string The display name GetStl() Gets the STL mesh representation of the profile. Internal Use Only public Stl GetStl() Returns Stl The STL mesh GetZrList() Gets the ZR contour list for the profile. Internal Use Only public List GetZrList() Returns List The list of ZR pairs MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByContent() Updates the profile based on content changes. Internal Use Only public void UpdateByContent()" + "summary": "Class AptProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. This profile uses APT definitions to describe the cutter geometry. public class AptProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IGetSelectionName, IGetInitStickConvex, IVolumeRemover, IDisposable, IUpdateByContent, IClearCache, IPolarResolution2dSourceProperty Inheritance object AptProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetZrList IGenStl IGetStl IDuplicate IGetSelectionName IGetInitStickConvex IVolumeRemover IDisposable IUpdateByContent IClearCache IPolarResolution2dSourceProperty Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors AptProfile() Initializes a new instance of the AptProfile class. public AptProfile() AptProfile(IAptBased) Initializes a new instance of the AptProfile class. public AptProfile(IAptBased apt) Parameters apt IAptBased The APT-based object. AptProfile(XElement, string) Initializes a new instance of the AptProfile class. public AptProfile(XElement src, string baseDirectory) Parameters src XElement XML element containing the profile configuration. baseDirectory string The base directory for resolving relative paths. Properties AbstractNote Gets the abstract note from the APT definition. public string AbstractNote { get; } Property Value string Apt Gets or sets the APT-based definition for the profile. public IAptBased Apt { get; set; } Property Value IAptBased DefaultAngleResolution_rad Gets or sets the default angle resolution in radians. public static double DefaultAngleResolution_rad { get; set; } Property Value double DefaultLinearResolution_mm Gets or sets the default linear resolution in millimeters. public static double DefaultLinearResolution_mm { get; set; } Property Value double PolarResolution2dSource public Func PolarResolution2dSource { get; set; } Property Value Func XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears all cached data. public void ClearCache() Dispose() Disposes of all resources. public void Dispose() Dispose(bool) Disposes of unmanaged resources. protected virtual void Dispose(bool disposing) Parameters disposing bool True if disposing, false if finalizing Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetInitStickConvex() Gets the initial stick convex representation of the profile. public InitStickConvex GetInitStickConvex() Returns InitStickConvex The initial stick convex representation GetSelectionName() Gets the display name for selection. public string GetSelectionName() Returns string The display name GetStl() Gets the STL mesh representation of the profile. public Stl GetStl() Returns Stl The STL mesh GetZrList() Gets the ZR contour list for the profile. public List GetZrList() Returns List The list of ZR pairs 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. UpdateByContent() Updates the profile based on content changes. public void UpdateByContent()" }, "api/Hi.Milling.Cutters.ConstRatioProfile.html": { "href": "api/Hi.Milling.Cutters.ConstRatioProfile.html", "title": "Class ConstRatioProfile | HiAPI-C# 2025", - "summary": "Class ConstRatioProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a constant ratio profile for a milling cutter. This profile maintains a constant ratio between inner and outer radii. Internal Use Only public class ConstRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache Inheritance object ConstRatioProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetStl IGetZrList IDuplicate IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors ConstRatioProfile(MillingCutter) Initializes a new instance of the ConstRatioProfile class. Internal Use Only public ConstRatioProfile(MillingCutter millingCutter) Parameters millingCutter MillingCutter The associated milling cutter ConstRatioProfile(MillingCutter, double) Initializes a new instance of the ConstRatioProfile class with a specified radius ratio. Internal Use Only public ConstRatioProfile(MillingCutter millingCutter, double innerRadiusRatio) Parameters millingCutter MillingCutter The associated milling cutter innerRadiusRatio double The ratio between inner and outer radii ConstRatioProfile(XElement, string, MillingCutter) Initializes a new instance of the ConstRatioProfile class. public ConstRatioProfile(XElement element, string baseDirectory, MillingCutter host) Parameters element XElement The XML element containing profile data. baseDirectory string The base directory for resolving relative paths. host MillingCutter The host milling cutter. Properties AbstractNote Gets the abstract note describing the profile. Internal Use Only public string AbstractNote { get; } Property Value string MillingCutter Gets or sets the associated milling cutter. Internal Use Only public MillingCutter MillingCutter { get; set; } Property Value MillingCutter RadiusRatio Gets or sets the ratio between inner and outer radii. Internal Use Only public double RadiusRatio { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ConstRatioProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a constant ratio profile for a milling cutter. This profile maintains a constant ratio between inner and outer radii. public class ConstRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGetStl, IDuplicate, IClearCache, IGenStl, IZrListSourceProperty Inheritance object ConstRatioProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetZrList IGetStl IDuplicate IClearCache IGenStl IZrListSourceProperty Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors ConstRatioProfile() Initializes a new instance of the ConstRatioProfile class. public ConstRatioProfile() ConstRatioProfile(double) Initializes a new instance of the ConstRatioProfile class with a specified radius ratio. public ConstRatioProfile(double innerRadiusRatio) Parameters innerRadiusRatio double The ratio between inner and outer radii ConstRatioProfile(XElement, string) Initializes a new instance of the ConstRatioProfile class. public ConstRatioProfile(XElement element, string baseDirectory) Parameters element XElement The XML element containing profile data. baseDirectory string The base directory for resolving relative paths. Properties AbstractNote Gets the abstract note describing the profile. public string AbstractNote { get; } Property Value string RadiusRatio Gets or sets the ratio between inner and outer radii. public double RadiusRatio { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZrListSource Get base geometry source. Runtime property. public Func ZrListSource { get; set; } Property Value Func Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. 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." }, "api/Hi.Milling.Cutters.CustomSpinningProfile.html": { "href": "api/Hi.Milling.Cutters.CustomSpinningProfile.html", "title": "Class CustomSpinningProfile | HiAPI-C# 2025", - "summary": "Class CustomSpinningProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a custom spinning profile for a milling cutter. This profile allows for custom geometry to be used as the cutter profile. Internal Use Only public class CustomSpinningProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache Inheritance object CustomSpinningProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetStl IGetZrList IDuplicate IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors CustomSpinningProfile(MillingCutter) Ctor public CustomSpinningProfile(MillingCutter host) Parameters host MillingCutter CustomSpinningProfile(XElement, string, MillingCutter, params object[]) Initializes a new instance of the CustomSpinningProfile class. public CustomSpinningProfile(XElement element, string baseDirectory, MillingCutter host, params object[] res) Parameters element XElement The XML element containing profile data. baseDirectory string The base directory for resolving relative paths. host MillingCutter The host milling cutter. res object[] Additional resolution parameters. Properties AbstractNote Gets the abstract note describing the profile. Internal Use Only public string AbstractNote { get; } Property Value string Geom Gets or sets the geometry that defines the profile. Internal Use Only public IGetStl Geom { get; set; } Property Value IGetStl Host Gets or sets the associated milling cutter. Internal Use Only public MillingCutter Host { get; set; } Property Value MillingCutter XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data. Internal Use Only public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetStl() Gets the STL mesh representation of the profile. Internal Use Only public Stl GetStl() Returns Stl The STL mesh GetZrList() Gets the ZR contour list for the profile. This method attempts to get the ZR list from various geometry types. Internal Use Only public List GetZrList() Returns List The list of ZR pairs MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CustomSpinningProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a custom spinning profile for a milling cutter. This profile allows for custom geometry to be used as the cutter profile. public class CustomSpinningProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache, IPolarResolution2dSourceProperty Inheritance object CustomSpinningProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetZrList IGenStl IGetStl IDuplicate IClearCache IPolarResolution2dSourceProperty Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors CustomSpinningProfile(IGetStl) Ctor public CustomSpinningProfile(IGetStl geom) Parameters geom IGetStl CustomSpinningProfile(XElement, string, params object[]) Initializes a new instance of the CustomSpinningProfile class. public CustomSpinningProfile(XElement element, string baseDirectory, params object[] res) Parameters element XElement The XML element containing profile data. baseDirectory string The base directory for resolving relative paths. res object[] Additional resolution parameters. Properties AbstractNote Gets the abstract note describing the profile. public string AbstractNote { get; } Property Value string Geom Gets or sets the geometry that defines the profile. public IGetStl Geom { get; set; } Property Value IGetStl PolarResolution2dSource public Func PolarResolution2dSource { get; set; } Property Value Func XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetStl() Gets the STL mesh representation of the profile. public Stl GetStl() Returns Stl The STL mesh GetZrList() Gets the ZR contour list for the profile. This method attempts to get the ZR list from various geometry types. public List GetZrList() Returns List The list of ZR pairs 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." }, "api/Hi.Milling.Cutters.CutterUtil.html": { "href": "api/Hi.Milling.Cutters.CutterUtil.html", @@ -2302,17 +2427,17 @@ "api/Hi.Milling.Cutters.FluteContourDisplayee.html": { "href": "api/Hi.Milling.Cutters.FluteContourDisplayee.html", "title": "Class FluteContourDisplayee | HiAPI-C# 2025", - "summary": "Class FluteContourDisplayee Namespace Hi.Milling.Cutters Assembly HiMech.dll Provides display functionality for flute contours in milling cutters. This class handles the visualization of both front and back surfaces of flute contours. Internal Use Only public class FluteContourDisplayee : IDisplayee, IExpandToBox3d, IClearCache, IDisposable Inheritance object FluteContourDisplayee Implements IDisplayee IExpandToBox3d IClearCache 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) Constructors FluteContourDisplayee(Func, FluteContour) Initializes a new instance of the FluteContourDisplayee class. Internal Use Only public FluteContourDisplayee(Func millingCutterHost, FluteContour fluteContour) Parameters millingCutterHost Func The function that provides the host milling cutter. fluteContour FluteContour The flute contour to be displayed. Properties FluteContour Gets or sets the flute contour to be displayed. Internal Use Only public FluteContour FluteContour { get; set; } Property Value FluteContour MillingCutterHost Gets or sets the function that provides the host milling cutter. Internal Use Only public Func MillingCutterHost { get; set; } Property Value Func Methods ClearCache() Clears the cached display data. Internal Use Only public void ClearCache() Display(Bind) Displays the flute contour using the specified binding. Internal Use Only public void Display(Bind bind) Parameters bind Bind The display binding to use. Dispose() Disposes of all resources. Internal Use Only public void Dispose() Dispose(bool) Disposes of unmanaged resources. Internal Use Only protected virtual void Dispose(bool disposing) Parameters disposing bool True if disposing, false if finalizing ExpandToBox3d(Box3d) Expands the destination box to include the bounds of this displayee. Internal Use Only public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand." + "summary": "Class FluteContourDisplayee Namespace Hi.Milling.Cutters Assembly HiMech.dll Provides display functionality for flute contours in milling cutters. This class handles the visualization of both front and back surfaces of flute contours. Internal Use Only public class FluteContourDisplayee : IDisplayee, IExpandToBox3d, IClearCache, IDisposable Inheritance object FluteContourDisplayee Implements IDisplayee IExpandToBox3d IClearCache IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors FluteContourDisplayee(Func, FluteContour) Initializes a new instance of the FluteContourDisplayee class. Internal Use Only public FluteContourDisplayee(Func millingCutterHost, FluteContour fluteContour) Parameters millingCutterHost Func The function that provides the host milling cutter. fluteContour FluteContour The flute contour to be displayed. Properties FluteContour Gets or sets the flute contour to be displayed. Internal Use Only public FluteContour FluteContour { get; set; } Property Value FluteContour MillingCutterHost Gets or sets the function that provides the host milling cutter. Internal Use Only public Func MillingCutterHost { get; set; } Property Value Func Methods ClearCache() Clears the cached display data. Internal Use Only public void ClearCache() Display(Bind) Displays the flute contour using the specified binding. Internal Use Only public void Display(Bind bind) Parameters bind Bind The display binding to use. Dispose() Disposes of all resources. Internal Use Only public void Dispose() Dispose(bool) Disposes of unmanaged resources. Internal Use Only protected virtual void Dispose(bool disposing) Parameters disposing bool True if disposing, false if finalizing ExpandToBox3d(Box3d) Expands the destination box to include the bounds of this displayee. Internal Use Only public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The box to expand." }, "api/Hi.Milling.Cutters.FluteDependentRatioProfile.html": { "href": "api/Hi.Milling.Cutters.FluteDependentRatioProfile.html", "title": "Class FluteDependentRatioProfile | HiAPI-C# 2025", - "summary": "Class FluteDependentRatioProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a flute number dependent ratio profile for a milling cutter. This profile determines the ratio between inner and outer radii based on the number of flutes. Internal Use Only public class FluteDependentRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache Inheritance object FluteDependentRatioProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetStl IGetZrList IDuplicate IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors FluteDependentRatioProfile(MillingCutter) Initializes a new instance of the FluteDependentRatioProfile class. Internal Use Only public FluteDependentRatioProfile(MillingCutter millingCutter) Parameters millingCutter MillingCutter The associated milling cutter FluteDependentRatioProfile(XElement, string, MillingCutter) Initializes a new instance of the FluteDependentRatioProfile class. public FluteDependentRatioProfile(XElement element, string baseDirectory, MillingCutter host) Parameters element XElement The XML element containing profile data. baseDirectory string The base directory for resolving relative paths. host MillingCutter The host milling cutter. Properties AbstractNote Gets the abstract note describing the profile. Internal Use Only public string AbstractNote { get; } Property Value string MillingCutter Gets or sets the associated milling cutter. Internal Use Only public MillingCutter MillingCutter { get; set; } Property Value MillingCutter RadiusRatio Gets the radius ratio based on the current number of flutes. Internal Use Only public double RadiusRatio { get; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FluteDependentRatioProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a flute number dependent ratio profile for a milling cutter. This profile determines the ratio between inner and outer radii based on the number of flutes. public class FluteDependentRatioProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache, IFluteNumSourceProperty, IZrListSourceProperty Inheritance object FluteDependentRatioProfile Implements IShaperProfile IMakeXmlSource IAbstractNote IGetZrList IGenStl IGetStl IDuplicate IClearCache IFluteNumSourceProperty IZrListSourceProperty Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors FluteDependentRatioProfile() Initializes a new instance. public FluteDependentRatioProfile() FluteDependentRatioProfile(XElement, string) Initializes a new instance of the FluteDependentRatioProfile class. public FluteDependentRatioProfile(XElement element, string baseDirectory) Parameters element XElement The XML element containing profile data. baseDirectory string The base directory for resolving relative paths. Properties AbstractNote Gets the abstract note describing the profile. public string AbstractNote { get; } Property Value string FluteNumSource public Func FluteNumSource { get; set; } Property Value Func RadiusRatio Gets the radius ratio based on the current number of flutes. public double RadiusRatio { get; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZrListSource Get base geometry source. Runtime property. public Func ZrListSource { get; set; } Property Value Func Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GenStl(IPolarResolution2d) Generate a new Stl. public Stl GenStl(IPolarResolution2d resolution) Parameters resolution IPolarResolution2d Returns Stl newly created Stl GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. 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." }, "api/Hi.Milling.Cutters.IShaperProfile.html": { "href": "api/Hi.Milling.Cutters.IShaperProfile.html", "title": "Interface IShaperProfile | HiAPI-C# 2025", - "summary": "Interface IShaperProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Interface defining the shape profile of a cutter flute. The cutter flute must also inherit IGetInitStickConvex or IGetSweptable. Internal Use Only public interface IShaperProfile : IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache Inherited Members IMakeXmlSource.MakeXmlSource(string, string) IAbstractNote.AbstractNote IGetStl.GetStl() IGetZrList.GetZrList() IDuplicate.Duplicate(params object[]) IClearCache.ClearCache() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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 This interface combines multiple capabilities: XML serialization (IMakeXmlSource) Abstract note support (IAbstractNote) STL mesh generation (IGetStl) ZR list generation (IGetZrList) Object duplication (IDuplicate) Cache management (IClearCache)" + "summary": "Interface IShaperProfile Namespace Hi.Milling.Cutters Assembly HiMech.dll Interface defining the shape profile of a cutter flute. public interface IShaperProfile : IMakeXmlSource, IAbstractNote, IGetZrList, IGenStl, IGetStl, IDuplicate, IClearCache Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) IAbstractNote.AbstractNote IGetZrList.GetZrList() IGenStl.GenStl(IPolarResolution2d) IGetStl.GetStl() IDuplicate.Duplicate(params object[]) IClearCache.ClearCache() Extension Methods StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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)" }, "api/Hi.Milling.Cutters.MillingCutter.IntegralModeEnum.html": { "href": "api/Hi.Milling.Cutters.MillingCutter.IntegralModeEnum.html", @@ -2327,17 +2452,22 @@ "api/Hi.Milling.Cutters.MillingCutter.html": { "href": "api/Hi.Milling.Cutters.MillingCutter.html", "title": "Class MillingCutter | HiAPI-C# 2025", - "summary": "Class MillingCutter Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a milling cutter with its geometric and physical properties. public class MillingCutter : ICutter, IGetSweptable, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IDisposable, IGetFluteHeight, IUpdateByContent, IClearCache, IGetThermalLayerList, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IDuplicate, IGetInitStickConvex, IVolumeRemover, ILinearAndRoundStlResolutionHost, IGetZrList Inheritance object MillingCutter Implements ICutter IGetSweptable IGetFletchBuckle IMakeXmlSource IAbstractNote IAnchoredCollidableStem IAnchoredCollidableNode IAnchoredCollidableBased IDisposable IGetFluteHeight IUpdateByContent IClearCache IGetThermalLayerList ITopoDisplayee IGetAsmb IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IGetAnchoredDisplayeeList IDuplicate IGetInitStickConvex IVolumeRemover ILinearAndRoundStlResolutionHost IGetZrList Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) CutterUtil.GetCutterBodyCoolingArea_mm2(ICutter) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MillingTemperatureUtil.GetMaterial(IGetThermalLayerList, double) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks The cutter can be solid end or insert end. The term “Flute” is the edge part of the solid end cutter or the full insert of the insert end body. The term “Shank” is the full part except for edge part (i.e. Flute) of the solid end cutter. Shank and Flute compose the full cutter. Constructors MillingCutter() Initializes a new instance of the MillingCutter class. public MillingCutter() MillingCutter(XElement, string, string, params object[]) Ctor. public MillingCutter(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths relFile string Relative file path res object[] Additional optional resources Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string AngleResolution_deg AngleResolution_deg. Call ClearCache() after setting the property. public double AngleResolution_deg { get; set; } Property Value double AngleResolution_rad AngleResolution_rad. Call ClearCache() after setting the property. public double AngleResolution_rad { get; set; } Property Value double CoatingLayerList Gets or sets the list of coating thermal layers. public List CoatingLayerList { get; set; } Property Value List CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CutterTip Gets the anchor point at the cutter tip. public Anchor CutterTip { get; } Property Value Anchor DefaultAngleResolution_rad Gets or sets the default angle resolution in radians. public static double DefaultAngleResolution_rad { get; set; } Property Value double DefaultLinearResolution_mm Gets or sets the default linear resolution in millimeters. public static double DefaultLinearResolution_mm { get; set; } Property Value double DefaultStlLongitudeNum Gets or sets the default number of longitude lines for STL generation. public static int DefaultStlLongitudeNum { get; set; } Property Value int EffectiveCuttingDiameter_mm Cutting Diameter for calculate cutting speed. public double EffectiveCuttingDiameter_mm { get; } Property Value double ExposedHeight_mm Has to be simultanous with ExposedCutterHeight_mm. public double ExposedHeight_mm { get; set; } Property Value double FluteContourTray Gets or sets the flute contour tray that defines the flute geometry. public IContourTray FluteContourTray { get; set; } Property Value IContourTray FluteHeight_mm Gets the height of the flute in millimeters. public double FluteHeight_mm { get; } Property Value double FluteMaterial Material of the flute. public CutterMaterial FluteMaterial { get; set; } Property Value CutterMaterial FluteMaterialFile Gets or sets the file path for the flute material definition. public string FluteMaterialFile { get; set; } Property Value string FullHeight_mm Gets the full height of the cutter in millimeters. public double FullHeight_mm { get; } Property Value double HoneRadius_mm Gets or sets the hone radius in millimeters. public double HoneRadius_mm { get; set; } Property Value double HoneRadius_um Gets the hone radius in micrometers. public double HoneRadius_um { get; set; } Property Value double InnerBeamProfile Gets or sets the inner beam profile. public IShaperProfile InnerBeamProfile { get; set; } Property Value IShaperProfile Remarks InnerBeamProfile may be dependent on ShaperProfile. InnerBeamProfile.ClearCache() and initialization must be performed after ShaperProfile.ClearCache() and initialization. InsertNum Gets or sets Insert Number. The property should be used Only if IntegralMode is InsertEnd. However, there is no exception mechanism. public int InsertNum { get; set; } Property Value int InsertThickness_mm Thickness of an insert. Only available if the cutter is InsertEnd. public double InsertThickness_mm { get; set; } Property Value double IntegralMode Gets or sets the main integral mode of the cutter. public MillingCutter.IntegralModeEnum IntegralMode { get; set; } Property Value MillingCutter.IntegralModeEnum IsSpinningCutter Is cutter spining when machining. public bool IsSpinningCutter { get; } Property Value bool Is cutter spining when machining. LinearResolution_mm LinearResolution_mm. Call ClearCache() after setting the property. public double LinearResolution_mm { get; set; } Property Value double MillingCutterOptLimit public MillingCutterOptLimit MillingCutterOptLimit { get; set; } Property Value MillingCutterOptLimit ReliefAngle_deg Gets or sets the relief angle in degrees. public double ReliefAngle_deg { get; set; } Property Value double ReliefAngle_rad Gets or sets the relief angle in radians. public double ReliefAngle_rad { get; set; } Property Value double ShankMassAssignmentMode Gets or sets the mass assignment mode for the shank. public MillingCutter.MassAssignmentMode ShankMassAssignmentMode { get; set; } Property Value MillingCutter.MassAssignmentMode ShankMass_g Gets or sets the cutter shank mass in grams. If IntegralMode is SolidEnd, the mass is the full cutter mass. since the flute mass is assumed small and dynamic depends on the CWE (Cutter-Workpiece-Engagement). public double ShankMass_g { get; set; } Property Value double ShankMaterial Material of the shank. It should be the same with FluteMaterial if the cutter is SolidEnd. public IStructureMaterial ShankMaterial { get; set; } Property Value IStructureMaterial ShankMaterialFile Gets or sets the file path for the shank material definition. It should be the same with FluteMaterialFile if the cutter is SolidEnd. public string ShankMaterialFile { get; set; } Property Value string ShaperProfile Gets or sets the shaper profile that defines the cutter's shape. public IShaperProfile ShaperProfile { get; set; } Property Value IShaperProfile ShaperTopoBrick cutable part of cutter. the part cut the workpiece if overlapped. public ITopoBrick ShaperTopoBrick { get; } Property Value ITopoBrick SingleInsertMass_g Gets or sets the total inserts' mass in grams. The property should be used Only if IntegralMode is InsertEnd. However, there is no exception mechanism. public double SingleInsertMass_g { get; set; } Property Value double StlLongitudeNum Stl Longitude Num. Dependent property form LinearResolution_mm and AngleResolution_rad. public int StlLongitudeNum { get; } Property Value int SumInsertMass_g Gets the total mass of all inserts in grams calculated from SingleInsertMass_g * InsertNum. public double SumInsertMass_g { get; } Property Value double SurfaceMaterial Gets the surface material of the cutter. public CutterMaterial SurfaceMaterial { get; } Property Value CutterMaterial UpperBeamGeom Gets the upper beam geometry of the cutter. public IGetStl UpperBeamGeom { get; set; } Property Value IGetStl UpperBeamTopoBrick uncutable part of cutter. the part triggers collision to workpiece if overlapped. public ITopoBrick UpperBeamTopoBrick { get; } Property Value ITopoBrick XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears all cached data. public void ClearCache() ClearThermalLayerListCache() Clears the thermal layer list cache. public void ClearThermalLayerListCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredCollidables() Gets the list of anchored collidable nodes contained by this stem. public List GetAnchoredCollidables() Returns List A list of anchored collidable nodes. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCutterFluteDisplayee() Gets the cutter flute displayee for visualization. public IAnchoredDisplayee GetCutterFluteDisplayee() Returns IAnchoredDisplayee The anchored displayee for the cutter flute. GetDeflectionPara_umdN(out double, out double) (L^3)/(3EI). Where deflection = F(L^3)/(3EI). for cantiliver beam. public void GetDeflectionPara_umdN(out double bendingPara_umdN, out double zDeflectionPara_umdN) Parameters bendingPara_umdN double zDeflectionPara_umdN double Exceptions Exception GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetFluteThermalLayerList() Flute material layer From outer(i.e. surface) to inner. public List GetFluteThermalLayerList() Returns List GetGuessShankMass_g() Get guess mass by volume and density. The volume is count from InnerBeamProfile and UpperBeamGeom. public double GetGuessShankMass_g() Returns double GetInitStickConvex() Get InitStickConvex. public InitStickConvex GetInitStickConvex() Returns InitStickConvex InitStickConvex GetMinimumUncutChipThickness_mm(ICuttingPara) Gets the minimum uncut chip thickness in millimeters for the specified cutting parameters. public double GetMinimumUncutChipThickness_mm(ICuttingPara millingPara) Parameters millingPara ICuttingPara The cutting parameters to use for calculation. Returns double The minimum uncut chip thickness in millimeters. GetMinimumUncutChipThickness_um(ICuttingPara) Gets the minimum uncut chip thickness in micrometers for the specified cutting parameters. public double GetMinimumUncutChipThickness_um(ICuttingPara millingPara) Parameters millingPara ICuttingPara The cutting parameters to use for calculation. Returns double The minimum uncut chip thickness in micrometers. GetNobleAnchoredDisplayee() Gets a noble anchored displayee for visualization. public AnchoredDisplayee GetNobleAnchoredDisplayee() Returns AnchoredDisplayee The anchored displayee. GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSweptable(double) Get Sweptable. public Sweptable GetSweptable(double fractionTolerance) Parameters fractionTolerance double The fraction tolerance for the sweptable. Returns Sweptable Sweptable GetTestBallCutter() Creates a test ball cutter. public static MillingCutter GetTestBallCutter() Returns MillingCutter A new ball cutter instance for testing. GetTestBottomCutter() Creates a test bottom cutter. public static MillingCutter GetTestBottomCutter() Returns MillingCutter A new bottom cutter instance for testing. GetTestFreeCutter() Creates a test free cutter. public static MillingCutter GetTestFreeCutter() Returns MillingCutter A new free cutter instance for testing. GetThermalLayerList() Gets the list of thermal layers. public List GetThermalLayerList() Returns List List of thermal layers. GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + "summary": "Class MillingCutter Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a milling cutter with its geometric and physical properties. public class MillingCutter : ICutter, IGetSweptable, IAnchoredDisplayee, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IAnchoredCollidableStem, IAnchoredCollidableNode, IAnchoredCollidableBased, IDisposable, INameNote, IGetFluteHeight, IDisplayee, IExpandToBox3d, IUpdateByContent, IClearCache, IGetThermalLayerList, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IDuplicate, IGetInitStickConvex, IVolumeRemover, IPolarResolution2d, IGetZrList Inheritance object MillingCutter Implements ICutter IGetSweptable IAnchoredDisplayee IGetFletchBuckle IMakeXmlSource IAbstractNote IAnchoredCollidableStem IAnchoredCollidableNode IAnchoredCollidableBased IDisposable INameNote IGetFluteHeight IDisplayee IExpandToBox3d IUpdateByContent IClearCache IGetThermalLayerList ITopo IGetAsmb IGetAnchor IGetTopoIndex IGetAnchoredDisplayeeList IDuplicate IGetInitStickConvex IVolumeRemover IPolarResolution2d IGetZrList Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) CutterUtil.GetCutterBodyCoolingArea_mm2(ICutter) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MillingTemperatureUtil.GetMaterial(IGetThermalLayerList, double) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks The cutter can be solid end or insert end. The term “Flute” is the edge part of the solid end cutter or the full insert of the insert end body. The term “Shank” is the full part except for edge part (i.e. Flute) of the solid end cutter. Shank and Flute compose the full cutter. Constructors MillingCutter() Initializes a new instance of the MillingCutter class. public MillingCutter() MillingCutter(XElement, string, string, params object[]) Ctor. public MillingCutter(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths relFile string Relative file path res object[] Additional optional resources Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string AngleResolution_deg AngleResolution_deg. Call ClearCache() after setting the property. public double AngleResolution_deg { get; set; } Property Value double AngleResolution_rad AngleResolution_rad. Call ClearCache() after setting the property. public double AngleResolution_rad { get; set; } Property Value double CoatingLayerList Gets or sets the list of coating thermal layers. The sequence starts from surface, i.e. from outer to inner. public List CoatingLayerList { get; set; } Property Value List CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CutterTip Gets the anchor point at the cutter tip. public Anchor CutterTip { get; } Property Value Anchor DefaultAngleResolution_rad Gets or sets the default angle resolution in radians. public static double DefaultAngleResolution_rad { get; set; } Property Value double DefaultLinearResolution_mm Gets or sets the default linear resolution in millimeters. public static double DefaultLinearResolution_mm { get; set; } Property Value double DefaultStlLongitudeNum Gets or sets the default number of longitude lines for STL generation. public static int DefaultStlLongitudeNum { get; set; } Property Value int EffectiveCuttingDiameter_mm Cutting Diameter for calculate cutting speed. public double EffectiveCuttingDiameter_mm { get; } Property Value double ExposedHeight_mm Has to be simultanous with ExposedCutterHeight_mm. public double ExposedHeight_mm { get; set; } Property Value double FluteContourTray Gets or sets the flute contour tray that defines the flute geometry. public IContourTray FluteContourTray { get; set; } Property Value IContourTray FluteHeight_mm Gets the height of the flute in millimeters. public double FluteHeight_mm { get; } Property Value double FluteMaterial Material of the flute. public CutterMaterial FluteMaterial { get; set; } Property Value CutterMaterial FluteMaterialFile Gets or sets the file path for the flute material definition. public string FluteMaterialFile { get; set; } Property Value string FullHeight_mm Gets the full height of the cutter in millimeters. public double FullHeight_mm { get; } Property Value double HoneRadius_mm Gets or sets the hone radius in millimeters. public double HoneRadius_mm { get; set; } Property Value double HoneRadius_um Gets the hone radius in micrometers. public double HoneRadius_um { get; set; } Property Value double InnerBeamProfile Gets or sets the inner beam profile. public IShaperProfile InnerBeamProfile { get; set; } Property Value IShaperProfile Remarks InnerBeamProfile may be dependent on ShaperProfile. InnerBeamProfile.ClearCache() and initialization must be performed after ShaperProfile.ClearCache() and initialization. InsertNum Gets or sets Insert Number. The property should be used Only if IntegralMode is InsertEnd. However, there is no exception mechanism. public int InsertNum { get; set; } Property Value int InsertThickness_mm Thickness of an insert. Only available if the cutter is InsertEnd. public double InsertThickness_mm { get; set; } Property Value double IntegralMode Gets or sets the main integral mode of the cutter. public MillingCutter.IntegralModeEnum IntegralMode { get; set; } Property Value MillingCutter.IntegralModeEnum IsSpinningCutter Is cutter spining when machining. public bool IsSpinningCutter { get; } Property Value bool Is cutter spining when machining. LinearResolution_mm LinearResolution_mm. Call ClearCache() after setting the property. public double LinearResolution_mm { get; set; } Property Value double MillingCutterOptLimit public MillingCutterOptLimit MillingCutterOptLimit { get; set; } Property Value MillingCutterOptLimit Name Name. public string Name { get; set; } Property Value string Note Note. public string Note { get; set; } Property Value string ReliefAngle_deg Gets or sets the relief angle in degrees. public double ReliefAngle_deg { get; set; } Property Value double ReliefAngle_rad Gets or sets the relief angle in radians. public double ReliefAngle_rad { get; set; } Property Value double ShankMassAssignmentMode Gets or sets the mass assignment mode for the shank. public MillingCutter.MassAssignmentMode ShankMassAssignmentMode { get; set; } Property Value MillingCutter.MassAssignmentMode ShankMass_g Gets or sets the cutter shank mass in grams. If IntegralMode is SolidEnd, the mass is the full cutter mass. If IntegralMode is InsertEnd, the mass is the shank mass. since the flute mass is assumed small and dynamic depends on the CWE (Cutter-Workpiece-Engagement). public double ShankMass_g { get; set; } Property Value double ShankMaterial Material of the shank. It should be the same with FluteMaterial if the cutter is SolidEnd. public IStructureMaterial ShankMaterial { get; set; } Property Value IStructureMaterial ShankMaterialFile Gets or sets the file path for the shank material definition. It should be the same with FluteMaterialFile if the cutter is SolidEnd. public string ShankMaterialFile { get; set; } Property Value string ShaperProfile Gets or sets the shaper profile that defines the cutter's shape. public IShaperProfile ShaperProfile { get; set; } Property Value IShaperProfile ShaperTopoBrick cutable part of cutter. the part cut the workpiece if overlapped. public ITopoBrick ShaperTopoBrick { get; } Property Value ITopoBrick SingleInsertMass_g Gets or sets the total inserts' mass in grams. The property should be used Only if IntegralMode is InsertEnd. However, there is no exception mechanism. public double SingleInsertMass_g { get; set; } Property Value double StrutTopoBrick uncutable part of cutter. the part triggers collision to workpiece if overlapped. public ITopoBrick StrutTopoBrick { get; } Property Value ITopoBrick SumInsertMass_g Gets the total mass of all inserts in grams calculated from SingleInsertMass_g * InsertNum. public double SumInsertMass_g { get; } Property Value double SurfaceMaterial Gets the surface material of the cutter. public CutterMaterial SurfaceMaterial { get; } Property Value CutterMaterial UpperBeamGeom Gets the upper beam geometry of the cutter. public IGetStl UpperBeamGeom { get; set; } Property Value IGetStl UpperBeamPolarResolution2dSource public Func UpperBeamPolarResolution2dSource { get; set; } Property Value Func XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears all cached data. public void ClearCache() ClearThermalLayerListCache() Clears the thermal layer list cache. public void ClearThermalLayerListCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredCollidables() Gets the list of anchored collidable nodes contained by this stem. public List GetAnchoredCollidables() Returns List A list of anchored collidable nodes. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCutterFluteDisplayee() Gets the cutter flute displayee for visualization. public IAnchoredDisplayee GetCutterFluteDisplayee() Returns IAnchoredDisplayee The anchored displayee for the cutter flute. GetDeflectionPara_umdN(out double, out double) (L^3)/(3EI). Where deflection = F(L^3)/(3EI). for cantiliver beam. public void GetDeflectionPara_umdN(out double bendingPara_umdN, out double zDeflectionPara_umdN) Parameters bendingPara_umdN double zDeflectionPara_umdN double Exceptions Exception GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetFluteThermalLayerList() Flute material layer From outer(i.e. surface) to inner. public List GetFluteThermalLayerList() Returns List GetGuessShankMass_g() Get guess mass by volume and density. The volume is count from InnerBeamProfile and UpperBeamGeom. public double GetGuessShankMass_g() Returns double GetInitStickConvex() Get InitStickConvex. public InitStickConvex GetInitStickConvex() Returns InitStickConvex InitStickConvex GetMinimumUncutChipThickness_mm(ICuttingPara) Gets the minimum uncut chip thickness in millimeters for the specified cutting parameters. The value is dependent on HoneRadius_um. public double GetMinimumUncutChipThickness_mm(ICuttingPara millingPara) Parameters millingPara ICuttingPara The cutting parameters to use for calculation. Returns double The minimum uncut chip thickness in millimeters. GetMinimumUncutChipThickness_um(ICuttingPara) Gets the minimum uncut chip thickness in micrometers for the specified cutting parameters. public double GetMinimumUncutChipThickness_um(ICuttingPara millingPara) Parameters millingPara ICuttingPara The cutting parameters to use for calculation. Returns double The minimum uncut chip thickness in micrometers. GetNobleAnchoredDisplayee() Gets a noble anchored displayee for visualization. public AnchoredDisplayee GetNobleAnchoredDisplayee() Returns AnchoredDisplayee The anchored displayee. GetSweptable(double) Get Sweptable. public Sweptable GetSweptable(double fractionTolerance) Parameters fractionTolerance double The fraction tolerance for the sweptable. Returns Sweptable Sweptable GetTestBallCutter() Creates a test ball cutter. public static MillingCutter GetTestBallCutter() Returns MillingCutter A new ball cutter instance for testing. GetTestBottomCutter() Creates a test bottom cutter. public static MillingCutter GetTestBottomCutter() Returns MillingCutter A new bottom cutter instance for testing. GetTestFreeCutter() Creates a test free cutter. public static MillingCutter GetTestFreeCutter() Returns MillingCutter A new free cutter instance for testing. GetThermalLayerList() Gets the list of thermal layers. public List GetThermalLayerList() Returns List List of thermal layers. GetZrList() Gets a list of Z-R coordinate pairs. public List GetZrList() Returns List A list of PairZr objects representing Z-R coordinates. 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. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + }, + "api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html": { + "href": "api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.ShapeModeEnum.html", + "title": "Enum MillingCutterEditorDisplayee.ShapeModeEnum | HiAPI-C# 2025", + "summary": "Enum MillingCutterEditorDisplayee.ShapeModeEnum Namespace Hi.Milling.Cutters Assembly HiMech.dll public enum MillingCutterEditorDisplayee.ShapeModeEnum Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields DetailPhysicsShape = 1 SolidBoundingShape = 0" }, "api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html": { "href": "api/Hi.Milling.Cutters.MillingCutterEditorDisplayee.html", "title": "Class MillingCutterEditorDisplayee | HiAPI-C# 2025", - "summary": "Class MillingCutterEditorDisplayee Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a displayable editor for milling cutter visualization. This class handles the rendering of cutter geometry, including flutes, profiles, and inner structures. Internal Use Only public class MillingCutterEditorDisplayee : IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IClearCache, IDisposable Inheritance object MillingCutterEditorDisplayee Implements IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IClearCache 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) Constructors MillingCutterEditorDisplayee() Initializes a new instance of the MillingCutterEditorDisplayee class. Internal Use Only public MillingCutterEditorDisplayee() MillingCutterEditorDisplayee(Func) Initializes a new instance of the MillingCutterEditorDisplayee class with a milling cutter host. Internal Use Only public MillingCutterEditorDisplayee(Func millingCutterHost) Parameters millingCutterHost Func Function that provides the milling cutter instance Properties MillingCutterHost Gets or sets the function that provides the milling cutter instance. Internal Use Only public Func MillingCutterHost { get; set; } Property Value Func Methods ClearCache() Clears all cached display data. Internal Use Only public void ClearCache() Display(Bind) Displays the milling cutter visualization. Internal Use Only public void Display(Bind bind) Parameters bind Bind The binding context for display Dispose() Disposes of all resources. Internal Use Only public void Dispose() Dispose(bool) Disposes of unmanaged resources. Internal Use Only protected virtual void Dispose(bool disposing) Parameters disposing bool True if disposing, false if finalizing ExpandToBox3d(Box3d) Expands the bounding box to include the cutter geometry. Internal Use Only public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The destination bounding box to expand GetRootAnchor() Gets the root anchor point of the cutter. Internal Use Only public Anchor GetRootAnchor() Returns Anchor The cutter tip anchor" + "summary": "Class MillingCutterEditorDisplayee Namespace Hi.Milling.Cutters Assembly HiMech.dll Represents a displayable editor for milling cutter visualization. This class handles the rendering of cutter geometry, including flutes, profiles, and inner structures. Internal Use Only public class MillingCutterEditorDisplayee : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IClearCache, IDisposable Inheritance object MillingCutterEditorDisplayee Implements IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d IClearCache IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors MillingCutterEditorDisplayee() Initializes a new instance of the MillingCutterEditorDisplayee class. public MillingCutterEditorDisplayee() MillingCutterEditorDisplayee(Func) Initializes a new instance of the MillingCutterEditorDisplayee class with a milling cutter host. public MillingCutterEditorDisplayee(Func millingCutterHost) Parameters millingCutterHost Func Function that provides the milling cutter instance Properties MillingCutterSourceFunc Gets or sets the function that provides the milling cutter instance. public Func MillingCutterSourceFunc { get; set; } Property Value Func ShapeMode public MillingCutterEditorDisplayee.ShapeModeEnum ShapeMode { get; set; } Property Value MillingCutterEditorDisplayee.ShapeModeEnum Methods ClearCache() Clears all cached display data. public void ClearCache() Display(Bind) Displays the milling cutter visualization. public void Display(Bind bind) Parameters bind Bind The binding context for display Dispose() Disposes of all resources. public void Dispose() Dispose(bool) Disposes of unmanaged resources. protected virtual void Dispose(bool disposing) Parameters disposing bool True if disposing, false if finalizing ExpandToBox3d(Box3d) Expands the bounding box to include the cutter geometry. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The destination bounding box to expand GetAnchor() Gets the root anchor point of the cutter. public Anchor GetAnchor() Returns Anchor The cutter tip anchor" }, "api/Hi.Milling.Cutters.html": { "href": "api/Hi.Milling.Cutters.html", "title": "Namespace Hi.Milling.Cutters | HiAPI-C# 2025", - "summary": "Namespace Hi.Milling.Cutters Classes AptProfile Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. This profile uses APT definitions to describe the cutter geometry. Internal Use Only ConstRatioProfile Represents a constant ratio profile for a milling cutter. This profile maintains a constant ratio between inner and outer radii. Internal Use Only CustomSpinningProfile Represents a custom spinning profile for a milling cutter. This profile allows for custom geometry to be used as the cutter profile. Internal Use Only CutterUtil Utility class providing extension methods for cutter operations. FluteContourDisplayee Provides display functionality for flute contours in milling cutters. This class handles the visualization of both front and back surfaces of flute contours. Internal Use Only FluteDependentRatioProfile Represents a flute number dependent ratio profile for a milling cutter. This profile determines the ratio between inner and outer radii based on the number of flutes. Internal Use Only MillingCutter Represents a milling cutter with its geometric and physical properties. MillingCutterEditorDisplayee Represents a displayable editor for milling cutter visualization. This class handles the rendering of cutter geometry, including flutes, profiles, and inner structures. Internal Use Only Interfaces IShaperProfile Interface defining the shape profile of a cutter flute. The cutter flute must also inherit IGetInitStickConvex or IGetSweptable. Internal Use Only Enums MillingCutter.IntegralModeEnum Defines the integral mode of the cutter. MillingCutter.MassAssignmentMode Defines the mass assignment mode for the cutter." + "summary": "Namespace Hi.Milling.Cutters Classes AptProfile Represents an APT (Automatically Programmed Tool) based profile for a milling cutter. This profile uses APT definitions to describe the cutter geometry. ConstRatioProfile Represents a constant ratio profile for a milling cutter. This profile maintains a constant ratio between inner and outer radii. CustomSpinningProfile Represents a custom spinning profile for a milling cutter. This profile allows for custom geometry to be used as the cutter profile. CutterUtil Utility class providing extension methods for cutter operations. FluteContourDisplayee Provides display functionality for flute contours in milling cutters. This class handles the visualization of both front and back surfaces of flute contours. Internal Use Only FluteDependentRatioProfile Represents a flute number dependent ratio profile for a milling cutter. This profile determines the ratio between inner and outer radii based on the number of flutes. MillingCutter Represents a milling cutter with its geometric and physical properties. MillingCutterEditorDisplayee Represents a displayable editor for milling cutter visualization. This class handles the rendering of cutter geometry, including flutes, profiles, and inner structures. Internal Use Only Interfaces IShaperProfile Interface defining the shape profile of a cutter flute. Enums MillingCutter.IntegralModeEnum Defines the integral mode of the cutter. MillingCutter.MassAssignmentMode Defines the mass assignment mode for the cutter. MillingCutterEditorDisplayee.ShapeModeEnum" }, "api/Hi.Milling.Engagements.BitwiseMillingEngagement.html": { "href": "api/Hi.Milling.Engagements.BitwiseMillingEngagement.html", @@ -2382,12 +2512,12 @@ "api/Hi.Milling.FluteContours.ConstHelixSideContour.html": { "href": "api/Hi.Milling.FluteContours.ConstHelixSideContour.html", "title": "Class ConstHelixSideContour | HiAPI-C# 2025", - "summary": "Class ConstHelixSideContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a constant helix side contour for milling cutters. public class ConstHelixSideContour : ISideContour, IWorkingContour, IExpandToBox3d, IMakeXmlSource, IUpdateByContent, IClearCache, IEquatable Inheritance object ConstHelixSideContour Implements ISideContour IWorkingContour IExpandToBox3d IMakeXmlSource IUpdateByContent IClearCache IEquatable Inherited Members object.Equals(object, object) 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) FluteContourUtil.GetDrawing(ISideContour, out Drawing, out Drawing, out NativeTopoStld) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ConstHelixSideContour(IGetZrList) Initializes a new instance of the ConstHelixSideContour class. public ConstHelixSideContour(IGetZrList zrListHost) Parameters zrListHost IGetZrList The Z-R list host. ConstHelixSideContour(double, double, IGetZrList) Initializes a new instance of the ConstHelixSideContour class. public ConstHelixSideContour(double helix_rad, double radialRakeAngle_rad, IGetZrList zrListHost) Parameters helix_rad double The helix angle in radians. radialRakeAngle_rad double The radial rake angle in radians. zrListHost IGetZrList The Z-R list host. ConstHelixSideContour(XElement, string, IGetZrList) Initializes a new instance of the ConstHelixSideContour class from XML. public ConstHelixSideContour(XElement src, string baseDirectory, IGetZrList zrListHost) Parameters src XElement The XML element containing the configuration. baseDirectory string The base directory for resolving relative paths. zrListHost IGetZrList The Z-R list host. Properties Helix_deg Helix_rad in degree. public double Helix_deg { get; set; } Property Value double Helix_rad Helix angle in radian. public double Helix_rad { get; set; } Property Value double KeyRange Gets the key range of the flute contour. public Range KeyRange { get; } Property Value Range Remarks For ISideContour, this represents the Z-value range (height range) For IBottomContour, this represents the R-value range (radial range) RadialRakeAngle_deg Gets or sets the radial rake angle in degrees. public double RadialRakeAngle_deg { get; set; } Property Value double RadialRakeAngle_rad Gets or sets the radial rake angle in radians. public double RadialRakeAngle_rad { get; set; } Property Value double RadialReliefAngle_deg Gets or sets the radial relief angle in degrees. public double RadialReliefAngle_deg { get; set; } Property Value double RadialReliefAngle_rad Gets or sets the radial relief angle in radians. public double RadialReliefAngle_rad { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZrListHost Gets or sets the Z-R list host. public IGetZrList ZrListHost { get; set; } Property Value IGetZrList Methods ClearCache() Clears the cached data. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour with a new Z-R list host. public IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The new Z-R list host. Returns IWorkingContour A duplicate of this contour. Equals(ConstHelixSideContour) Indicates whether the current object is equal to another object of the same type. public bool Equals(ConstHelixSideContour other) Parameters other ConstHelixSideContour An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetSpanContourPosList() Gets a list of span contour positions that define the working contour geometry. public List GetSpanContourPosList() Returns List A list of SpanContourPos4d objects representing the contour geometry Remarks The positions are ordered: For ISideContour, positions are ordered by ascending Z values For IBottomContour, positions are ordered by ascending R values Note: Future implementation may use List> for block flute support. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + "summary": "Class ConstHelixSideContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a constant helix side contour for milling cutters. public class ConstHelixSideContour : ISideContour, IWorkingContour, IExpandToBox3d, IMakeXmlSource, IUpdateByContent, IClearCache, IEquatable Inheritance object ConstHelixSideContour Implements ISideContour IWorkingContour IExpandToBox3d IMakeXmlSource IUpdateByContent IClearCache IEquatable Inherited Members object.Equals(object, object) 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) FluteContourUtil.GetDrawing(ISideContour, out Drawing, out Drawing, out NativeTopoStld) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ConstHelixSideContour(IGetZrList) Initializes a new instance of the ConstHelixSideContour class. public ConstHelixSideContour(IGetZrList zrListHost) Parameters zrListHost IGetZrList The Z-R list host. ConstHelixSideContour(double, double, IGetZrList) Initializes a new instance of the ConstHelixSideContour class. public ConstHelixSideContour(double helix_rad, double radialRakeAngle_rad, IGetZrList zrListHost) Parameters helix_rad double The helix angle in radians. radialRakeAngle_rad double The radial rake angle in radians. zrListHost IGetZrList The Z-R list host. ConstHelixSideContour(XElement, string, IGetZrList) Initializes a new instance of the ConstHelixSideContour class from XML. public ConstHelixSideContour(XElement src, string baseDirectory, IGetZrList zrListHost) Parameters src XElement The XML element containing the configuration. baseDirectory string The base directory for resolving relative paths. zrListHost IGetZrList The Z-R list host. Properties Helix_deg Helix_rad in degree. public double Helix_deg { get; set; } Property Value double Helix_rad Helix angle in radian. public double Helix_rad { get; set; } Property Value double KeyRange Gets the key range of the flute contour. public Range KeyRange { get; } Property Value Range Remarks For ISideContour, this represents the Z-value range (height range) For IBottomContour, this represents the R-value range (radial range) RadialRakeAngle_deg Gets or sets the radial rake angle in degrees. public double RadialRakeAngle_deg { get; set; } Property Value double RadialRakeAngle_rad Gets or sets the radial rake angle in radians. public double RadialRakeAngle_rad { get; set; } Property Value double RadialReliefAngle_deg Gets or sets the radial relief angle in degrees. public double RadialReliefAngle_deg { get; set; } Property Value double RadialReliefAngle_rad Gets or sets the radial relief angle in radians. public double RadialReliefAngle_rad { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string ZrListHost Gets or sets the Z-R list host. public IGetZrList ZrListHost { get; set; } Property Value IGetZrList Methods ClearCache() Clears the cached data. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour with a new Z-R list host. public IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The new Z-R list host. Returns IWorkingContour A duplicate of this contour. Equals(ConstHelixSideContour) Indicates whether the current object is equal to another object of the same type. public bool Equals(ConstHelixSideContour other) Parameters other ConstHelixSideContour An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetSpanContourPosList() Gets a list of span contour positions that define the working contour geometry. public List GetSpanContourPosList() Returns List A list of SpanContourPos4d objects representing the contour geometry Remarks The positions are ordered: For ISideContour, positions are ordered by ascending Z values For IBottomContour, positions are ordered by ascending R values Note: Future implementation may use List> for block flute support. 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. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" }, "api/Hi.Milling.FluteContours.FluteContour.html": { "href": "api/Hi.Milling.FluteContours.FluteContour.html", "title": "Class FluteContour | HiAPI-C# 2025", - "summary": "Class FluteContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a flute contour for milling tools. public class FluteContour : IMakeXmlSource, IDisposable, IClearCache Inheritance object FluteContour Implements IMakeXmlSource IDisposable IClearCache 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) Constructors FluteContour() Initializes a new instance of the FluteContour class public FluteContour() FluteContour(FluteContour, double) Initializes a new instance of the FluteContour class with a source contour and shift angle public FluteContour(FluteContour src, double shiftAngle_rad) Parameters src FluteContour The source flute contour to copy from shiftAngle_rad double The shift angle in radians FluteContour(XElement, string, params object[]) Initializes a new instance of the FluteContour class from XML data public FluteContour(XElement src, string baseDirectory, params object[] res) Parameters src XElement The source XML element baseDirectory string The base directory for resolving relative paths res object[] Additional resources for initialization Properties BaseBottomContour Gets or sets the base bottom contour of the flute. This represents the original bottom profile before any transformations. public IWorkingContour BaseBottomContour { get; set; } Property Value IWorkingContour BaseSideContour Gets or sets the base side contour of the flute. This represents the original side profile before any transformations. public IWorkingContour BaseSideContour { get; set; } Property Value IWorkingContour SetupAngle_deg Gets or sets the setup angle in degrees. This is a convenience property that converts ShiftAngle_rad to degrees. public double SetupAngle_deg { get; set; } Property Value double ShiftAngle_rad Gets or sets the shift angle in radians. This angle represents the angular offset of the flute from its base position. public double ShiftAngle_rad { get; set; } Property Value double ShiftedBottomContour Gets the shifted bottom contour of the flute. This is the bottom profile after applying the shift angle transformation. public ShiftedWorkingContour ShiftedBottomContour { get; } Property Value ShiftedWorkingContour ShiftedSideContour Gets the shifted side contour of the flute. This is the side profile after applying the shift angle transformation. public ShiftedWorkingContour ShiftedSideContour { get; } Property Value ShiftedWorkingContour XName Gets the XML name for serialization public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data in the flute contour public void ClearCache() Dispose() Releases all resources used by the FluteContour public void Dispose() Dispose(bool) Releases the unmanaged resources used by the FluteContour and optionally releases the managed resources protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources Duplicate(IGetZrList) Creates a duplicate of this flute contour public FluteContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information Returns FluteContour A new instance of FluteContour with the same properties ExpandToBox3d(Box3d) Expands the given bounding box to include this flute contour public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand MakeXmlSource(string, string) Creates an XML element representing this flute contour public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path Returns XElement An XML element containing the flute contour data UpdateByContent() Updates the internal state based on the current content public void UpdateByContent()" + "summary": "Class FluteContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a flute contour for milling tools. public class FluteContour : IMakeXmlSource, IDisposable, IClearCache Inheritance object FluteContour Implements IMakeXmlSource IDisposable IClearCache 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) Constructors FluteContour() Initializes a new instance of the FluteContour class public FluteContour() FluteContour(FluteContour, double) Initializes a new instance of the FluteContour class with a source contour and shift angle public FluteContour(FluteContour src, double shiftAngle_rad) Parameters src FluteContour The source flute contour to copy from shiftAngle_rad double The shift angle in radians FluteContour(XElement, string, params object[]) Initializes a new instance of the FluteContour class from XML data public FluteContour(XElement src, string baseDirectory, params object[] res) Parameters src XElement The source XML element baseDirectory string The base directory for resolving relative paths res object[] Additional resources for initialization Properties BaseBottomContour Gets or sets the base bottom contour of the flute. This represents the original bottom profile before any transformations. public IWorkingContour BaseBottomContour { get; set; } Property Value IWorkingContour BaseSideContour Gets or sets the base side contour of the flute. This represents the original side profile before any transformations. public IWorkingContour BaseSideContour { get; set; } Property Value IWorkingContour SetupAngle_deg Gets or sets the setup angle in degrees. This is a convenience property that converts ShiftAngle_rad to degrees. public double SetupAngle_deg { get; set; } Property Value double ShiftAngle_rad Gets or sets the shift angle in radians. This angle represents the angular offset of the flute from its base position. public double ShiftAngle_rad { get; set; } Property Value double ShiftedBottomContour Gets the shifted bottom contour of the flute. This is the bottom profile after applying the shift angle transformation. public ShiftedWorkingContour ShiftedBottomContour { get; } Property Value ShiftedWorkingContour ShiftedSideContour Gets the shifted side contour of the flute. This is the side profile after applying the shift angle transformation. public ShiftedWorkingContour ShiftedSideContour { get; } Property Value ShiftedWorkingContour XName Gets the XML name for serialization public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data in the flute contour public void ClearCache() Dispose() Releases all resources used by the FluteContour public void Dispose() Dispose(bool) Releases the unmanaged resources used by the FluteContour and optionally releases the managed resources protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources Duplicate(IGetZrList) Creates a duplicate of this flute contour public FluteContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information Returns FluteContour A new instance of FluteContour with the same properties ExpandToBox3d(Box3d) Expands the given bounding box to include this flute contour public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand 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. UpdateByContent() Updates the internal state based on the current content public void UpdateByContent()" }, "api/Hi.Milling.FluteContours.FluteContourUtil.html": { "href": "api/Hi.Milling.FluteContours.FluteContourUtil.html", @@ -2397,47 +2527,57 @@ "api/Hi.Milling.FluteContours.FreeContourTray.html": { "href": "api/Hi.Milling.FluteContours.FreeContourTray.html", "title": "Class FreeContourTray | HiAPI-C# 2025", - "summary": "Class FreeContourTray Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a container for multiple flute contours with free arrangement. public class FreeContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache Inheritance object FreeContourTray Implements IContourTray IMakeXmlSource IExpandToBox3d IUpdateByContent IClearCache 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 This class provides a flexible way to manage multiple flute contours: Supports XML serialization for data persistence Allows arbitrary arrangement of flute contours Implements IContourTray for standard contour tray functionality Constructors FreeContourTray() Initializes a new instance of the FreeContourTray class public FreeContourTray() FreeContourTray(XElement, string, params object[]) Initializes a new instance of the FreeContourTray class from XML data public FreeContourTray(XElement src, string baseDirectory, params object[] res) Parameters src XElement The source XML element containing the contour tray data baseDirectory string The base directory for resolving relative paths res object[] Additional resources for initialization Properties ContourList Gets or sets the list of flute contours in this tray public List ContourList { get; set; } Property Value List XName Gets the XML name for serialization public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour tray public IContourTray Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information Returns IContourTray A new instance of FreeContourTray with the same properties ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetFluteContourList() Gets the list of flute contours contained in this tray. public List GetFluteContourList() Returns List A list of flute contours. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + "summary": "Class FreeContourTray Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a container for multiple flute contours with free arrangement. public class FreeContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache, IGetFluteNum Inheritance object FreeContourTray Implements IContourTray IMakeXmlSource IExpandToBox3d IUpdateByContent IClearCache IGetFluteNum 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 This class provides a flexible way to manage multiple flute contours: Supports XML serialization for data persistence Allows arbitrary arrangement of flute contours Implements IContourTray for standard contour tray functionality Constructors FreeContourTray() Initializes a new instance of the FreeContourTray class public FreeContourTray() FreeContourTray(XElement, string, params object[]) Initializes a new instance of the FreeContourTray class from XML data public FreeContourTray(XElement src, string baseDirectory, params object[] res) Parameters src XElement The source XML element containing the contour tray data baseDirectory string The base directory for resolving relative paths res object[] Additional resources for initialization Properties ContourList Gets or sets the list of flute contours in this tray public List ContourList { get; set; } Property Value List XName Gets the XML name for serialization public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour tray public IContourTray Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information Returns IContourTray A new instance of FreeContourTray with the same properties ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetFluteContourList() Gets the list of flute contours contained in this tray. public List GetFluteContourList() Returns List A list of flute contours. GetFluteNum() Gets the number of flutes in the contour tray. public int GetFluteNum() Returns int 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. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" }, "api/Hi.Milling.FluteContours.FreeformSideContour.html": { "href": "api/Hi.Milling.FluteContours.FreeformSideContour.html", "title": "Class FreeformSideContour | HiAPI-C# 2025", - "summary": "Class FreeformSideContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a freeform side contour for milling tools, allowing arbitrary contour shapes. public class FreeformSideContour : ISideContour, IWorkingContour, IExpandToBox3d, IMakeXmlSource, IUpdateByContent, IClearCache, IEquatable Inheritance object FreeformSideContour Implements ISideContour IWorkingContour IExpandToBox3d IMakeXmlSource IUpdateByContent IClearCache IEquatable Inherited Members object.Equals(object, object) 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) FluteContourUtil.GetDrawing(ISideContour, out Drawing, out Drawing, out NativeTopoStld) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks This class provides a flexible way to define side contours with custom shapes: Implements ISideContour for basic side contour functionality Supports XML serialization for data persistence Maintains a list of contour positions ordered by Z-coordinate Constructors FreeformSideContour() Initializes a new instance of the FreeformSideContour class public FreeformSideContour() FreeformSideContour(XElement, string) Initializes a new instance of the FreeformSideContour class from XML data public FreeformSideContour(XElement src, string baseDirectory) Parameters src XElement The source XML element containing the contour data baseDirectory string The base directory for resolving relative paths Properties KeyRange Gets the Z-value range (height range) of the contour public Range KeyRange { get; } Property Value Range Remarks The range is calculated from the first and last points in the SpanContourPosList, which are ordered by Z-coordinate SpanContourPosList Gets or sets the list of contour positions ordered by Z-coordinate public List SpanContourPosList { get; set; } Property Value List Remarks Each position in the list represents a point on the contour with its associated geometric and angular properties XName Gets the XML name for serialization public static string XName { get; } Property Value string Methods ClearCache() Clears the cached key range value public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this freeform side contour public IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information Returns IWorkingContour A new instance of FreeformSideContour with the same properties Equals(FreeformSideContour) Determines whether the specified FreeformSideContour is equal to the current FreeformSideContour public bool Equals(FreeformSideContour other) Parameters other FreeformSideContour The FreeformSideContour to compare with the current FreeformSideContour Returns bool true if the specified FreeformSideContour is equal to the current FreeformSideContour; otherwise, false 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 ExpandToBox3d(Box3d) Expands the given bounding box to include this contour public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand GetHashCode() Returns a hash code for this instance public override int GetHashCode() Returns int A hash code value based on the contour positions GetSpanContourPosList() Gets the list of span contour positions that define the contour geometry public List GetSpanContourPosList() Returns List The list of contour positions ordered by Z-coordinate MakeXmlSource(string, string) Creates an XML element representing this freeform side contour public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path Returns XElement An XML element containing the contour data UpdateByContent() Updates the contour's internal state based on its current content public void UpdateByContent()" + "summary": "Class FreeformSideContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a freeform side contour for milling tools, allowing arbitrary contour shapes. public class FreeformSideContour : ISideContour, IWorkingContour, IExpandToBox3d, IMakeXmlSource, IUpdateByContent, IClearCache, IEquatable Inheritance object FreeformSideContour Implements ISideContour IWorkingContour IExpandToBox3d IMakeXmlSource IUpdateByContent IClearCache IEquatable Inherited Members object.Equals(object, object) 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) FluteContourUtil.GetDrawing(ISideContour, out Drawing, out Drawing, out NativeTopoStld) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks This class provides a flexible way to define side contours with custom shapes: Implements ISideContour for basic side contour functionality Supports XML serialization for data persistence Maintains a list of contour positions ordered by Z-coordinate Constructors FreeformSideContour() Initializes a new instance of the FreeformSideContour class public FreeformSideContour() FreeformSideContour(XElement, string) Initializes a new instance of the FreeformSideContour class from XML data public FreeformSideContour(XElement src, string baseDirectory) Parameters src XElement The source XML element containing the contour data baseDirectory string The base directory for resolving relative paths Properties KeyRange Gets the Z-value range (height range) of the contour public Range KeyRange { get; } Property Value Range Remarks The range is calculated from the first and last points in the SpanContourPosList, which are ordered by Z-coordinate SpanContourPosList Gets or sets the list of contour positions ordered by Z-coordinate public List SpanContourPosList { get; set; } Property Value List Remarks Each position in the list represents a point on the contour with its associated geometric and angular properties XName Gets the XML name for serialization public static string XName { get; } Property Value string Methods ClearCache() Clears the cached key range value public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this freeform side contour public IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information Returns IWorkingContour A new instance of FreeformSideContour with the same properties Equals(FreeformSideContour) Determines whether the specified FreeformSideContour is equal to the current FreeformSideContour public bool Equals(FreeformSideContour other) Parameters other FreeformSideContour The FreeformSideContour to compare with the current FreeformSideContour Returns bool true if the specified FreeformSideContour is equal to the current FreeformSideContour; otherwise, false 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 ExpandToBox3d(Box3d) Expands the given bounding box to include this contour public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand GetHashCode() Returns a hash code for this instance public override int GetHashCode() Returns int A hash code value based on the contour positions GetSpanContourPosList() Gets the list of span contour positions that define the contour geometry public List GetSpanContourPosList() Returns List The list of contour positions ordered by Z-coordinate 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. UpdateByContent() Updates the contour's internal state based on its current content public void UpdateByContent()" }, "api/Hi.Milling.FluteContours.IBottomContour.html": { "href": "api/Hi.Milling.FluteContours.IBottomContour.html", "title": "Interface IBottomContour | HiAPI-C# 2025", - "summary": "Interface IBottomContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a bottom flute contour for milling tools. public interface IBottomContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d Inherited Members IWorkingContour.KeyRange IWorkingContour.GetSpanContourPosList() IWorkingContour.Duplicate(IGetZrList) IMakeXmlSource.MakeXmlSource(string, string) IExpandToBox3d.ExpandToBox3d(Box3d) 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 The bottom contour defines the cutting geometry at the bottom of the tool: Implements IWorkingContour for basic contour functionality Uses R-axis values (radius) as the key range for radial operations Provides geometry for bottom cutting operations in milling tools" + "summary": "Interface IBottomContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a bottom flute contour for milling tools. public interface IBottomContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d, IClearCache Inherited Members IWorkingContour.KeyRange IWorkingContour.GetSpanContourPosList() IWorkingContour.Duplicate(IGetZrList) IMakeXmlSource.MakeXmlSource(string, string, bool) IExpandToBox3d.ExpandToBox3d(Box3d) IClearCache.ClearCache() 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 The bottom contour defines the cutting geometry at the bottom of the tool: Implements IWorkingContour for basic contour functionality Uses R-axis values (radius) as the key range for radial operations Provides geometry for bottom cutting operations in milling tools" }, "api/Hi.Milling.FluteContours.IContourTray.html": { "href": "api/Hi.Milling.FluteContours.IContourTray.html", "title": "Interface IContourTray | HiAPI-C# 2025", - "summary": "Interface IContourTray Namespace Hi.Milling.FluteContours Assembly HiMech.dll Interface for a container that holds multiple flute contours. public interface IContourTray : IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache Inherited Members IMakeXmlSource.MakeXmlSource(string, string) IExpandToBox3d.ExpandToBox3d(Box3d) IUpdateByContent.UpdateByContent() IClearCache.ClearCache() 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) Methods Duplicate(IGetZrList) Creates a duplicate of this contour tray. IContourTray Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information. Returns IContourTray A new instance of IContourTray with the same properties. GetFluteContourList() Gets the list of flute contours contained in this tray. List GetFluteContourList() Returns List A list of flute contours. GetFluteNum() Gets the number of flutes in this contour tray. int GetFluteNum() Returns int The number of flute contours." + "summary": "Interface IContourTray Namespace Hi.Milling.FluteContours Assembly HiMech.dll Interface for a container that holds multiple flute contours. public interface IContourTray : IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache, IGetFluteNum Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) IExpandToBox3d.ExpandToBox3d(Box3d) IUpdateByContent.UpdateByContent() IClearCache.ClearCache() IGetFluteNum.GetFluteNum() 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) Methods Duplicate(IGetZrList) Creates a duplicate of this contour tray. IContourTray Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information. Returns IContourTray A new instance of IContourTray with the same properties. GetFluteContourList() Gets the list of flute contours contained in this tray. List GetFluteContourList() Returns List A list of flute contours." + }, + "api/Hi.Milling.FluteContours.IFluteNumSourceProperty.html": { + "href": "api/Hi.Milling.FluteContours.IFluteNumSourceProperty.html", + "title": "Interface IFluteNumSourceProperty | HiAPI-C# 2025", + "summary": "Interface IFluteNumSourceProperty Namespace Hi.Milling.FluteContours Assembly HiMech.dll Interface that requiring a FluteNumSource property. public interface IFluteNumSourceProperty 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) Properties FluteNumSource Func FluteNumSource { get; set; } Property Value Func" + }, + "api/Hi.Milling.FluteContours.IGetFluteNum.html": { + "href": "api/Hi.Milling.FluteContours.IGetFluteNum.html", + "title": "Interface IGetFluteNum | HiAPI-C# 2025", + "summary": "Interface IGetFluteNum Namespace Hi.Milling.FluteContours Assembly HiMech.dll public interface IGetFluteNum 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) Methods GetFluteNum() Gets the number of flutes in the contour tray. int GetFluteNum() Returns int" }, "api/Hi.Milling.FluteContours.ISideContour.html": { "href": "api/Hi.Milling.FluteContours.ISideContour.html", "title": "Interface ISideContour | HiAPI-C# 2025", - "summary": "Interface ISideContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a side flute contour for milling tools. public interface ISideContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d Inherited Members IWorkingContour.KeyRange IWorkingContour.GetSpanContourPosList() IWorkingContour.Duplicate(IGetZrList) IMakeXmlSource.MakeXmlSource(string, string) IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) FluteContourUtil.GetDrawing(ISideContour, out Drawing, out Drawing, out NativeTopoStld) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks The side contour defines the cutting geometry along the side of the tool: Implements IWorkingContour for basic contour functionality Uses Z-axis values as the key range for height-based operations Provides geometry for side cutting operations in milling tools" + "summary": "Interface ISideContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a side flute contour for milling tools. public interface ISideContour : IWorkingContour, IMakeXmlSource, IExpandToBox3d, IClearCache Inherited Members IWorkingContour.KeyRange IWorkingContour.GetSpanContourPosList() IWorkingContour.Duplicate(IGetZrList) IMakeXmlSource.MakeXmlSource(string, string, bool) IExpandToBox3d.ExpandToBox3d(Box3d) IClearCache.ClearCache() Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) FluteContourUtil.GetDrawing(ISideContour, out Drawing, out Drawing, out NativeTopoStld) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks The side contour defines the cutting geometry along the side of the tool: Implements IWorkingContour for basic contour functionality Uses Z-axis values as the key range for height-based operations Provides geometry for side cutting operations in milling tools" }, "api/Hi.Milling.FluteContours.IWorkingContour.html": { "href": "api/Hi.Milling.FluteContours.IWorkingContour.html", "title": "Interface IWorkingContour | HiAPI-C# 2025", - "summary": "Interface IWorkingContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a working contour for cutting operations in milling tools. This interface is implemented by both side contours (ISideContour) and bottom contours (IBottomContour). public interface IWorkingContour : IMakeXmlSource, IExpandToBox3d Inherited Members IMakeXmlSource.MakeXmlSource(string, string) IExpandToBox3d.ExpandToBox3d(Box3d) 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 The working contour provides essential geometry for tool cutting operations: For side contours, the key range represents Z values (height) For bottom contours, the key range represents R values (radius) Properties KeyRange Gets the key range of the flute contour. Range KeyRange { get; } Property Value Range Remarks For ISideContour, this represents the Z-value range (height range) For IBottomContour, this represents the R-value range (radial range) Methods Duplicate(IGetZrList) Creates a duplicate of this working contour. IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information for the new contour. Returns IWorkingContour A new instance of IWorkingContour with the same properties and geometry. GetSpanContourPosList() Gets a list of span contour positions that define the working contour geometry. List GetSpanContourPosList() Returns List A list of SpanContourPos4d objects representing the contour geometry Remarks The positions are ordered: For ISideContour, positions are ordered by ascending Z values For IBottomContour, positions are ordered by ascending R values Note: Future implementation may use List> for block flute support." + "summary": "Interface IWorkingContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a working contour for cutting operations in milling tools. This interface is implemented by both side contours (ISideContour) and bottom contours (IBottomContour). public interface IWorkingContour : IMakeXmlSource, IExpandToBox3d, IClearCache Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) IExpandToBox3d.ExpandToBox3d(Box3d) IClearCache.ClearCache() 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 The working contour provides essential geometry for tool cutting operations: For side contours, the key range represents Z values (height) For bottom contours, the key range represents R values (radius) Properties KeyRange Gets the key range of the flute contour. Range KeyRange { get; } Property Value Range Remarks For ISideContour, this represents the Z-value range (height range) For IBottomContour, this represents the R-value range (radial range) Methods Duplicate(IGetZrList) Creates a duplicate of this working contour. IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The host containing Z-R list information for the new contour. Returns IWorkingContour A new instance of IWorkingContour with the same properties and geometry. GetSpanContourPosList() Gets a list of span contour positions that define the working contour geometry. List GetSpanContourPosList() Returns List A list of SpanContourPos4d objects representing the contour geometry Remarks The positions are ordered: For ISideContour, positions are ordered by ascending Z values For IBottomContour, positions are ordered by ascending R values Note: Future implementation may use List> for block flute support." }, "api/Hi.Milling.FluteContours.ShiftedWorkingContour.html": { "href": "api/Hi.Milling.FluteContours.ShiftedWorkingContour.html", "title": "Class ShiftedWorkingContour | HiAPI-C# 2025", - "summary": "Class ShiftedWorkingContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a working contour that has been shifted by a specified angle. This class wraps another working contour and applies an angular transformation to it. public class ShiftedWorkingContour : IWorkingContour, IExpandToBox3d, IMakeXmlSource, IEquatable Inheritance object ShiftedWorkingContour Implements IWorkingContour IExpandToBox3d IMakeXmlSource IEquatable Inherited Members object.Equals(object, object) 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) Constructors ShiftedWorkingContour() Initializes a new instance of the ShiftedWorkingContour class public ShiftedWorkingContour() ShiftedWorkingContour(double, IWorkingContour) Initializes a new instance of the ShiftedWorkingContour class with a specified shift angle and baseline contour public ShiftedWorkingContour(double shiftAngle_rad, IWorkingContour baselineWorkingContour) Parameters shiftAngle_rad double The shift angle in radians baselineWorkingContour IWorkingContour The baseline working contour to be shifted ShiftedWorkingContour(XElement, string, IWorkingContour) Initializes a new instance of the ShiftedWorkingContour class from XML data public ShiftedWorkingContour(XElement src, string baseDirectory, IWorkingContour baselineWorkingContour) Parameters src XElement The source XML element baseDirectory string The base directory for resolving relative paths baselineWorkingContour IWorkingContour The baseline working contour to be shifted Properties BaselineWorkingContour Gets or sets the baseline working contour that is being shifted public IWorkingContour BaselineWorkingContour { get; set; } Property Value IWorkingContour KeyRange Gets the key range of the baseline working contour public Range KeyRange { get; } Property Value Range ShiftAngle_deg Gets or sets the shift angle in degrees public double ShiftAngle_deg { get; set; } Property Value double ShiftAngle_rad Gets or sets the shift angle in radians public double ShiftAngle_rad { get; set; } Property Value double XName Gets the XML name for serialization public static string XName { get; } Property Value string Methods Duplicate(IGetZrList) Creates a duplicate of this contour with a new Z-radius list provider. public IWorkingContour Duplicate(IGetZrList zrList) Parameters zrList IGetZrList The Z-radius list provider for the duplicate. Returns IWorkingContour A new instance of ShiftedWorkingContour. Equals(ShiftedWorkingContour) Determines whether the specified ShiftedWorkingContour is equal to the current ShiftedWorkingContour public bool Equals(ShiftedWorkingContour contour) Parameters contour ShiftedWorkingContour The ShiftedWorkingContour to compare with the current ShiftedWorkingContour Returns bool true if the specified ShiftedWorkingContour is equal to the current ShiftedWorkingContour; otherwise, false 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 ExpandToBox3d(Box3d) Expands the given bounding box to include this shifted working contour public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand GetHashCode() Returns a hash code for this instance public override int GetHashCode() Returns int A hash code value GetSpanContourPosList() Gets the list of span contour positions after applying the shift transformation public List GetSpanContourPosList() Returns List A list of transformed span contour positions MakeXmlSource(string, string) Creates an XML element representing this shifted working contour public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path Returns XElement An XML element containing the shifted working contour data Operators operator ==(ShiftedWorkingContour, ShiftedWorkingContour) Determines whether two ShiftedWorkingContour instances are equal public static bool operator ==(ShiftedWorkingContour left, ShiftedWorkingContour right) Parameters left ShiftedWorkingContour The first ShiftedWorkingContour to compare right ShiftedWorkingContour The second ShiftedWorkingContour to compare Returns bool true if the specified ShiftedWorkingContour instances are equal; otherwise, false operator !=(ShiftedWorkingContour, ShiftedWorkingContour) Determines whether two ShiftedWorkingContour instances are not equal public static bool operator !=(ShiftedWorkingContour left, ShiftedWorkingContour right) Parameters left ShiftedWorkingContour The first ShiftedWorkingContour to compare right ShiftedWorkingContour The second ShiftedWorkingContour to compare Returns bool true if the specified ShiftedWorkingContour instances are not equal; otherwise, false" + "summary": "Class ShiftedWorkingContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a working contour that has been shifted by a specified angle. This class wraps another working contour and applies an angular transformation to it. public class ShiftedWorkingContour : IWorkingContour, IExpandToBox3d, IClearCache, IMakeXmlSource, IEquatable Inheritance object ShiftedWorkingContour Implements IWorkingContour IExpandToBox3d IClearCache IMakeXmlSource IEquatable Inherited Members object.Equals(object, object) 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) Constructors ShiftedWorkingContour() Initializes a new instance of the ShiftedWorkingContour class public ShiftedWorkingContour() ShiftedWorkingContour(double, IWorkingContour) Initializes a new instance of the ShiftedWorkingContour class with a specified shift angle and baseline contour public ShiftedWorkingContour(double shiftAngle_rad, IWorkingContour baselineWorkingContour) Parameters shiftAngle_rad double The shift angle in radians baselineWorkingContour IWorkingContour The baseline working contour to be shifted ShiftedWorkingContour(XElement, string, IWorkingContour) Initializes a new instance of the ShiftedWorkingContour class from XML data public ShiftedWorkingContour(XElement src, string baseDirectory, IWorkingContour baselineWorkingContour) Parameters src XElement The source XML element baseDirectory string The base directory for resolving relative paths baselineWorkingContour IWorkingContour The baseline working contour to be shifted Properties BaselineWorkingContour Gets or sets the baseline working contour that is being shifted public IWorkingContour BaselineWorkingContour { get; set; } Property Value IWorkingContour KeyRange Gets the key range of the baseline working contour public Range KeyRange { get; } Property Value Range ShiftAngle_deg Gets or sets the shift angle in degrees public double ShiftAngle_deg { get; set; } Property Value double ShiftAngle_rad Gets or sets the shift angle in radians public double ShiftAngle_rad { get; set; } Property Value double XName Gets the XML name for serialization public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour with a new Z-radius list provider. public IWorkingContour Duplicate(IGetZrList zrList) Parameters zrList IGetZrList The Z-radius list provider for the duplicate. Returns IWorkingContour A new instance of ShiftedWorkingContour. Equals(ShiftedWorkingContour) Determines whether the specified ShiftedWorkingContour is equal to the current ShiftedWorkingContour public bool Equals(ShiftedWorkingContour contour) Parameters contour ShiftedWorkingContour The ShiftedWorkingContour to compare with the current ShiftedWorkingContour Returns bool true if the specified ShiftedWorkingContour is equal to the current ShiftedWorkingContour; otherwise, false 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 ExpandToBox3d(Box3d) Expands the given bounding box to include this shifted working contour public void ExpandToBox3d(Box3d dst) Parameters dst Box3d The bounding box to expand GetHashCode() Returns a hash code for this instance public override int GetHashCode() Returns int A hash code value GetSpanContourPosList() Gets the list of span contour positions after applying the shift transformation public List GetSpanContourPosList() Returns List A list of transformed span contour positions 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. Operators operator ==(ShiftedWorkingContour, ShiftedWorkingContour) Determines whether two ShiftedWorkingContour instances are equal public static bool operator ==(ShiftedWorkingContour left, ShiftedWorkingContour right) Parameters left ShiftedWorkingContour The first ShiftedWorkingContour to compare right ShiftedWorkingContour The second ShiftedWorkingContour to compare Returns bool true if the specified ShiftedWorkingContour instances are equal; otherwise, false operator !=(ShiftedWorkingContour, ShiftedWorkingContour) Determines whether two ShiftedWorkingContour instances are not equal public static bool operator !=(ShiftedWorkingContour left, ShiftedWorkingContour right) Parameters left ShiftedWorkingContour The first ShiftedWorkingContour to compare right ShiftedWorkingContour The second ShiftedWorkingContour to compare Returns bool true if the specified ShiftedWorkingContour instances are not equal; otherwise, false" }, "api/Hi.Milling.FluteContours.SideContourDisplayee.html": { "href": "api/Hi.Milling.FluteContours.SideContourDisplayee.html", "title": "Class SideContourDisplayee | HiAPI-C# 2025", - "summary": "Class SideContourDisplayee Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a displayable side contour. public class SideContourDisplayee : IDisplayee, IExpandToBox3d, IDisposable Inheritance object SideContourDisplayee Implements IDisplayee IExpandToBox3d 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) Constructors SideContourDisplayee(ISideContour) Initializes a new instance of the SideContourDisplayee class. public SideContourDisplayee(ISideContour sideContourSurface) Parameters sideContourSurface ISideContour The side contour surface to display. Properties SideContourSurface Gets or sets the side contour surface. public ISideContour SideContourSurface { get; set; } Property Value ISideContour Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ResetDrawingCache() Resets the drawing cache. public void ResetDrawingCache()" + "summary": "Class SideContourDisplayee Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a displayable side contour. public class SideContourDisplayee : IDisplayee, IExpandToBox3d, IDisposable Inheritance object SideContourDisplayee Implements IDisplayee IExpandToBox3d IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors SideContourDisplayee(ISideContour) Initializes a new instance of the SideContourDisplayee class. public SideContourDisplayee(ISideContour sideContourSurface) Parameters sideContourSurface ISideContour The side contour surface to display. Properties SideContourSurface Gets or sets the side contour surface. public ISideContour SideContourSurface { get; set; } Property Value ISideContour Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ResetDrawingCache() Resets the drawing cache. public void ResetDrawingCache()" }, "api/Hi.Milling.FluteContours.SlideBottomContour.html": { "href": "api/Hi.Milling.FluteContours.SlideBottomContour.html", "title": "Class SlideBottomContour | HiAPI-C# 2025", - "summary": "Class SlideBottomContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a slide bottom contour for milling cutters. public class SlideBottomContour : IBottomContour, IWorkingContour, IMakeXmlSource, IExpandToBox3d Inheritance object SlideBottomContour Implements IBottomContour IWorkingContour IMakeXmlSource IExpandToBox3d 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) Constructors SlideBottomContour() Initializes a new instance of the SlideBottomContour class. public SlideBottomContour() SlideBottomContour(XElement, string) Ctor by XML. public SlideBottomContour(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties AxialRakeAngle_deg AxialRakeAngle_rad in degree. public double AxialRakeAngle_deg { get; set; } Property Value double AxialRakeAngle_rad Axial rake angle. Sometimes it is equal to Helix angle from side contour. in radian. public double AxialRakeAngle_rad { get; set; } Property Value double CutterLengthOnBottomProjection_mm cutter length projection from outer edge on bottom plane. public double CutterLengthOnBottomProjection_mm { get; set; } Property Value double DiskAngle_deg angle between bottom surface and horizontal plane. unit is degree. public double DiskAngle_deg { get; set; } Property Value double DiskAngle_rad angle between bottom surface and horizontal plane. unit is radian. public double DiskAngle_rad { get; set; } Property Value double EccentricAngle_deg Gets or sets the eccentric angle in degrees. public double EccentricAngle_deg { get; set; } Property Value double EccentricAngle_rad Projection angle between the line from outer edge tip to center and bottom flute contour on bottom plane. Sometimes it is equal to Radial Rake Angle from side contour. in radian. public double EccentricAngle_rad { get; set; } Property Value double InnerHeight_mm Gets the inner height of the contour in millimeters. public double InnerHeight_mm { get; } Property Value double KeyRange Gets the key range of the flute contour. public Range KeyRange { get; } Property Value Range Remarks For ISideContour, this represents the Z-value range (height range) For IBottomContour, this represents the R-value range (radial range) OuterRadius_mm Gets or sets the outer radius of the contour in millimeters. public double OuterRadius_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(IGetZrList) Creates a duplicate of this contour with the specified ZR list host. public IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The ZR list host to use for the duplicate Returns IWorkingContour A new working contour instance ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetSpanContourPos4d(double) public SpanContourPos4d GetSpanContourPos4d(double r) Parameters r double specific radius Returns SpanContourPos4d GetSpanContourPosList() Gets a list of span contour positions that define the working contour geometry. public List GetSpanContourPosList() Returns List A list of SpanContourPos4d objects representing the contour geometry Remarks The positions are ordered: For ISideContour, positions are ordered by ascending Z values For IBottomContour, positions are ordered by ascending R values Note: Future implementation may use List> for block flute support. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class SlideBottomContour Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a slide bottom contour for milling cutters. public class SlideBottomContour : IBottomContour, IWorkingContour, IMakeXmlSource, IExpandToBox3d, IClearCache Inheritance object SlideBottomContour Implements IBottomContour IWorkingContour IMakeXmlSource IExpandToBox3d IClearCache 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) Constructors SlideBottomContour() Initializes a new instance of the SlideBottomContour class. public SlideBottomContour() SlideBottomContour(XElement, string) Ctor by XML. public SlideBottomContour(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties AxialRakeAngle_deg AxialRakeAngle_rad in degree. public double AxialRakeAngle_deg { get; set; } Property Value double AxialRakeAngle_rad Axial rake angle. Sometimes it is equal to Helix angle from side contour. in radian. public double AxialRakeAngle_rad { get; set; } Property Value double CutterLengthOnBottomProjection_mm cutter length projection from outer edge on bottom plane. public double CutterLengthOnBottomProjection_mm { get; set; } Property Value double DiskAngle_deg angle between bottom surface and horizontal plane. unit is degree. public double DiskAngle_deg { get; set; } Property Value double DiskAngle_rad angle between bottom surface and horizontal plane. unit is radian. public double DiskAngle_rad { get; set; } Property Value double EccentricAngle_deg Gets or sets the eccentric angle in degrees. public double EccentricAngle_deg { get; set; } Property Value double EccentricAngle_rad Projection angle between the line from outer edge tip to center and bottom flute contour on bottom plane. Sometimes it is equal to Radial Rake Angle from side contour. in radian. public double EccentricAngle_rad { get; set; } Property Value double InnerHeight_mm Gets the inner height of the contour in millimeters. public double InnerHeight_mm { get; } Property Value double KeyRange Gets the key range of the flute contour. public Range KeyRange { get; } Property Value Range Remarks For ISideContour, this represents the Z-value range (height range) For IBottomContour, this represents the R-value range (radial range) OuterRadius_mm Gets or sets the outer radius of the contour in millimeters. public double OuterRadius_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour with the specified ZR list host. public IWorkingContour Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The ZR list host to use for the duplicate Returns IWorkingContour A new working contour instance ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetSpanContourPos4d(double) public SpanContourPos4d GetSpanContourPos4d(double r) Parameters r double specific radius Returns SpanContourPos4d GetSpanContourPosList() Gets a list of span contour positions that define the working contour geometry. public List GetSpanContourPosList() Returns List A list of SpanContourPos4d objects representing the contour geometry Remarks The positions are ordered: For ISideContour, positions are ordered by ascending Z values For IBottomContour, positions are ordered by ascending R values Note: Future implementation may use List> for block flute support. 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." }, "api/Hi.Milling.FluteContours.SpanContourPos4d.html": { "href": "api/Hi.Milling.FluteContours.SpanContourPos4d.html", @@ -2447,12 +2587,12 @@ "api/Hi.Milling.FluteContours.UniformContourTray.html": { "href": "api/Hi.Milling.FluteContours.UniformContourTray.html", "title": "Class UniformContourTray | HiAPI-C# 2025", - "summary": "Class UniformContourTray Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a uniform contour tray for milling tool flutes. public class UniformContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IUpdateByContent, IClearCache Inheritance object UniformContourTray Implements IContourTray IMakeXmlSource IExpandToBox3d IUpdateByContent IClearCache 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) Constructors UniformContourTray() Initializes a new instance of the UniformContourTray class. public UniformContourTray() UniformContourTray(XElement, string, params object[]) Ctor. public UniformContourTray(XElement src, string baseDirectory, params object[] res) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths res object[] Additional optional resources Properties BaselineContourShiftAngle_deg Gets or sets the baseline contour shift angle in degrees. public double BaselineContourShiftAngle_deg { get; set; } Property Value double BaselineOneContour Gets or sets the baseline contour. public FluteContour BaselineOneContour { get; set; } Property Value FluteContour TrackNum Gets or sets the number of tracks in the contour tray. public int TrackNum { get; set; } Property Value int XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour tray with the specified ZR list host. public IContourTray Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The ZR list host to use for the duplicate Returns IContourTray A new contour tray instance ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetFluteContourList() Gets the list of flute contours contained in this tray. public List GetFluteContourList() Returns List A list of flute contours. GetFluteNum() Gets the number of flutes. public virtual int GetFluteNum() Returns int The number of flutes. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + "summary": "Class UniformContourTray Namespace Hi.Milling.FluteContours Assembly HiMech.dll Represents a uniform contour tray for milling tool flutes. public class UniformContourTray : IContourTray, IMakeXmlSource, IExpandToBox3d, IGetFluteNum, IUpdateByContent, IClearCache Inheritance object UniformContourTray Implements IContourTray IMakeXmlSource IExpandToBox3d IGetFluteNum IUpdateByContent IClearCache 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) Constructors UniformContourTray() Initializes a new instance of the UniformContourTray class. public UniformContourTray() UniformContourTray(XElement, string, params object[]) Ctor. public UniformContourTray(XElement src, string baseDirectory, params object[] res) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths res object[] Additional optional resources Properties BaselineContourShiftAngle_deg Gets or sets the baseline contour shift angle in degrees. public double BaselineContourShiftAngle_deg { get; set; } Property Value double BaselineOneContour Gets or sets the baseline contour. public FluteContour BaselineOneContour { get; set; } Property Value FluteContour TrackNum Gets or sets the number of tracks in the contour tray. public int TrackNum { get; set; } Property Value int XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(IGetZrList) Creates a duplicate of this contour tray with the specified ZR list host. public IContourTray Duplicate(IGetZrList zrListHost) Parameters zrListHost IGetZrList The ZR list host to use for the duplicate Returns IContourTray A new contour tray instance ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetFluteContourList() Gets the list of flute contours contained in this tray. public List GetFluteContourList() Returns List A list of flute contours. GetFluteNum() Gets the number of flutes. public int GetFluteNum() Returns int The number of flutes. 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. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" }, "api/Hi.Milling.FluteContours.html": { "href": "api/Hi.Milling.FluteContours.html", "title": "Namespace Hi.Milling.FluteContours | HiAPI-C# 2025", - "summary": "Namespace Hi.Milling.FluteContours Classes ConstHelixSideContour Represents a constant helix side contour for milling cutters. FluteContour Represents a flute contour for milling tools. FluteContourUtil Provides utility methods for working with flute contours in milling tools. FreeContourTray Represents a container for multiple flute contours with free arrangement. FreeformSideContour Represents a freeform side contour for milling tools, allowing arbitrary contour shapes. ShiftedWorkingContour Represents a working contour that has been shifted by a specified angle. This class wraps another working contour and applies an angular transformation to it. SideContourDisplayee Represents a displayable side contour. SlideBottomContour Represents a slide bottom contour for milling cutters. SpanContourPos4d Represents a position in 4D space (r, theta, z, radial angle) for contour spans UniformContourTray Represents a uniform contour tray for milling tool flutes. Interfaces IBottomContour Represents a bottom flute contour for milling tools. IContourTray Interface for a container that holds multiple flute contours. ISideContour Represents a side flute contour for milling tools. IWorkingContour Represents a working contour for cutting operations in milling tools. This interface is implemented by both side contours (ISideContour) and bottom contours (IBottomContour)." + "summary": "Namespace Hi.Milling.FluteContours Classes ConstHelixSideContour Represents a constant helix side contour for milling cutters. FluteContour Represents a flute contour for milling tools. FluteContourUtil Provides utility methods for working with flute contours in milling tools. FreeContourTray Represents a container for multiple flute contours with free arrangement. FreeformSideContour Represents a freeform side contour for milling tools, allowing arbitrary contour shapes. ShiftedWorkingContour Represents a working contour that has been shifted by a specified angle. This class wraps another working contour and applies an angular transformation to it. SideContourDisplayee Represents a displayable side contour. SlideBottomContour Represents a slide bottom contour for milling cutters. SpanContourPos4d Represents a position in 4D space (r, theta, z, radial angle) for contour spans UniformContourTray Represents a uniform contour tray for milling tool flutes. Interfaces IBottomContour Represents a bottom flute contour for milling tools. IContourTray Interface for a container that holds multiple flute contours. IFluteNumSourceProperty Interface that requiring a FluteNumSource property. IGetFluteNum ISideContour Represents a side flute contour for milling tools. IWorkingContour Represents a working contour for cutting operations in milling tools. This interface is implemented by both side contours (ISideContour) and bottom contours (IBottomContour)." }, "api/Hi.Milling.IGetDiameter.html": { "href": "api/Hi.Milling.IGetDiameter.html", @@ -2489,10 +2629,35 @@ "title": "Class MillingRemovalUtil | HiAPI-C# 2025", "summary": "Class MillingRemovalUtil Namespace Hi.Milling Assembly HiMech.dll Utility for milling removal. public static class MillingRemovalUtil Inheritance object MillingRemovalUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetContoursOnToolRunningCoordinate(Substraction, MachineMotionStep) Gets contours on tool running coordinate from a subtraction. public static List> GetContoursOnToolRunningCoordinate(this Substraction substraction, MachineMotionStep machineStep) Parameters substraction Substraction The subtraction containing contact contours. machineStep MachineMotionStep The machining step with coordinate transformation. Returns List> List of contours on tool running coordinate. GetMrr_mm3ds(List>, Vec3d, double) Calculates the material removal rate in cubic millimeters per second. public static double GetMrr_mm3ds(List> contoursOnToolRunningCoordinate, Vec3d movingDirectionOnToolRunningCoordinate, double feedrate_mmds) Parameters contoursOnToolRunningCoordinate List> Contours on tool running coordinate. movingDirectionOnToolRunningCoordinate Vec3d Moving direction on tool running coordinate. feedrate_mmds double Feed rate in millimeters per second. Returns double Material removal rate in cubic millimeters per second." }, + "api/Hi.Milling.MillingTools.MillingTool.html": { + "href": "api/Hi.Milling.MillingTools.MillingTool.html", + "title": "Class MillingTool | HiAPI-C# 2025", + "summary": "Class MillingTool Namespace Hi.Milling.MillingTools Assembly HiMech.dll Represents a central stick milling tool that combines a holder and a cutter. public class MillingTool : IMachiningTool, IDisplayee, IExpandToBox3d, ITopo, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache, IGetFluteNum Inheritance object MillingTool Implements IMachiningTool IDisplayee IExpandToBox3d ITopo IGetAsmb IGetAnchor IGetTopoIndex IGetAnchoredDisplayeeList IGetFletchBuckle IMakeXmlSource IAbstractNote IDuplicate IClearCache IGetFluteNum Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) MillingToolUtil.GetFullH(IMachiningTool) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) 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) Constructors MillingTool() Ctor. public MillingTool() MillingTool(XElement, string, string) Initializes a new instance of the MillingTool class. public MillingTool(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing the tool configuration. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Properties AbstractNote Gets an abstract note describing the tool's dimensions and cutter. public string AbstractNote { get; } Property Value string Asmb Gets the assembly containing the tool components. public Asmb Asmb { get; } Property Value Asmb Cutter Gets the cutting tool. public ICutter Cutter { get; set; } Property Value ICutter CutterFile Gets or sets the file path of the cutter. public string CutterFile { get; set; } Property Value string ExposedCutterBendingPara_umdN Gets or sets the parameter for exposed cutter bending in micrometers per Newton. public double ExposedCutterBendingPara_umdN { get; } Property Value double ExposedCutterHeight_mm Gets or sets the exposed cutter height in millimeters. public double ExposedCutterHeight_mm { get; set; } Property Value double ExposedCutterZDeflectionPara_umdN Gets or sets the parameter for exposed cutter Z-axis deflection in micrometers per Newton. public double ExposedCutterZDeflectionPara_umdN { get; } Property Value double Holder Gets or sets the tool holder. public IHolder Holder { get; set; } Property Value IHolder HolderFile Gets or sets the holder file path. public string HolderFile { get; set; } Property Value string Note Gets or sets a note for this machining tool. public string Note { get; set; } Property Value string ObservationAnchor Gets the tool anchor reference point. public Anchor ObservationAnchor { get; } Property Value Anchor ObservationAnchorReference Gets the tool observation anchor reference point. public MillingToolAnchorReference ObservationAnchorReference { get; set; } Property Value MillingToolAnchorReference ObservationHeightFromToolTip Gets the tool observation point relative to the reference. public double ObservationHeightFromToolTip { get; } Property Value double ObservationRingRadius_mm Obsoleted. Gets the tool observation reference point. public double ObservationRingRadius_mm { get; set; } Property Value double PreservedDistanceBetweenFluteAndSpindleNose_mm Gets or sets the preserved distance between flute and clamp in millimeters. public double PreservedDistanceBetweenFluteAndSpindleNose_mm { get; set; } Property Value double RelativeHeightFromObservationAnchor_mm Gets the tool observation point relative to the reference. public double RelativeHeightFromObservationAnchor_mm { get; set; } Property Value double SpindleBuckle Gets the motor-side buckle. public Anchor SpindleBuckle { get; } Property Value Anchor SpindleBuckleToToolTipLength Height For NC Compensation table and step number computation. public double SpindleBuckleToToolTipLength { get; } Property Value double ToolTip Gets the tool tip anchor point from the cutter. public Anchor ToolTip { get; } Property Value Anchor XName Initializes a new instance of the StickMachiningTool class from XML data. public static string XName { get; } Property Value string Methods AlignAnchorByExposedCutterHeight() Aligns the anchor by the exposed cutter height. public void AlignAnchorByExposedCutterHeight() ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box Remarks For display GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetFluteNum() Gets the number of flutes in the contour tray. public int GetFluteNum() Returns int 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." + }, + "api/Hi.Milling.MillingTools.MillingToolAnchorReference.html": { + "href": "api/Hi.Milling.MillingTools.MillingToolAnchorReference.html", + "title": "Enum MillingToolAnchorReference | HiAPI-C# 2025", + "summary": "Enum MillingToolAnchorReference Namespace Hi.Milling.MillingTools Assembly HiMech.dll Defines reference points for anchoring milling tools. public enum MillingToolAnchorReference Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields HolderAnc = 2 The holder anchor as the reference point. None = 0 No specific anchor reference point. SpindleBuckleAnc = 4 The spindle buckle anchor as the reference point. ToolTip = 1 The tool tip as the anchor reference point." + }, + "api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html": { + "href": "api/Hi.Milling.MillingTools.MillingToolEditorDisplayee.html", + "title": "Class MillingToolEditorDisplayee | HiAPI-C# 2025", + "summary": "Class MillingToolEditorDisplayee Namespace Hi.Milling.MillingTools Assembly HiMech.dll public class MillingToolEditorDisplayee : ITopoDisplayee, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IClearCache Inheritance object MillingToolEditorDisplayee Implements ITopoDisplayee ITopo IGetAsmb IGetAnchoredDisplayeeList IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) 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) Properties HolderEditorDisplayee public HolderEditorDisplayee HolderEditorDisplayee { get; } Property Value HolderEditorDisplayee MillingCutterEditorDisplayee public MillingCutterEditorDisplayee MillingCutterEditorDisplayee { get; } Property Value MillingCutterEditorDisplayee MillingTool public MillingTool MillingTool { get; } Property Value MillingTool MillingToolGetter public Func MillingToolGetter { get; set; } Property Value Func ShowCutter public bool ShowCutter { get; set; } Property Value bool ShowHolder public bool ShowHolder { get; set; } Property Value bool Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb." + }, + "api/Hi.Milling.MillingTools.MillingToolUtil.html": { + "href": "api/Hi.Milling.MillingTools.MillingToolUtil.html", + "title": "Class MillingToolUtil | HiAPI-C# 2025", + "summary": "Class MillingToolUtil Namespace Hi.Milling.MillingTools Assembly HiMech.dll Provides utility methods for working with milling tools. public static class MillingToolUtil Inheritance object MillingToolUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetFullH(IMachiningTool) Gets the full height of the milling tool. public static double GetFullH(this IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool to measure. Returns double The height of the tool in the Z dimension." + }, + "api/Hi.Milling.MillingTools.html": { + "href": "api/Hi.Milling.MillingTools.html", + "title": "Namespace Hi.Milling.MillingTools | HiAPI-C# 2025", + "summary": "Namespace Hi.Milling.MillingTools Classes MillingTool Represents a central stick milling tool that combines a holder and a cutter. MillingToolEditorDisplayee MillingToolUtil Provides utility methods for working with milling tools. Enums MillingToolAnchorReference Defines reference points for anchoring milling tools." + }, "api/Hi.Milling.SpindleCapability.html": { "href": "api/Hi.Milling.SpindleCapability.html", "title": "Class SpindleCapability | HiAPI-C# 2025", - "summary": "Class SpindleCapability Namespace Hi.Milling Assembly HiMech.dll Represents the capability of a spindle, including power, torque, and thermal characteristics. Internal Use Only public class SpindleCapability : IMakeXmlSource, INameNote Inheritance object SpindleCapability Implements IMakeXmlSource INameNote 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) Constructors SpindleCapability() Ctor. public SpindleCapability() SpindleCapability(XElement, string, params object[]) Initializes a new instance of the SpindleCapability class. public SpindleCapability(XElement src, string baseDirectory, params object[] res) Parameters src XElement The XML element containing spindle data. baseDirectory string The base directory for resolving relative paths. res object[] Additional resolution parameters. Properties DryRunFrictionPowerCoefficient_mWdrpm Dry Run Friction Power Coefficient. unit is mW/rpm. DryRunFrictionPower = DryRunFrictionPowerCoefficient * S. public double DryRunFrictionPowerCoefficient_mWdrpm { get; set; } Property Value double Remarks default value 4.82 is estimated by paper: The Friction of Radially Loaded Hybrid Spindle Bearings under High Speeds. Figure 13. At 9k rpm, Torque 0.046Nm. DryRunWindagePowerCoefficient_pWdrpm3 Dry Run Windage Power Coefficient. unit is pW/(rpm^3). DryRunWindagePower = DryRunWindagePowerCoefficient * (S^3). public double DryRunWindagePowerCoefficient_pWdrpm3 { get; set; } Property Value double Remarks default value 90 is estimated by paper: CFD Study on the Windage Power Loss of High Speed Gear. rpm W 5000 12 6000 20 7000 29 EnergyEfficiency Energy Conversion Efficiency. Where is Ouput/Input. public double EnergyEfficiency { get; set; } Property Value double GearShiftSpindleSpeed_cycleds Crossover speed. Gear Shift speed. spindle speed at shifting point between low gear mode and high gear mode. null means there is no gear shift mechanism. public double? GearShiftSpindleSpeed_cycleds { get; set; } Property Value double? GearShiftSpindleSpeed_rpm Gear shift spindle speed in RPM. public double? GearShiftSpindleSpeed_rpm { get; set; } Property Value double? InfInsistentSpindleSpeedToPower_cycleDs_kW SpindleSpeed(cycle/sec) to Power(kW) at infinte workable time. public List InfInsistentSpindleSpeedToPower_cycleDs_kW { get; set; } Property Value List InfInsistentSpindleSpeedToTorque_cycleDs_Nm SpindleSpeed(cycle/sec) to Torque(Nm) at 100% insistent ratio. public List InfInsistentSpindleSpeedToTorque_cycleDs_Nm { get; set; } Property Value List Name Name. public string Name { get; set; } Property Value string Note Note. public string Note { get; set; } Property Value string WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW WorkableDuration To SpindleSpeedToPowerContours. The dictionary is workable time (min) to (x:SpindleSpeed(cycle/sec), y:Power(kW)) public Dictionary> WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW { get; set; } Property Value Dictionary> WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm WorkableDuration To SpindleSpeedToTorqueContours. The dictionary is workable time (min) to (x:SpindleSpeed(cycle/sec), y:Torque(Nm)). public Dictionary> WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm { get; set; } Property Value Dictionary> WorkingTemperatureUpperBoundary_C Upper boundary of working temperature in Celsius. public double WorkingTemperatureUpperBoundary_C { get; set; } Property Value double WorkingTemperatureUpperBoundary_K Upper boundary of working temperature in Kelvin. public double WorkingTemperatureUpperBoundary_K { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods GetHeatPara(double) Gets thermal parameters for the spindle at a given speed. Internal Use Only public (double HeatCapacity_JdK, double ConvectionPara_WdK) GetHeatPara(double spindleSpeed_cycleDs) Parameters spindleSpeed_cycleDs double Spindle speed in cycles per second Returns (double HeatCapacity_JdK, double ConvectionPara_WdK) A tuple containing heat capacity and convection parameter MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class SpindleCapability Namespace Hi.Milling Assembly HiMech.dll Represents the capability of a spindle, including power, torque, and thermal characteristics. Internal Use Only public class SpindleCapability : IMakeXmlSource, INameNote Inheritance object SpindleCapability Implements IMakeXmlSource INameNote 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) Constructors SpindleCapability() Ctor. public SpindleCapability() SpindleCapability(XElement, string, params object[]) Initializes a new instance of the SpindleCapability class. public SpindleCapability(XElement src, string baseDirectory, params object[] res) Parameters src XElement The XML element containing spindle data. baseDirectory string The base directory for resolving relative paths. res object[] Additional resolution parameters. Properties DryRunFrictionPowerCoefficient_mWdrpm Dry Run Friction Power Coefficient. unit is mW/rpm. DryRunFrictionPower = DryRunFrictionPowerCoefficient * S. public double DryRunFrictionPowerCoefficient_mWdrpm { get; set; } Property Value double Remarks default value 4.82 is estimated by paper: The Friction of Radially Loaded Hybrid Spindle Bearings under High Speeds. Figure 13. At 9k rpm, Torque 0.046Nm. DryRunWindagePowerCoefficient_pWdrpm3 Dry Run Windage Power Coefficient. unit is pW/(rpm^3). DryRunWindagePower = DryRunWindagePowerCoefficient * (S^3). public double DryRunWindagePowerCoefficient_pWdrpm3 { get; set; } Property Value double Remarks default value 90 is estimated by paper: CFD Study on the Windage Power Loss of High Speed Gear. rpm W 5000 12 6000 20 7000 29 EnergyEfficiency Energy Conversion Efficiency. Where is Ouput/Input. public double EnergyEfficiency { get; set; } Property Value double GearShiftSpindleSpeed_cycleds Crossover speed. Gear Shift speed. spindle speed at shifting point between low gear mode and high gear mode. null means there is no gear shift mechanism. public double? GearShiftSpindleSpeed_cycleds { get; set; } Property Value double? GearShiftSpindleSpeed_rpm Gear shift spindle speed in RPM. public double? GearShiftSpindleSpeed_rpm { get; set; } Property Value double? InfInsistentSpindleSpeedToPower_cycleDs_kW SpindleSpeed(cycle/sec) to Power(kW) at infinte workable time. public List InfInsistentSpindleSpeedToPower_cycleDs_kW { get; set; } Property Value List InfInsistentSpindleSpeedToTorque_cycleDs_Nm SpindleSpeed(cycle/sec) to Torque(Nm) at 100% insistent ratio. public List InfInsistentSpindleSpeedToTorque_cycleDs_Nm { get; set; } Property Value List Name Name. public string Name { get; set; } Property Value string Note Note. public string Note { get; set; } Property Value string WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW WorkableDuration To SpindleSpeedToPowerContours. The dictionary is workable time (min) to (x:SpindleSpeed(cycle/sec), y:Power(kW)) public Dictionary> WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW { get; set; } Property Value Dictionary> WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm WorkableDuration To SpindleSpeedToTorqueContours. The dictionary is workable time (min) to (x:SpindleSpeed(cycle/sec), y:Torque(Nm)). public Dictionary> WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm { get; set; } Property Value Dictionary> WorkingTemperatureUpperBoundary_C Upper boundary of working temperature in Celsius. public double WorkingTemperatureUpperBoundary_C { get; set; } Property Value double WorkingTemperatureUpperBoundary_K Upper boundary of working temperature in Kelvin. public double WorkingTemperatureUpperBoundary_K { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods GetHeatPara(double) Gets thermal parameters for the spindle at a given speed. Internal Use Only public (double HeatCapacity_JdK, double ConvectionPara_WdK) GetHeatPara(double spindleSpeed_cycleDs) Parameters spindleSpeed_cycleDs double Spindle speed in cycles per second Returns (double HeatCapacity_JdK, double ConvectionPara_WdK) A tuple containing heat capacity and convection parameter 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." }, "api/Hi.Milling.html": { "href": "api/Hi.Milling.html", @@ -2502,17 +2667,17 @@ "api/Hi.MillingForces.Fittings.CuttingParaUtil.html": { "href": "api/Hi.MillingForces.Fittings.CuttingParaUtil.html", "title": "Class CuttingParaUtil | HiAPI-C# 2025", - "summary": "Class CuttingParaUtil Namespace Hi.MillingForces.Fittings Assembly HiMech.dll Utility methods for working with cutting parameters. public static class CuttingParaUtil Inheritance object CuttingParaUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ToRakeFaceCuttingPara(ICuttingPara) Converts various cutting parameter types to a RakeFaceCuttingPara. This function is for adjusting obsoleted design as some milling parameter formats are not used anymore. public static RakeFaceCuttingPara ToRakeFaceCuttingPara(this ICuttingPara millingPara) Parameters millingPara ICuttingPara The cutting parameter to convert. Returns RakeFaceCuttingPara A RakeFaceCuttingPara instance, or null if conversion is not possible." + "summary": "Class CuttingParaUtil Namespace Hi.MillingForces.Fittings Assembly HiMech.dll Utility methods for working with cutting parameters. public static class CuttingParaUtil Inheritance object CuttingParaUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ToRakeFaceCuttingPara(ICuttingPara) Converts various cutting parameter types to a RakeFaceCuttingPara. This function is for adjusting obsoleted design as some milling parameter formats are not used anymore. public static RakeFaceCuttingPara3d ToRakeFaceCuttingPara(this ICuttingPara millingPara) Parameters millingPara ICuttingPara The cutting parameter to convert. Returns RakeFaceCuttingPara3d A RakeFaceCuttingPara instance, or null if conversion is not possible." }, "api/Hi.MillingForces.Fittings.ICuttingPara.html": { "href": "api/Hi.MillingForces.Fittings.ICuttingPara.html", "title": "Interface ICuttingPara | HiAPI-C# 2025", - "summary": "Interface ICuttingPara Namespace Hi.MillingForces.Fittings Assembly HiMech.dll Interface of milling parameter. The milling parameter is trainable. public interface ICuttingPara : IGetCuttingPara, IMakeXmlSource, INameNote Inherited Members IGetCuttingPara.GetCuttingPara() IMakeXmlSource.MakeXmlSource(string, string) INameNote.Name INameNote.Note Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties ElementNum Element number. int ElementNum { get; } Property Value int FluteFormNum Flute form number. int FluteFormNum { get; } Property Value int Methods CloneTemplate() Clone template. ICuttingPara CloneTemplate() Returns ICuttingPara clone template GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. List GenUnitParas() Returns List unit parameters. GetElementByIndex(int) Get element by index. For parameter training. double GetElementByIndex(int elementIndex) Parameters elementIndex int element index Returns double value SetElementByIndex(int, double) Set element by index. For parameter training. void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int element index v double value ToTemplateXElement() Get XElement for templating. XElement ToTemplateXElement() Returns XElement" + "summary": "Interface ICuttingPara Namespace Hi.MillingForces.Fittings Assembly HiMech.dll Interface of milling parameter. The milling parameter is trainable. public interface ICuttingPara : IGetCuttingPara, IMakeXmlSource, INameNote Inherited Members IGetCuttingPara.GetCuttingPara() IMakeXmlSource.MakeXmlSource(string, string, bool) INameNote.Name INameNote.Note Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Properties ElementNum Element number. int ElementNum { get; } Property Value int FluteFormNum Flute form number. int FluteFormNum { get; } Property Value int Methods CloneTemplate() Clone template. ICuttingPara CloneTemplate() Returns ICuttingPara clone template GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. List GenUnitParas() Returns List unit parameters. GetElementByIndex(int) Get element by index. For parameter training. double GetElementByIndex(int elementIndex) Parameters elementIndex int element index Returns double value SetElementByIndex(int, double) Set element by index. For parameter training. void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int element index v double value ToTemplateXElement() Get XElement for templating. XElement ToTemplateXElement() Returns XElement" }, "api/Hi.MillingForces.Fittings.IGetCuttingPara.html": { "href": "api/Hi.MillingForces.Fittings.IGetCuttingPara.html", "title": "Interface IGetCuttingPara | HiAPI-C# 2025", - "summary": "Interface IGetCuttingPara Namespace Hi.MillingForces.Fittings Assembly HiMech.dll Interface of GetCuttingPara(). public interface IGetCuttingPara : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string) 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) Methods GetCuttingPara() Get ICuttingPara. ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara" + "summary": "Interface IGetCuttingPara Namespace Hi.MillingForces.Fittings Assembly HiMech.dll Interface of GetCuttingPara(). public interface IGetCuttingPara : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Methods GetCuttingPara() Get ICuttingPara. ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara" }, "api/Hi.MillingForces.Fittings.SampleCategory.html": { "href": "api/Hi.MillingForces.Fittings.SampleCategory.html", @@ -2622,12 +2787,12 @@ "api/Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html": { "href": "api/Hi.MillingForces.ProfileMillingParas.LocalProfileMillingPara.html", "title": "Class LocalProfileMillingPara | HiAPI-C# 2025", - "summary": "Class LocalProfileMillingPara Namespace Hi.MillingForces.ProfileMillingParas Assembly HiMech.dll Milling parameter of altintas model. public class LocalProfileMillingPara : IEquatable, IMakeXmlSource, IGetLocalProfileMillingPara, ICsvRowIo Inheritance object LocalProfileMillingPara Implements IEquatable IMakeXmlSource IGetLocalProfileMillingPara ICsvRowIo 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors LocalProfileMillingPara() Ctor. public LocalProfileMillingPara() LocalProfileMillingPara(Vec3d, Vec3d) Ctor. public LocalProfileMillingPara(Vec3d shearPara, Vec3d ploughPara) Parameters shearPara Vec3d shear milling parameter. (x,y,z)=(Ktc,Krc,Kac) ploughPara Vec3d plough milling parameter. (x,y,z)=(Kte,Kre,Kae) LocalProfileMillingPara(LocalProfileMillingPara) Copy constructor. public LocalProfileMillingPara(LocalProfileMillingPara srcPara) Parameters srcPara LocalProfileMillingPara Source parameter to copy from. LocalProfileMillingPara(double, double, double, double, double, double) Constructor with specific milling parameters. public LocalProfileMillingPara(double Krc, double Ktc, double Kac, double Kre, double Kte, double Kae) Parameters Krc double Radial shear coefficient. Ktc double Tangential shear coefficient. Kac double Axial shear coefficient. Kre double Radial plough coefficient. Kte double Tangential plough coefficient. Kae double Axial plough coefficient. LocalProfileMillingPara(XElement) Ctor by XML. public LocalProfileMillingPara(XElement src) Parameters src XElement XML Fields Zero Gets a LocalProfileMillingPara instance with all parameters set to zero. public static LocalProfileMillingPara Zero Field Value LocalProfileMillingPara Properties AA7075 Gets milling parameters for AA7075 aluminum alloy. public static LocalProfileMillingPara AA7075 { get; } Property Value LocalProfileMillingPara Al6061T6 Al6061T6. Build by 20190213 PMC end-mill exp. public static LocalProfileMillingPara Al6061T6 { get; } Property Value LocalProfileMillingPara Al6061T6_ Milling parameters for Al6061T6 material (older version). Determined by NCCU. public static LocalProfileMillingPara Al6061T6_ { get; } Property Value LocalProfileMillingPara Al6061T6_R0p5 Milling parameters for Al6061T6 material with 0.5mm radius. Built by PMC on 2019-02-13. public static LocalProfileMillingPara Al6061T6_R0p5 { get; } Property Value LocalProfileMillingPara CsvText Csv text. public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. public string CsvTitleText { get; } Property Value string Inconel718 Gets milling parameters for Inconel 718 material. public static LocalProfileMillingPara Inconel718 { get; } Property Value LocalProfileMillingPara Kp Coefficient of (Kpr,Kpt,Kpa). public Vec3d Kp { get; set; } Property Value Vec3d Kpa Coefficient of axial plough force. public double Kpa { get; set; } Property Value double Kpr Coefficient of radial plough force. public double Kpr { get; set; } Property Value double Kpt Coefficient of tangential plough force. public double Kpt { get; set; } Property Value double Ks Coefficient of (Ksr,Kst,Ksa). public Vec3d Ks { get; set; } Property Value Vec3d Ksa Coefficient of axial shear force. public double Ksa { get; set; } Property Value double Ksr Coefficient of radial shear force. public double Ksr { get; set; } Property Value double Kst Coefficient of tangential shear force. public double Kst { get; set; } Property Value double NaN Gets a LocalProfileMillingPara instance with all parameters set to NaN (Not a Number). public static LocalProfileMillingPara NaN { get; } Property Value LocalProfileMillingPara S45C_ColumnEnd Gets milling parameters for S45C material with column end configuration. public static LocalProfileMillingPara S45C_ColumnEnd { get; } Property Value LocalProfileMillingPara SS304 Milling parameters for SS304 stainless steel. Reference: “The effect of cutting force model coefficient variability on process planning in milling”, Firat Eren, University of New Hampshire, Durham. public static LocalProfileMillingPara SS304 { get; } Property Value LocalProfileMillingPara SS304_R0 Gets milling parameters for SS304 stainless steel with no radius (R0). public static LocalProfileMillingPara SS304_R0 { get; } Property Value LocalProfileMillingPara SS304_R0p5 Gets milling parameters for SS304 stainless steel with 0.5mm radius (R0.5) and 4 flutes. public static LocalProfileMillingPara SS304_R0p5 { get; } Property Value LocalProfileMillingPara SS304_R3 Gets milling parameters for SS304 stainless steel with 3mm radius (R3) and 4 flutes. public static LocalProfileMillingPara SS304_R3 { get; } Property Value LocalProfileMillingPara Steel17_4PH Milling parameters for Steel 17-4PH material. public static LocalProfileMillingPara Steel17_4PH { get; } Property Value LocalProfileMillingPara Ti6Al4V Gets milling parameters for Ti6Al4V material. public static LocalProfileMillingPara Ti6Al4V { get; } Property Value LocalProfileMillingPara Ti6Al4V_Altintas2001 Gets milling parameters for Ti6Al4V material based on Altintas 2001 research. public static LocalProfileMillingPara Ti6Al4V_Altintas2001 { get; } Property Value LocalProfileMillingPara XName Name for XML IO. public static string XName { get; } Property Value string Methods Equals(LocalProfileMillingPara) Indicates whether the current object is equal to another object of the same type. public bool Equals(LocalProfileMillingPara other) Parameters other LocalProfileMillingPara An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GetElementByIndex(RtaMillingParaKey) Gets the parameter value by the specified key. public double GetElementByIndex(RtaMillingParaKey key) Parameters key RtaMillingParaKey The parameter key to retrieve. Returns double The parameter value corresponding to the key. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetMillingPara() Get LocalProfileMillingPara. public LocalProfileMillingPara GetMillingPara() Returns LocalProfileMillingPara LocalProfileMillingPara MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetElementByIndex(RtaMillingParaKey, double) Sets the parameter value for the specified key. public void SetElementByIndex(RtaMillingParaKey key, double v) Parameters key RtaMillingParaKey The parameter key to set. v double The value to set. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class LocalProfileMillingPara Namespace Hi.MillingForces.ProfileMillingParas Assembly HiMech.dll Milling parameter of altintas model. public class LocalProfileMillingPara : IEquatable, IMakeXmlSource, IGetLocalProfileMillingPara, ICsvRowIo Inheritance object LocalProfileMillingPara Implements IEquatable IMakeXmlSource IGetLocalProfileMillingPara ICsvRowIo 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) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors LocalProfileMillingPara() Ctor. public LocalProfileMillingPara() LocalProfileMillingPara(Vec3d, Vec3d) Ctor. public LocalProfileMillingPara(Vec3d shearPara, Vec3d ploughPara) Parameters shearPara Vec3d shear milling parameter. (x,y,z)=(Ktc,Krc,Kac) ploughPara Vec3d plough milling parameter. (x,y,z)=(Kte,Kre,Kae) LocalProfileMillingPara(LocalProfileMillingPara) Copy constructor. public LocalProfileMillingPara(LocalProfileMillingPara srcPara) Parameters srcPara LocalProfileMillingPara Source parameter to copy from. LocalProfileMillingPara(double, double, double, double, double, double) Constructor with specific milling parameters. public LocalProfileMillingPara(double Krc, double Ktc, double Kac, double Kre, double Kte, double Kae) Parameters Krc double Radial shear coefficient. Ktc double Tangential shear coefficient. Kac double Axial shear coefficient. Kre double Radial plough coefficient. Kte double Tangential plough coefficient. Kae double Axial plough coefficient. LocalProfileMillingPara(XElement) Ctor by XML. public LocalProfileMillingPara(XElement src) Parameters src XElement XML Fields Zero Gets a LocalProfileMillingPara instance with all parameters set to zero. public static LocalProfileMillingPara Zero Field Value LocalProfileMillingPara Properties AA7075 Gets milling parameters for AA7075 aluminum alloy. public static LocalProfileMillingPara AA7075 { get; } Property Value LocalProfileMillingPara Al6061T6 Al6061T6. Build by 20190213 PMC end-mill exp. public static LocalProfileMillingPara Al6061T6 { get; } Property Value LocalProfileMillingPara Al6061T6_ Milling parameters for Al6061T6 material (older version). Determined by NCCU. public static LocalProfileMillingPara Al6061T6_ { get; } Property Value LocalProfileMillingPara Al6061T6_R0p5 Milling parameters for Al6061T6 material with 0.5mm radius. Built by PMC on 2019-02-13. public static LocalProfileMillingPara Al6061T6_R0p5 { get; } Property Value LocalProfileMillingPara CsvText Csv text. public string CsvText { get; set; } Property Value string CsvTitleText Csv titles text. public string CsvTitleText { get; } Property Value string Inconel718 Gets milling parameters for Inconel 718 material. public static LocalProfileMillingPara Inconel718 { get; } Property Value LocalProfileMillingPara Kp Coefficient of (Kpr,Kpt,Kpa). public Vec3d Kp { get; set; } Property Value Vec3d Kpa Coefficient of axial plough force. public double Kpa { get; set; } Property Value double Kpr Coefficient of radial plough force. public double Kpr { get; set; } Property Value double Kpt Coefficient of tangential plough force. public double Kpt { get; set; } Property Value double Ks Coefficient of (Ksr,Kst,Ksa). public Vec3d Ks { get; set; } Property Value Vec3d Ksa Coefficient of axial shear force. public double Ksa { get; set; } Property Value double Ksr Coefficient of radial shear force. public double Ksr { get; set; } Property Value double Kst Coefficient of tangential shear force. public double Kst { get; set; } Property Value double NaN Gets a LocalProfileMillingPara instance with all parameters set to NaN (Not a Number). public static LocalProfileMillingPara NaN { get; } Property Value LocalProfileMillingPara S45C_ColumnEnd Gets milling parameters for S45C material with column end configuration. public static LocalProfileMillingPara S45C_ColumnEnd { get; } Property Value LocalProfileMillingPara SS304 Milling parameters for SS304 stainless steel. Reference: “The effect of cutting force model coefficient variability on process planning in milling”, Firat Eren, University of New Hampshire, Durham. public static LocalProfileMillingPara SS304 { get; } Property Value LocalProfileMillingPara SS304_R0 Gets milling parameters for SS304 stainless steel with no radius (R0). public static LocalProfileMillingPara SS304_R0 { get; } Property Value LocalProfileMillingPara SS304_R0p5 Gets milling parameters for SS304 stainless steel with 0.5mm radius (R0.5) and 4 flutes. public static LocalProfileMillingPara SS304_R0p5 { get; } Property Value LocalProfileMillingPara SS304_R3 Gets milling parameters for SS304 stainless steel with 3mm radius (R3) and 4 flutes. public static LocalProfileMillingPara SS304_R3 { get; } Property Value LocalProfileMillingPara Steel17_4PH Milling parameters for Steel 17-4PH material. public static LocalProfileMillingPara Steel17_4PH { get; } Property Value LocalProfileMillingPara Ti6Al4V Gets milling parameters for Ti6Al4V material. public static LocalProfileMillingPara Ti6Al4V { get; } Property Value LocalProfileMillingPara Ti6Al4V_Altintas2001 Gets milling parameters for Ti6Al4V material based on Altintas 2001 research. public static LocalProfileMillingPara Ti6Al4V_Altintas2001 { get; } Property Value LocalProfileMillingPara XName Name for XML IO. public static string XName { get; } Property Value string Methods Equals(LocalProfileMillingPara) Indicates whether the current object is equal to another object of the same type. public bool Equals(LocalProfileMillingPara other) Parameters other LocalProfileMillingPara An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GetElementByIndex(RtaMillingParaKey) Gets the parameter value by the specified key. public double GetElementByIndex(RtaMillingParaKey key) Parameters key RtaMillingParaKey The parameter key to retrieve. Returns double The parameter value corresponding to the key. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. GetMillingPara() Get LocalProfileMillingPara. public LocalProfileMillingPara GetMillingPara() Returns LocalProfileMillingPara LocalProfileMillingPara 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. SetElementByIndex(RtaMillingParaKey, double) Sets the parameter value for the specified key. public void SetElementByIndex(RtaMillingParaKey key, double v) Parameters key RtaMillingParaKey The parameter key to set. v double The value to set. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html": { "href": "api/Hi.MillingForces.ProfileMillingParas.ProfileMillingParaMap.html", "title": "Class ProfileMillingParaMap | HiAPI-C# 2025", - "summary": "Class ProfileMillingParaMap Namespace Hi.MillingForces.ProfileMillingParas Assembly HiMech.dll Represents a mapping of milling parameters for profile milling operations. This class manages cutting parameters for both side and bottom milling operations. public class ProfileMillingParaMap : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote Inheritance object ProfileMillingParaMap Implements ICuttingPara IGetCuttingPara IMakeXmlSource INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors ProfileMillingParaMap(LocalProfileMillingPara, LocalProfileMillingPara, bool) Ctor for single LocalProfileMillingPara. public ProfileMillingParaMap(LocalProfileMillingPara sidePara, LocalProfileMillingPara bottomPara = null, bool containUpperSide = false) Parameters sidePara LocalProfileMillingPara milling parameter on side bottomPara LocalProfileMillingPara milling parameter on bottom containUpperSide bool Whether to include upper side parameters ProfileMillingParaMap(ProfileMillingParaMap) Copy ctor. public ProfileMillingParaMap(ProfileMillingParaMap src) Parameters src ProfileMillingParaMap src ProfileMillingParaMap(int, int, int, bool) Initializes a new instance of the ProfileMillingParaMap class with specified dimensions. public ProfileMillingParaMap(int fluteNum, int yDivisionNum, int zDivisionNum, bool isUpperSideContained = false) Parameters fluteNum int The number of flutes. yDivisionNum int The number of divisions in Y direction. zDivisionNum int The number of divisions in Z direction. isUpperSideContained bool Whether to include the upper side of the milling profile. ProfileMillingParaMap(XElement, string, bool) Initializes a new instance of the ProfileMillingParaMap class from XML data. public ProfileMillingParaMap(XElement src, string baseDirectory, bool isRtaVersion) Parameters src XElement The XML element containing the parameter data. baseDirectory string The base directory for resolving relative paths. isRtaVersion bool Whether the data is in RTA format. Properties BottomShearParas Gets the bottom shear parameters array. Each element contains cutting coefficients for each flute. public Vec3d[] BottomShearParas { get; } Property Value Vec3d[] ElementNum Gets the total number of elements in the parameter map. public int ElementNum { get; } Property Value int FluteFormNum Gets the number of flute forms in the parameter map. The number should be 1 or be equal to the flute number of the cutter. public int FluteFormNum { get; } Property Value int IsUpperSideContained Gets a value indicating whether the upper side of the milling profile is included in calculations. public bool IsUpperSideContained { get; } Property Value bool Name Gets or sets the name of the parameter map. public string Name { get; set; } Property Value string Note Gets or sets additional notes or descriptions for the parameter map. public string Note { get; set; } Property Value string PloughPara Gets the ploughing force coefficients (Kpr, Kpt, Kpa) for the entire tool. public Vec3d PloughPara { get; } Property Value Vec3d SideShearParas Gets the side shear parameters array. The dimensions represent [flute form, Y division, Z division]. Each element contains cutting coefficients (Ksr, Kst, Ksa) for the corresponding position. public Vec3d[,,] SideShearParas { get; } Property Value Vec3d[,,] SideYParaNum Gets the number of divisions in the Y direction for side milling parameters. public int SideYParaNum { get; } Property Value int SideZParaNum Gets the number of divisions in the Z direction for side milling parameters. public int SideZParaNum { get; } Property Value int XName Name for XML IO. public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods CloneTemplate() Creates a template clone of this parameter map. public ICuttingPara CloneTemplate() Returns ICuttingPara A new instance with the same dimensions but zero values. GenUnitParas() Generates a list of unit cutting parameters. public List GenUnitParas() Returns List A list of unit cutting parameters. GetBottomMillingPara(int) Gets the milling parameters for the bottom of a specific flute. public LocalProfileMillingPara GetBottomMillingPara(int fluteIndex) Parameters fluteIndex int The index of the flute. Returns LocalProfileMillingPara The local milling parameters for the bottom of the specified flute. GetCuttingPara() Gets the cutting parameter interface for this instance. public ICuttingPara GetCuttingPara() Returns ICuttingPara The cutting parameter interface. GetElementByIndex(int) Gets a parameter value by its element index. public double GetElementByIndex(int elementIndex) Parameters elementIndex int The index of the element to get. Returns double The value at the specified index. GetElements() Gets the elements as an array of values. public double[] GetElements() Returns double[] An array containing all parameter values. GetSideMillingPara(int, double, double) Gets the milling parameters for a specific side position. public LocalProfileMillingPara GetSideMillingPara(int fluteIndex, double atanYX_rad, double atanZX_rad) Parameters fluteIndex int The index of the flute. atanYX_rad double The YX angle in radians. atanZX_rad double The ZX angle in radians. Returns LocalProfileMillingPara The local milling parameters for the specified position. MakeXmlSource(string, string) Creates an XML element representing the current parameter map. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Returns XElement An XML element containing the parameter data. SetElementByIndex(int, double) Sets a parameter value by its element index. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int The index of the element to set. v double The value to set. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToTemplateXElement() Creates a template XML element for the parameter map. public XElement ToTemplateXElement() Returns XElement A template XML element." + "summary": "Class ProfileMillingParaMap Namespace Hi.MillingForces.ProfileMillingParas Assembly HiMech.dll Represents a mapping of milling parameters for profile milling operations. This class manages cutting parameters for both side and bottom milling operations. public class ProfileMillingParaMap : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote Inheritance object ProfileMillingParaMap Implements ICuttingPara IGetCuttingPara IMakeXmlSource INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors ProfileMillingParaMap(LocalProfileMillingPara, LocalProfileMillingPara, bool) Ctor for single LocalProfileMillingPara. public ProfileMillingParaMap(LocalProfileMillingPara sidePara, LocalProfileMillingPara bottomPara = null, bool containUpperSide = false) Parameters sidePara LocalProfileMillingPara milling parameter on side bottomPara LocalProfileMillingPara milling parameter on bottom containUpperSide bool Whether to include upper side parameters ProfileMillingParaMap(ProfileMillingParaMap) Copy ctor. public ProfileMillingParaMap(ProfileMillingParaMap src) Parameters src ProfileMillingParaMap src ProfileMillingParaMap(int, int, int, bool) Initializes a new instance of the ProfileMillingParaMap class with specified dimensions. public ProfileMillingParaMap(int fluteNum, int yDivisionNum, int zDivisionNum, bool isUpperSideContained = false) Parameters fluteNum int The number of flutes. yDivisionNum int The number of divisions in Y direction. zDivisionNum int The number of divisions in Z direction. isUpperSideContained bool Whether to include the upper side of the milling profile. ProfileMillingParaMap(XElement, string, bool) Initializes a new instance of the ProfileMillingParaMap class from XML data. public ProfileMillingParaMap(XElement src, string baseDirectory, bool isRtaVersion) Parameters src XElement The XML element containing the parameter data. baseDirectory string The base directory for resolving relative paths. isRtaVersion bool Whether the data is in RTA format. Properties BottomShearParas Gets the bottom shear parameters array. Each element contains cutting coefficients for each flute. public Vec3d[] BottomShearParas { get; } Property Value Vec3d[] ElementNum Gets the total number of elements in the parameter map. public int ElementNum { get; } Property Value int FluteFormNum Gets the number of flute forms in the parameter map. The number should be 1 or be equal to the flute number of the cutter. public int FluteFormNum { get; } Property Value int IsUpperSideContained Gets a value indicating whether the upper side of the milling profile is included in calculations. public bool IsUpperSideContained { get; } Property Value bool Name Gets or sets the name of the parameter map. public string Name { get; set; } Property Value string Note Gets or sets additional notes or descriptions for the parameter map. public string Note { get; set; } Property Value string PloughPara Gets the ploughing force coefficients (Kpr, Kpt, Kpa) for the entire tool. public Vec3d PloughPara { get; } Property Value Vec3d SideShearParas Gets the side shear parameters array. The dimensions represent [flute form, Y division, Z division]. Each element contains cutting coefficients (Ksr, Kst, Ksa) for the corresponding position. public Vec3d[,,] SideShearParas { get; } Property Value Vec3d[,,] SideYParaNum Gets the number of divisions in the Y direction for side milling parameters. public int SideYParaNum { get; } Property Value int SideZParaNum Gets the number of divisions in the Z direction for side milling parameters. public int SideZParaNum { get; } Property Value int XName Name for XML IO. public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods CloneTemplate() Creates a template clone of this parameter map. public ICuttingPara CloneTemplate() Returns ICuttingPara A new instance with the same dimensions but zero values. GenUnitParas() Generates a list of unit cutting parameters. public List GenUnitParas() Returns List A list of unit cutting parameters. GetBottomMillingPara(int) Gets the milling parameters for the bottom of a specific flute. public LocalProfileMillingPara GetBottomMillingPara(int fluteIndex) Parameters fluteIndex int The index of the flute. Returns LocalProfileMillingPara The local milling parameters for the bottom of the specified flute. GetCuttingPara() Gets the cutting parameter interface for this instance. public ICuttingPara GetCuttingPara() Returns ICuttingPara The cutting parameter interface. GetElementByIndex(int) Gets a parameter value by its element index. public double GetElementByIndex(int elementIndex) Parameters elementIndex int The index of the element to get. Returns double The value at the specified index. GetElements() Gets the elements as an array of values. public double[] GetElements() Returns double[] An array containing all parameter values. GetSideMillingPara(int, double, double) Gets the milling parameters for a specific side position. public LocalProfileMillingPara GetSideMillingPara(int fluteIndex, double atanYX_rad, double atanZX_rad) Parameters fluteIndex int The index of the flute. atanYX_rad double The YX angle in radians. atanZX_rad double The ZX angle in radians. Returns LocalProfileMillingPara The local milling parameters for the specified position. 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. SetElementByIndex(int, double) Sets a parameter value by its element index. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int The index of the element to set. v double The value to set. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToTemplateXElement() Creates a template XML element for the parameter map. public XElement ToTemplateXElement() Returns XElement A template XML element." }, "api/Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey.html": { "href": "api/Hi.MillingForces.ProfileMillingParas.RtaMillingParaKey.html", @@ -2639,15 +2804,10 @@ "title": "Namespace Hi.MillingForces.ProfileMillingParas | HiAPI-C# 2025", "summary": "Namespace Hi.MillingForces.ProfileMillingParas Classes LocalProfileMillingPara Milling parameter of altintas model. ProfileMillingParaMap Represents a mapping of milling parameters for profile milling operations. This class manages cutting parameters for both side and bottom milling operations. Interfaces IGetLocalProfileMillingPara Interface of getting LocalProfileMillingPara. Enums RtaMillingParaKey Keys for milling parameters in radial-tangential-axial (RTA) coordinate system" }, - "api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara.html": { - "href": "api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.RakeFace2DCuttingPara.html", - "title": "Class RakeFace2DCuttingPara | HiAPI-C# 2025", - "summary": "Class RakeFace2DCuttingPara Namespace Hi.MillingForces.ProjectedRakeFaceCuttingParas Assembly HiMech.dll Represents a 2D cutting parameter for rake face cutting operations. public class RakeFace2DCuttingPara : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote Inheritance object RakeFace2DCuttingPara Implements ICuttingPara IGetCuttingPara IMakeXmlSource INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors RakeFace2DCuttingPara() Initializes a new instance of the RakeFace2DCuttingPara class. public RakeFace2DCuttingPara() RakeFace2DCuttingPara(RakeFace2DCuttingPara) Initializes a new instance of the RakeFace2DCuttingPara class by copying from another instance. public RakeFace2DCuttingPara(RakeFace2DCuttingPara src) Parameters src RakeFace2DCuttingPara The source instance to copy from. RakeFace2DCuttingPara(XElement, string) Initializes a new instance of the RakeFace2DCuttingPara class from XML. public RakeFace2DCuttingPara(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Fields element_num Gets the number of elements in the cutting parameter. public const int element_num = 4 Field Value int Properties ElementNum Element number. public int ElementNum { get; } Property Value int FluteFormNum Flute form number. public int FluteFormNum { get; } Property Value int Name Gets or sets the name of the cutting parameter. public string Name { get; set; } Property Value string Note Gets or sets additional notes about the cutting parameter. public string Note { get; set; } Property Value string PloughPara Gets or sets the plough parameter vector. public Vec2d PloughPara { get; set; } Property Value Vec2d ShearPara Gets or sets the shear parameter vector. public Vec2d ShearPara { get; set; } Property Value Vec2d XName Name for XML IO. public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods CloneTemplate() Clone template. public ICuttingPara CloneTemplate() Returns ICuttingPara clone template GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. public List GenUnitParas() Returns List unit parameters. GetCuttingPara() Get ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara GetElementByIndex(int) Gets the cutting parameter element at the specified index. public double GetElementByIndex(int index) Parameters index int The index of the element to retrieve. Returns double The cutting parameter element at the specified index. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetElementByIndex(int, double) Set element by index. For parameter training. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int element index v double value ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" - }, - "api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.html": { - "href": "api/Hi.MillingForces.ProjectedRakeFaceCuttingParas.html", - "title": "Namespace Hi.MillingForces.ProjectedRakeFaceCuttingParas | HiAPI-C# 2025", - "summary": "Namespace Hi.MillingForces.ProjectedRakeFaceCuttingParas Classes RakeFace2DCuttingPara Represents a 2D cutting parameter for rake face cutting operations." + "api/Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html": { + "href": "api/Hi.MillingForces.RakeFaceCuttingParas.IRakeFaceCuttingPara.html", + "title": "Interface IRakeFaceCuttingPara | HiAPI-C# 2025", + "summary": "Interface IRakeFaceCuttingPara Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll public interface IRakeFaceCuttingPara : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, IDuplicate Inherited Members ICuttingPara.FluteFormNum ICuttingPara.ElementNum ICuttingPara.ToTemplateXElement() ICuttingPara.GenUnitParas() ICuttingPara.SetElementByIndex(int, double) ICuttingPara.GetElementByIndex(int) ICuttingPara.CloneTemplate() IGetCuttingPara.GetCuttingPara() IMakeXmlSource.MakeXmlSource(string, string, bool) INameNote.Name INameNote.Note IDuplicate.Duplicate(params object[]) Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Properties AnchorRakeAngle_deg Gets or sets the anchor rake angle in degrees. double AnchorRakeAngle_deg { get; set; } Property Value double AnchorRakeAngle_rad Gets or sets the anchor rake angle in radians. Different rake angles may have different ploughing parameters but share the same shearing parameters. double AnchorRakeAngle_rad { get; set; } Property Value double Kpc Gets or sets the ploughing coefficient along the rake face cross line (c). Unit: N/mm. double Kpc { get; set; } Property Value double Kpn Gets or sets the ploughing coefficient along the rake face normal direction (n). Unit: N/mm. double Kpn { get; set; } Property Value double Ksc Gets or sets the shear coefficient along the rake face cross line (c). Direction is from outer to center on side cutting. Unit: N/mm². double Ksc { get; set; } Property Value double Ksn Gets or sets the shear coefficient along the rake face normal direction (n). Unit: N/mm². double Ksn { get; set; } Property Value double" }, "api/Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil.html": { "href": "api/Hi.MillingForces.RakeFaceCuttingParas.MillingPhysicsUtil.html", @@ -2657,22 +2817,27 @@ "api/Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html": { "href": "api/Hi.MillingForces.RakeFaceCuttingParas.MultiFormRakeFaceCuttingPara.html", "title": "Class MultiFormRakeFaceCuttingPara | HiAPI-C# 2025", - "summary": "Class MultiFormRakeFaceCuttingPara Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll Represents a multi-form rake face cutting parameter set that can handle multiple flute forms. Internal Use Only. public class MultiFormRakeFaceCuttingPara : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote Inheritance object MultiFormRakeFaceCuttingPara Implements ICuttingPara IGetCuttingPara IMakeXmlSource INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors MultiFormRakeFaceCuttingPara(int) Initializes a new instance of the MultiFormRakeFaceCuttingPara class with the specified number of flute forms. public MultiFormRakeFaceCuttingPara(int fluteFormNum) Parameters fluteFormNum int The number of flute forms to initialize. MultiFormRakeFaceCuttingPara(XElement, string) Initializes a new instance of the MultiFormRakeFaceCuttingPara class from XML data. public MultiFormRakeFaceCuttingPara(XElement src, string baseDirectory) Parameters src XElement The source XML element. baseDirectory string The base directory for resolving relative paths. Properties ElementNum Gets the total number of elements in this parameter set. public int ElementNum { get; } Property Value int FluteFormNum Gets the number of flute forms in this parameter set. public int FluteFormNum { get; } Property Value int LocalRakeFaceCuttingParas Gets or sets the array of local rake face cutting parameters for each flute form. public RakeFaceCuttingPara[] LocalRakeFaceCuttingParas { get; set; } Property Value RakeFaceCuttingPara[] Name Gets or sets the name of this parameter set. public string Name { get; set; } Property Value string Note Gets or sets additional notes about this parameter set. public string Note { get; set; } Property Value string XName Gets the XML element name for this type. public static string XName { get; } Property Value string XmlSourceFile Gets or sets the XML source file path. public string XmlSourceFile { get; set; } Property Value string Methods CloneTemplate() Creates a clone of this parameter set as a template. public ICuttingPara CloneTemplate() Returns ICuttingPara A cloned instance of this parameter set. GenUnitParas() Generates a list of unit cutting parameters. public List GenUnitParas() Returns List A list of unit cutting parameters. GetCuttingPara() Gets this instance as an ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara This instance. GetElementByIndex(int) Gets the value of an element at the specified index. public double GetElementByIndex(int elementIndex) Parameters elementIndex int The index of the element to get. Returns double The value of the element at the specified index. GetLocalRakeFaceCuttingPara(int) Gets the local rake face cutting parameters for the specified flute index. public RakeFaceCuttingPara GetLocalRakeFaceCuttingPara(int fluteIndex) Parameters fluteIndex int The zero-based index of the flute. Returns RakeFaceCuttingPara The rake face cutting parameters for the specified flute. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetElementByIndex(int, double) Sets the value of an element at the specified index. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int The index of the element to set. v double The value to set. ToString() Returns a string representation of this parameter set. public override string ToString() Returns string A string containing the name and note of this parameter set. ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" + "summary": "Class MultiFormRakeFaceCuttingPara Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll Represents a multi-form rake face cutting parameter set that can handle multiple flute forms. Internal Use Only. public class MultiFormRakeFaceCuttingPara : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote Inheritance object MultiFormRakeFaceCuttingPara Implements ICuttingPara IGetCuttingPara IMakeXmlSource INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors MultiFormRakeFaceCuttingPara(int) Initializes a new instance of the MultiFormRakeFaceCuttingPara class with the specified number of flute forms. public MultiFormRakeFaceCuttingPara(int fluteFormNum) Parameters fluteFormNum int The number of flute forms to initialize. MultiFormRakeFaceCuttingPara(XElement, string) Initializes a new instance of the MultiFormRakeFaceCuttingPara class from XML data. public MultiFormRakeFaceCuttingPara(XElement src, string baseDirectory) Parameters src XElement The source XML element. baseDirectory string The base directory for resolving relative paths. Properties ElementNum Gets the total number of elements in this parameter set. public int ElementNum { get; } Property Value int FluteFormNum Gets the number of flute forms in this parameter set. public int FluteFormNum { get; } Property Value int LocalRakeFaceCuttingParas Gets or sets the array of local rake face cutting parameters for each flute form. public RakeFaceCuttingPara3d[] LocalRakeFaceCuttingParas { get; set; } Property Value RakeFaceCuttingPara3d[] Name Gets or sets the name of this parameter set. public string Name { get; set; } Property Value string Note Gets or sets additional notes about this parameter set. public string Note { get; set; } Property Value string XName Gets the XML element name for this type. public static string XName { get; } Property Value string XmlSourceFile Gets or sets the XML source file path. public string XmlSourceFile { get; set; } Property Value string Methods CloneTemplate() Creates a clone of this parameter set as a template. public ICuttingPara CloneTemplate() Returns ICuttingPara A cloned instance of this parameter set. GenUnitParas() Generates a list of unit cutting parameters. public List GenUnitParas() Returns List A list of unit cutting parameters. GetCuttingPara() Gets this instance as an ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara This instance. GetElementByIndex(int) Gets the value of an element at the specified index. public double GetElementByIndex(int elementIndex) Parameters elementIndex int The index of the element to get. Returns double The value of the element at the specified index. GetLocalRakeFaceCuttingPara(int) Gets the local rake face cutting parameters for the specified flute index. public RakeFaceCuttingPara3d GetLocalRakeFaceCuttingPara(int fluteIndex) Parameters fluteIndex int The zero-based index of the flute. Returns RakeFaceCuttingPara3d The rake face cutting parameters for the specified flute. 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. SetElementByIndex(int, double) Sets the value of an element at the specified index. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int The index of the element to set. v double The value to set. ToString() Returns a string representation of this parameter set. public override string ToString() Returns string A string containing the name and note of this parameter set. ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" }, - "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara.html": { - "href": "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara.html", - "title": "Class RakeFaceCuttingPara | HiAPI-C# 2025", - "summary": "Class RakeFaceCuttingPara Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll Represents local ECN (Edge-Cross-Normal) cutting parameters for rake face cutting. E: cutting edge direction C: Cross vector, along the rake face cross line, perpendicular to cutting edge N: rake face normal direction Internal Use Only. public class RakeFaceCuttingPara : IDuplicate, ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote Inheritance object RakeFaceCuttingPara Implements IDuplicate ICuttingPara IGetCuttingPara IMakeXmlSource INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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 Velocity is measured relative to the cutter Resulting force is applied to the cutter Constructors RakeFaceCuttingPara() Initializes a new instance of the RakeFaceCuttingPara class. public RakeFaceCuttingPara() RakeFaceCuttingPara(Vec3d, Vec3d, double) Initializes a new instance of the RakeFaceCuttingPara class with specified shear and plough vectors. public RakeFaceCuttingPara(Vec3d shearEcn, Vec3d ploughEcn, double anchorRakeAngle_rad = NaN) Parameters shearEcn Vec3d The shear coefficient vector in ECN coordinates (N/mm²). ploughEcn Vec3d The plough coefficient vector in ECN coordinates (N/mm). anchorRakeAngle_rad double The anchor rake angle in radians. RakeFaceCuttingPara(RakeFaceCuttingPara) Initializes a new instance of the RakeFaceCuttingPara class by copying from another instance. public RakeFaceCuttingPara(RakeFaceCuttingPara src) Parameters src RakeFaceCuttingPara The source instance to copy from. RakeFaceCuttingPara(double, double, double, double, double, double, double) Initializes a new instance of the RakeFaceCuttingPara class with individual coefficient values. public RakeFaceCuttingPara(double kse, double ksc, double ksn, double kpe, double kpc, double kpn, double anchorRakeAngle_rad) Parameters kse double The shear coefficient along the cutting edge direction (N/mm²). ksc double The shear coefficient along the rake face cross line (N/mm²). ksn double The shear coefficient along the rake face normal direction (N/mm²). kpe double The plough coefficient along the cutting edge direction (N/mm). kpc double The plough coefficient along the rake face cross line (N/mm). kpn double The plough coefficient along the rake face normal direction (N/mm). anchorRakeAngle_rad double The anchor rake angle in radians. RakeFaceCuttingPara(XElement, string) Ctor by XML. public RakeFaceCuttingPara(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties AnchorRakeAngle_deg Gets or sets the anchor rake angle in degrees. public double AnchorRakeAngle_deg { get; set; } Property Value double AnchorRakeAngle_rad Gets or sets the anchor rake angle in radians. Different rake angles may have different ploughing parameters but share the same shearing parameters. public double AnchorRakeAngle_rad { get; set; } Property Value double ChipFlowAngle_deg Gets the chip flow angle in degrees. public double ChipFlowAngle_deg { get; } Property Value double ChipFlowAngle_rad Gets or sets the chip flow angle in radians. public double ChipFlowAngle_rad { get; } Property Value double CsvText Gets or sets the cutting parameters as a comma-separated value string. Format: Kse,Ksc,Ksn,Kpe,Kpc,Kpn,AnchorRakeAngle_deg public string CsvText { get; set; } Property Value string ElementNum Element number: 6 for (Shear(e,c,n),Plough(e,c,n)). public int ElementNum { get; } Property Value int FluteFormNum Gets the number of flute forms in this parameter set. Always returns 1 as this class represents a single form. public int FluteFormNum { get; } Property Value int FrictionAngle_deg Gets the friction angle in degrees. public double FrictionAngle_deg { get; } Property Value double FrictionAngle_rad Gets the friction angle in radians. public double FrictionAngle_rad { get; } Property Value double Kp Gets the ploughing coefficient vector in ECN coordinates. public Vec3d Kp { get; set; } Property Value Vec3d KpOnZeroRakeAngleCoordinate Plough parameter remains constant on any rake angle. The vector changed by the view of coordinate transformation. public Vec3d KpOnZeroRakeAngleCoordinate { get; } Property Value Vec3d Kpc Gets or sets the ploughing coefficient along the rake face cross line (c). Unit: N/mm. public double Kpc { get; set; } Property Value double Kpe Gets or sets the ploughing coefficient along the cutting edge direction (e). Unit: N/mm. public double Kpe { get; set; } Property Value double Kpn Gets or sets the ploughing coefficient along the rake face normal direction (n). Unit: N/mm. public double Kpn { get; set; } Property Value double Ks Gets the shear coefficient vector in ECN coordinates. public Vec3d Ks { get; set; } Property Value Vec3d Ksc Gets or sets the shear coefficient along the rake face cross line (c). Direction is from outer to center on side cutting. Unit: N/mm². public double Ksc { get; set; } Property Value double Kse Gets or sets the shear coefficient along the cutting edge direction (e). Direction is from lower to upper on side cutting. Unit: N/mm². public double Kse { get; set; } Property Value double Ksn Gets or sets the shear coefficient along the rake face normal direction (n). Unit: N/mm². public double Ksn { get; set; } Property Value double Name Gets or sets the name of this parameter set. public string Name { get; set; } Property Value string Note Gets or sets additional notes about this parameter set. public string Note { get; set; } Property Value string XName Gets the XML element name for this type. public static string XName { get; } Property Value string Methods CloneTemplate() Creates a clone of this parameter set as a template. public ICuttingPara CloneTemplate() Returns ICuttingPara A new instance with the same anchor rake angle. Duplicate(params object[]) Creates a deep copy of this instance. public object Duplicate(params object[] res) Parameters res object[] Optional parameters (not used). Returns object A new instance with the same values. GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. public List GenUnitParas() Returns List unit parameters. GetCuttingPara() Gets this instance as an ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara This instance. GetElementByIndex(int) value of (Shear(e,c,n),Plough(e,c,n)) by index. public double GetElementByIndex(int index) Parameters index int The index of the element to get (0-5). Returns double The value at the specified index. Remarks Index mapping: 0 - Kse (N/mm²) 1 - Ksc (N/mm²) 2 - Ksn (N/mm²) 3 - Kpe (N/mm) 4 - Kpc (N/mm) 5 - Kpn (N/mm) MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetElementByIndex(int, double) Sets the value of an element at the specified index. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int The index of the element to set (0-5). v double The value to set. Remarks Index mapping: 0 - Kse (N/mm²) 1 - Ksc (N/mm²) 2 - Ksn (N/mm²) 3 - Kpe (N/mm) 4 - Kpc (N/mm) 5 - Kpn (N/mm) ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" + "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d.html": { + "href": "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara2d.html", + "title": "Class RakeFaceCuttingPara2d | HiAPI-C# 2025", + "summary": "Class RakeFaceCuttingPara2d Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll Represents a 2D cutting parameter for rake face cutting operations. public class RakeFaceCuttingPara2d : IRakeFaceCuttingPara, ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, IDuplicate Inheritance object RakeFaceCuttingPara2d Implements IRakeFaceCuttingPara ICuttingPara IGetCuttingPara IMakeXmlSource INameNote IDuplicate Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors RakeFaceCuttingPara2d() Initializes a new instance of the RakeFaceCuttingPara2d class. public RakeFaceCuttingPara2d() RakeFaceCuttingPara2d(RakeFaceCuttingPara2d) Initializes a new instance of the RakeFaceCuttingPara2d class by copying from another instance. public RakeFaceCuttingPara2d(RakeFaceCuttingPara2d src) Parameters src RakeFaceCuttingPara2d The source instance to copy from. RakeFaceCuttingPara2d(XElement, string) Initializes a new instance of the RakeFaceCuttingPara2d class from XML. public RakeFaceCuttingPara2d(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Fields element_num Gets the number of elements in the cutting parameter. public const int element_num = 4 Field Value int Properties AnchorRakeAngle_deg Gets or sets the anchor rake angle in degrees. public double AnchorRakeAngle_deg { get; set; } Property Value double AnchorRakeAngle_rad Gets or sets the anchor rake angle in radians. Different rake angles may have different ploughing parameters but share the same shearing parameters. public double AnchorRakeAngle_rad { get; set; } Property Value double ElementNum Element number. public int ElementNum { get; } Property Value int FluteFormNum Flute form number. public int FluteFormNum { get; } Property Value int Kp Gets the ploughing coefficient vector in ECN coordinates. public Vec2d Kp { get; set; } Property Value Vec2d Kpc Gets or sets the ploughing coefficient along the rake face cross line (c). Unit: N/mm. public double Kpc { get; set; } Property Value double Kpn Gets or sets the ploughing coefficient along the rake face normal direction (n). Unit: N/mm. public double Kpn { get; set; } Property Value double Ks Gets the shear coefficient vector in ECN coordinates. public Vec2d Ks { get; set; } Property Value Vec2d Ksc Gets or sets the shear coefficient along the rake face cross line (c). Direction is from outer to center on side cutting. Unit: N/mm². public double Ksc { get; set; } Property Value double Ksn Gets or sets the shear coefficient along the rake face normal direction (n). Unit: N/mm². public double Ksn { get; set; } Property Value double Name Gets or sets the name of the cutting parameter. public string Name { get; set; } Property Value string Note Gets or sets additional notes about the cutting parameter. public string Note { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods CloneTemplate() Clone template. public ICuttingPara CloneTemplate() Returns ICuttingPara clone template Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. public List GenUnitParas() Returns List unit parameters. GetCuttingPara() Get ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara GetElementByIndex(int) Gets the cutting parameter element at the specified index. public double GetElementByIndex(int index) Parameters index int The index of the element to retrieve. Returns double The cutting parameter element at the specified index. 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. SetElementByIndex(int, double) Sets the value of an element at the specified index. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int The index of the element to set (0-5). v double The value to set. Remarks Index mapping: 0 - Kse (N/mm²) 1 - Ksc (N/mm²) 2 - Ksn (N/mm²) 3 - Kpe (N/mm) 4 - Kpc (N/mm) 5 - Kpn (N/mm) ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" + }, + "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d.html": { + "href": "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingPara3d.html", + "title": "Class RakeFaceCuttingPara3d | HiAPI-C# 2025", + "summary": "Class RakeFaceCuttingPara3d Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll Represents local ECN (Edge-Cross-Normal) cutting parameters for rake face cutting. E: cutting edge direction C: Cross vector, along the rake face cross line, perpendicular to cutting edge N: rake face normal direction Internal Use Only. public class RakeFaceCuttingPara3d : IRakeFaceCuttingPara, ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, IDuplicate Inheritance object RakeFaceCuttingPara3d Implements IRakeFaceCuttingPara ICuttingPara IGetCuttingPara IMakeXmlSource INameNote IDuplicate Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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 Velocity is measured relative to the cutter Resulting force is applied to the cutter Constructors RakeFaceCuttingPara3d() Initializes a new instance of the RakeFaceCuttingPara class. public RakeFaceCuttingPara3d() RakeFaceCuttingPara3d(Vec3d, Vec3d, double) Initializes a new instance of the RakeFaceCuttingPara class with specified shear and plough vectors. public RakeFaceCuttingPara3d(Vec3d shearEcn, Vec3d ploughEcn, double anchorRakeAngle_rad = NaN) Parameters shearEcn Vec3d The shear coefficient vector in ECN coordinates (N/mm²). ploughEcn Vec3d The plough coefficient vector in ECN coordinates (N/mm). anchorRakeAngle_rad double The anchor rake angle in radians. RakeFaceCuttingPara3d(RakeFaceCuttingPara3d) Initializes a new instance of the RakeFaceCuttingPara class by copying from another instance. public RakeFaceCuttingPara3d(RakeFaceCuttingPara3d src) Parameters src RakeFaceCuttingPara3d The source instance to copy from. RakeFaceCuttingPara3d(double, double, double, double, double, double, double) Initializes a new instance of the RakeFaceCuttingPara class with individual coefficient values. public RakeFaceCuttingPara3d(double kse, double ksc, double ksn, double kpe, double kpc, double kpn, double anchorRakeAngle_rad) Parameters kse double The shear coefficient along the cutting edge direction (N/mm²). ksc double The shear coefficient along the rake face cross line (N/mm²). ksn double The shear coefficient along the rake face normal direction (N/mm²). kpe double The plough coefficient along the cutting edge direction (N/mm). kpc double The plough coefficient along the rake face cross line (N/mm). kpn double The plough coefficient along the rake face normal direction (N/mm). anchorRakeAngle_rad double The anchor rake angle in radians. RakeFaceCuttingPara3d(XElement, string) Ctor by XML. public RakeFaceCuttingPara3d(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties AnchorRakeAngle_deg Gets or sets the anchor rake angle in degrees. public double AnchorRakeAngle_deg { get; set; } Property Value double AnchorRakeAngle_rad Gets or sets the anchor rake angle in radians. Different rake angles may have different ploughing parameters but share the same shearing parameters. public double AnchorRakeAngle_rad { get; set; } Property Value double ChipFlowAngle_deg Gets the chip flow angle in degrees. public double ChipFlowAngle_deg { get; } Property Value double ChipFlowAngle_rad Gets or sets the chip flow angle in radians. public double ChipFlowAngle_rad { get; } Property Value double CsvText Gets or sets the cutting parameters as a comma-separated value string. Format: Kse,Ksc,Ksn,Kpe,Kpc,Kpn,AnchorRakeAngle_deg public string CsvText { get; set; } Property Value string ElementNum Element number: 6 for (Shear(e,c,n),Plough(e,c,n)). public int ElementNum { get; } Property Value int FluteFormNum Gets the number of flute forms in this parameter set. Always returns 1 as this class represents a single form. public int FluteFormNum { get; } Property Value int FrictionAngle_deg Gets the friction angle in degrees. public double FrictionAngle_deg { get; } Property Value double FrictionAngle_rad Gets the friction angle in radians. public double FrictionAngle_rad { get; } Property Value double Kp Gets the ploughing coefficient vector in ECN coordinates. public Vec3d Kp { get; set; } Property Value Vec3d KpOnZeroRakeAngleCoordinate Plough parameter remains constant on any rake angle. The vector changed by the view of coordinate transformation. public Vec3d KpOnZeroRakeAngleCoordinate { get; } Property Value Vec3d Kpc Gets or sets the ploughing coefficient along the rake face cross line (c). Unit: N/mm. public double Kpc { get; set; } Property Value double Kpe Gets or sets the ploughing coefficient along the cutting edge direction (e). Unit: N/mm. public double Kpe { get; set; } Property Value double Kpn Gets or sets the ploughing coefficient along the rake face normal direction (n). Unit: N/mm. public double Kpn { get; set; } Property Value double Ks Gets the shear coefficient vector in ECN coordinates. public Vec3d Ks { get; set; } Property Value Vec3d Ksc Gets or sets the shear coefficient along the rake face cross line (c). Direction is from outer to center on side cutting. Unit: N/mm². public double Ksc { get; set; } Property Value double Kse Gets or sets the shear coefficient along the cutting edge direction (e). Direction is from lower to upper on side cutting. Unit: N/mm². public double Kse { get; set; } Property Value double Ksn Gets or sets the shear coefficient along the rake face normal direction (n). Unit: N/mm². public double Ksn { get; set; } Property Value double Name Gets or sets the name of this parameter set. public string Name { get; set; } Property Value string Note Gets or sets additional notes about this parameter set. public string Note { get; set; } Property Value string XName Gets the XML element name for this type. public static string XName { get; } Property Value string Methods CloneTemplate() Creates a clone of this parameter set as a template. public ICuttingPara CloneTemplate() Returns ICuttingPara A new instance with the same anchor rake angle. Duplicate(params object[]) Creates a deep copy of this instance. public object Duplicate(params object[] res) Parameters res object[] Optional parameters (not used). Returns object A new instance with the same values. GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. public List GenUnitParas() Returns List unit parameters. GetCuttingPara() Gets this instance as an ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara This instance. GetElementByIndex(int) value of (Shear(e,c,n),Plough(e,c,n)) by index. public double GetElementByIndex(int index) Parameters index int The index of the element to get (0-5). Returns double The value at the specified index. Remarks Index mapping: 0 - Kse (N/mm²) 1 - Ksc (N/mm²) 2 - Ksn (N/mm²) 3 - Kpe (N/mm) 4 - Kpc (N/mm) 5 - Kpn (N/mm) 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. SetElementByIndex(int, double) Sets the value of an element at the specified index. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int The index of the element to set (0-5). v double The value to set. Remarks Index mapping: 0 - Kse (N/mm²) 1 - Ksc (N/mm²) 2 - Ksn (N/mm²) 3 - Kpe (N/mm) 4 - Kpc (N/mm) 5 - Kpn (N/mm) ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" }, "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html": { "href": "api/Hi.MillingForces.RakeFaceCuttingParas.RakeFaceCuttingParaMap.html", "title": "Class RakeFaceCuttingParaMap | HiAPI-C# 2025", - "summary": "Class RakeFaceCuttingParaMap Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll Represents a map of rake face cutting parameters. public class RakeFaceCuttingParaMap : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, ICloneable Inheritance object RakeFaceCuttingParaMap Implements ICuttingPara IGetCuttingPara IMakeXmlSource INameNote ICloneable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors RakeFaceCuttingParaMap(RakeFaceCuttingParaMap) Creates a copy of this parameter map. public RakeFaceCuttingParaMap(RakeFaceCuttingParaMap source) Parameters source RakeFaceCuttingParaMap The source parameter map to copy from. RakeFaceCuttingParaMap(int, int, int) Initializes a new instance of the RakeFaceCuttingParaMap class. public RakeFaceCuttingParaMap(int fluteFormNum, int nAngleDivisionNum, int ecAngleDivisionNum) Parameters fluteFormNum int The number of flute forms. nAngleDivisionNum int The number of normal angle divisions. ecAngleDivisionNum int The number of eccentric angle divisions. RakeFaceCuttingParaMap(XElement, string) Ctor by XML. public RakeFaceCuttingParaMap(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties CircleParas CircleParas[FluteFormIndex,NAngleIndex,EcAngleIndex]. public Vec3d[,,] CircleParas { get; } Property Value Vec3d[,,] EcAngleDivisionNum Angle division number from +E axis on EC plane. Note that range of EcAngle is -pi~pi. public int EcAngleDivisionNum { get; } Property Value int EcAngleInterval_deg Gets or sets the eccentric angle interval in degrees. public double EcAngleInterval_deg { get; } Property Value double EcAngleInterval_rad Gets or sets the eccentric angle interval in radians. public double EcAngleInterval_rad { get; } Property Value double ElementNum Element number. public int ElementNum { get; } Property Value int FluteFormNum Gets or sets the number of flute forms. public int FluteFormNum { get; } Property Value int NAngleDivisionNum Angle division number from N axis. Like R on polar coordinate, but it expresses by angle. Note that range of NAngle is 0~pi/2. public int NAngleDivisionNum { get; } Property Value int NAngleInterval_deg Gets or sets the normal angle interval in degrees. public double NAngleInterval_deg { get; } Property Value double NAngleInterval_rad Gets or sets the normal angle interval in radians. public double NAngleInterval_rad { get; } Property Value double Name Gets or sets the name of the parameter map. public string Name { get; set; } Property Value string Note Gets or sets the note for the parameter map. public string Note { get; set; } Property Value string PloughParas Gets or sets the ploughing parameters. public Vec3d[] PloughParas { get; } Property Value Vec3d[] TipParas TipParas[FluteFormIndex]. tip shear para. public Vec3d[] TipParas { get; } Property Value Vec3d[] XName Name for XML IO. public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods Clone() Creates a new object that is a copy of the current instance. public object Clone() Returns object A new object that is a copy of this instance. CloneTemplate() Clone template. public ICuttingPara CloneTemplate() Returns ICuttingPara clone template GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. public List GenUnitParas() Returns List unit parameters. GetCuttingPara() Get ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara GetElementByIndex(int) Get element by index. For parameter training. public double GetElementByIndex(int elementIndex) Parameters elementIndex int element index Returns double value GetLocalRakeFaceCuttingPara(int, double, double) Gets the local rake face cutting parameters for the specified conditions. public RakeFaceCuttingPara GetLocalRakeFaceCuttingPara(int fluteIndex, double nAngle_rad, double ecAngle_rad) Parameters fluteIndex int The index of the flute. nAngle_rad double The normal angle in radians. ecAngle_rad double The effective cutting angle in radians. Returns RakeFaceCuttingPara A rake face cutting parameter object. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetElementByIndex(int, double) Set element by index. For parameter training. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int element index v double value Test() Test method for validating the interpolation functionality of the RakeFaceCuttingParaMap. Creates a sample map and outputs interpolated values at various angles. public static void Test() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" + "summary": "Class RakeFaceCuttingParaMap Namespace Hi.MillingForces.RakeFaceCuttingParas Assembly HiMech.dll Represents a map of rake face cutting parameters. public class RakeFaceCuttingParaMap : ICuttingPara, IGetCuttingPara, IMakeXmlSource, INameNote, ICloneable Inheritance object RakeFaceCuttingParaMap Implements ICuttingPara IGetCuttingPara IMakeXmlSource INameNote ICloneable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CuttingParaUtil.ToRakeFaceCuttingPara(ICuttingPara) 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) Constructors RakeFaceCuttingParaMap(RakeFaceCuttingParaMap) Creates a copy of this parameter map. public RakeFaceCuttingParaMap(RakeFaceCuttingParaMap source) Parameters source RakeFaceCuttingParaMap The source parameter map to copy from. RakeFaceCuttingParaMap(int, int, int) Initializes a new instance of the RakeFaceCuttingParaMap class. public RakeFaceCuttingParaMap(int fluteFormNum, int nAngleDivisionNum, int ecAngleDivisionNum) Parameters fluteFormNum int The number of flute forms. nAngleDivisionNum int The number of normal angle divisions. ecAngleDivisionNum int The number of eccentric angle divisions. RakeFaceCuttingParaMap(XElement, string) Ctor by XML. public RakeFaceCuttingParaMap(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties CircleParas CircleParas[FluteFormIndex,NAngleIndex,EcAngleIndex]. public Vec3d[,,] CircleParas { get; } Property Value Vec3d[,,] EcAngleDivisionNum Angle division number from +E axis on EC plane. Note that range of EcAngle is -pi~pi. public int EcAngleDivisionNum { get; } Property Value int EcAngleInterval_deg Gets or sets the eccentric angle interval in degrees. public double EcAngleInterval_deg { get; } Property Value double EcAngleInterval_rad Gets or sets the eccentric angle interval in radians. public double EcAngleInterval_rad { get; } Property Value double ElementNum Element number. public int ElementNum { get; } Property Value int FluteFormNum Gets or sets the number of flute forms. public int FluteFormNum { get; } Property Value int NAngleDivisionNum Angle division number from N axis. Like R on polar coordinate, but it expresses by angle. Note that range of NAngle is 0~pi/2. public int NAngleDivisionNum { get; } Property Value int NAngleInterval_deg Gets or sets the normal angle interval in degrees. public double NAngleInterval_deg { get; } Property Value double NAngleInterval_rad Gets or sets the normal angle interval in radians. public double NAngleInterval_rad { get; } Property Value double Name Gets or sets the name of the parameter map. public string Name { get; set; } Property Value string Note Gets or sets the note for the parameter map. public string Note { get; set; } Property Value string PloughParas Gets or sets the ploughing parameters. public Vec3d[] PloughParas { get; } Property Value Vec3d[] TipParas TipParas[FluteFormIndex]. tip shear para. public Vec3d[] TipParas { get; } Property Value Vec3d[] XName Name for XML IO. public static string XName { get; } Property Value string XmlSourceFile public string XmlSourceFile { get; set; } Property Value string Methods Clone() Creates a new object that is a copy of the current instance. public object Clone() Returns object A new object that is a copy of this instance. CloneTemplate() Clone template. public ICuttingPara CloneTemplate() Returns ICuttingPara clone template GenUnitParas() Generate ICuttingParas. The elements of each ICuttingPara are (1,0,0,0,..),(0,1,0,0,..),.… For parameter training. public List GenUnitParas() Returns List unit parameters. GetCuttingPara() Get ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara GetElementByIndex(int) Get element by index. For parameter training. public double GetElementByIndex(int elementIndex) Parameters elementIndex int element index Returns double value GetLocalRakeFaceCuttingPara(int, double, double) Gets the local rake face cutting parameters for the specified conditions. public RakeFaceCuttingPara3d GetLocalRakeFaceCuttingPara(int fluteIndex, double nAngle_rad, double ecAngle_rad) Parameters fluteIndex int The index of the flute. nAngle_rad double The normal angle in radians. ecAngle_rad double The effective cutting angle in radians. Returns RakeFaceCuttingPara3d A rake face cutting parameter 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. SetElementByIndex(int, double) Set element by index. For parameter training. public void SetElementByIndex(int elementIndex, double v) Parameters elementIndex int element index v double value Test() Test method for validating the interpolation functionality of the RakeFaceCuttingParaMap. Creates a sample map and outputs interpolated values at various angles. public static void Test() ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. ToTemplateXElement() Get XElement for templating. public XElement ToTemplateXElement() Returns XElement" }, "api/Hi.MillingForces.RakeFaceCuttingParas.html": { "href": "api/Hi.MillingForces.RakeFaceCuttingParas.html", "title": "Namespace Hi.MillingForces.RakeFaceCuttingParas | HiAPI-C# 2025", - "summary": "Namespace Hi.MillingForces.RakeFaceCuttingParas Classes MillingPhysicsUtil Utility class for milling physics calculations. MultiFormRakeFaceCuttingPara Represents a multi-form rake face cutting parameter set that can handle multiple flute forms. Internal Use Only. RakeFaceCuttingPara Represents local ECN (Edge-Cross-Normal) cutting parameters for rake face cutting. E: cutting edge direction C: Cross vector, along the rake face cross line, perpendicular to cutting edge N: rake face normal direction Internal Use Only. RakeFaceCuttingParaMap Represents a map of rake face cutting parameters." + "summary": "Namespace Hi.MillingForces.RakeFaceCuttingParas Classes MillingPhysicsUtil Utility class for milling physics calculations. MultiFormRakeFaceCuttingPara Represents a multi-form rake face cutting parameter set that can handle multiple flute forms. Internal Use Only. RakeFaceCuttingPara2d Represents a 2D cutting parameter for rake face cutting operations. RakeFaceCuttingPara3d Represents local ECN (Edge-Cross-Normal) cutting parameters for rake face cutting. E: cutting edge direction C: Cross vector, along the rake face cross line, perpendicular to cutting edge N: rake face normal direction Internal Use Only. RakeFaceCuttingParaMap Represents a map of rake face cutting parameters. Interfaces IRakeFaceCuttingPara" }, "api/Hi.MillingForces.RakeFacePhysicsBrief.html": { "href": "api/Hi.MillingForces.RakeFacePhysicsBrief.html", @@ -2687,7 +2852,7 @@ "api/Hi.MillingForces.Training.MillingTraining.html": { "href": "api/Hi.MillingForces.Training.MillingTraining.html", "title": "Class MillingTraining | HiAPI-C# 2025", - "summary": "Class MillingTraining Namespace Hi.MillingForces.Training Assembly HiNc.dll Provides utilities for milling force training and parameter identification. public static class MillingTraining Inheritance object MillingTraining Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties CycleDivisionNum Division number of a spindle cycle. public static int CycleDivisionNum { get; } Property Value int StepQuantityNames Gets the names of step quantities used in training. public static string[] StepQuantityNames { get; } Property Value string[] TextAngleOffset_deg Gets the text key for angle offset in degrees. public static string TextAngleOffset_deg { get; } Property Value string TextTrainingErrRatio Gets the text key for training error ratio. public static string TextTrainingErrRatio { get; } Property Value string Methods Convert(ICuttingPara, ICuttingPara, GeneralApt, double, double, IMessageHost, CancellationToken) Converts one cutting parameter model to another based on the provided parameters. public static ICuttingPara Convert(ICuttingPara src, ICuttingPara dstTemplate, GeneralApt apt, double helixAngle_rad, double radialRakeAngle_rad, IMessageHost messageHost, CancellationToken cancellationToken) Parameters src ICuttingPara Source cutting parameter model dstTemplate ICuttingPara Destination template for the converted model apt GeneralApt General apt parameters helixAngle_rad double Helix angle in radians radialRakeAngle_rad double Radial rake angle in radians messageHost IMessageHost Message host for logging cancellationToken CancellationToken Cancellation token Returns ICuttingPara The converted cutting parameter model Convert(LocalProfileMillingPara, double, double, IMessageHost, CancellationToken) Converts a LocalProfileMillingPara to a RakeFaceCuttingPara. public static RakeFaceCuttingPara Convert(LocalProfileMillingPara src, double helixAngle_rad, double radialRakeAngle_rad, IMessageHost messageHost, CancellationToken cancellationToken) Parameters src LocalProfileMillingPara Source LocalProfileMillingPara helixAngle_rad double Helix angle in radians radialRakeAngle_rad double Radial rake angle in radians messageHost IMessageHost Message host for logging cancellationToken CancellationToken Cancellation token Returns RakeFaceCuttingPara The converted RakeFaceCuttingPara GatherAndBuild(ConcurrentDictionary>, ClStrip, SampleFlag, bool, double, IMessageHost, CancellationToken) Gathers training samples and builds a cutting parameter model. public static ICuttingPara GatherAndBuild(ConcurrentDictionary> stepToTimeShotListDictionary, ClStrip clStrip, SampleFlag sampleFlags, bool enableFzOnlyDuringDrilling, double outlierRatio, IMessageHost messageHost, CancellationToken cancellationToken) Parameters stepToTimeShotListDictionary ConcurrentDictionary> Dictionary mapping step indices to time shot lists clStrip ClStrip The cutter location strip sampleFlags SampleFlag Sample flags indicating which forces to use enableFzOnlyDuringDrilling bool Whether to enable Fz only during drilling outlierRatio double Ratio of outliers to exclude messageHost IMessageHost Message host for logging cancellationToken CancellationToken Cancellation token Returns ICuttingPara The built cutting parameter model GatherAndGetUpdate(ConcurrentDictionary>, ClStrip, ICuttingPara, SampleFlag, double, IMessageHost, CancellationToken) Gathers training samples and updates an existing cutting parameter model. public static ICuttingPara GatherAndGetUpdate(ConcurrentDictionary> stepToTimeShotListDictionary, ClStrip clStrip, ICuttingPara anchorPara, SampleFlag sampleFlags, double outlierRatio, IMessageHost messageHost, CancellationToken cancellationToken) Parameters stepToTimeShotListDictionary ConcurrentDictionary> Dictionary mapping step indices to time shot lists clStrip ClStrip The cutter location strip anchorPara ICuttingPara The anchor cutting parameter model to update sampleFlags SampleFlag Sample flags indicating which forces to use outlierRatio double Ratio of outliers to exclude messageHost IMessageHost Message host for logging cancellationToken CancellationToken Cancellation token Returns ICuttingPara The updated cutting parameter model" + "summary": "Class MillingTraining Namespace Hi.MillingForces.Training Assembly HiNc.dll Provides utilities for milling force training and parameter identification. public static class MillingTraining Inheritance object MillingTraining Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties CycleDivisionNum Division number of a spindle cycle. public static int CycleDivisionNum { get; } Property Value int ParaTemplate public static ICuttingPara ParaTemplate { get; set; } Property Value ICuttingPara StepQuantityNames Gets the names of step quantities used in training. public static string[] StepQuantityNames { get; } Property Value string[] TextAngleOffset_deg Gets the text key for angle offset in degrees. public static string TextAngleOffset_deg { get; } Property Value string TextTrainingErrRatio Gets the text key for training error ratio. public static string TextTrainingErrRatio { get; } Property Value string Methods Convert(ICuttingPara, ICuttingPara, GeneralApt, double, double, IMessageKit, CancellationToken) Converts one cutting parameter model to another based on the provided parameters. public static ICuttingPara Convert(ICuttingPara src, ICuttingPara dstTemplate, GeneralApt apt, double helixAngle_rad, double radialRakeAngle_rad, IMessageKit messageHost, CancellationToken cancellationToken) Parameters src ICuttingPara Source cutting parameter model dstTemplate ICuttingPara Destination template for the converted model apt GeneralApt General apt parameters helixAngle_rad double Helix angle in radians radialRakeAngle_rad double Radial rake angle in radians messageHost IMessageKit Message host for logging cancellationToken CancellationToken Cancellation token Returns ICuttingPara The converted cutting parameter model Convert(LocalProfileMillingPara, double, double, IMessageKit, CancellationToken) Converts a LocalProfileMillingPara to a RakeFaceCuttingPara. public static RakeFaceCuttingPara2d Convert(LocalProfileMillingPara src, double helixAngle_rad, double radialRakeAngle_rad, IMessageKit messageHost, CancellationToken cancellationToken) Parameters src LocalProfileMillingPara Source LocalProfileMillingPara helixAngle_rad double Helix angle in radians radialRakeAngle_rad double Radial rake angle in radians messageHost IMessageKit Message host for logging cancellationToken CancellationToken Cancellation token Returns RakeFaceCuttingPara2d The converted RakeFaceCuttingPara GatherAndBuild(ConcurrentDictionary>, ClStrip, SampleFlag, bool, double, IMessageKit, CancellationToken) Gathers training samples and builds a cutting parameter model. public static ICuttingPara GatherAndBuild(ConcurrentDictionary> stepToTimeShotListDictionary, ClStrip clStrip, SampleFlag sampleFlags, bool enableFzOnlyDuringDrilling, double outlierRatio, IMessageKit messageHost, CancellationToken cancellationToken) Parameters stepToTimeShotListDictionary ConcurrentDictionary> Dictionary mapping step indices to time shot lists clStrip ClStrip The cutter location strip sampleFlags SampleFlag Sample flags indicating which forces to use enableFzOnlyDuringDrilling bool Whether to enable Fz only during drilling outlierRatio double Ratio of outliers to exclude messageHost IMessageKit Message host for logging cancellationToken CancellationToken Cancellation token Returns ICuttingPara The built cutting parameter model GatherAndGetUpdate(ConcurrentDictionary>, ClStrip, ICuttingPara, SampleFlag, double, IMessageKit, CancellationToken) Gathers training samples and updates an existing cutting parameter model. public static ICuttingPara GatherAndGetUpdate(ConcurrentDictionary> stepToTimeShotListDictionary, ClStrip clStrip, ICuttingPara anchorPara, SampleFlag sampleFlags, double outlierRatio, IMessageKit messageHost, CancellationToken cancellationToken) Parameters stepToTimeShotListDictionary ConcurrentDictionary> Dictionary mapping step indices to time shot lists clStrip ClStrip The cutter location strip anchorPara ICuttingPara The anchor cutting parameter model to update sampleFlags SampleFlag Sample flags indicating which forces to use outlierRatio double Ratio of outliers to exclude messageHost IMessageKit Message host for logging cancellationToken CancellationToken Cancellation token Returns ICuttingPara The updated cutting parameter model" }, "api/Hi.MillingForces.Training.html": { "href": "api/Hi.MillingForces.Training.html", @@ -2699,35 +2864,10 @@ "title": "Namespace Hi.MillingForces | HiAPI-C# 2025", "summary": "Namespace Hi.MillingForces Classes FluteZData Represents data for a flute at a specific Z position during milling operation MillingForce Milling force. MillingForceLicense Provides license information and management for the milling force calculation functionality. MillingForceLuggage Represents a container for milling force data and calculations. MillingForceUtil Utility class for milling force calculations and related operations. MillingForceUtil.AnglePack Container class for angle-specific calculations during milling operation RakeFacePhysicsBrief Physics brief on rake face for milling. Interfaces IGetMillingForce Interface of GetMillingForce(). IMillingForceAccessor Interface of MillingForce. Enums ToolObservationReference Defines reference points for tool observation measurements." }, - "api/Hi.MillingMech.MillingTools.MillingToolAnchorReference.html": { - "href": "api/Hi.MillingMech.MillingTools.MillingToolAnchorReference.html", - "title": "Enum MillingToolAnchorReference | HiAPI-C# 2025", - "summary": "Enum MillingToolAnchorReference Namespace Hi.MillingMech.MillingTools Assembly HiMech.dll Defines reference points for anchoring milling tools. public enum MillingToolAnchorReference Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields HolderAnc = 2 The holder anchor as the reference point. None = 0 No specific anchor reference point. SpindleBuckleAnc = 4 The spindle buckle anchor as the reference point. ToolTip = 1 The tool tip as the anchor reference point." - }, - "api/Hi.MillingMech.MillingTools.MillingToolUtil.html": { - "href": "api/Hi.MillingMech.MillingTools.MillingToolUtil.html", - "title": "Class MillingToolUtil | HiAPI-C# 2025", - "summary": "Class MillingToolUtil Namespace Hi.MillingMech.MillingTools Assembly HiMech.dll Provides utility methods for working with milling tools. public static class MillingToolUtil Inheritance object MillingToolUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetFluteNum(IMachiningTool) Gets the number of flutes if the tool is equipped with a MillingCutter. public static int? GetFluteNum(this IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool to check. Returns int? The number of flutes if available; otherwise, null. GetFullH(IMachiningTool) Gets the full height of the milling tool. public static double GetFullH(this IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool to measure. Returns double The height of the tool in the Z dimension." - }, - "api/Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode.html": { - "href": "api/Hi.MillingMech.MillingTools.StickMachiningTool.CutterAlignmentMode.html", - "title": "Enum StickMachiningTool.CutterAlignmentMode | HiAPI-C# 2025", - "summary": "Enum StickMachiningTool.CutterAlignmentMode Namespace Hi.MillingMech.MillingTools Assembly HiMech.dll Defines the modes for aligning the cutter. public enum StickMachiningTool.CutterAlignmentMode Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields ExposedCutterHeight = 0 Align based on exposed cutter height. PreservedDistanceBetweenFluteAndSpindleNose = 1 Align based on preserved distance between flute and spindle nose." - }, - "api/Hi.MillingMech.MillingTools.StickMachiningTool.html": { - "href": "api/Hi.MillingMech.MillingTools.StickMachiningTool.html", - "title": "Class StickMachiningTool | HiAPI-C# 2025", - "summary": "Class StickMachiningTool Namespace Hi.MillingMech.MillingTools Assembly HiMech.dll Represents a central stick milling tool that combines a holder and a cutter. public class StickMachiningTool : IMachiningTool, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetFletchBuckle, IMakeXmlSource, IAbstractNote, IDuplicate, IClearCache Inheritance object StickMachiningTool Implements IMachiningTool ITopoDisplayee IGetAsmb IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IGetAnchoredDisplayeeList IGetFletchBuckle IMakeXmlSource IAbstractNote IDuplicate IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) MillingToolUtil.GetFluteNum(IMachiningTool) MillingToolUtil.GetFullH(IMachiningTool) 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) Constructors StickMachiningTool() Ctor. public StickMachiningTool() StickMachiningTool(XElement, string, string) Initializes a new instance of the StickMachiningTool class. public StickMachiningTool(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing the tool configuration. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Properties AbstractNote Gets an abstract note describing the tool's dimensions and cutter. public string AbstractNote { get; } Property Value string Asmb Gets the assembly containing the tool components. public Asmb Asmb { get; } Property Value Asmb Cutter Gets the cutting tool. public ICutter Cutter { get; set; } Property Value ICutter CutterFile Gets or sets the file path of the cutter. public string CutterFile { get; set; } Property Value string ExposedCutterBendingPara_umdN Gets or sets the parameter for exposed cutter bending in micrometers per Newton. public double ExposedCutterBendingPara_umdN { get; } Property Value double ExposedCutterHeight_mm Gets or sets the exposed cutter height in millimeters. public double ExposedCutterHeight_mm { get; set; } Property Value double ExposedCutterZDeflectionPara_umdN Gets or sets the parameter for exposed cutter Z-axis deflection in micrometers per Newton. public double ExposedCutterZDeflectionPara_umdN { get; } Property Value double Holder Gets or sets the tool holder. public IHolder Holder { get; set; } Property Value IHolder HolderFile Gets or sets the holder file path. public string HolderFile { get; set; } Property Value string KeyCutterAlignmentMode Gets or sets the key cutter alignment mode. public StickMachiningTool.CutterAlignmentMode KeyCutterAlignmentMode { get; set; } Property Value StickMachiningTool.CutterAlignmentMode Note Gets or sets a note for this machining tool. public string Note { get; set; } Property Value string ObservationAnchor Gets the tool anchor reference point. public Anchor ObservationAnchor { get; } Property Value Anchor ObservationAnchorReference Gets the tool observation anchor reference point. public MillingToolAnchorReference ObservationAnchorReference { get; set; } Property Value MillingToolAnchorReference ObservationHeightFromToolTip Gets the tool observation point relative to the reference. public double ObservationHeightFromToolTip { get; } Property Value double ObservationRingRadius_mm Gets the tool observation reference point. public double ObservationRingRadius_mm { get; set; } Property Value double PreservedDistanceBetweenFluteAndSpindleNose_mm Gets or sets the preserved distance between flute and clamp in millimeters. public double PreservedDistanceBetweenFluteAndSpindleNose_mm { get; set; } Property Value double RelativeHeightFromObservationAnchor_mm Gets the tool observation point relative to the reference. public double RelativeHeightFromObservationAnchor_mm { get; set; } Property Value double SpindleBuckle Gets the motor-side buckle. public Anchor SpindleBuckle { get; } Property Value Anchor SpindleBuckleToToolTipLength Height For NC Compensation table and step number computation. public double SpindleBuckleToToolTipLength { get; } Property Value double ToolTip Gets the tool tip anchor point from the cutter. public Anchor ToolTip { get; } Property Value Anchor XName Initializes a new instance of the StickMachiningTool class from XML data. public static string XName { get; } Property Value string Methods AlignAnchorByExposedCutterHeight() Aligns the anchor by the exposed cutter height. public void AlignAnchorByExposedCutterHeight() ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box Remarks For display GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" - }, - "api/Hi.MillingMech.MillingTools.html": { - "href": "api/Hi.MillingMech.MillingTools.html", - "title": "Namespace Hi.MillingMech.MillingTools | HiAPI-C# 2025", - "summary": "Namespace Hi.MillingMech.MillingTools Classes MillingToolUtil Provides utility methods for working with milling tools. StickMachiningTool Represents a central stick milling tool that combines a holder and a cutter. Enums MillingToolAnchorReference Defines reference points for anchoring milling tools. StickMachiningTool.CutterAlignmentMode Defines the modes for aligning the cutter." - }, "api/Hi.MillingProcs.MillingGuide.html": { "href": "api/Hi.MillingProcs.MillingGuide.html", "title": "Class MillingGuide | HiAPI-C# 2025", - "summary": "Class MillingGuide Namespace Hi.MillingProcs Assembly HiNc.dll Provides guidance and configuration for milling visualization and analysis. public class MillingGuide : IMakeXmlSource Inheritance object MillingGuide Implements IMakeXmlSource 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) Constructors MillingGuide() Initializes a new instance of the MillingGuide class with default configurations. public MillingGuide() MillingGuide(XElement, string) Initializes a new instance of the MillingGuide class from XML data. public MillingGuide(XElement src, string baseDirectory) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths Properties ClStripChartConfig Gets or sets the configuration for cutter location strip charts. public ClStripChartConfig ClStripChartConfig { get; set; } Property Value ClStripChartConfig DictionaryColorGuide Gets or sets the dictionary of color guides for visualizing different properties. public DictionaryColorGuide DictionaryColorGuide { get; set; } Property Value DictionaryColorGuide ForceWCycleLineDivConfig Gets or sets the configuration for force cycle line division. public ForceCycleLineDivConfig ForceWCycleLineDivConfig { get; set; } Property Value ForceCycleLineDivConfig SensorSpindleMomentCycleLineDivConfig Gets or sets the configuration for sensor spindle moment cycle line division. public SpindleMomentCycleLineDivConfig SensorSpindleMomentCycleLineDivConfig { get; set; } Property Value SpindleMomentCycleLineDivConfig SimSpindleMomentCycleLineDivConfig Gets or sets the configuration for simulation spindle moment cycle line division. public SpindleMomentCycleLineDivConfig SimSpindleMomentCycleLineDivConfig { get; set; } Property Value SpindleMomentCycleLineDivConfig XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class MillingGuide Namespace Hi.MillingProcs Assembly HiNc.dll Provides guidance and configuration for milling visualization and analysis. public class MillingGuide : IMakeXmlSource Inheritance object MillingGuide Implements IMakeXmlSource 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) Constructors MillingGuide() Initializes a new instance of the MillingGuide class with default configurations. public MillingGuide() MillingGuide(XElement, string) Initializes a new instance of the MillingGuide class from XML data. public MillingGuide(XElement src, string baseDirectory) Parameters src XElement XML element containing configuration data baseDirectory string Base directory for resolving relative paths Properties ClStripChartConfig Gets or sets the configuration for cutter location strip charts. public ClStripChartConfig ClStripChartConfig { get; set; } Property Value ClStripChartConfig DictionaryColorGuide Gets or sets the dictionary of color guides for visualizing different properties. public DictionaryColorGuide DictionaryColorGuide { get; set; } Property Value DictionaryColorGuide ForceWCycleLineDivConfig Gets or sets the configuration for force cycle line division. public ForceCycleLineDivConfig ForceWCycleLineDivConfig { get; set; } Property Value ForceCycleLineDivConfig SensorSpindleMomentCycleLineDivConfig Gets or sets the configuration for sensor spindle moment cycle line division. public SpindleMomentCycleLineDivConfig SensorSpindleMomentCycleLineDivConfig { get; set; } Property Value SpindleMomentCycleLineDivConfig SimSpindleMomentCycleLineDivConfig Gets or sets the configuration for simulation spindle moment cycle line division. public SpindleMomentCycleLineDivConfig SimSpindleMomentCycleLineDivConfig { get; set; } Property Value SpindleMomentCycleLineDivConfig XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.MillingProcs.html": { "href": "api/Hi.MillingProcs.html", @@ -2737,12 +2877,12 @@ "api/Hi.MillingStepUtils.ClStripChartConfig.html": { "href": "api/Hi.MillingStepUtils.ClStripChartConfig.html", "title": "Class ClStripChartConfig | HiAPI-C# 2025", - "summary": "Class ClStripChartConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for ClStrip charts. public class ClStripChartConfig : IMakeXmlSource Inheritance object ClStripChartConfig Implements IMakeXmlSource 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) Constructors ClStripChartConfig() Initializes a new instance of the ClStripChartConfig class. public ClStripChartConfig() ClStripChartConfig(XElement) Ctor. public ClStripChartConfig(XElement src) Parameters src XElement XML Properties ItemConfigDictionary Dictionary of chart item configurations, indexed by key. public Dictionary ItemConfigDictionary { get; set; } Property Value Dictionary XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ClStripChartConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for ClStrip charts. public class ClStripChartConfig : IMakeXmlSource Inheritance object ClStripChartConfig Implements IMakeXmlSource 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) Constructors ClStripChartConfig() Initializes a new instance of the ClStripChartConfig class. public ClStripChartConfig() ClStripChartConfig(XElement) Ctor. public ClStripChartConfig(XElement src) Parameters src XElement XML Properties ItemConfigDictionary Dictionary of chart item configurations, indexed by key. public Dictionary ItemConfigDictionary { get; set; } Property Value Dictionary XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.MillingStepUtils.ClStripChartItemConfig.html": { "href": "api/Hi.MillingStepUtils.ClStripChartItemConfig.html", "title": "Class ClStripChartItemConfig | HiAPI-C# 2025", - "summary": "Class ClStripChartItemConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for an individual ClStrip chart item. public class ClStripChartItemConfig : IMakeXmlSource Inheritance object ClStripChartItemConfig Implements IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ClStripChartItemConfig() Ctor. public ClStripChartItemConfig() ClStripChartItemConfig(XElement) Ctor. public ClStripChartItemConfig(XElement src) Parameters src XElement XML Properties TimeChartYConfig Gets or sets the Y-axis configuration for time charts. public TimeChartYConfig TimeChartYConfig { get; set; } Property Value TimeChartYConfig XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class ClStripChartItemConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for an individual ClStrip chart item. public class ClStripChartItemConfig : IMakeXmlSource Inheritance object ClStripChartItemConfig Implements IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ClStripChartItemConfig() Ctor. public ClStripChartItemConfig() ClStripChartItemConfig(XElement) Ctor. public ClStripChartItemConfig(XElement src) Parameters src XElement XML Properties TimeChartYConfig Gets or sets the Y-axis configuration for time charts. public TimeChartYConfig TimeChartYConfig { get; set; } Property Value TimeChartYConfig XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.MillingStepUtils.ForceCycleFlag.html": { "href": "api/Hi.MillingStepUtils.ForceCycleFlag.html", @@ -2752,7 +2892,7 @@ "api/Hi.MillingStepUtils.ForceCycleLineDivConfig.html": { "href": "api/Hi.MillingStepUtils.ForceCycleLineDivConfig.html", "title": "Class ForceCycleLineDivConfig | HiAPI-C# 2025", - "summary": "Class ForceCycleLineDivConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for force cycle line division display and analysis. public class ForceCycleLineDivConfig : TimeChartYConfig, IMakeXmlSource Inheritance object TimeChartYConfig ForceCycleLineDivConfig Implements IMakeXmlSource Inherited Members TimeChartYConfig.VRangeMode TimeChartYConfig.VRange TimeChartYConfig.ToString() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ForceCycleLineDivConfig() Default constructor with initial range settings. public ForceCycleLineDivConfig() ForceCycleLineDivConfig(XElement) Ctor. public ForceCycleLineDivConfig(XElement src) Parameters src XElement XML Properties MainForceCycleFlag Gets or sets the main force cycle flag determining how forces are represented. public ForceCycleFlag MainForceCycleFlag { get; set; } Property Value ForceCycleFlag XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string relFile string Returns XElement" + "summary": "Class ForceCycleLineDivConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for force cycle line division display and analysis. public class ForceCycleLineDivConfig : TimeChartYConfig, IMakeXmlSource Inheritance object TimeChartYConfig ForceCycleLineDivConfig Implements IMakeXmlSource Inherited Members TimeChartYConfig.VRangeMode TimeChartYConfig.VRange TimeChartYConfig.ToString() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ForceCycleLineDivConfig() Default constructor with initial range settings. public ForceCycleLineDivConfig() ForceCycleLineDivConfig(XElement) Ctor. public ForceCycleLineDivConfig(XElement src) Parameters src XElement XML Properties MainForceCycleFlag Gets or sets the main force cycle flag determining how forces are represented. public ForceCycleFlag MainForceCycleFlag { get; set; } Property Value ForceCycleFlag XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string, bool) public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly) Parameters baseDirectory string relFile string exhibitionOnly bool Returns XElement" }, "api/Hi.MillingStepUtils.LineChartVRangeMode.html": { "href": "api/Hi.MillingStepUtils.LineChartVRangeMode.html", @@ -2762,43 +2902,18 @@ "api/Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html": { "href": "api/Hi.MillingStepUtils.SpindleMomentCycleLineDivConfig.html", "title": "Class SpindleMomentCycleLineDivConfig | HiAPI-C# 2025", - "summary": "Class SpindleMomentCycleLineDivConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for spindle moment cycle line division display and analysis. public class SpindleMomentCycleLineDivConfig : IMakeXmlSource Inheritance object SpindleMomentCycleLineDivConfig Implements IMakeXmlSource 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) Constructors SpindleMomentCycleLineDivConfig() Ctor. public SpindleMomentCycleLineDivConfig() SpindleMomentCycleLineDivConfig(XElement) Ctor. public SpindleMomentCycleLineDivConfig(XElement src) Parameters src XElement XML Properties TimeChartYConfig Gets or sets the Y-axis configuration for the time chart display. public TimeChartYConfig TimeChartYConfig { get; set; } Property Value TimeChartYConfig XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class SpindleMomentCycleLineDivConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for spindle moment cycle line division display and analysis. public class SpindleMomentCycleLineDivConfig : IMakeXmlSource Inheritance object SpindleMomentCycleLineDivConfig Implements IMakeXmlSource 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) Constructors SpindleMomentCycleLineDivConfig() Ctor. public SpindleMomentCycleLineDivConfig() SpindleMomentCycleLineDivConfig(XElement) Ctor. public SpindleMomentCycleLineDivConfig(XElement src) Parameters src XElement XML Properties TimeChartYConfig Gets or sets the Y-axis configuration for the time chart display. public TimeChartYConfig TimeChartYConfig { get; set; } Property Value TimeChartYConfig XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.MillingStepUtils.TimeChartYConfig.html": { "href": "api/Hi.MillingStepUtils.TimeChartYConfig.html", "title": "Class TimeChartYConfig | HiAPI-C# 2025", - "summary": "Class TimeChartYConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for Y-axis settings in time charts. public class TimeChartYConfig : IMakeXmlSource Inheritance object TimeChartYConfig Implements IMakeXmlSource Derived ForceCycleLineDivConfig Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors TimeChartYConfig() Ctor. public TimeChartYConfig() TimeChartYConfig(XElement) Ctor. public TimeChartYConfig(XElement src) Parameters src XElement XML Properties VRange Minimum and maximum values for the vertical range. public Range VRange { get; set; } Property Value Range VRangeMode Vertical range mode. public LineChartVRangeMode VRangeMode { get; set; } Property Value LineChartVRangeMode XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class TimeChartYConfig Namespace Hi.MillingStepUtils Assembly HiNc.dll Configuration for Y-axis settings in time charts. public class TimeChartYConfig : IMakeXmlSource Inheritance object TimeChartYConfig Implements IMakeXmlSource Derived ForceCycleLineDivConfig Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors TimeChartYConfig() Ctor. public TimeChartYConfig() TimeChartYConfig(XElement) Ctor. public TimeChartYConfig(XElement src) Parameters src XElement XML Properties VRange Minimum and maximum values for the vertical range. public Range VRange { get; set; } Property Value Range VRangeMode Vertical range mode. public LineChartVRangeMode VRangeMode { get; set; } Property Value LineChartVRangeMode XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.MillingStepUtils.html": { "href": "api/Hi.MillingStepUtils.html", "title": "Namespace Hi.MillingStepUtils | HiAPI-C# 2025", "summary": "Namespace Hi.MillingStepUtils Classes ClStripChartConfig Configuration for ClStrip charts. ClStripChartItemConfig Configuration for an individual ClStrip chart item. ForceCycleLineDivConfig Configuration for force cycle line division display and analysis. SpindleMomentCycleLineDivConfig Configuration for spindle moment cycle line division display and analysis. TimeChartYConfig Configuration for Y-axis settings in time charts. Enums ForceCycleFlag Flags representing different force cycle types. LineChartVRangeMode Specifies the mode for vertical range in line charts." }, - "api/Hi.MillingSteps.IGetSourceCommand.html": { - "href": "api/Hi.MillingSteps.IGetSourceCommand.html", - "title": "Interface IGetSourceCommand | HiAPI-C# 2025", - "summary": "Interface IGetSourceCommand Namespace Hi.MillingSteps Assembly HiMech.dll Defines an interface for retrieving source command information. public interface IGetSourceCommand 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) Methods GetSourceCommand() Gets the source command associated with this instance. ISourceCommand GetSourceCommand() Returns ISourceCommand The source command object." - }, - "api/Hi.MillingSteps.IMachiningStepHost.html": { - "href": "api/Hi.MillingSteps.IMachiningStepHost.html", - "title": "Interface IMachiningStepHost | HiAPI-C# 2025", - "summary": "Interface IMachiningStepHost Namespace Hi.MillingSteps Assembly HiMech.dll Represents a host interface for milling steps that provides access to milling equipment and related resources. public interface IMachiningStepHost : IGetMachiningEquipment Inherited Members IGetMachiningEquipment.GetMillingEquipment() 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) Properties DictionaryColorGuide Gets the color guide for dictionary-based coloring. DictionaryColorGuide DictionaryColorGuide { get; } Property Value DictionaryColorGuide MachiningEquipment Gets the milling equipment used for machining operations. MachiningEquipment MachiningEquipment { get; } Property Value MachiningEquipment MachiningToolHouse Gets the tool house containing milling tools. MachiningToolHouse MachiningToolHouse { get; } Property Value MachiningToolHouse MillingStepLuggageReader Gets the parallel bulk reader for milling step luggage data. ParallelBulkReader MillingStepLuggageReader { get; } Property Value ParallelBulkReader TimeMapping Gets the time mapping for synchronization. TimeMapping TimeMapping { get; } Property Value TimeMapping" - }, - "api/Hi.MillingSteps.ISourceCommand.html": { - "href": "api/Hi.MillingSteps.ISourceCommand.html", - "title": "Interface ISourceCommand | HiAPI-C# 2025", - "summary": "Interface ISourceCommand Namespace Hi.MillingSteps Assembly HiMech.dll Represents a source command interface that provides access to file line information and command flags. public interface ISourceCommand : IFileLine, IFileLineIndex, IGetIndexedFileLine, IGetFileLineIndex, IGetSourceCommand Inherited Members IFileLine.FilePath IFileLine.Line IFileLineIndex.FileIndex IFileLineIndex.LineIndex IGetIndexedFileLine.GetIndexedFileLine() IGetFileLineIndex.GetFileLineIndex() IGetSourceCommand.GetSourceCommand() 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) Properties FlagsText Gets the text representation of command flags. string FlagsText { get; } Property Value string" - }, - "api/Hi.MillingSteps.MachineMotionStep.html": { - "href": "api/Hi.MillingSteps.MachineMotionStep.html", - "title": "Class MachineMotionStep | HiAPI-C# 2025", - "summary": "Class MachineMotionStep Namespace Hi.MillingSteps Assembly HiMech.dll MachiningStep has spindle information. Note that the spindle information is only for milling behavior. public class MachineMotionStep : IGetFeedrate, IGetSpindleSpeed Inheritance object MachineMotionStep Implements IGetFeedrate IGetSpindleSpeed Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors MachineMotionStep(MachineMotionStep) Initializes a new instance of the MachineMotionStep class by copying from another instance. public MachineMotionStep(MachineMotionStep src) Parameters src MachineMotionStep The source machining step to copy from. MachineMotionStep(TimeSpan, TimeSpan, double, double[], double, double, SpindleDirection, int, Mat4d, Mat4d, SeqPair) Initializes a new instance of the MachineMotionStep class with specified parameters. public MachineMotionStep(TimeSpan stepDuration, TimeSpan accumulatedTime, double beginSpindleAngle_rad, double[] mcValues, double feedrate_mmds, double spindleSpeed_radds, SpindleDirection spindleDirection, int toolId, Mat4d programZeroToWorkpieceGeomToMat4d, Mat4d workpieceGeomToProgramZeroMat4d, SeqPair seqOnWorkpieceGeomCoordinate) Parameters stepDuration TimeSpan The duration of this step. accumulatedTime TimeSpan The accumulated time up to this step. beginSpindleAngle_rad double The initial spindle angle in radians. mcValues double[] The machine coordinate values. feedrate_mmds double The feed rate in millimeters per second. spindleSpeed_radds double The spindle speed in radians per second. spindleDirection SpindleDirection The direction of spindle rotation. toolId int The ID of the tool being used. programZeroToWorkpieceGeomToMat4d Mat4d The transformation matrix from program zero to workpiece geometry. workpieceGeomToProgramZeroMat4d Mat4d The transformation matrix from workpiece geometry to program zero. seqOnWorkpieceGeomCoordinate SeqPair The sequence of transformations on workpiece geometry coordinate. Properties AccumulatedTime The work time at the end of the step. public TimeSpan AccumulatedTime { get; set; } Property Value TimeSpan BeginSpindleAngle_deg Begin spindle rotation angle. in deg; public double BeginSpindleAngle_deg { get; set; } Property Value double BeginSpindleAngle_rad Begin spindle rotation angle. in rad; public double BeginSpindleAngle_rad { get; set; } Property Value double CdnTransformProgramToToolRunning Gets the transformation matrix from program to tool running coordinate. public Mat4d CdnTransformProgramToToolRunning { get; } Property Value Mat4d CdnTransformProgramToWorkpieceGeom Gets the transformation matrix from program zero to workpiece geometry. public Mat4d CdnTransformProgramToWorkpieceGeom { get; } Property Value Mat4d CdnTransformToolRunningToProgram Gets the transformation matrix from tool running to program coordinate. public Mat4d CdnTransformToolRunningToProgram { get; } Property Value Mat4d CdnTransformToolRunningToWorkpieceGeom Tool running coordinate to workpiece geom coordinate. public Mat4d CdnTransformToolRunningToWorkpieceGeom { get; } Property Value Mat4d CdnTransformWorkpieceGeomToProgram Gets the transformation matrix from workpiece geometry to program zero. public Mat4d CdnTransformWorkpieceGeomToProgram { get; } Property Value Mat4d CdnTransformWorkpieceGeomToToolRunning Gets the transformation matrix from workpiece geometry to tool running coordinate. public Mat4d CdnTransformWorkpieceGeomToToolRunning { get; } Property Value Mat4d CyclePeriod Gets the cycle period as a TimeSpan. public TimeSpan CyclePeriod { get; } Property Value TimeSpan CyclePeriod_s Gets the cycle period in seconds. public double CyclePeriod_s { get; } Property Value double EndSpindleAngle_deg Gets the end spindle angle in degrees. public double EndSpindleAngle_deg { get; } Property Value double EndSpindleAngle_rad Gets the end spindle angle in radians. public double EndSpindleAngle_rad { get; } Property Value double FeedPerCycle_mm Gets the feed per cycle in millimeters. public double FeedPerCycle_mm { get; } Property Value double Feedrate_mmds Gets or sets the feed rate in millimeters per second. public double Feedrate_mmds { get; set; } Property Value double GeomCl Gets the current position in workpiece geometry coordinate. public DVec3d GeomCl { get; } Property Value DVec3d McValues Machine coordinate values. public double[] McValues { get; set; } Property Value double[] MoveOnProgramCoordinate_mm Gets the movement vector in program coordinate in millimeters. public Vec3d MoveOnProgramCoordinate_mm { get; } Property Value Vec3d MoveOnWorkpieceGeomCoordinate_mm Gets the movement vector in workpiece geometry coordinate in millimeters. public Vec3d MoveOnWorkpieceGeomCoordinate_mm { get; } Property Value Vec3d MovingDirectionOnWorkpieceGeomCoordinate Gets the movement direction vector in workpiece geometry coordinate. public Vec3d MovingDirectionOnWorkpieceGeomCoordinate { get; } Property Value Vec3d MovingLength_mm Gets the length of movement in millimeters. public double MovingLength_mm { get; } Property Value double PassedSpindleAngle_deg For milling behavior only. public double PassedSpindleAngle_deg { get; } Property Value double PassedSpindleAngle_rad For milling behavior only. public double PassedSpindleAngle_rad { get; } Property Value double ProgramCl Gets the current position in program coordinate. public DVec3d ProgramCl { get; } Property Value DVec3d ProgramToWorkpieceGeomMat4d Gets or sets the transformation matrix from program zero to workpiece geometry. public Mat4d ProgramToWorkpieceGeomMat4d { get; set; } Property Value Mat4d SeqOnToolRunningCoordinate Gets the sequence of transformations on tool running coordinate. public SeqPair SeqOnToolRunningCoordinate { get; } Property Value SeqPair SeqOnWorkpieceGeomCoordinate Gets or sets the sequence of transformations on workpiece geometry coordinate. public SeqPair SeqOnWorkpieceGeomCoordinate { get; set; } Property Value SeqPair SpindleDirection Gets or sets the direction of spindle rotation. public SpindleDirection SpindleDirection { get; set; } Property Value SpindleDirection SpindleSpeed_cycleds Gets the spindle speed in cycles per second. public double SpindleSpeed_cycleds { get; } Property Value double SpindleSpeed_radds For milling behavior only. public double SpindleSpeed_radds { get; set; } Property Value double SpindleSpeed_rpm Gets the spindle speed in revolutions per minute. public double SpindleSpeed_rpm { get; } Property Value double StepBeginTime The work time at the begin of the step. public TimeSpan StepBeginTime { get; } Property Value TimeSpan StepDuration Gets or sets the duration of this step. public TimeSpan StepDuration { get; set; } Property Value TimeSpan ToolId Gets or sets the ID of the tool being used. public int ToolId { get; set; } Property Value int WorkpieceGeomToProgramMat4d Gets or sets the transformation matrix from workpiece geometry to program zero. public Mat4d WorkpieceGeomToProgramMat4d { get; set; } Property Value Mat4d Methods GetFeedPerTooth_mm(IMachiningTool) Gets the feed per tooth in millimeters. public double GetFeedPerTooth_mm(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The feed per tooth in millimeters. GetFeedrate_mmds() Gets the program feedrate in millimeters per second. public double GetFeedrate_mmds() Returns double Feedrate in mm/s GetMachiningTool(MachiningToolHouse) Gets the machining tool from the tool house. public IMachiningTool GetMachiningTool(MachiningToolHouse toolHouse) Parameters toolHouse MachiningToolHouse The machining tool house. Returns IMachiningTool The machining tool. GetProgramSideCuspHeight_mm(IMachiningTool) Gets the program side cusp height in millimeters. public double GetProgramSideCuspHeight_mm(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The program side cusp height in millimeters. GetSideCuspList_mm(IMachiningTool) Gets the list of side cusp heights in millimeters. public List GetSideCuspList_mm(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns List The list of side cusp heights in millimeters. GetSideCuspPhaseInterval_rad(IMachiningTool) Gets the side cusp phase interval in radians. public double GetSideCuspPhaseInterval_rad(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The side cusp phase interval in radians. GetSpindleDirection() Gets the spindle rotation direction. public SpindleDirection GetSpindleDirection() Returns SpindleDirection The spindle direction (clockwise, counterclockwise, or stopped) GetSpindleSpeed_radds() Gets the spindle speed in radians per second. public double GetSpindleSpeed_radds() Returns double Spindle speed in rad/s GetToothArcDuration_s(IMachiningTool) Gets the duration of a single tooth arc in seconds. public double GetToothArcDuration_s(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns double The duration of a single tooth arc in seconds. GetToothSeqOnToolRunningCoordinate(IMachiningTool) Gets the sequence of transformations for a single tooth on tool running coordinate. public SeqPair GetToothSeqOnToolRunningCoordinate(IMachiningTool millingTool) Parameters millingTool IMachiningTool The milling tool. Returns SeqPair The sequence of transformations for a single tooth. ToString() Returns a string representation of this machining step. public override string ToString() Returns string A string representation of this machining step." - }, - "api/Hi.MillingSteps.MachiningStep.html": { - "href": "api/Hi.MillingSteps.MachiningStep.html", - "title": "Class MachiningStep | HiAPI-C# 2025", - "summary": "Class MachiningStep Namespace Hi.MillingSteps Assembly HiMech.dll public class MachiningStep : IGetSourceCommand, IFlexDictionaryHost, IGetFeedrate, IGetSpindleSpeed, IGetRgbWithPriority Inheritance object MachiningStep Implements IGetSourceCommand IFlexDictionaryHost IGetFeedrate IGetSpindleSpeed IGetRgbWithPriority 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) FlexDictionaryUtil.CallFlexDictionary(IFlexDictionaryHost) FlexDictionaryUtil.GetFlexDictionaryBytes(IFlexDictionaryHost, IntegerKeyDictionaryConverter) FlexDictionaryUtil.WriteFlexDictionary(IFlexDictionaryHost, BinaryWriter, IntegerKeyDictionaryConverter) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MachiningStep(IMachiningStepHost, int, ISourceCommand, MachineMotionStep, MillingPhysicsStep) Initializes a new instance of the MillingStep class. public MachiningStep(IMachiningStepHost host, int stepIndex, ISourceCommand sourceCommand, MachineMotionStep machiningStep, MillingPhysicsStep millingPhysicsStep) Parameters host IMachiningStepHost The host of the milling step. stepIndex int The index of the step. sourceCommand ISourceCommand The source command. machiningStep MachineMotionStep The machining step. millingPhysicsStep MillingPhysicsStep The milling physics step. Properties AccumulatedCraterWear_um Gets the accumulated crater wear in micrometers [Present(\"Accumulated Crater Wear\", \"A.C.Wear\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedCraterWear_um { get; } Property Value double AccumulatedFlankWearDepth_um Gets the accumulated flank wear depth in micrometers [Present(\"Accumulated Flank Wear Depth\", \"A.F.Wear.Depth\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedFlankWearDepth_um { get; } Property Value double AccumulatedFlankWearWidth_um Gets the accumulated flank wear width in micrometers [Present(\"Accumulated Flank Wear Width\", \"A.F.Wear.Width\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedFlankWearWidth_um { get; } Property Value double AccumulatedSpindleEnergyConsumption_kWh Gets the accumulated spindle energy consumption in kilowatt-hours [Present(\"Accumulated Spindle Energy Consumption\", null, PhysicsUnit.kWh, \"G6\")] [JsAce(ClassExt = \"MachiningStep\")] public double AccumulatedSpindleEnergyConsumption_kWh { get; } Property Value double AccumulatedTime Gets the accumulated time. [Present(\"Accumulated Time\", null, PhysicsUnit.None, \"G\")] [JsAce(ClassExt = \"MachiningStep\")] public TimeSpan AccumulatedTime { get; } Property Value TimeSpan AvgAbsMomentAboutSensorVec3d_Nm Gets the average absolute moment about sensor vector in Newton-meters [Present(\"Avg Abs Moment To Tool About Sensor\", \"Avg-Abs-M-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgAbsMomentAboutSensorVec3d_Nm { get; } Property Value Vec3d AvgAbsMomentXAboutSensorOnSpindleRotationCoordinate_Nm Gets the average absolute moment X about sensor on spindle rotation coordinate in Newton-meters [Present(\"Avg Abs Moment X To Tool About Sensor On Spindle Rotation Coordinate\", \"AvgAbsMx-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsMomentXAboutSensorOnSpindleRotationCoordinate_Nm { get; } Property Value double? AvgAbsMomentXAboutToolTipOnSpindleRotationCoordinate_Nm Gets the average absolute moment X about tool tip on spindle rotation coordinate in Newton-meters [Present(\"Avg Abs Moment X To Tool About Tool Tip On Spindle Rotation Coordinate\", \"AvgAbsMx-ToTool-Tip-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double AvgAbsMomentXAboutToolTipOnSpindleRotationCoordinate_Nm { get; } Property Value double AvgAbsTorqueByMapping_Nm Gets the average absolute torque by mapping in Newton-meters [Present(\"Avg Abs Torque By Mapping\", \"AvgAbsTorque-Map\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorqueByMapping_Nm { get; } Property Value double? AvgAbsTorqueErrorRatioWithMapping numerator is sim value minus mapping value; denominator is the mapping value. [Present(\"Avg Torque Error Ratio by Mapping\", \"Torque-Err-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorqueErrorRatioWithMapping { get; } Property Value double? AvgAbsTorqueSignedErrorRelationWithMapping The sign is from sim value minus mapping value. the quantity is Math.Sqrt(err.Square() / Math.Abs(sim * mapping)) [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorqueSignedErrorRelationWithMapping { get; } Property Value double? AvgAbsTorque_Nm AvgAbsTorqueOnSpindleRotationCoordinate [Present(\"Avg Abs Torque\", \"AvgAbsTorque\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgAbsTorque_Nm { get; } Property Value double? AvgForceToToolOnToolRunningCoordinate_N Gets the average force to tool on tool running coordinate in N. [Present(\"AvgForceToToolOnToolRunningCoordinate\", \"AvgForce-ToTool-TR\", PhysicsUnit.N, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgForceToToolOnToolRunningCoordinate_N { get; } Property Value Vec3d AvgForceXToToolOnToolRunningCoordinate_N Gets the average force X to tool on tool running coordinate in N. [JsAce(ClassExt = \"MachiningStep\")] public double? AvgForceXToToolOnToolRunningCoordinate_N { get; } Property Value double? AvgForceYToToolOnToolRunningCoordinate_N Gets the average force Y to tool on tool running coordinate in N. [JsAce(ClassExt = \"MachiningStep\")] public double? AvgForceYToToolOnToolRunningCoordinate_N { get; } Property Value double? AvgForceZToToolOnToolRunningCoordinate_N Gets the average force Z to tool on tool running coordinate in N. [JsAce(ClassExt = \"MachiningStep\")] public double? AvgForceZToToolOnToolRunningCoordinate_N { get; } Property Value double? AvgMomentAboutSensor_Nm Gets the average moment about sensor in Newton-meters [Present(\"Avg Moment To Tool About Sensor\", \"AvgM-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentAboutSensor_Nm { get; } Property Value double? AvgMomentAboutToolTipOnProgramCoordinate_Nm Gets the average moment about tool tip on program coordinate in Newton-meters [Present(\"Avg Moment To Tool About Tool Tip On Workpiece Program Coordinate\", \"AvgAbsM-ToTool-Tip-W\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgMomentAboutToolTipOnProgramCoordinate_Nm { get; } Property Value Vec3d AvgMomentAboutToolTipOnToolRunningCoordinate_Nm Gets the average moment about tool tip on tool running coordinate in Newton-meters [Present(\"Avg Moment To Tool About Tool Tip On Tool Running Coordinate\", \"AvgAbsM-ToTool-Tip-TR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d AvgMomentAboutToolTipOnToolRunningCoordinate_Nm { get; } Property Value Vec3d AvgMomentAboutToolTip_Nm Gets the average moment about tool tip in Newton-meters [Present(\"Avg Moment To Tool About ToolTip\", \"AvgM-ToTool-Tip-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentAboutToolTip_Nm { get; } Property Value double? AvgMomentXyAboutObservationPoint_Nm Gets the average moment XY about observation point in Newton-meters [Present(\"Avg Moment XY To Tool About Sensor\", \"AvgM-ToTool-Sensor.XY\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXyAboutObservationPoint_Nm { get; } Property Value double? AvgMomentXyByMapping_Nm Gets the average moment XY by mapping in Newton-meters [Present(\"Avg Moment XY By Mapping\", \"AvgM-Map.XY\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXyByMapping_Nm { get; } Property Value double? AvgMomentXyErrorRatioWithMapping Gets the average moment XY error ratio with mapping. Numerator is sim value minus mapping value; denominator is the mapping value. [Present(\"Avg Moment XY Error Ratio by Mapping\", \"M-XY-Err-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXyErrorRatioWithMapping { get; } Property Value double? AvgMomentXySignedErrorRelationWithMapping The sign is from sim value minus mapping value. the quantity is Math.Sqrt(err.Square() / Math.Abs(sim * mapping)) [JsAce(ClassExt = \"MachiningStep\")] public double? AvgMomentXySignedErrorRelationWithMapping { get; } Property Value double? BeginSpindleAngle_deg Gets the beginning spindle angle in degrees. [Present(\"Beginning Spindle Angle Shift\", \"Spd. Ang. Shift\", PhysicsUnit.deg, \"F2\")] [JsAce(ClassExt = \"MachiningStep\")] public double BeginSpindleAngle_deg { get; } Property Value double ChipMass_g Gets the chip mass in grams. [JsAce(ClassExt = \"MachiningStep\")] public double? ChipMass_g { get; } Property Value double? ChipMass_mg Gets the chip mass in milligrams. [Present(\"Chip Mass\", null, PhysicsUnit.mg, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipMass_mg { get; } Property Value double? ChipTemperature_C Gets the chip temperature in Celsius [Present(\"Chip Temperature\", \"Chip T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipTemperature_C { get; } Property Value double? ChipThickness_mm Gets the chip thickness in mm. [Present(\"Chip Thickness\", null, PhysicsUnit.mm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipThickness_mm { get; } Property Value double? ChipThickness_um Gets the chip thickness in micrometers public double? ChipThickness_um { get; } Property Value double? ChipVolume_mm3 Gets the chip volume in mm³. [Present(\"Chip Volume\", null, PhysicsUnit.mm3, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ChipVolume_mm3 { get; } Property Value double? Cl Gets the cutter location. [Present(\"Cutter Location\", \"CL\", PhysicsUnit.mm, \"F5\")] public DVec3d Cl { get; } Property Value DVec3d CutterBodyTemperature_C Gets the cutter body temperature in Celsius [Present(\"Cutter Body Temperature\", \"Ct. Body T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? CutterBodyTemperature_C { get; } Property Value double? CutterDermisTemperature_C Gets the cutter dermis temperature in Celsius [Present(\"Cutter Dermis Temperature\", \"Ct. Dermis T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? CutterDermisTemperature_C { get; } Property Value double? CuttingDepth_mm Gets the cutting depth in mm. [Present(\"Cutting Depth\", \"ap\", PhysicsUnit.mm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double CuttingDepth_mm { get; } Property Value double CuttingSpeed_mmds Gets the cutting speed in mm/s. [Present(\"Cutting Speed\", \"Vc\", PhysicsUnit.mmds, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double? CuttingSpeed_mmds { get; } Property Value double? CuttingWidth_mm Gets the cutting width in mm. [Present(\"Cutting Width\", \"ae\", PhysicsUnit.mm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double CuttingWidth_mm { get; } Property Value double DeltaTipDeflectionOnToolRunningCoordinate_um Gets the delta tip deflection on tool running coordinate in micrometers [Present(\"Delta Tip Deflection On Tool Running Coordinate\", \"Dlt.Df.-Tip-TR\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d DeltaTipDeflectionOnToolRunningCoordinate_um { get; } Property Value Vec3d FeedPerCycle_mm Gets the feed per cycle in mm. [Present(\"Feed per Cycle\", \"frc\", PhysicsUnit.mm, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double FeedPerCycle_mm { get; } Property Value double FeedPerTooth_mm Gets the feed per tooth in mm. [Present(\"Feed per Tooth\", \"frt\", PhysicsUnit.mm, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double FeedPerTooth_mm { get; } Property Value double Feedrate_mmdmin Gets the feedrate in mm/min. [Present(\"Feedrate\", \"F\", PhysicsUnit.mmdmin, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double Feedrate_mmdmin { get; } Property Value double Feedrate in mm/s FileNo Gets the file number. [Present] [JsAce(ClassExt = \"MachiningStep\")] public int? FileNo { get; } Property Value int? FilePath Gets the file path. [Present] [JsAce(ClassExt = \"MachiningStep\")] public string FilePath { get; } Property Value string FlagsText Gets the flags text. [Present] [JsAce(ClassExt = \"MachiningStep\")] public string FlagsText { get; } Property Value string FlexDictionary Gets or sets the flexible dictionary. public Dictionary FlexDictionary { get; set; } Property Value Dictionary FrictionPower_W friction power to workpiece per cycle. the unit is watt. [JsAce(ClassExt = \"MachiningStep\")] public double? FrictionPower_W { get; } Property Value double? Host Gets or sets the host of the milling step. public IMachiningStepHost Host { get; set; } Property Value IMachiningStepHost InfInsistentSpindlePowerRatio Gets the infinite insistent spindle power ratio [Present(\"Continue Spindle Power Ratio\", \"Cont.Spd.Pow.R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? InfInsistentSpindlePowerRatio { get; } Property Value double? InfInsistentSpindleTorqueRatio Gets the infinite insistent spindle torque ratio [Present(\"Continue Spindle Torque Ratio\", \"Cont.Spd.Torque-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? InfInsistentSpindleTorqueRatio { get; } Property Value double? InstantCraterWear_um Gets the instant crater wear in micrometers [Present(\"Instant Crater Wear\", \"I.C.Wear\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? InstantCraterWear_um { get; } Property Value double? IsTouched Gets whether the step is touched. [Present(\"Is Touched\", null, PhysicsUnit.None, \"G\")] [JsAce(ClassExt = \"MachiningStep\")] public bool IsTouched { get; } Property Value bool this[string] Gets or sets a value in the flexible dictionary by key. public object this[string key] { get; set; } Parameters key string The key to look up. Property Value object The value associated with the key, or null if not found. LineNo Gets the line number. [Present] [JsAce(ClassExt = \"MachiningStep\")] public int? LineNo { get; } Property Value int? LineText Gets the line text. [Present] [JsAce(ClassExt = \"MachiningStep\")] public string LineText { get; } Property Value string MachineMotionStep Gets or sets the machining step. public MachineMotionStep MachineMotionStep { get; set; } Property Value MachineMotionStep MachiningTool Gets the machining tool used for this milling step. public IMachiningTool MachiningTool { get; } Property Value IMachiningTool MaxAbsForce_N Max absolute force at the rotation cycle. [Present(\"Max Absolute Force\", \"Max Abs F.\", PhysicsUnit.N, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? MaxAbsForce_N { get; } Property Value double? MaxBottomEdgeDeflectionOnToolRunningCoordinate_mm Gets the maximum bottom edge deflection on tool running coordinate in millimeters [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MaxBottomEdgeDeflectionOnToolRunningCoordinate_mm { get; } Property Value Vec3d MaxForceOnToolRunningCoordinate_N Gets the maximum force on tool running coordinate in N. public Vec3d MaxForceOnToolRunningCoordinate_N { get; } Property Value Vec3d MaxMomentAboutSensor_Nm Gets the maximum moment about sensor in Newton-meters [Present(\"Max Moment To Tool About Sensor\", \"MaxM-ToTool-Sensor-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double MaxMomentAboutSensor_Nm { get; } Property Value double MaxMomentAboutToolTip_Nm Gets the maximum moment about tool tip in Newton-meters [Present(\"Max Moment To Tool About ToolTip\", \"MaxM-ToTool-Tip-SR\", PhysicsUnit.Nm, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double MaxMomentAboutToolTip_Nm { get; } Property Value double MaxSpindlePowerRatio Gets the maximum spindle power ratio [Present(\"Max Spindle Power Ratio\", \"Max.Spd.Pow.R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? MaxSpindlePowerRatio { get; } Property Value double? MaxSpindleTorqueRatio Gets the maximum spindle torque ratio [Present(\"Max Spindle Torque Ratio\", \"Max.Spd.Torque-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? MaxSpindleTorqueRatio { get; } Property Value double? MaxTipDeflectionOnToolRunningCoordinate_mm Gets the maximum tip deflection on tool running coordinate in millimeters [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MaxTipDeflectionOnToolRunningCoordinate_mm { get; } Property Value Vec3d MaxTipDeflectionOnToolRunningCoordinate_um Gets the maximum tip deflection on tool running coordinate in micrometers [Present(\"Max Tip Deflection On Tool Running Coordinate\", \"Max.Df.-Tip-TR\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MaxTipDeflectionOnToolRunningCoordinate_um { get; } Property Value Vec3d MillingPhysicsStep Gets or sets the milling physics step. public MillingPhysicsStep MillingPhysicsStep { get; set; } Property Value MillingPhysicsStep MillingStepLuggage Get luggage by sequencing loading performance optimization. public MillingStepLuggage MillingStepLuggage { get; } Property Value MillingStepLuggage MoveOnProgramCoordinate Gets the move on program coordinate. [Present(\"Move On Workpiece Program Coordinate\", \"Move-W\", PhysicsUnit.mm, \"F4\")] [JsAce(ClassExt = \"MachiningStep\")] public Vec3d MoveOnProgramCoordinate { get; } Property Value Vec3d MovingLength_mm Gets the moving length in mm. [Present(\"Move Length\", \"Move Len.\", PhysicsUnit.mm, \"F4\")] [JsAce(ClassExt = \"MachiningStep\")] public double MovingLength_mm { get; } Property Value double Mrr_mm3ds Gets the material removal rate in mm³/s. [Present(\"MRR\", null, PhysicsUnit.mm3ds, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double Mrr_mm3ds { get; } Property Value double ProgramSideCusp_um Gets the program side cusp in micrometers. Side cusp without deformation. The value is count by feed per tooth and the tool radius. [Present(\"Program Side Cusp\", null, PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double ProgramSideCusp_um { get; } Property Value double ReCutDepth_um Gets or sets the recut depth in micrometers. [Present(\"Re-Cut Depth on Bottom Edge on Tool Running Coordinate\", \"Re-Cut Depth\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double ReCutDepth_um { get; } Property Value double SideCuspList_um Gets the list of side cusps in micrometers. [JsAce(ClassExt = \"MachiningStep\")] public List SideCuspList_um { get; } Property Value List SourceCommand Gets or sets the source command. public ISourceCommand SourceCommand { get; set; } Property Value ISourceCommand SpindleCyclePeriod_s Gets the spindle cycle period in seconds. [Present(\"Spindle Cycle Period\", null, PhysicsUnit.sec, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleCyclePeriod_s { get; } Property Value double SpindleInputPower_W Gets the input spindle power in Watts. [Present(\"Spindle Input Power\", null, PhysicsUnit.watt, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleInputPower_W { get; } Property Value double Input spindle power in Watts. SpindleOutputPower_W Spindle power. Watt. Axial Power Taken By Workpiece. [Present(\"Spindle Output Power\", null, PhysicsUnit.watt, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleOutputPower_W { get; } Property Value double SpindleSpeed_rpm Gets the spindle speed in RPM. [Present(\"Spindle Speed\", \"S\", PhysicsUnit.rpm, \"G5\")] [JsAce(ClassExt = \"MachiningStep\")] public double SpindleSpeed_rpm { get; } Property Value double Spindle speed in rad/s SpindleTemperature_C Gets the spindle temperature in Celsius [Present(\"Spindle Temperature\", \"Spd.Temp.\", PhysicsUnit.C, \"G2\")] [JsAce(ClassExt = \"MachiningStep\")] public double? SpindleTemperature_C { get; } Property Value double? SpindleWorkingTemperatureRatio Gets the spindle working temperature ratio [Present(\"Spindle Working Temperature Ratio\", \"Spd.Temp.R.\", PhysicsUnit.None, \"G2\")] [JsAce(ClassExt = \"MachiningStep\")] public double? SpindleWorkingTemperatureRatio { get; } Property Value double? StepDuration Gets the step duration. [Present(\"Step Duration\", null, PhysicsUnit.sec, \"ss\\\\.ffffff\")] [JsAce(ClassExt = \"MachiningStep\")] public TimeSpan StepDuration { get; } Property Value TimeSpan StepIndex Gets the index of the step. [Key] [DatabaseGenerated(DatabaseGeneratedOption.None)] public int StepIndex { get; } Property Value int ThermalStress_MPa Gets the thermal stress in MPa [Present(\"Thermal Stress\", \"Th. S.\", PhysicsUnit.MPa, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ThermalStress_MPa { get; } Property Value double? ThermalYieldRatio Gets the thermal yield ratio [Present(\"Thermal Yield Ratio\", \"Th. Yield R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? ThermalYieldRatio { get; } Property Value double? TipDeflectionsOnToolRunningCoordinate_um Gets the tip deflections on tool running coordinate in micrometers [JsAce(ClassExt = \"MachiningStep\")] public List TipDeflectionsOnToolRunningCoordinate_um { get; } Property Value List ToolId Gets the tool ID. [Present(\"Tool ID\", \"T\", PhysicsUnit.None, \"G\")] [JsAce(ClassExt = \"MachiningStep\")] public int ToolId { get; } Property Value int ToothArcDuration_s Gets the tooth arc duration in seconds. [Present(\"Tooth Arc Duration\", null, PhysicsUnit.sec, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double ToothArcDuration_s { get; } Property Value double ToothSeqOnToolRunningCoordinate Gets the sequence pair of transformation matrices representing tooth positions on the tool running coordinate system. public SeqPair ToothSeqOnToolRunningCoordinate { get; } Property Value SeqPair WorkpieceDermisTemperature_C Gets the workpiece dermis temperature in Celsius [Present(\"Workpiece Dermis Temperature\", \"W. Dermis T.\", PhysicsUnit.C, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? WorkpieceDermisTemperature_C { get; } Property Value double? WorkpiecePlasticDepth_um Gets the workpiece plastic depth in micrometers [Present(\"Workpiece Plastic Deformation Depth\", \"W.P.Depth\", PhysicsUnit.um, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double WorkpiecePlasticDepth_um { get; } Property Value double YieldingStressRatio Gets the yielding stress ratio [Present(\"Yielding Stress Ratio\", \"Y-Stress-R.\", PhysicsUnit.None, \"G4\")] [JsAce(ClassExt = \"MachiningStep\")] public double? YieldingStressRatio { get; } Property Value double? Methods GetCutterDermisAvgTemperature_C(double) Gets the average cutter dermis temperature in Celsius at the specified depth. [JsAce(ClassExt = \"MachiningStep\")] public double GetCutterDermisAvgTemperature_C(double depth_mm) Parameters depth_mm double The depth in millimeters Returns double Average temperature in Celsius GetCutterDermisTemperature_C(double) Gets the cutter dermis temperature in Celsius at the specified depth. [JsAce(ClassExt = \"MachiningStep\")] public double GetCutterDermisTemperature_C(double depth_mm) Parameters depth_mm double The depth in millimeters Returns double Temperature in Celsius GetFeedrate_mmds() Gets the program feedrate in millimeters per second. public double GetFeedrate_mmds() Returns double Feedrate in mm/s GetKeyToQuantityNativeDictionary(IMachiningChain) Internal use. public static ConcurrentDictionary GetKeyToQuantityNativeDictionary(IMachiningChain machiningChain) Parameters machiningChain IMachiningChain Returns ConcurrentDictionary GetMcValue(IMachiningChain, string) Gets the MC value for the specified tag in the machining chain. public double? GetMcValue(IMachiningChain chain, string tag) Parameters chain IMachiningChain The machining chain. tag string The tag to look up. Returns double? The MC value for the specified tag. GetMcValue(int) Gets the MC value at the specified index. [JsAce(ClassExt = \"MachiningStep\")] public double? GetMcValue(int index) Parameters index int The index to look up. Returns double? The MC value at the specified index. GetRgbWithPriority(out Vec3d, out double) Gets the RGB color and priority for the milling step. public void GetRgbWithPriority(out Vec3d rgb, out double priority) Parameters rgb Vec3d The RGB color vector. priority double The priority value. GetSourceCommand() Gets the source command associated with this instance. public ISourceCommand GetSourceCommand() Returns ISourceCommand The source command object. GetSpindleDirection() Gets the spindle direction for this milling step. public SpindleDirection GetSpindleDirection() Returns SpindleDirection GetSpindleSpeed_radds() Gets the spindle speed in radians per second. public double GetSpindleSpeed_radds() Returns double Spindle speed in rad/s" - }, "api/Hi.MillingSteps.MillingPhysicsStep.html": { "href": "api/Hi.MillingSteps.MillingPhysicsStep.html", "title": "Class MillingPhysicsStep | HiAPI-C# 2025", @@ -2809,30 +2924,10 @@ "title": "Class MillingStepLuggage | HiAPI-C# 2025", "summary": "Class MillingStepLuggage Namespace Hi.MillingSteps Assembly HiMech.dll Represents additional data associated with a milling step. [BsonIgnoreExtraElements] public class MillingStepLuggage Inheritance object MillingStepLuggage 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) Constructors MillingStepLuggage() Initializes a new instance of the MillingStepLuggage class. public MillingStepLuggage() MillingStepLuggage(int, Substraction, LayerMillingEngagement, MillingForceLuggage) Initializes a new instance of the MillingStepLuggage class with specified parameters. public MillingStepLuggage(int stepIndex, Substraction substraction, LayerMillingEngagement layerMillingEngagement, MillingForceLuggage millingForceLuggage) Parameters stepIndex int The index of the associated milling step. substraction Substraction The substraction information. layerMillingEngagement LayerMillingEngagement The layer milling engagement information. millingForceLuggage MillingForceLuggage The milling force luggage information. Properties LayerMillingEngagement Gets or sets the layer milling engagement information. [BsonElement] public LayerMillingEngagement LayerMillingEngagement { get; set; } Property Value LayerMillingEngagement MillingForceLuggage Gets or sets the milling force luggage information. [BsonElement] public MillingForceLuggage MillingForceLuggage { get; set; } Property Value MillingForceLuggage StepIndex Gets or sets the index of the associated milling step. [Key] [DatabaseGenerated(DatabaseGeneratedOption.None)] [BsonId] public int StepIndex { get; set; } Property Value int Substraction Gets or sets the substraction information for the milling step. [BsonElement] public Substraction Substraction { get; set; } Property Value Substraction" }, - "api/Hi.MillingSteps.MillingStepUtil.html": { - "href": "api/Hi.MillingSteps.MillingStepUtil.html", - "title": "Class MillingStepUtil | HiAPI-C# 2025", - "summary": "Class MillingStepUtil Namespace Hi.MillingSteps Assembly HiMech.dll Utility class for milling step related constants and helper methods. public static class MillingStepUtil Inheritance object MillingStepUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties MillingStepDbName Gets the database name for milling steps. public static string MillingStepDbName { get; } Property Value string MillingStepLuggageCollectionName Gets the collection name for milling step luggage. public static string MillingStepLuggageCollectionName { get; } Property Value string" - }, - "api/Hi.MillingSteps.PresentAttribute.html": { - "href": "api/Hi.MillingSteps.PresentAttribute.html", - "title": "Class PresentAttribute | HiAPI-C# 2025", - "summary": "Class PresentAttribute Namespace Hi.MillingSteps Assembly HiMech.dll Attribute for presenting property information with localization support. public class PresentAttribute : Attribute Inheritance object Attribute PresentAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) 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) Constructors PresentAttribute() Initializes a new instance of the PresentAttribute class. public PresentAttribute() PresentAttribute(PresentAttribute) Initializes a new instance of the PresentAttribute class by copying from another instance. public PresentAttribute(PresentAttribute src) Parameters src PresentAttribute The source attribute to copy from. PresentAttribute(string, string, PhysicsUnit, string) Initializes a new instance of the PresentAttribute class with specified parameters. public PresentAttribute(string name, string shortName, PhysicsUnit unit, string dataFormatString) Parameters name string The display name of the property. shortName string The short name of the property. unit PhysicsUnit The physics unit of the property. dataFormatString string The format string for displaying the property value. Properties DataFormatString Gets or sets the format string for displaying the property value. public string DataFormatString { get; set; } Property Value string Name Gets or sets the display name of the property. public string Name { get; set; } Property Value string ShortName Gets or sets the short name of the property. public string ShortName { get; set; } Property Value string TailUnitString Gets the unit string with parentheses for display purposes. public string TailUnitString { get; } Property Value string Unit Gets or sets the physics unit of the property. public PhysicsUnit Unit { get; set; } Property Value PhysicsUnit Methods GetPresentName(StringLocalizer) Gets the localized presentation name with unit string. public string GetPresentName(StringLocalizer loc) Parameters loc StringLocalizer The string localizer. Returns string The localized name with unit string. GetPresentName(IStringLocalizer) Gets the localized presentation name with unit string. public string GetPresentName(IStringLocalizer loc) Parameters loc IStringLocalizer The string localizer. Returns string The localized name with unit string." - }, - "api/Hi.MillingSteps.StepPropertyAccess.html": { - "href": "api/Hi.MillingSteps.StepPropertyAccess.html", - "title": "Class StepPropertyAccess | HiAPI-C# 2025", - "summary": "Class StepPropertyAccess Namespace Hi.MillingSteps Assembly HiMech.dll Provides access to properties of a milling step with presentation information. public class StepPropertyAccess Inheritance object StepPropertyAccess 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) Constructors StepPropertyAccess(PresentAttribute, Func) Initializes a new instance of the StepPropertyAccess class for numeric properties. public StepPropertyAccess(PresentAttribute presentAttribute, Func getQuantityFunc) Parameters presentAttribute PresentAttribute The presentation attribute for the property. getQuantityFunc Func The function to retrieve the numeric value. StepPropertyAccess(PresentAttribute, Func) Initializes a new instance of the StepPropertyAccess class for non-numeric properties. public StepPropertyAccess(PresentAttribute presentAttribute, Func getNonQuantityFunc) Parameters presentAttribute PresentAttribute The presentation attribute for the property. getNonQuantityFunc Func The function to retrieve the non-numeric value. Properties GetNonQuantityFunc Gets or sets the function to retrieve a non-numeric value from a milling step. public Func GetNonQuantityFunc { get; set; } Property Value Func GetQuantityFunc Gets or sets the function to retrieve a numeric value from a milling step. public Func GetQuantityFunc { get; set; } Property Value Func PresentAttribute Gets or sets the presentation attribute for the property. public PresentAttribute PresentAttribute { get; set; } Property Value PresentAttribute Methods GetValue(MachiningStep) Gets the value of the property for the specified milling step. public object GetValue(MachiningStep step) Parameters step MachiningStep The milling step to get the property value from. Returns object The property value, or null if neither function is set. GetValueText(MachiningStep) Gets the formatted text representation of the property value for the specified milling step. public string GetValueText(MachiningStep step) Parameters step MachiningStep The milling step to get the property value from. Returns string The formatted text representation of the property value. GetValueText(object) Gets the formatted text representation of the specified value. public string GetValueText(object v) Parameters v object The value to format. Returns string The formatted text representation of the value." - }, - "api/Hi.MillingSteps.StringValueAttribute.html": { - "href": "api/Hi.MillingSteps.StringValueAttribute.html", - "title": "Class StringValueAttribute | HiAPI-C# 2025", - "summary": "Class StringValueAttribute Namespace Hi.MillingSteps Assembly HiMech.dll Attribute for associating a string value with an enum value or other element. public class StringValueAttribute : Attribute Inheritance object Attribute StringValueAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) 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) Constructors StringValueAttribute(string) Initializes a new instance of the StringValueAttribute class with the specified value. public StringValueAttribute(string value) Parameters value string The string value to associate with the element. Properties Value Gets or sets the string value associated with the element. public string Value { get; set; } Property Value string" - }, "api/Hi.MillingSteps.html": { "href": "api/Hi.MillingSteps.html", "title": "Namespace Hi.MillingSteps | HiAPI-C# 2025", - "summary": "Namespace Hi.MillingSteps Classes MachineMotionStep MachiningStep has spindle information. Note that the spindle information is only for milling behavior. MachiningStep MillingPhysicsStep Represents the physics step of a milling operation, containing physical properties and calculations. MillingStepLuggage Represents additional data associated with a milling step. MillingStepUtil Utility class for milling step related constants and helper methods. PresentAttribute Attribute for presenting property information with localization support. StepPropertyAccess Provides access to properties of a milling step with presentation information. StringValueAttribute Attribute for associating a string value with an enum value or other element. Interfaces IGetSourceCommand Defines an interface for retrieving source command information. IMachiningStepHost Represents a host interface for milling steps that provides access to milling equipment and related resources. ISourceCommand Represents a source command interface that provides access to file line information and command flags." + "summary": "Namespace Hi.MillingSteps Classes MillingPhysicsStep Represents the physics step of a milling operation, containing physical properties and calculations. MillingStepLuggage Represents additional data associated with a milling step." }, "api/Hi.MongoUtils.IMongoRunner.html": { "href": "api/Hi.MongoUtils.IMongoRunner.html", @@ -2912,7 +3007,7 @@ "api/Hi.Native.box3d.html": { "href": "api/Hi.Native.box3d.html", "title": "Struct box3d | HiAPI-C# 2025", - "summary": "Struct box3d Namespace Hi.Native Assembly HiGeom.dll Native implementation of a 3D bounding box structure for interop scenarios. public struct box3d : IExpandToBox3d Implements IExpandToBox3d Inherited Members ValueType.Equals(object) ValueType.GetHashCode() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Extension Methods GeomUtil.GetBox3d(IExpandToBox3d) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors box3d(Box3d) Initializes a new instance of the box3d struct from a Box3d object. public box3d(Box3d src) Parameters src Box3d The source Box3d object to convert from. Fields max The maximum point of the box (upper-right-front corner). public vec3d max Field Value vec3d min The minimum point of the box (lower-left-back corner). public vec3d min Field Value vec3d Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name." + "summary": "Struct box3d Namespace Hi.Native Assembly HiGeom.dll Native implementation of a 3D bounding box structure for interop scenarios. public struct box3d : IExpandToBox3d Implements IExpandToBox3d Inherited Members ValueType.Equals(object) ValueType.GetHashCode() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Extension Methods GeomUtil.ExpandToBox3d(IExpandToBox3d, Mat4d, Box3d) GeomUtil.GetBox3d(IExpandToBox3d) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors box3d(Box3d) Initializes a new instance of the box3d struct from a Box3d object. public box3d(Box3d src) Parameters src Box3d The source Box3d object to convert from. Fields max The maximum point of the box (upper-right-front corner). public vec3d max Field Value vec3d min The minimum point of the box (lower-left-back corner). public vec3d min Field Value vec3d Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box ToString() Returns the fully qualified type name of this instance. public override string ToString() Returns string The fully qualified type name." }, "api/Hi.Native.expand_to_box3d_func_t.html": { "href": "api/Hi.Native.expand_to_box3d_func_t.html", @@ -3012,32 +3107,42 @@ "api/Hi.NcMech.Fixtures.Fixture.html": { "href": "api/Hi.NcMech.Fixtures.Fixture.html", "title": "Class Fixture | HiAPI-C# 2025", - "summary": "Class Fixture Namespace Hi.NcMech.Fixtures Assembly HiMech.dll Represents a fixture used to hold workpieces during machining operations. public class Fixture : IGetSolid, IMakeXmlSource, IDisplayee, IExpandToBox3d, IGetRootAnchor, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable Inheritance object Fixture Implements IGetSolid IMakeXmlSource IDisplayee IExpandToBox3d IGetRootAnchor IDisposable IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) 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) Constructors Fixture() Initializes a new instance of the Fixture class. public Fixture() Fixture(XElement, string, string) Initializes a new instance of the Fixture class from XML. public Fixture(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing fixture data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Fields XName Name for XML IO. public static string XName Field Value string Properties Asmb Gets the assembly that contains the fixture components. public Asmb Asmb { get; } Property Value Asmb CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag Geom Geometry. Delegate by Solid.Geom. public IGetStl Geom { get; set; } Property Value IGetStl Solid Gets the solid representation of the fixture. public Solid Solid { get; } Property Value Solid TableBuckle Table buckle. Root. Solid anchor. public Anchor TableBuckle { get; } Property Value Anchor TableToWorkpieceBranch Gets the branch connecting the table to the workpiece. public Branch TableToWorkpieceBranch { get; } Property Value Branch TableToWorkpieceTransformer Transformer from fixture origin to workpiece origin. public ITransformer TableToWorkpieceTransformer { get; set; } Property Value ITransformer WorkpieceBuckle Gets the workpiece buckle anchor point. public Anchor WorkpieceBuckle { get; } Property Value Anchor Methods ClearGeomCache() Update cache of Geom. The method is used after inner content of Geom is altered. public void ClearGeomCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SetWorkpieceTransformationToTopCenter() Sets the workpiece transformation to position it at the top center of the fixture. public void SetWorkpieceTransformationToTopCenter()" + "summary": "Class Fixture Namespace Hi.NcMech.Fixtures Assembly HiMech.dll Represents a fixture used to hold workpieces during machining operations. public class Fixture : IGetSolid, IMakeXmlSource, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetAsmb, IGetAnchor, IGetTopoIndex, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable Inheritance object Fixture Implements IGetSolid IMakeXmlSource IDisplayee IExpandToBox3d IGetAnchoredDisplayeeList IGetAsmb IGetAnchor IGetTopoIndex IDisposable IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors Fixture() Initializes a new instance of the Fixture class. public Fixture() Fixture(XElement, string, string) Initializes a new instance of the Fixture class from XML. public Fixture(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing fixture data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Fields XName Name for XML IO. public static string XName Field Value string Properties Asmb Gets the assembly that contains the fixture components. public Asmb Asmb { get; } Property Value Asmb CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag Geom Geometry. Delegate by Solid.Geom. public IGetStl Geom { get; set; } Property Value IGetStl GeomAnchor public Anchor GeomAnchor { get; } Property Value Anchor GeomToTableBranch public Branch GeomToTableBranch { get; } Property Value Branch GeomToTableTransformer Transformer from Geometry origin to table (machine tool side) origin. public ITransformer GeomToTableTransformer { get; set; } Property Value ITransformer GeomToWorkpieceBranch public Branch GeomToWorkpieceBranch { get; } Property Value Branch GeomToWorkpieceTransformer Transformer from Geometry origin to workpiece origin. public ITransformer GeomToWorkpieceTransformer { get; set; } Property Value ITransformer Solid Gets the solid representation of the fixture. public Solid Solid { get; } Property Value Solid TableBuckle Table buckle. Root. Solid anchor. public Anchor TableBuckle { get; } Property Value Anchor ThemeColor public static Vec3d ThemeColor { get; } Property Value Vec3d WorkpieceBuckle Gets the workpiece buckle anchor point. public Anchor WorkpieceBuckle { get; } Property Value Anchor Methods ClearGeomCache() Update cache of Geom. The method is used after inner content of Geom is altered. public void ClearGeomCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry 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. SetWorkpieceTransformationToGeomTopCenter() Sets the workpiece transformation to position it at the top center of the fixture. public void SetWorkpieceTransformationToGeomTopCenter()" + }, + "api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html": { + "href": "api/Hi.NcMech.Fixtures.FixtureEditorDisplayee.html", + "title": "Class FixtureEditorDisplayee | HiAPI-C# 2025", + "summary": "Class FixtureEditorDisplayee Namespace Hi.NcMech.Fixtures Assembly HiMech.dll public class FixtureEditorDisplayee : IDisplayee, IExpandToBox3d, IGetAsmb, IGetAnchor, IGetTopoIndex Inheritance object FixtureEditorDisplayee Implements IDisplayee IExpandToBox3d IGetAsmb IGetAnchor IGetTopoIndex Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Properties Config public FixtureEditorDisplayeeConfig Config { get; set; } Property Value FixtureEditorDisplayeeConfig Fixture public Fixture Fixture { get; } Property Value Fixture FixtureGetter public Func FixtureGetter { get; set; } Property Value Func RenderingMode public Solid.RenderingModeEnum RenderingMode { get; set; } Property Value Solid.RenderingModeEnum ShowGeomAnchor public bool ShowGeomAnchor { get; set; } Property Value bool ShowTableBuckle public bool ShowTableBuckle { get; set; } Property Value bool ShowWorkpieceBuckle public bool ShowWorkpieceBuckle { get; set; } Property Value bool Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb." + }, + "api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html": { + "href": "api/Hi.NcMech.Fixtures.FixtureEditorDisplayeeConfig.html", + "title": "Class FixtureEditorDisplayeeConfig | HiAPI-C# 2025", + "summary": "Class FixtureEditorDisplayeeConfig Namespace Hi.NcMech.Fixtures Assembly HiMech.dll Configuration settings for FixtureSetupDisplayee public class FixtureEditorDisplayeeConfig : IMakeXmlSource Inheritance object FixtureEditorDisplayeeConfig Implements IMakeXmlSource 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) Constructors FixtureEditorDisplayeeConfig() public FixtureEditorDisplayeeConfig() FixtureEditorDisplayeeConfig(XElement) Constructor for XML deserialization public FixtureEditorDisplayeeConfig(XElement element) Parameters element XElement Properties RenderingMode public Solid.RenderingModeEnum RenderingMode { get; set; } Property Value Solid.RenderingModeEnum ShowGeomAnchor public bool ShowGeomAnchor { get; set; } Property Value bool ShowTableBuckle public bool ShowTableBuckle { get; set; } Property Value bool ShowWorkpieceBuckle public bool ShowWorkpieceBuckle { get; set; } Property Value bool XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.NcMech.Fixtures.html": { "href": "api/Hi.NcMech.Fixtures.html", "title": "Namespace Hi.NcMech.Fixtures | HiAPI-C# 2025", - "summary": "Namespace Hi.NcMech.Fixtures Classes Fixture Represents a fixture used to hold workpieces during machining operations." + "summary": "Namespace Hi.NcMech.Fixtures Classes Fixture Represents a fixture used to hold workpieces during machining operations. FixtureEditorDisplayee FixtureEditorDisplayeeConfig Configuration settings for FixtureSetupDisplayee" }, "api/Hi.NcMech.Holders.CylindroidHolder.html": { "href": "api/Hi.NcMech.Holders.CylindroidHolder.html", "title": "Class CylindroidHolder | HiAPI-C# 2025", - "summary": "Class CylindroidHolder Namespace Hi.NcMech.Holders Assembly HiMech.dll Represents a cylindrical tool holder for machining operations. public class CylindroidHolder : IHolder, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetBuckleAnchorList, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable Inheritance object CylindroidHolder Implements IHolder ITopoDisplayee IGetAsmb IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IGetAnchoredDisplayeeList IGetBuckleAnchorList IMakeXmlSource IAbstractNote IGetFletchBuckle IDuplicate INameNote IGetSolid IDisposable IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) 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) Constructors CylindroidHolder() Ctor. public CylindroidHolder() CylindroidHolder(Cylindroid) Ctor. public CylindroidHolder(Cylindroid cylindroid) Parameters cylindroid Cylindroid The cylindroid geometry for this holder. CylindroidHolder(XElement, string, string) Initializes a new instance of the CylindroidHolder class from XML. public CylindroidHolder(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing holder data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Fields XName XML Name. public static string XName Field Value string Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Branch Gets the branch connecting the fletch buckle to the tail buckle. public Branch Branch { get; } Property Value Branch CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag Cylindroid Gets or sets the cylindroid geometry that defines this holder. public Cylindroid Cylindroid { get; set; } Property Value Cylindroid GeomAnchor Equivalent of GetTailBuckle(). public Anchor GeomAnchor { get; } Property Value Anchor Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetBuckleAnchorList() Get buckle anchors. public List GetBuckleAnchorList() Returns List buckle anchors GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. GetTailBuckle() Tool Buckle. Generally locate on free-end-side. public Anchor GetTailBuckle() Returns Anchor MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByCylindroid() Update Branch By Cylindroid. Call the function if the Cylindroid content changed. public void UpdateByCylindroid()" + "summary": "Class CylindroidHolder Namespace Hi.NcMech.Holders Assembly HiMech.dll Represents a cylindrical tool holder for machining operations. public class CylindroidHolder : IHolder, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IClearCache Inheritance object CylindroidHolder Implements IHolder ITopo IGetAsmb IGetAnchoredDisplayeeList IAnchoredDisplayee IDisplayee IExpandToBox3d IMakeXmlSource IAbstractNote IGetFletchBuckle IDuplicate INameNote IAnchoredCollidabled IGetCollidable IGetAnchor IGetTopoIndex IGetSolid IDisposable IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) 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) Constructors CylindroidHolder() Ctor. public CylindroidHolder() CylindroidHolder(Cylindroid) Ctor. public CylindroidHolder(Cylindroid cylindroid) Parameters cylindroid Cylindroid The cylindroid geometry for this holder. CylindroidHolder(XElement, string, string) Initializes a new instance of the CylindroidHolder class from XML. public CylindroidHolder(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing holder data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Fields XName XML Name. public static string XName Field Value string Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string Branch Gets the branch connecting the fletch buckle to the tail buckle. public Branch Branch { get; } Property Value Branch CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag CutterBuckle public Anchor CutterBuckle { get; } Property Value Anchor Cylindroid Gets or sets the cylindroid geometry that defines this holder. public Cylindroid Cylindroid { get; set; } Property Value Cylindroid GeomAnchor Equivalent of CutterBuckle. public Anchor GeomAnchor { get; } Property Value Anchor Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string PolarResolution2d public PolarResolution2d PolarResolution2d { get; set; } Property Value PolarResolution2d SpindleBuckle public Anchor SpindleBuckle { get; } Property Value Anchor Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCollidable() Get ICollidable. public ICollidable GetCollidable() Returns ICollidable The collidable object. GetCollidableAnchor() public Anchor GetCollidableAnchor() Returns Anchor GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. GetTailBuckle() Cutter Buckle. Generally locate on free-end-side. public Anchor GetTailBuckle() Returns Anchor 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. UpdateByCylindroid() Update Branch By Cylindroid. Call the function if the Cylindroid content changed. public void UpdateByCylindroid()" }, "api/Hi.NcMech.Holders.FreeformHolder.html": { "href": "api/Hi.NcMech.Holders.FreeformHolder.html", "title": "Class FreeformHolder | HiAPI-C# 2025", - "summary": "Class FreeformHolder Namespace Hi.NcMech.Holders Assembly HiMech.dll Represents a freeform tool holder with customizable geometry. public class FreeformHolder : IHolder, ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetBuckleAnchorList, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable Inheritance object FreeformHolder Implements IHolder ITopoDisplayee IGetAsmb IGetTopoIndex IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IGetAnchoredDisplayeeList IGetBuckleAnchorList IMakeXmlSource IAbstractNote IGetFletchBuckle IDuplicate INameNote IGetSolid IDisposable IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) 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) Constructors FreeformHolder() Ctor. public FreeformHolder() FreeformHolder(IGetStl) Initializes a new instance of the FreeformHolder class from STL geometry. public FreeformHolder(IGetStl rawGeom) Parameters rawGeom IGetStl The STL geometry provider. FreeformHolder(IGetStl, ITransformer) Initializes a new instance of the FreeformHolder class from STL geometry with a transformer. public FreeformHolder(IGetStl rawGeom, ITransformer transformer) Parameters rawGeom IGetStl The STL geometry provider. transformer ITransformer The geometry transformer. FreeformHolder(XElement, string, string) Initializes a new instance of the FreeformHolder class from XML data. public FreeformHolder(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing holder data baseDirectory string Base directory path for resolving relative paths relFile string Relative file path Fields XName XML Name. public static string XName Field Value string Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag GeomAnchor Gets the geometry anchor point public Anchor GeomAnchor { get; } Property Value Anchor GeomToBaseBranch Gets the branch from geometry to base public Branch GeomToBaseBranch { get; } Property Value Branch GeomToBaseTransformer Gets or sets the transformer from geometry to base public ITransformer GeomToBaseTransformer { get; set; } Property Value ITransformer GeomToTailBranch Gets the branch from geometry to tail public Branch GeomToTailBranch { get; } Property Value Branch GeomToTailTransformer Gets or sets the transformer from geometry to tail public ITransformer GeomToTailTransformer { get; set; } Property Value ITransformer GeomTransformer Gets or sets the geometry transformer. public ITransformer GeomTransformer { get; set; } Property Value ITransformer Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string RawGeom Gets or sets the raw geometry public IGetStl RawGeom { get; set; } Property Value IGetStl TransformationGeom Gets the transformation geometry. Internal Use Only. public TransformationGeom TransformationGeom { get; } Property Value TransformationGeom Remarks Call UpdateByRawGeomOrTransformer() to keep state of Hi.NcMech.Holders.FreeformHolder.Solid if content modified. Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetBuckleAnchorList() Get buckle anchors. public List GetBuckleAnchorList() Returns List buckle anchors GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. GetTailBuckle() Tool Buckle. Generally locate on free-end-side. public Anchor GetTailBuckle() Returns Anchor MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByRawGeomOrTransformer() Update Branch By RawGeom. Call the function if the RawGeom content changed. public void UpdateByRawGeomOrTransformer()" + "summary": "Class FreeformHolder Namespace Hi.NcMech.Holders Assembly HiMech.dll Represents a freeform tool holder with customizable geometry. public class FreeformHolder : IHolder, ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IDuplicate, INameNote, IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex, IGetSolid, IDisposable, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IClearCache Inheritance object FreeformHolder Implements IHolder ITopo IGetAsmb IGetAnchoredDisplayeeList IAnchoredDisplayee IDisplayee IExpandToBox3d IMakeXmlSource IAbstractNote IGetFletchBuckle IDuplicate INameNote IAnchoredCollidabled IGetCollidable IGetAnchor IGetTopoIndex IGetSolid IDisposable IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) 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) Constructors FreeformHolder() Ctor. public FreeformHolder() FreeformHolder(IStlSource) Initializes a new instance of the FreeformHolder class from STL geometry. public FreeformHolder(IStlSource geom) Parameters geom IStlSource The STL geometry provider. FreeformHolder(XElement, string, string) Initializes a new instance of the FreeformHolder class from XML data. public FreeformHolder(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing holder data baseDirectory string Base directory path for resolving relative paths relFile string Relative file path Fields XName XML Name. public static string XName Field Value string Properties AbstractNote Gets a descriptive note or abstract about the object. public string AbstractNote { get; } Property Value string CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag CutterBuckle Gets the tail buckle (tool buckle) anchor point public Anchor CutterBuckle { get; } Property Value Anchor Geom Gets the transformation geometry. Internal Use Only. public IStlSource Geom { get; set; } Property Value IStlSource Remarks Call UpdateByGeom() to keep state of Hi.NcMech.Holders.FreeformHolder.Solid if content modified. GeomAnchor Gets the geometry anchor point public Anchor GeomAnchor { get; } Property Value Anchor GeomAnchorToSpindleBuckleBranch Gets the branch from GeomAnchor to SpindleBuckle. public Branch GeomAnchorToSpindleBuckleBranch { get; } Property Value Branch GeomToCutterBranch Gets the branch from GeomAnchor to CutterBuckle. public Branch GeomToCutterBranch { get; } Property Value Branch GeomToCutterTransformer Gets or sets the transformer from geometry to tail (Cutter). public ITransformer GeomToCutterTransformer { get; set; } Property Value ITransformer GeomToSpindleTransformer Gets or sets the transformer from geometry to base (Spindle) public ITransformer GeomToSpindleTransformer { get; set; } Property Value ITransformer Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string PolarResolution2d Gets or sets the polar resolution 2D settings. public PolarResolution2d PolarResolution2d { get; set; } Property Value PolarResolution2d SpindleBuckle Gets the base buckle (spindle buckle) anchor point public Anchor SpindleBuckle { get; } Property Value Anchor Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCollidable() Get ICollidable. public ICollidable GetCollidable() Returns ICollidable The collidable object. GetCollidableAnchor() public Anchor GetCollidableAnchor() Returns Anchor GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetFletchBuckle() Get fletch buckle anchor. the anchor that generally connect to fixed part such as ground and triggering(motor)-side. public Anchor GetFletchBuckle() Returns Anchor buckle anchor GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. GetTailBuckle() Cutter Buckle. Generally locate on free-end-side. public Anchor GetTailBuckle() Returns Anchor 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. UpdateByGeom() Call the function if the Geom content changed. public void UpdateByGeom()" }, "api/Hi.NcMech.Holders.HolderEditorDisplayee.html": { "href": "api/Hi.NcMech.Holders.HolderEditorDisplayee.html", "title": "Class HolderEditorDisplayee | HiAPI-C# 2025", - "summary": "Class HolderEditorDisplayee Namespace Hi.NcMech.Holders Assembly HiMech.dll Displayee for holder editor that provides visualization functionality public class HolderEditorDisplayee : IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d Inheritance object HolderEditorDisplayee Implements IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d 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) Constructors HolderEditorDisplayee() Initializes a new instance of the HolderEditorDisplayee class public HolderEditorDisplayee() HolderEditorDisplayee(IHolder) Initializes a new instance of the HolderEditorDisplayee class with a specified holder public HolderEditorDisplayee(IHolder holder) Parameters holder IHolder The holder to display Properties Holder Gets or sets the holder to be displayed public IHolder Holder { get; set; } Property Value IHolder Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor." + "summary": "Class HolderEditorDisplayee Namespace Hi.NcMech.Holders Assembly HiMech.dll Displayee for holder editor that provides visualization functionality public class HolderEditorDisplayee : IAnchoredDisplayee, IGetAnchor, IDisplayee, IExpandToBox3d, IGetAsmb, IGetTopoIndex Inheritance object HolderEditorDisplayee Implements IAnchoredDisplayee IGetAnchor IDisplayee IExpandToBox3d IGetAsmb IGetTopoIndex Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors HolderEditorDisplayee() Initializes a new instance of the HolderEditorDisplayee class public HolderEditorDisplayee() HolderEditorDisplayee(IHolder) Initializes a new instance of the HolderEditorDisplayee class with a specified holder public HolderEditorDisplayee(IHolder holder) Parameters holder IHolder The holder to display Properties Holder Gets or sets the holder to be displayed public IHolder Holder { get; set; } Property Value IHolder RenderingMode public Solid.RenderingModeEnum RenderingMode { get; set; } Property Value Solid.RenderingModeEnum ShowCutterBuckle public bool ShowCutterBuckle { get; set; } Property Value bool ShowGeomAnchor public bool ShowGeomAnchor { get; set; } Property Value bool ShowSpindleBuckle public bool ShowSpindleBuckle { get; set; } Property Value bool Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb." }, "api/Hi.NcMech.Holders.IHolder.html": { "href": "api/Hi.NcMech.Holders.IHolder.html", "title": "Interface IHolder | HiAPI-C# 2025", - "summary": "Interface IHolder Namespace Hi.NcMech.Holders Assembly HiMech.dll Interface for tool holders in NC machining. public interface IHolder : ITopoDisplayee, IGetAsmb, IGetTopoIndex, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IGetAnchoredDisplayeeList, IGetBuckleAnchorList, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IAnchoredCollidableBased, IDuplicate, INameNote Inherited Members IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IGetBuckleAnchorList.GetBuckleAnchorList() IMakeXmlSource.MakeXmlSource(string, string) IAbstractNote.AbstractNote IGetFletchBuckle.GetFletchBuckle() IAnchoredCollidableBased.CollidableName IAnchoredCollidableBased.GetAnchoredCollidableNode() IDuplicate.Duplicate(params object[]) INameNote.Name INameNote.Note Extension Methods TopoDisplayeeUtil.Display(ITopoDisplayee, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopoDisplayee, Box3d) 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) Methods GetTailBuckle() Tool Buckle. Generally locate on free-end-side. Anchor GetTailBuckle() Returns Anchor" + "summary": "Interface IHolder Namespace Hi.NcMech.Holders Assembly HiMech.dll Interface for tool holders in NC machining. public interface IHolder : ITopo, IGetAsmb, IGetAnchoredDisplayeeList, IAnchoredDisplayee, IDisplayee, IExpandToBox3d, IMakeXmlSource, IAbstractNote, IGetFletchBuckle, IAnchoredCollidableBased, IDuplicate, INameNote, IAnchoredCollidabled, IGetCollidable, IGetAnchor, IGetTopoIndex, IGetSolid Inherited Members IGetAsmb.GetAsmb() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IMakeXmlSource.MakeXmlSource(string, string, bool) IAbstractNote.AbstractNote IGetFletchBuckle.GetFletchBuckle() IAnchoredCollidableBased.CollidableName IAnchoredCollidableBased.GetAnchoredCollidableNode() IDuplicate.Duplicate(params object[]) INameNote.Name INameNote.Note IAnchoredCollidabled.GetCollidableAnchor() IGetCollidable.GetCollidable() IGetAnchor.GetAnchor() IGetSolid.GetSolid() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) TopoDisplayeeUtil.Display(ITopo, Bind) TopoDisplayeeUtil.ExpandToBox3d(ITopo, Box3d) 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) Properties CutterBuckle Anchor CutterBuckle { get; } Property Value Anchor GeomAnchor Anchor GeomAnchor { get; } Property Value Anchor SpindleBuckle Anchor SpindleBuckle { get; } Property Value Anchor ThemeColor public static Vec3d ThemeColor { get; } Property Value Vec3d Methods GetTailBuckle() Cutter Buckle. Generally locate on free-end-side. Anchor GetTailBuckle() Returns Anchor" }, "api/Hi.NcMech.Holders.html": { "href": "api/Hi.NcMech.Holders.html", @@ -3047,27 +3152,22 @@ "api/Hi.NcMech.ICollisionIndexPairsSource.html": { "href": "api/Hi.NcMech.ICollisionIndexPairsSource.html", "title": "Interface ICollisionIndexPairsSource | HiAPI-C# 2025", - "summary": "Interface ICollisionIndexPairsSource Namespace Hi.NcMech Assembly HiMech.dll Interface that provides access to collision index pairs and XML serialization capabilities. Extends IGetCollisionIndexPairs with XML serialization support. public interface ICollisionIndexPairsSource : IGetCollisionIndexPairs, IMakeXmlSource Inherited Members IGetCollisionIndexPairs.GetCollisionIndexPairs() IMakeXmlSource.MakeXmlSource(string, string) 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)" - }, - "api/Hi.NcMech.IGetSolidMachiningChain.html": { - "href": "api/Hi.NcMech.IGetSolidMachiningChain.html", - "title": "Interface IGetSolidMachiningChain | HiAPI-C# 2025", - "summary": "Interface IGetSolidMachiningChain Namespace Hi.NcMech Assembly HiMech.dll Interface of get ISolidMachiningChain. public interface IGetSolidMachiningChain 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) Methods GetSolidMachiningChain() Get ISolidMachiningChain. ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain ISolidMachiningChain" - }, - "api/Hi.NcMech.ISolidMachiningChain.html": { - "href": "api/Hi.NcMech.ISolidMachiningChain.html", - "title": "Interface ISolidMachiningChain | HiAPI-C# 2025", - "summary": "Interface ISolidMachiningChain Namespace Hi.NcMech Assembly HiMech.dll Interface for a machining chain that provides access to solid geometry. Extends IMachiningChain with solid geometry capabilities. public interface ISolidMachiningChain : IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary Inherited Members IMachiningChain.GetTableBuckle() IMachiningChain.GetToolBuckle() IMachiningChain.McCodes IMachiningChain.McTransformers IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IGetSolidMachiningChain.GetSolidMachiningChain() IMakeXmlSource.MakeXmlSource(string, string) IGetAnchorToSolidDictionary.GetAnchorToSolidDictionary() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) 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)" + "summary": "Interface ICollisionIndexPairsSource Namespace Hi.NcMech Assembly HiMech.dll Interface that provides access to collision index pairs and XML serialization capabilities. Extends IGetCollisionIndexPairs with XML serialization support. public interface ICollisionIndexPairsSource : IGetCollisionIndexPairs, IMakeXmlSource Inherited Members IGetCollisionIndexPairs.GetCollisionIndexPairs() IMakeXmlSource.MakeXmlSource(string, string, bool) 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)" }, "api/Hi.NcMech.Solids.IGetSolid.html": { "href": "api/Hi.NcMech.Solids.IGetSolid.html", "title": "Interface IGetSolid | HiAPI-C# 2025", "summary": "Interface IGetSolid Namespace Hi.NcMech.Solids Assembly HiMech.dll Interface for retrieving solid geometry objects. Provides a standardized way to access solid models. public interface IGetSolid 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) Methods GetSolid() Gets the solid geometry object. Solid GetSolid() Returns Solid The solid geometry object." }, + "api/Hi.NcMech.Solids.Solid.RenderingModeEnum.html": { + "href": "api/Hi.NcMech.Solids.Solid.RenderingModeEnum.html", + "title": "Enum Solid.RenderingModeEnum | HiAPI-C# 2025", + "summary": "Enum Solid.RenderingModeEnum Namespace Hi.NcMech.Solids Assembly HiMech.dll public enum Solid.RenderingModeEnum Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields Edge = 1 Hide = 2 Solid = 0" + }, "api/Hi.NcMech.Solids.Solid.html": { "href": "api/Hi.NcMech.Solids.Solid.html", "title": "Class Solid | HiAPI-C# 2025", - "summary": "Class Solid Namespace Hi.NcMech.Solids Assembly HiMech.dll Represents a solid geometry object with display, collision detection, and STL capabilities. Provides thread-safe access to geometry data and caching mechanisms. public class Solid : IGetTriTree, ICollidable, IGetCollidable, IDisplayee, IExpandToBox3d, IDisposable, IGetSolid, IUpdateByContent, IClearCache, IStlSource, IGetStl, IMakeXmlSource Inheritance object Solid Implements IGetTriTree ICollidable IGetCollidable IDisplayee IExpandToBox3d IDisposable IGetSolid IUpdateByContent IClearCache IStlSource IGetStl IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors Solid() Initializes a new instance of the Solid class. public Solid() Solid(IGetStl) Initializes a new instance of the Solid class with the specified STL geometry source. public Solid(IGetStl geom) Parameters geom IGetStl The STL geometry source. Solid(XElement, string) Initializes a new instance of the Solid class from XML. public Solid(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties CollisionFlag Gets or sets the collision flag indicating the collision state of this solid. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag Geom Gets or sets the STL geometry source. Setting this property will clear the cached data. public IGetStl Geom { get; set; } Property Value IGetStl NativeSmoothTopoStl Gets the native smooth topology STL representation. The data is created from the STL representation when first accessed. public NativeTopoStld NativeSmoothTopoStl { get; } Property Value NativeTopoStld NativeStl Gets the native STL representation. The data is created from the STL representation when first accessed. public NativeStl NativeStl { get; } Property Value NativeStl Prepared Gets or sets whether the solid geometry is prepared for use. Setting this to true will ensure all necessary data structures are initialized. Setting this to false will clear the cached data. public bool Prepared { get; set; } Property Value bool Stl Gets the STL representation of the solid geometry. The STL data is cached after first access. public Stl Stl { get; } Property Value Stl TriTree Gets the triangle tree representation for collision detection. The tree is built from the native STL data when first accessed. public TriTree TriTree { get; } Property Value TriTree Methods ClearCache() Manually clears the cached data if the content of Geom has changed. The cache determines the behavior of the Solid. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetCollidable() Get ICollidable. public ICollidable GetCollidable() Returns ICollidable The collidable object. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. GetSourceGeom() Gets the source geometry object. public IGetStl GetSourceGeom() Returns IGetStl The source geometry object. GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetTriTree() Get TriTree. public TriTree GetTriTree() Returns TriTree TriTree MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + "summary": "Class Solid Namespace Hi.NcMech.Solids Assembly HiMech.dll Represents a solid geometry object with display, collision detection, and STL capabilities. Provides thread-safe access to geometry data and caching mechanisms. public class Solid : IGetTriTree, ICollidable, IGetCollidable, IDisplayee, IExpandToBox3d, IStlSource, IGetStl, IPolarResolution2dSourceProperty, IDisposable, IMakeXmlSource, IGetSolid, IUpdateByContent, IClearCache Inheritance object Solid Implements IGetTriTree ICollidable IGetCollidable IDisplayee IExpandToBox3d IStlSource IGetStl IPolarResolution2dSourceProperty IDisposable IMakeXmlSource IGetSolid IUpdateByContent IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) StlUtil.ToFaceDrawing(IGetStl) StlUtil.ToLineDrawing(IGetStl) 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) Constructors Solid() Initializes a new instance of the Solid class. public Solid() Solid(IGetStl) Initializes a new instance of the Solid class with the specified STL geometry source. public Solid(IGetStl geom) Parameters geom IGetStl The STL geometry source. Solid(XElement, string) Initializes a new instance of the Solid class from XML. public Solid(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties CollisionFlag Gets or sets the collision flag indicating the collision state of this solid. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag Geom Gets or sets the STL geometry source. Setting this property will clear the cached data. public IGetStl Geom { get; set; } Property Value IGetStl NativeSmoothTopoStl Gets the native smooth topology STL representation. The data is created from the STL representation when first accessed. public NativeTopoStld NativeSmoothTopoStl { get; } Property Value NativeTopoStld NativeStl Gets the native STL representation. The data is created from the STL representation when first accessed. public NativeStl NativeStl { get; } Property Value NativeStl PolarResolution2dSource public Func PolarResolution2dSource { get; set; } Property Value Func Prepared Gets or sets whether the solid geometry is prepared for use. Setting this to true will ensure all necessary data structures are initialized. Setting this to false will clear the cached data. public bool Prepared { get; set; } Property Value bool Stl Gets the STL representation of the solid geometry. The STL data is cached after first access. public Stl Stl { get; } Property Value Stl TriTree Gets the triangle tree representation for collision detection. The tree is built from the native STL data when first accessed. public TriTree TriTree { get; } Property Value TriTree Methods ClearCache() Manually clears the cached data if the content of Geom has changed. The cache determines the behavior of the Solid. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Display(Bind, RenderingModeEnum) public void Display(Bind bind, Solid.RenderingModeEnum renderingMode) Parameters bind Bind renderingMode Solid.RenderingModeEnum DisplayFeatureEdges(Bind) public void DisplayFeatureEdges(Bind bind) Parameters bind Bind Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetCollidable() Get ICollidable. public ICollidable GetCollidable() Returns ICollidable The collidable object. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. GetSourceGeom() Gets the source geometry object. public IGetStl GetSourceGeom() Returns IGetStl The source geometry object. GetStl() Gets the STL geometry data. public Stl GetStl() Returns Stl The STL geometry object GetTriTree() Get TriTree. public TriTree GetTriTree() Returns TriTree TriTree 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. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" }, "api/Hi.NcMech.Solids.SolidFuncSource.html": { "href": "api/Hi.NcMech.Solids.SolidFuncSource.html", @@ -3077,7 +3177,7 @@ "api/Hi.NcMech.Solids.html": { "href": "api/Hi.NcMech.Solids.html", "title": "Namespace Hi.NcMech.Solids | HiAPI-C# 2025", - "summary": "Namespace Hi.NcMech.Solids Classes Solid Represents a solid geometry object with display, collision detection, and STL capabilities. Provides thread-safe access to geometry data and caching mechanisms. SolidFuncSource Provides a function-based source for solid geometry objects. Allows dynamic generation of solid models through a delegate function. Interfaces IGetSolid Interface for retrieving solid geometry objects. Provides a standardized way to access solid models." + "summary": "Namespace Hi.NcMech.Solids Classes Solid Represents a solid geometry object with display, collision detection, and STL capabilities. Provides thread-safe access to geometry data and caching mechanisms. SolidFuncSource Provides a function-based source for solid geometry objects. Allows dynamic generation of solid models through a delegate function. Interfaces IGetSolid Interface for retrieving solid geometry objects. Provides a standardized way to access solid models. Enums Solid.RenderingModeEnum" }, "api/Hi.NcMech.Topo.INcStroke.html": { "href": "api/Hi.NcMech.Topo.INcStroke.html", @@ -3087,32 +3187,32 @@ "api/Hi.NcMech.Topo.INcTransformer.html": { "href": "api/Hi.NcMech.Topo.INcTransformer.html", "title": "Interface INcTransformer | HiAPI-C# 2025", - "summary": "Interface INcTransformer Namespace Hi.NcMech.Topo Assembly HiMech.dll Transformer for NC motion axis. public interface INcTransformer : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke Inherited Members IDynamicRegular.Step ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string) INcStroke.GetKeyCode() INcStroke.GetStrokeMin() INcStroke.GetStrokeMax() INcStroke.GetSpeedLimit() 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)" + "summary": "Interface INcTransformer Namespace Hi.NcMech.Topo Assembly HiMech.dll Transformer for NC motion axis. public interface INcTransformer : IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke Inherited Members IDynamicRegular.Step ITransformer.GetMat() ITransformer.GetMatInv() ITransformer.Clone() IMakeXmlSource.MakeXmlSource(string, string, bool) INcStroke.GetKeyCode() INcStroke.GetStrokeMin() INcStroke.GetStrokeMax() INcStroke.GetSpeedLimit() 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)" }, "api/Hi.NcMech.Topo.ITopoBrick.html": { "href": "api/Hi.NcMech.Topo.ITopoBrick.html", "title": "Interface ITopoBrick | HiAPI-C# 2025", - "summary": "Interface ITopoBrick Namespace Hi.NcMech.Topo Assembly HiMech.dll Interface that represents a topological brick in NC machining. Combines solid geometry, display capabilities, and collision detection functionality. public interface ITopoBrick : IGetSolid, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable Inherited Members IGetSolid.GetSolid() IGetRootAnchor.GetRootAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IAnchoredCollidableLeaf.GetCollidableAnchor() IAnchoredCollidableBased.CollidableName IAnchoredCollidableBased.GetAnchoredCollidableNode() ICollidable.CollisionFlag ICollidable.GetCollidee() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) 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)" + "summary": "Interface ITopoBrick Namespace Hi.NcMech.Topo Assembly HiMech.dll Interface that represents a topological brick in NC machining. Combines solid geometry, display capabilities, and collision detection functionality. public interface ITopoBrick : IGetSolid, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable Inherited Members IGetSolid.GetSolid() IGetAnchor.GetAnchor() IDisplayee.Display(Bind) IExpandToBox3d.ExpandToBox3d(Box3d) IAnchoredCollidableLeaf.GetCollidableAnchor() IAnchoredCollidableBased.CollidableName IAnchoredCollidableBased.GetAnchoredCollidableNode() ICollidable.CollisionFlag ICollidable.GetCollidee() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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)" }, "api/Hi.NcMech.Topo.NcRotation.html": { "href": "api/Hi.NcMech.Topo.NcRotation.html", "title": "Class NcRotation | HiAPI-C# 2025", - "summary": "Class NcRotation Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a rotational transformer for NC machine tool axes. Provides functionality for rotational motion with stroke and speed limits. public class NcRotation : DynamicRotation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke Inheritance object DynamicRotation NcRotation Implements IGetInverseTransformer INcTransformer IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource INcStroke Inherited Members DynamicRotation.Set(DynamicRotation) DynamicRotation.Step DynamicRotation.GetMat() DynamicRotation.GetMatInv() DynamicRotation.GetInverseTransformer() DynamicRotation.Axis DynamicRotation.Angle_rad DynamicRotation.Angle_deg DynamicRotation.Pivot 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) Constructors NcRotation() Initializes a new instance of the NcRotation class. public NcRotation() NcRotation(Vec3d, double) Initializes a new instance of the NcRotation class with the specified axis and angle. public NcRotation(Vec3d axis, double angle_rad = 0) Parameters axis Vec3d The rotation axis vector. angle_rad double The rotation angle in radians. NcRotation(Vec3d, double, Vec3d) Initializes a new instance of the NcRotation class with the specified axis, angle and pivot point. public NcRotation(Vec3d axis, double angle_rad, Vec3d pivot) Parameters axis Vec3d The rotation axis vector. angle_rad double The rotation angle in radians. pivot Vec3d The pivot point for rotation. NcRotation(XElement) Initializes a new instance of the NcRotation class from XML. public NcRotation(XElement src) Parameters src XElement The XML source element. Properties KeyCode Gets or sets the key code of the motion axis. public string KeyCode { get; set; } Property Value string SpeedLimit_radds Gets or sets the speed limit in radians per second. public double SpeedLimit_radds { get; set; } Property Value double SpeedLimit_rpm Gets or sets the speed limit in revolutions per minute. public double SpeedLimit_rpm { get; set; } Property Value double StrokeMax_deg Gets or sets the maximum stroke angle in degrees. public double StrokeMax_deg { get; set; } Property Value double StrokeMax_rad Gets or sets the maximum stroke angle in radians. public double StrokeMax_rad { get; set; } Property Value double StrokeMin_deg Gets or sets the minimum stroke angle in degrees. public double StrokeMin_deg { get; set; } Property Value double StrokeMin_rad Gets or sets the minimum stroke angle in radians. public double StrokeMin_rad { get; set; } Property Value double XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public override ITransformer Clone() Returns ITransformer clone GetKeyCode() Get key code of the motion axis. public string GetKeyCode() Returns string GetSpeedLimit() Get speed limit. public double GetSpeedLimit() Returns double Remarks Gets the speed limit in radians per second. GetStrokeMax() Get positivest stroke. public double GetStrokeMax() Returns double Remarks Gets the maximum stroke angle in radians. GetStrokeMin() Get negativest stroke. public double GetStrokeMin() Returns double Remarks Gets the minimum stroke angle in radians. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public override XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class NcRotation Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a rotational transformer for NC machine tool axes. Provides functionality for rotational motion with stroke and speed limits. public class NcRotation : DynamicRotation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke Inheritance object DynamicRotation NcRotation Implements IGetInverseTransformer INcTransformer IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource INcStroke Inherited Members DynamicRotation.Set(DynamicRotation) DynamicRotation.Step DynamicRotation.GetMat() DynamicRotation.GetMatInv() DynamicRotation.GetInverseTransformer() DynamicRotation.Axis DynamicRotation.Angle_rad DynamicRotation.Angle_deg DynamicRotation.Pivot 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) Constructors NcRotation() Initializes a new instance of the NcRotation class. public NcRotation() NcRotation(Vec3d, double) Initializes a new instance of the NcRotation class with the specified axis and angle. public NcRotation(Vec3d axis, double angle_rad = 0) Parameters axis Vec3d The rotation axis vector. angle_rad double The rotation angle in radians. NcRotation(Vec3d, double, Vec3d) Initializes a new instance of the NcRotation class with the specified axis, angle and pivot point. public NcRotation(Vec3d axis, double angle_rad, Vec3d pivot) Parameters axis Vec3d The rotation axis vector. angle_rad double The rotation angle in radians. pivot Vec3d The pivot point for rotation. NcRotation(XElement) Initializes a new instance of the NcRotation class from XML. public NcRotation(XElement src) Parameters src XElement The XML source element. Properties KeyCode Gets or sets the key code of the motion axis. public string KeyCode { get; set; } Property Value string SpeedLimit_radds Gets or sets the speed limit in radians per second. public double SpeedLimit_radds { get; set; } Property Value double SpeedLimit_rpm Gets or sets the speed limit in revolutions per minute. public double SpeedLimit_rpm { get; set; } Property Value double StrokeMax_deg Gets or sets the maximum stroke angle in degrees. public double StrokeMax_deg { get; set; } Property Value double StrokeMax_rad Gets or sets the maximum stroke angle in radians. public double StrokeMax_rad { get; set; } Property Value double StrokeMin_deg Gets or sets the minimum stroke angle in degrees. public double StrokeMin_deg { get; set; } Property Value double StrokeMin_rad Gets or sets the minimum stroke angle in radians. public double StrokeMin_rad { get; set; } Property Value double XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public override ITransformer Clone() Returns ITransformer clone GetKeyCode() Get key code of the motion axis. public string GetKeyCode() Returns string GetSpeedLimit() Get speed limit. public double GetSpeedLimit() Returns double Remarks Gets the speed limit in radians per second. GetStrokeMax() Get positivest stroke. public double GetStrokeMax() Returns double Remarks Gets the maximum stroke angle in radians. GetStrokeMin() Get negativest stroke. public double GetStrokeMin() Returns double Remarks Gets the minimum stroke angle in radians. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public override 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." }, "api/Hi.NcMech.Topo.NcTranslation.html": { "href": "api/Hi.NcMech.Topo.NcTranslation.html", "title": "Class NcTranslation | HiAPI-C# 2025", - "summary": "Class NcTranslation Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a translational transformer for NC machine tool axes. Provides functionality for linear motion with stroke and speed limits. public class NcTranslation : DynamicTranslation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke Inheritance object DynamicTranslation NcTranslation Implements IGetInverseTransformer INcTransformer IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource INcStroke Inherited Members DynamicTranslation.Set(DynamicTranslation) DynamicTranslation.Step DynamicTranslation.GetMat() DynamicTranslation.GetMatInv() DynamicTranslation.GetInverseTransformer() DynamicTranslation.Axis DynamicTranslation.Len 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) Constructors NcTranslation() Initializes a new instance of the NcTranslation class. public NcTranslation() NcTranslation(Vec3d, double) Initializes a new instance of the NcTranslation class with the specified translation vector and length. public NcTranslation(Vec3d trans, double len = 0) Parameters trans Vec3d The translation vector. len double The translation length. NcTranslation(XElement) Initializes a new instance of the NcTranslation class from XML. public NcTranslation(XElement src) Parameters src XElement The XML source element. Properties KeyCode Gets or sets the key code of the motion axis. public string KeyCode { get; set; } Property Value string SpeedLimit_mmdmin Gets or sets the speed limit in millimeters per minute. public double SpeedLimit_mmdmin { get; set; } Property Value double SpeedLimit_mmds Gets or sets the speed limit in millimeters per second. public double SpeedLimit_mmds { get; set; } Property Value double StrokeMax_mm Gets or sets the maximum stroke distance in millimeters. public double StrokeMax_mm { get; set; } Property Value double StrokeMin_mm Gets or sets the minimum stroke distance in millimeters. public double StrokeMin_mm { get; set; } Property Value double XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public override ITransformer Clone() Returns ITransformer clone GetKeyCode() Get key code of the motion axis. public string GetKeyCode() Returns string GetSpeedLimit() Get speed limit. public double GetSpeedLimit() Returns double Remarks Gets the speed limit in millimeters per second. GetStrokeMax() Get positivest stroke. public double GetStrokeMax() Returns double Remarks Gets the maximum stroke distance in millimeters. GetStrokeMin() Get negativest stroke. public double GetStrokeMin() Returns double Remarks Gets the minimum stroke distance in millimeters. MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public override XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class NcTranslation Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a translational transformer for NC machine tool axes. Provides functionality for linear motion with stroke and speed limits. public class NcTranslation : DynamicTranslation, IGetInverseTransformer, INcTransformer, IDynamicRegular, IDynamicTransformer, ITransformer, IMakeXmlSource, INcStroke Inheritance object DynamicTranslation NcTranslation Implements IGetInverseTransformer INcTransformer IDynamicRegular IDynamicTransformer ITransformer IMakeXmlSource INcStroke Inherited Members DynamicTranslation.Set(DynamicTranslation) DynamicTranslation.Step DynamicTranslation.GetMat() DynamicTranslation.GetMatInv() DynamicTranslation.GetInverseTransformer() DynamicTranslation.Axis DynamicTranslation.Len 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) Constructors NcTranslation() Initializes a new instance of the NcTranslation class. public NcTranslation() NcTranslation(Vec3d, double) Initializes a new instance of the NcTranslation class with the specified translation vector and length. public NcTranslation(Vec3d trans, double len = 0) Parameters trans Vec3d The translation vector. len double The translation length. NcTranslation(XElement) Initializes a new instance of the NcTranslation class from XML. public NcTranslation(XElement src) Parameters src XElement The XML source element. Properties KeyCode Gets or sets the key code of the motion axis. public string KeyCode { get; set; } Property Value string SpeedLimit_mmdmin Gets or sets the speed limit in millimeters per minute. public double SpeedLimit_mmdmin { get; set; } Property Value double SpeedLimit_mmds Gets or sets the speed limit in millimeters per second. public double SpeedLimit_mmds { get; set; } Property Value double StrokeMax_mm Gets or sets the maximum stroke distance in millimeters. public double StrokeMax_mm { get; set; } Property Value double StrokeMin_mm Gets or sets the minimum stroke distance in millimeters. public double StrokeMin_mm { get; set; } Property Value double XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods Clone() Clones this instance. public override ITransformer Clone() Returns ITransformer clone GetKeyCode() Get key code of the motion axis. public string GetKeyCode() Returns string GetSpeedLimit() Get speed limit. public double GetSpeedLimit() Returns double Remarks Gets the speed limit in millimeters per second. GetStrokeMax() Get positivest stroke. public double GetStrokeMax() Returns double Remarks Gets the maximum stroke distance in millimeters. GetStrokeMin() Get negativest stroke. public double GetStrokeMin() Returns double Remarks Gets the minimum stroke distance in millimeters. MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public override 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." }, "api/Hi.NcMech.Topo.SolidSourceTopoBrick.html": { "href": "api/Hi.NcMech.Topo.SolidSourceTopoBrick.html", "title": "Class SolidSourceTopoBrick | HiAPI-C# 2025", - "summary": "Class SolidSourceTopoBrick Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a topological brick that sources its geometry from a solid model. Implements display, collision detection, and content update capabilities. public class SolidSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IUpdateByContent, IClearCache Inheritance object SolidSourceTopoBrick Implements ITopoBrick IGetSolid IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IUpdateByContent IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) 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) Constructors SolidSourceTopoBrick() Initializes a new instance of the SolidSourceTopoBrick class. public SolidSourceTopoBrick() SolidSourceTopoBrick(Anchor) Initializes a new instance of the SolidSourceTopoBrick class with the specified anchor. public SolidSourceTopoBrick(Anchor anchor) Parameters anchor Anchor The anchor point for this brick. SolidSourceTopoBrick(Anchor, IGetSolid) Initializes a new instance of the SolidSourceTopoBrick class with the specified anchor and solid source. public SolidSourceTopoBrick(Anchor anchor, IGetSolid solidSource) Parameters anchor Anchor The anchor point for this brick. solidSource IGetSolid The solid geometry source. Properties Anchor Gets the anchor point for this brick. public Anchor Anchor { get; } Property Value Anchor CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag SolidSource Gets the solid geometry source. public IGetSolid SolidSource { get; } Property Value IGetSolid Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + "summary": "Class SolidSourceTopoBrick Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a topological brick that sources its geometry from a solid model. Implements display, collision detection, and content update capabilities. public class SolidSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IUpdateByContent, IClearCache Inheritance object SolidSourceTopoBrick Implements ITopoBrick IGetSolid IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IUpdateByContent IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors SolidSourceTopoBrick() Initializes a new instance of the SolidSourceTopoBrick class. public SolidSourceTopoBrick() SolidSourceTopoBrick(Anchor) Initializes a new instance of the SolidSourceTopoBrick class with the specified anchor. public SolidSourceTopoBrick(Anchor anchor) Parameters anchor Anchor The anchor point for this brick. SolidSourceTopoBrick(Anchor, IGetSolid) Initializes a new instance of the SolidSourceTopoBrick class with the specified anchor and solid source. public SolidSourceTopoBrick(Anchor anchor, IGetSolid solidSource) Parameters anchor Anchor The anchor point for this brick. solidSource IGetSolid The solid geometry source. Properties Anchor Gets the anchor point for this brick. public Anchor Anchor { get; } Property Value Anchor CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag SolidSource Gets the solid geometry source. public IGetSolid SolidSource { get; } Property Value IGetSolid Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" }, "api/Hi.NcMech.Topo.StlSourceTopoBrick.html": { "href": "api/Hi.NcMech.Topo.StlSourceTopoBrick.html", "title": "Class StlSourceTopoBrick | HiAPI-C# 2025", - "summary": "Class StlSourceTopoBrick Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a topological brick that sources its geometry from an STL file. Implements display, collision detection, and content update capabilities. public class StlSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetRootAnchor, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IDisposable, IUpdateByContent, IClearCache Inheritance object StlSourceTopoBrick Implements ITopoBrick IGetSolid IAnchoredDisplayee IGetRootAnchor IDisplayee IExpandToBox3d IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IDisposable IUpdateByContent IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) 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) Constructors StlSourceTopoBrick() Initializes a new instance of the StlSourceTopoBrick class. public StlSourceTopoBrick() StlSourceTopoBrick(Anchor) Initializes a new instance of the StlSourceTopoBrick class with the specified anchor. public StlSourceTopoBrick(Anchor anchor) Parameters anchor Anchor The anchor point for this brick. StlSourceTopoBrick(Anchor, IGetStl) Initializes a new instance of the StlSourceTopoBrick class with the specified anchor and geometry. public StlSourceTopoBrick(Anchor anchor, IGetStl geom) Parameters anchor Anchor The anchor point for this brick. geom IGetStl The STL geometry source. Properties Anchor Gets the anchor point for this brick. public Anchor Anchor { get; } Property Value Anchor CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag Geom Gets or sets the STL geometry source. public IGetStl Geom { get; set; } Property Value IGetStl Solid Gets the solid geometry instance. public Solid Solid { get; } Property Value Solid Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" + "summary": "Class StlSourceTopoBrick Namespace Hi.NcMech.Topo Assembly HiMech.dll Represents a topological brick that sources its geometry from an STL file. Implements display, collision detection, and content update capabilities. public class StlSourceTopoBrick : ITopoBrick, IGetSolid, IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IDisposable, IUpdateByContent, IClearCache Inheritance object StlSourceTopoBrick Implements ITopoBrick IGetSolid IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IDisposable IUpdateByContent IClearCache Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors StlSourceTopoBrick() Initializes a new instance of the StlSourceTopoBrick class. public StlSourceTopoBrick() StlSourceTopoBrick(Anchor) Initializes a new instance of the StlSourceTopoBrick class with the specified anchor. public StlSourceTopoBrick(Anchor anchor) Parameters anchor Anchor The anchor point for this brick. StlSourceTopoBrick(Anchor, IGetStl) Initializes a new instance of the StlSourceTopoBrick class with the specified anchor and geometry. public StlSourceTopoBrick(Anchor anchor, IGetStl geom) Parameters anchor Anchor The anchor point for this brick. geom IGetStl The STL geometry source. Properties Anchor Gets the anchor point for this brick. public Anchor Anchor { get; } Property Value Anchor CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag Geom Gets or sets the STL geometry source. public IGetStl Geom { get; set; } Property Value IGetStl Solid Gets the solid geometry instance. public Solid Solid { get; } Property Value Solid Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() Dispose(bool) Releases the unmanaged resources and optionally releases the managed resources. protected virtual void Dispose(bool disposing) Parameters disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetSolid() Gets the solid geometry object. public Solid GetSolid() Returns Solid The solid geometry object. UpdateByContent() Updates the object based on its current content. public void UpdateByContent()" }, "api/Hi.NcMech.Topo.html": { "href": "api/Hi.NcMech.Topo.html", @@ -3122,27 +3222,37 @@ "api/Hi.NcMech.Workpieces.Workpiece.html": { "href": "api/Hi.NcMech.Workpieces.Workpiece.html", "title": "Class Workpiece | HiAPI-C# 2025", - "summary": "Class Workpiece Namespace Hi.NcMech.Workpieces Assembly HiMech.dll Workpiece. public class Workpiece : IDisplayee, IExpandToBox3d, IDisposable, IGetRootAnchor, IGetAnchoredDisplayeeList, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IGetCuttingPara, IMakeXmlSource Inheritance object Workpiece Implements IDisplayee IExpandToBox3d IDisposable IGetRootAnchor IGetAnchoredDisplayeeList IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IGetCuttingPara IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) 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) Constructors Workpiece() Initializes a new instance of the Workpiece class. public Workpiece() Workpiece(XElement, string, string) Initializes a new instance of the Workpiece class. public Workpiece(XElement src, string baseDirectory, string relFile) Parameters src XElement XML element source. baseDirectory string Base directory. relFile string Relative file path. Properties Asmb Asmb. public Asmb Asmb { get; } Property Value Asmb BottomResolution Resolution. public double BottomResolution { get; } Property Value double CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag DiffRangeColorRule Internal used. public RangeColorRule DiffRangeColorRule { get; set; } Property Value RangeColorRule DiffVisualRadius_mm Visual radius for difference visualization. public double DiffVisualRadius_mm { get; set; } Property Value double FixtureBuckle Buckle anchor. public Anchor FixtureBuckle { get; } Property Value Anchor FixtureToProgramZeroMat4d Matrix transformation from fixture to program zero. public Mat4d FixtureToProgramZeroMat4d { get; } Property Value Mat4d GeomAnchor Anchor of workpiece geometry. public Anchor GeomAnchor { get; } Property Value Anchor HasDiff Indicates whether there are differences between ideal and actual geometry. public bool HasDiff { get; } Property Value bool IdealGeom Ideal geometry representation. public IGetStl IdealGeom { get; set; } Property Value IGetStl IdealGeomFaceDrawing Gets the drawing representing the ideal geometry faces of the workpiece. public Drawing IdealGeomFaceDrawing { get; } Property Value Drawing InitGeom Raw geometry for initiate. public IMakeXmlSource InitGeom { get; set; } Property Value IMakeXmlSource InitResolution Resolution for initialization. public double InitResolution { get; set; } Property Value double IsRuntimeGeomInit Indicates whether the runtime geometry is initialized. public bool IsRuntimeGeomInit { get; } Property Value bool MillingPara Milling parameters. public ICuttingPara MillingPara { get; set; } Property Value ICuttingPara MillingParaFile File path for milling parameters. public string MillingParaFile { get; set; } Property Value string ProgramZeroAnchor Anchor of geometry zero and cutter location zero. public Anchor ProgramZeroAnchor { get; } Property Value Anchor RawGeomDrawing Gets the drawing representing the raw geometry of the workpiece. public Drawing RawGeomDrawing { get; } Property Value Drawing WorkpieceGeomToFixtureBuckleBranch Branch connecting workpiece geometry to fixture buckle. public Branch WorkpieceGeomToFixtureBuckleBranch { get; } Property Value Branch WorkpieceGeomToFixtureBuckleTransformer Transformer connecting workpiece geometry to fixture buckle. public ITransformer WorkpieceGeomToFixtureBuckleTransformer { get; set; } Property Value ITransformer WorkpieceGeomToProgramZeroBranch Branch connecting workpiece geometry to program zero. public Branch WorkpieceGeomToProgramZeroBranch { get; } Property Value Branch WorkpieceGeomToProgramZeroTransformer Transformer connecting workpiece geometry to program zero. public ITransformer WorkpieceGeomToProgramZeroTransformer { get; set; } Property Value ITransformer WorkpieceMaterial Workpiece material. public WorkpieceMaterial WorkpieceMaterial { get; set; } Property Value WorkpieceMaterial WorkpieceMaterialFile File path for workpiece material. public string WorkpieceMaterialFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearIdealGeomCache() Clears the ideal geometry cache. public void ClearIdealGeomCache() ClearRawGeomCache() Clears the raw geometry cache. public void ClearRawGeomCache() Diff(double, CancellationToken, Progress) Calculates the difference between ideal and actual geometry. public void Diff(double detectionRadius, CancellationToken token, Progress progress = null) Parameters detectionRadius double Detection radius. token CancellationToken Cancellation token. progress Progress Progress reporting interface. Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetCuttingPara() Get ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetRuntimeGeom(CancellationToken, IProgress) Gets the runtime geometry. public CubeTree GetRuntimeGeom(CancellationToken token, IProgress progress = null) Parameters token CancellationToken Cancellation token. progress IProgress Progress reporting interface. Returns CubeTree Cube tree representing the runtime geometry. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ReadRuntimeGeom(string) Reads the runtime geometry from a file. public void ReadRuntimeGeom(string file) Parameters file string Source file path. ResetRuntimeGeom(ClStrip) Resets the runtime geometry. public void ResetRuntimeGeom(ClStrip clStrip) Parameters clStrip ClStrip Cutter location strip. WriteRuntimeGeom(string, CancellationToken, Progress) Writes the runtime geometry to a file. public void WriteRuntimeGeom(string file, CancellationToken token, Progress progress = null) Parameters file string Target file path. token CancellationToken Cancellation token. progress Progress Progress reporting interface." + "summary": "Class Workpiece Namespace Hi.NcMech.Workpieces Assembly HiMech.dll Workpiece. public class Workpiece : IDisplayee, IExpandToBox3d, IDisposable, IGetAnchor, IGetTopoIndex, IGetAnchoredDisplayeeList, IAnchoredCollidableLeaf, IAnchoredCollidableNode, IAnchoredCollidableBased, ICollidable, IGetCuttingPara, IMakeXmlSource Inheritance object Workpiece Implements IDisplayee IExpandToBox3d IDisposable IGetAnchor IGetTopoIndex IGetAnchoredDisplayeeList IAnchoredCollidableLeaf IAnchoredCollidableNode IAnchoredCollidableBased ICollidable IGetCuttingPara IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods CollisionUtil.Detect(ICollidable, ICollidable, Mat4d, double, int) DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors Workpiece() Initializes a new instance of the Workpiece class. public Workpiece() Workpiece(XElement, string, string) Initializes a new instance of the Workpiece class. public Workpiece(XElement src, string baseDirectory, string relFile) Parameters src XElement XML element source. baseDirectory string Base directory. relFile string Relative file path. Properties Asmb Asmb. public Asmb Asmb { get; } Property Value Asmb BottomResolution Resolution. public double BottomResolution { get; } Property Value double CollidableName Gets the name of the collidable object. public string CollidableName { get; } Property Value string CollisionFlag Gets or sets the collision flag. public CollisionFlag CollisionFlag { get; set; } Property Value CollisionFlag CuttingPara Milling parameters. public ICuttingPara CuttingPara { get; set; } Property Value ICuttingPara CuttingParaFile File path for milling parameters. public string CuttingParaFile { get; set; } Property Value string DiffAttachmentBag transient object. For Internal Use. public ConcurrentBag DiffAttachmentBag { get; set; } Property Value ConcurrentBag DiffRangeColorRule Internal used. public RangeColorRule DiffRangeColorRule { get; set; } Property Value RangeColorRule DiffVisualRadius_mm Visual radius for difference visualization. public double DiffVisualRadius_mm { get; set; } Property Value double FixtureBuckle Buckle anchor. public Anchor FixtureBuckle { get; } Property Value Anchor FixtureToProgramZeroMat4d Matrix transformation from fixture to program zero. public Mat4d FixtureToProgramZeroMat4d { get; } Property Value Mat4d GeomAnchor Anchor of workpiece geometry. public Anchor GeomAnchor { get; } Property Value Anchor HasDiff Indicates whether there are differences between ideal and actual geometry. public bool HasDiff { get; } Property Value bool IdealGeom Ideal geometry representation. public IGetStl IdealGeom { get; set; } Property Value IGetStl IdealSolid Gets the drawing representing the ideal geometry faces of the workpiece. The derived solid from IdealGeom. public Solid IdealSolid { get; } Property Value Solid InitGeom Raw geometry for initiate. public IMakeXmlSource InitGeom { get; set; } Property Value IMakeXmlSource InitResolution Resolution for initialization. public double InitResolution { get; set; } Property Value double InitSolid The derived solid from InitGeom. public Solid InitSolid { get; } Property Value Solid IsRuntimeGeomInit Indicates whether the runtime geometry is initialized. public bool IsRuntimeGeomInit { get; } Property Value bool ProgramZeroAnchor Anchor of geometry zero and cutter location zero. public Anchor ProgramZeroAnchor { get; } Property Value Anchor WorkpieceGeomToFixtureBuckleBranch Branch connecting workpiece geometry to fixture buckle. public Branch WorkpieceGeomToFixtureBuckleBranch { get; } Property Value Branch WorkpieceGeomToFixtureBuckleTransformer Transformer connecting workpiece geometry to fixture buckle. public ITransformer WorkpieceGeomToFixtureBuckleTransformer { get; set; } Property Value ITransformer WorkpieceGeomToProgramZeroBranch Branch connecting workpiece geometry to program zero. public Branch WorkpieceGeomToProgramZeroBranch { get; } Property Value Branch WorkpieceGeomToProgramZeroTransformer Transformer connecting workpiece geometry to program zero. public ITransformer WorkpieceGeomToProgramZeroTransformer { get; set; } Property Value ITransformer WorkpieceMaterial Workpiece material. public WorkpieceMaterial WorkpieceMaterial { get; set; } Property Value WorkpieceMaterial WorkpieceMaterialFile File path for workpiece material. public string WorkpieceMaterialFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearIdealGeomCache() Clears the ideal geometry cache. public void ClearIdealGeomCache() ClearRawGeomCache() Clears the raw geometry cache. public void ClearRawGeomCache() Diff(double, CancellationToken, Progress) Calculates the difference between ideal and actual geometry. public void Diff(double detectionRadius, CancellationToken token, Progress progress = null) Parameters detectionRadius double Detection radius. token CancellationToken Cancellation token. progress Progress Progress reporting interface. Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. 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 ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchoredCollidableNode() Gets the anchored collidable node associated with this object. public IAnchoredCollidableNode GetAnchoredCollidableNode() Returns IAnchoredCollidableNode The anchored collidable node. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetCollidableAnchor() Gets the anchor associated with this collidable leaf. public Anchor GetCollidableAnchor() Returns Anchor The anchor for this collidable leaf. GetCollidee() Get ICollidee. public ICollidee GetCollidee() Returns ICollidee ICollidee GetCuttingPara() Get ICuttingPara. public ICuttingPara GetCuttingPara() Returns ICuttingPara ICuttingPara GetRuntimeGeom(CancellationToken, IProgress) Gets the runtime geometry. public CubeTree GetRuntimeGeom(CancellationToken token, IProgress progress = null) Parameters token CancellationToken Cancellation token. progress IProgress Progress reporting interface. Returns CubeTree Cube tree representing the runtime geometry. 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. ReadRuntimeGeom(string) Reads the runtime geometry from a file. public void ReadRuntimeGeom(string file) Parameters file string Source file path. ResetRuntimeGeom(ClStrip) Resets the runtime geometry. public void ResetRuntimeGeom(ClStrip clStrip) Parameters clStrip ClStrip Cutter location strip. SetRuntimeGeom(CubeTree) public void SetRuntimeGeom(CubeTree runtimeGeom_) Parameters runtimeGeom_ CubeTree WriteRuntimeGeom(string, CancellationToken, Progress) Writes the runtime geometry to a file. public void WriteRuntimeGeom(string file, CancellationToken token, Progress progress = null) Parameters file string Target file path. token CancellationToken Cancellation token. progress Progress Progress reporting interface." + }, + "api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html": { + "href": "api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayee.html", + "title": "Class WorkpieceEditorDisplayee | HiAPI-C# 2025", + "summary": "Class WorkpieceEditorDisplayee Namespace Hi.NcMech.Workpieces Assembly HiMech.dll public class WorkpieceEditorDisplayee : IDisplayee, IExpandToBox3d Inheritance object WorkpieceEditorDisplayee Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Properties Config public WorkpieceEditorDisplayeeConfig Config { get; set; } Property Value WorkpieceEditorDisplayeeConfig FixtureRenderingMode public Solid.RenderingModeEnum FixtureRenderingMode { get; set; } Property Value Solid.RenderingModeEnum IdealGeomRenderingMode public Solid.RenderingModeEnum IdealGeomRenderingMode { get; set; } Property Value Solid.RenderingModeEnum MachiningEquipmentGetter public Func MachiningEquipmentGetter { get; set; } Property Value Func RawGeomRenderingMode public Solid.RenderingModeEnum RawGeomRenderingMode { get; set; } Property Value Solid.RenderingModeEnum ShowRuntimeGeom public bool ShowRuntimeGeom { get; set; } Property Value bool Methods ClearIdealGeomCache() public void ClearIdealGeomCache() ClearRawGeomCache() public void ClearRawGeomCache() Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + }, + "api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html": { + "href": "api/Hi.NcMech.Workpieces.WorkpieceEditorDisplayeeConfig.html", + "title": "Class WorkpieceEditorDisplayeeConfig | HiAPI-C# 2025", + "summary": "Class WorkpieceEditorDisplayeeConfig Namespace Hi.NcMech.Workpieces Assembly HiMech.dll Configuration settings for EquipmentWorkpieceSetupDispalyee public class WorkpieceEditorDisplayeeConfig : IMakeXmlSource Inheritance object WorkpieceEditorDisplayeeConfig Implements IMakeXmlSource 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) Constructors WorkpieceEditorDisplayeeConfig() public WorkpieceEditorDisplayeeConfig() WorkpieceEditorDisplayeeConfig(XElement) Constructor for XML deserialization public WorkpieceEditorDisplayeeConfig(XElement element) Parameters element XElement Properties FixtureRenderingMode public Solid.RenderingModeEnum FixtureRenderingMode { get; set; } Property Value Solid.RenderingModeEnum IdealGeomRenderingMode public Solid.RenderingModeEnum IdealGeomRenderingMode { get; set; } Property Value Solid.RenderingModeEnum RawGeomRenderingMode public Solid.RenderingModeEnum RawGeomRenderingMode { get; set; } Property Value Solid.RenderingModeEnum ShowFixtureBuckle public bool ShowFixtureBuckle { get; set; } Property Value bool ShowGeomAnchor public bool ShowGeomAnchor { get; set; } Property Value bool ShowProgramZeroAnchor public bool ShowProgramZeroAnchor { get; set; } Property Value bool ShowRuntimeGeom public bool ShowRuntimeGeom { get; set; } Property Value bool XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.NcMech.Workpieces.html": { "href": "api/Hi.NcMech.Workpieces.html", "title": "Namespace Hi.NcMech.Workpieces | HiAPI-C# 2025", - "summary": "Namespace Hi.NcMech.Workpieces Classes Workpiece Workpiece." + "summary": "Namespace Hi.NcMech.Workpieces Classes Workpiece Workpiece. WorkpieceEditorDisplayee WorkpieceEditorDisplayeeConfig Configuration settings for EquipmentWorkpieceSetupDispalyee" }, "api/Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html": { "href": "api/Hi.NcMech.Xyzabc.CodeXyzabcMachineTool.html", "title": "Class CodeXyzabcMachineTool | HiAPI-C# 2025", - "summary": "Class CodeXyzabcMachineTool Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll For legacy compatible. Use GeneralXyzabcMachineTool instead. public class CodeXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote Inheritance object CodeXyzabcMachineTool Implements IXyzabcMachineTool IDisplayee IGetCollisionIndexPairs IXyzabcChain IGetXyzabcChain ISolidMachiningChain IMachiningChain IGetAsmb IGetTopoIndex IGetRootAnchor IGetSolidMachiningChain IMakeXmlSource IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CodeXyzabcMachineTool(CodeXyzabcChain) Initializes a new instance of the CodeXyzabcMachineTool class. public CodeXyzabcMachineTool(CodeXyzabcChain xyzabcChain) Parameters xyzabcChain CodeXyzabcChain The XYZABC chain instance. CodeXyzabcMachineTool(XElement, string) Initializes a new instance of the CodeXyzabcMachineTool class from XML. public CodeXyzabcMachineTool(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Properties CollisionIndexPairs Gets or sets the collection of collision index pairs. public HashSet CollisionIndexPairs { get; set; } Property Value HashSet EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded Gets or sets whether to automatically generate collision index pairs when loading from XML. public bool EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded { get; set; } Property Value bool McCodes Gets the machine codes array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine transformers array. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string TableAnchor Anchor to attach fixture or workpiece. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetTableBuckle. public Anchor TableAnchor { get; } Property Value Anchor ToolAnchor Anchor to attach tool. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetToolBuckle. public Anchor ToolAnchor { get; } Property Value Anchor XName Name of XML element. public static string XName { get; } Property Value string XyzabcChain Gets the XYZABC chain instance. public IXyzabcChain XyzabcChain { get; } Property Value IXyzabcChain Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenerateCollisionIndexPairs() Generates collision index pairs for the machine tool components. public void GenerateCollisionIndexPairs() GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCollisionIndexPairs() Gets a collection of collision index pairs for collision detection. public IEnumerable GetCollisionIndexPairs() Returns IEnumerable A collection of CollisionIndexPair objects. GetMachiningChain() public IMachiningChain GetMachiningChain() Returns IMachiningChain GetMcCodeTransformerDictionary() public Dictionary GetMcCodeTransformerDictionary() Returns Dictionary GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolidMachiningChain() Get ISolidMachiningChain. public ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain ISolidMachiningChain GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain GetXyzabcMachineTool() public CodeXyzabcMachineTool GetXyzabcMachineTool() Returns CodeXyzabcMachineTool MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CodeXyzabcMachineTool Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll For legacy compatible. Use GeneralXyzabcMachineTool instead. public class CodeXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote Inheritance object CodeXyzabcMachineTool Implements IXyzabcMachineTool IDisplayee IGetCollisionIndexPairs IXyzabcChain IGetXyzabcChain IMachiningChain IGetAsmb IGetAnchor IGetTopoIndex IMakeXmlSource IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CodeXyzabcMachineTool(CodeXyzabcChain) Initializes a new instance of the CodeXyzabcMachineTool class. public CodeXyzabcMachineTool(CodeXyzabcChain xyzabcChain) Parameters xyzabcChain CodeXyzabcChain The XYZABC chain instance. CodeXyzabcMachineTool(XElement, string) Initializes a new instance from XML. public CodeXyzabcMachineTool(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Properties CollisionIndexPairs Gets or sets the collection of collision index pairs. public HashSet CollisionIndexPairs { get; set; } Property Value HashSet EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded Gets or sets whether to automatically generate collision index pairs when loading from XML. public bool EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded { get; set; } Property Value bool McCodes Gets the machine codes array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine transformers array. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string TableAnchor Anchor to attach fixture or workpiece. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetTableBuckle. public Anchor TableAnchor { get; } Property Value Anchor ToolAnchor Anchor to attach tool. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetToolBuckle. public Anchor ToolAnchor { get; } Property Value Anchor XName Name of XML element. public static string XName { get; } Property Value string XyzabcChain Gets the XYZABC chain instance. public IXyzabcChain XyzabcChain { get; } Property Value IXyzabcChain Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GenerateCollisionIndexPairs() Generates collision index pairs for the machine tool components. public void GenerateCollisionIndexPairs() GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCollisionIndexPairs() Gets a collection of collision index pairs for collision detection. public IEnumerable GetCollisionIndexPairs() Returns IEnumerable A collection of CollisionIndexPair objects. GetMachiningChain() public IMachiningChain GetMachiningChain() Returns IMachiningChain GetMcCodeTransformerDictionary() public Dictionary GetMcCodeTransformerDictionary() Returns Dictionary GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain GetXyzabcMachineTool() public CodeXyzabcMachineTool GetXyzabcMachineTool() Returns CodeXyzabcMachineTool 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." }, "api/Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html": { "href": "api/Hi.NcMech.Xyzabc.CodeXyzabcMachineToolUri.html", "title": "Class CodeXyzabcMachineToolUri | HiAPI-C# 2025", - "summary": "Class CodeXyzabcMachineToolUri Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll Represents a URI-based container for CodeXyzabcMachineTool. public class CodeXyzabcMachineToolUri : IGetCodeXyzabcMachineTool, IMakeXmlSource, IUriGetter Inheritance object CodeXyzabcMachineToolUri Implements IGetCodeXyzabcMachineTool IMakeXmlSource IUriGetter 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) Constructors CodeXyzabcMachineToolUri(string, CodeXyzabcMachineTool) Initializes a new instance of the CodeXyzabcMachineToolUri class. public CodeXyzabcMachineToolUri(string uri, CodeXyzabcMachineTool data) Parameters uri string URI location. data CodeXyzabcMachineTool Machine tool data. CodeXyzabcMachineToolUri(XElement, string, object[]) Ctor. public CodeXyzabcMachineToolUri(XElement src, string baseDirectory, object[] res) Parameters src XElement XML element source. baseDirectory string Base directory. res object[] Additional resources. Properties IsEncrypted Gets or sets whether the content is encrypted. public bool IsEncrypted { get; set; } Property Value bool MachineTool Gets or sets the machine tool. public CodeXyzabcMachineTool MachineTool { get; } Property Value CodeXyzabcMachineTool Uri Gets the URI string. public string Uri { get; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetMachiningChain() public IMachiningChain GetMachiningChain() Returns IMachiningChain GetSolidMachiningChain() public ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain GetXyzabcMachineTool() Get CodeXyzabcMachineTool. public CodeXyzabcMachineTool GetXyzabcMachineTool() Returns CodeXyzabcMachineTool Machine tool. LoadFromUri(string, object[]) Loads the machine tool data from the URI. public void LoadFromUri(string baseDirectory, object[] res) Parameters baseDirectory string Base directory. res object[] Additional resources. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state SaveToUri(string) Saves the machine tool data to the URI. public void SaveToUri(string baseDirectory) Parameters baseDirectory string Base directory." + "summary": "Class CodeXyzabcMachineToolUri Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll Represents a URI-based container for CodeXyzabcMachineTool. public class CodeXyzabcMachineToolUri : IGetCodeXyzabcMachineTool, IMakeXmlSource, IUriGetter Inheritance object CodeXyzabcMachineToolUri Implements IGetCodeXyzabcMachineTool IMakeXmlSource IUriGetter 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) Constructors CodeXyzabcMachineToolUri(string, CodeXyzabcMachineTool) Initializes a new instance of the CodeXyzabcMachineToolUri class. public CodeXyzabcMachineToolUri(string uri, CodeXyzabcMachineTool data) Parameters uri string URI location. data CodeXyzabcMachineTool Machine tool data. CodeXyzabcMachineToolUri(XElement, string, object[]) Ctor. public CodeXyzabcMachineToolUri(XElement src, string baseDirectory, object[] res) Parameters src XElement XML element source. baseDirectory string Base directory. res object[] Additional resources. Properties IsEncrypted Gets or sets whether the content is encrypted. public bool IsEncrypted { get; set; } Property Value bool MachineTool Gets or sets the machine tool. public CodeXyzabcMachineTool MachineTool { get; } Property Value CodeXyzabcMachineTool Uri Gets the URI string. public string Uri { get; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetMachiningChain() public IMachiningChain GetMachiningChain() Returns IMachiningChain GetXyzabcMachineTool() Get CodeXyzabcMachineTool. public CodeXyzabcMachineTool GetXyzabcMachineTool() Returns CodeXyzabcMachineTool Machine tool. LoadFromUri(string, object[]) Loads the machine tool data from the URI. public void LoadFromUri(string baseDirectory, object[] res) Parameters baseDirectory string Base directory. res object[] Additional resources. 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. SaveToUri(string) Saves the machine tool data to the URI. public void SaveToUri(string baseDirectory) Parameters baseDirectory string Base directory." }, "api/Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html": { "href": "api/Hi.NcMech.Xyzabc.GeneralXyzabcMachineTool.html", "title": "Class GeneralXyzabcMachineTool | HiAPI-C# 2025", - "summary": "Class GeneralXyzabcMachineTool Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll General implementation of an XYZABC machine tool. public class GeneralXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote Inheritance object GeneralXyzabcMachineTool Implements IXyzabcMachineTool IDisplayee IGetCollisionIndexPairs IXyzabcChain IGetXyzabcChain ISolidMachiningChain IMachiningChain IGetAsmb IGetTopoIndex IGetRootAnchor IGetSolidMachiningChain IMakeXmlSource IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeneralXyzabcMachineTool(IXyzabcChain) Initializes a new instance of the GeneralXyzabcMachineTool class. public GeneralXyzabcMachineTool(IXyzabcChain xyzabcChain) Parameters xyzabcChain IXyzabcChain XYZABC chain to use. GeneralXyzabcMachineTool(XElement, string) Initializes a new instance of the GeneralXyzabcMachineTool class from XML. public GeneralXyzabcMachineTool(XElement src, string baseDirectory) Parameters src XElement XML element source. baseDirectory string Base directory. Fields XName Name of XML element. public static string XName Field Value string Properties CollisionIndexPairs Collection of collision index pairs for collision detection. public HashSet CollisionIndexPairs { get; } Property Value HashSet EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded Gets or sets whether to automatically generate collision index pairs when loaded from XML. public bool EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded { get; set; } Property Value bool McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string TableAnchor Anchor to attach fixture or workpiece. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetTableBuckle. public Anchor TableAnchor { get; } Property Value Anchor ToolAnchor Anchor to attach tool. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetToolBuckle. public Anchor ToolAnchor { get; } Property Value Anchor XyzabcChain XYZABC chain for this machine tool. public IXyzabcChain XyzabcChain { get; } Property Value IXyzabcChain XyzabcChainFile File path for XYZABC chain. public string XyzabcChainFile { get; set; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCollisionIndexPairs() Gets a collection of collision index pairs for collision detection. public IEnumerable GetCollisionIndexPairs() Returns IEnumerable A collection of CollisionIndexPair objects. GetMachiningChain() public IMachiningChain GetMachiningChain() Returns IMachiningChain GetMcCodeTransformerDictionary() public Dictionary GetMcCodeTransformerDictionary() Returns Dictionary GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolidMachiningChain() Get ISolidMachiningChain. public ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain ISolidMachiningChain GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain GetXyzabcMachineTool() public GeneralXyzabcMachineTool GetXyzabcMachineTool() Returns GeneralXyzabcMachineTool MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class GeneralXyzabcMachineTool Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll General implementation of an XYZABC machine tool. public class GeneralXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote Inheritance object GeneralXyzabcMachineTool Implements IXyzabcMachineTool IDisplayee IGetCollisionIndexPairs IXyzabcChain IGetXyzabcChain IMachiningChain IGetAsmb IGetAnchor IGetTopoIndex IMakeXmlSource IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d INameNote Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeneralXyzabcMachineTool(IXyzabcChain) Initializes a new instance of the GeneralXyzabcMachineTool class. public GeneralXyzabcMachineTool(IXyzabcChain xyzabcChain) Parameters xyzabcChain IXyzabcChain XYZABC chain to use. GeneralXyzabcMachineTool(XElement, string) Initializes a new instance of the GeneralXyzabcMachineTool class from XML. public GeneralXyzabcMachineTool(XElement src, string baseDirectory) Parameters src XElement XML element source. baseDirectory string Base directory. Fields XName Name of XML element. public static string XName Field Value string Properties CollisionIndexPairs Collection of collision index pairs for collision detection. public HashSet CollisionIndexPairs { get; } Property Value HashSet EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded Gets or sets whether to automatically generate collision index pairs when loaded from XML. public bool EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded { get; set; } Property Value bool McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string TableAnchor Anchor to attach fixture or workpiece. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetTableBuckle. public Anchor TableAnchor { get; } Property Value Anchor ToolAnchor Anchor to attach tool. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetToolBuckle. public Anchor ToolAnchor { get; } Property Value Anchor XyzabcChain XYZABC chain for this machine tool. public IXyzabcChain XyzabcChain { get; } Property Value IXyzabcChain XyzabcChainFile File path for XYZABC chain. public string XyzabcChainFile { get; set; } Property Value string Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetCollisionIndexPairs() Gets a collection of collision index pairs for collision detection. public IEnumerable GetCollisionIndexPairs() Returns IEnumerable A collection of CollisionIndexPair objects. GetMachiningChain() public IMachiningChain GetMachiningChain() Returns IMachiningChain GetMcCodeTransformerDictionary() public Dictionary GetMcCodeTransformerDictionary() Returns Dictionary GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain GetXyzabcMachineTool() public GeneralXyzabcMachineTool GetXyzabcMachineTool() Returns GeneralXyzabcMachineTool 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." }, "api/Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool.html": { "href": "api/Hi.NcMech.Xyzabc.IGetCodeXyzabcMachineTool.html", @@ -3152,7 +3262,7 @@ "api/Hi.NcMech.Xyzabc.IXyzabcMachineTool.html": { "href": "api/Hi.NcMech.Xyzabc.IXyzabcMachineTool.html", "title": "Interface IXyzabcMachineTool | HiAPI-C# 2025", - "summary": "Interface IXyzabcMachineTool Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll Interface for XYZABC machine tools that combines chain, display, collision and other functionalities. public interface IXyzabcMachineTool : IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote Inherited Members IDisplayee.Display(Bind) IGetCollisionIndexPairs.GetCollisionIndexPairs() IXyzabcChain.GetTransformerX() IXyzabcChain.GetTransformerY() IXyzabcChain.GetTransformerZ() IXyzabcChain.GetTransformerA() IXyzabcChain.GetTransformerB() IXyzabcChain.GetTransformerC() IGetXyzabcChain.GetXyzabcChain() IMachiningChain.GetTableBuckle() IMachiningChain.GetToolBuckle() IMachiningChain.McCodes IMachiningChain.McTransformers IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IGetSolidMachiningChain.GetSolidMachiningChain() IMakeXmlSource.MakeXmlSource(string, string) IGetAnchorToSolidDictionary.GetAnchorToSolidDictionary() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IExpandToBox3d.ExpandToBox3d(Box3d) INameNote.Name INameNote.Note Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object)" + "summary": "Interface IXyzabcMachineTool Namespace Hi.NcMech.Xyzabc Assembly HiMech.dll Interface for XYZABC machine tools that combines chain, display, collision and other functionalities. public interface IXyzabcMachineTool : IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote Inherited Members IDisplayee.Display(Bind) IGetCollisionIndexPairs.GetCollisionIndexPairs() IXyzabcChain.GetTransformerX() IXyzabcChain.GetTransformerY() IXyzabcChain.GetTransformerZ() IXyzabcChain.GetTransformerA() IXyzabcChain.GetTransformerB() IXyzabcChain.GetTransformerC() IGetXyzabcChain.GetXyzabcChain() IMachiningChain.GetTableBuckle() IMachiningChain.GetToolBuckle() IMachiningChain.McCodes IMachiningChain.McTransformers IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() IMakeXmlSource.MakeXmlSource(string, string, bool) IGetAnchorToSolidDictionary.GetAnchorToSolidDictionary() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IExpandToBox3d.ExpandToBox3d(Box3d) INameNote.Name INameNote.Note Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object)" }, "api/Hi.NcMech.Xyzabc.html": { "href": "api/Hi.NcMech.Xyzabc.html", @@ -3162,27 +3272,27 @@ "api/Hi.NcMech.html": { "href": "api/Hi.NcMech.html", "title": "Namespace Hi.NcMech | HiAPI-C# 2025", - "summary": "Namespace Hi.NcMech Interfaces ICollisionIndexPairsSource Interface that provides access to collision index pairs and XML serialization capabilities. Extends IGetCollisionIndexPairs with XML serialization support. IGetSolidMachiningChain Interface of get ISolidMachiningChain. ISolidMachiningChain Interface for a machining chain that provides access to solid geometry. Extends IMachiningChain with solid geometry capabilities." + "summary": "Namespace Hi.NcMech Interfaces ICollisionIndexPairsSource Interface that provides access to collision index pairs and XML serialization capabilities. Extends IGetCollisionIndexPairs with XML serialization support." }, "api/Hi.NcOpt.CuttingVelocityOptLimit.html": { "href": "api/Hi.NcOpt.CuttingVelocityOptLimit.html", "title": "Class CuttingVelocityOptLimit | HiAPI-C# 2025", - "summary": "Class CuttingVelocityOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents optimization limits for cutting velocity parameters. public class CuttingVelocityOptLimit : ICuttingVelocityOptLimit, IMakeXmlSource, IDuplicate Inheritance object CuttingVelocityOptLimit Implements ICuttingVelocityOptLimit IMakeXmlSource IDuplicate 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) Constructors CuttingVelocityOptLimit() Initializes a new instance of the CuttingVelocityOptLimit class. public CuttingVelocityOptLimit() CuttingVelocityOptLimit(XElement, string) Initializes a new instance of the CuttingVelocityOptLimit class from XML. public CuttingVelocityOptLimit(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Properties MaxCuttingVelocity_mmdmin Gets or sets the maximum cutting velocity in millimeters per minute. public double MaxCuttingVelocity_mmdmin { get; set; } Property Value double MaxCuttingVelocity_mmds Gets or sets the maximum cutting velocity in millimeters per second. public double MaxCuttingVelocity_mmds { get; set; } Property Value double MinCuttingVelocity_mmdmin Gets or sets the minimum cutting velocity in millimeters per minute. public double MinCuttingVelocity_mmdmin { get; set; } Property Value double MinCuttingVelocity_mmds Gets or sets the minimum cutting velocity in millimeters per second. public double MinCuttingVelocity_mmds { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxCuttingVelocity_mmds() Gets the maximum cutting velocity in millimeters per second. public double GetMaxCuttingVelocity_mmds() Returns double The maximum cutting velocity in millimeters per second. GetMinCuttingVelocity_mmds() Gets the minimum cutting velocity in millimeters per second. public double GetMinCuttingVelocity_mmds() Returns double The minimum cutting velocity in millimeters per second. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CuttingVelocityOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents optimization limits for cutting velocity parameters. public class CuttingVelocityOptLimit : ICuttingVelocityOptLimit, IMakeXmlSource, IDuplicate, IToXElement Inheritance object CuttingVelocityOptLimit Implements ICuttingVelocityOptLimit IMakeXmlSource IDuplicate IToXElement 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) Constructors CuttingVelocityOptLimit() Initializes a new instance of the CuttingVelocityOptLimit class. public CuttingVelocityOptLimit() CuttingVelocityOptLimit(XElement, string) Initializes a new instance of the CuttingVelocityOptLimit class from XML. public CuttingVelocityOptLimit(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Properties MaxCuttingVelocity_mmdmin Gets or sets the maximum cutting velocity in millimeters per minute. public double MaxCuttingVelocity_mmdmin { get; set; } Property Value double MaxCuttingVelocity_mmds Gets or sets the maximum cutting velocity in millimeters per second. public double MaxCuttingVelocity_mmds { get; set; } Property Value double MinCuttingVelocity_mmdmin Gets or sets the minimum cutting velocity in millimeters per minute. public double MinCuttingVelocity_mmdmin { get; set; } Property Value double MinCuttingVelocity_mmds Gets or sets the minimum cutting velocity in millimeters per second. public double MinCuttingVelocity_mmds { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxCuttingVelocity_mmds() Gets the maximum cutting velocity in millimeters per second. public double GetMaxCuttingVelocity_mmds() Returns double The maximum cutting velocity in millimeters per second. GetMinCuttingVelocity_mmds() Gets the minimum cutting velocity in millimeters per second. public double GetMinCuttingVelocity_mmds() Returns double The minimum cutting velocity in millimeters per second. 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.NcOpt.FixedFeedPerCycleOptLimit.html": { "href": "api/Hi.NcOpt.FixedFeedPerCycleOptLimit.html", "title": "Class FixedFeedPerCycleOptLimit | HiAPI-C# 2025", - "summary": "Class FixedFeedPerCycleOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents fixed feed-per-cycle optimization limits. Provides implementation for feed-per-cycle optimization with fixed minimum and maximum values. public class FixedFeedPerCycleOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache Inheritance object FixedFeedPerCycleOptLimit Implements IFeedPerToothOptLimit IMakeXmlSource IDuplicate IClearCache 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) Constructors FixedFeedPerCycleOptLimit(Func, double) Initializes a new instance of the FixedFeedPerCycleOptLimit class with specified parameters. public FixedFeedPerCycleOptLimit(Func fluteNumFunc, double maxFeedPerCycle_mm) Parameters fluteNumFunc Func Function that returns the number of flutes maxFeedPerCycle_mm double Maximum feed per cycle in millimeters FixedFeedPerCycleOptLimit(XElement, string, MillingCutter) Ctor. public FixedFeedPerCycleOptLimit(XElement src, string baseDirectory, MillingCutter cutter) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths cutter MillingCutter The milling cutter to use for flute number calculation Properties FluteNum Gets the number of flutes. public int FluteNum { get; } Property Value int MaxFeedPerCycle_mm Gets or sets the maximum feed per cycle value in millimeters. public double MaxFeedPerCycle_mm { get; set; } Property Value double MinFeedPerCycle_mm Gets or sets the minimum feed per cycle value in millimeters. public double MinFeedPerCycle_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FixedFeedPerCycleOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents fixed feed-per-cycle optimization limits. Provides implementation for feed-per-cycle optimization with fixed minimum and maximum values. public class FixedFeedPerCycleOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache, IToXElement Inheritance object FixedFeedPerCycleOptLimit Implements IFeedPerToothOptLimit IMakeXmlSource IDuplicate IClearCache IToXElement 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) Constructors FixedFeedPerCycleOptLimit(Func, double) Initializes a new instance of the FixedFeedPerCycleOptLimit class with specified parameters. public FixedFeedPerCycleOptLimit(Func fluteNumFunc, double maxFeedPerCycle_mm) Parameters fluteNumFunc Func Function that returns the number of flutes maxFeedPerCycle_mm double Maximum feed per cycle in millimeters FixedFeedPerCycleOptLimit(XElement, string, MillingCutter) Ctor. public FixedFeedPerCycleOptLimit(XElement src, string baseDirectory, MillingCutter cutter) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths cutter MillingCutter The milling cutter to use for flute number calculation Properties FluteNum Gets the number of flutes. public int FluteNum { get; } Property Value int MaxFeedPerCycle_mm Gets or sets the maximum feed per cycle value in millimeters. public double MaxFeedPerCycle_mm { get; set; } Property Value double MinFeedPerCycle_mm Gets or sets the minimum feed per cycle value in millimeters. public double MinFeedPerCycle_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.NcOpt.FixedFeedPerToothOptLimit.html": { "href": "api/Hi.NcOpt.FixedFeedPerToothOptLimit.html", "title": "Class FixedFeedPerToothOptLimit | HiAPI-C# 2025", - "summary": "Class FixedFeedPerToothOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents fixed feed-per-tooth optimization limits. Provides implementation for feed-per-tooth optimization with fixed minimum and maximum values. public class FixedFeedPerToothOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate Inheritance object FixedFeedPerToothOptLimit Implements IFeedPerToothOptLimit IMakeXmlSource IDuplicate Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors FixedFeedPerToothOptLimit() Ctor. public FixedFeedPerToothOptLimit() FixedFeedPerToothOptLimit(XElement, string) Initializes a new instance of the FixedFeedPerToothOptLimit class. public FixedFeedPerToothOptLimit(XElement element, string baseDirectory) Parameters element XElement The XML element containing optimization limit data. baseDirectory string The base directory for resolving relative paths. Properties MaxFeedPerTooth_mm Gets or sets the maximum feed per tooth value in millimeters. public double MaxFeedPerTooth_mm { get; set; } Property Value double MinFeedPerTooth_mm Gets or sets the minimum feed per tooth value in millimeters. public double MinFeedPerTooth_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class FixedFeedPerToothOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents fixed feed-per-tooth optimization limits. Provides implementation for feed-per-tooth optimization with fixed minimum and maximum values. public class FixedFeedPerToothOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IToXElement Inheritance object FixedFeedPerToothOptLimit Implements IFeedPerToothOptLimit IMakeXmlSource IDuplicate IToXElement Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors FixedFeedPerToothOptLimit() Ctor. public FixedFeedPerToothOptLimit() FixedFeedPerToothOptLimit(XElement, string) Initializes a new instance of the FixedFeedPerToothOptLimit class. public FixedFeedPerToothOptLimit(XElement element, string baseDirectory) Parameters element XElement The XML element containing optimization limit data. baseDirectory string The base directory for resolving relative paths. Properties MaxFeedPerTooth_mm Gets or sets the maximum feed per tooth value in millimeters. public double MaxFeedPerTooth_mm { get; set; } Property Value double MinFeedPerTooth_mm Gets or sets the minimum feed per tooth value in millimeters. public double MinFeedPerTooth_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.NcOpt.ICutterOptLimit.html": { "href": "api/Hi.NcOpt.ICutterOptLimit.html", "title": "Interface ICutterOptLimit | HiAPI-C# 2025", - "summary": "Interface ICutterOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Interface for cutter optimization limits. Combines feed-per-tooth optimization capabilities with duplication and XML serialization support. Inherits from IMakeXmlSource, IFeedPerToothOptLimit, and IDuplicate. public interface ICutterOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate Inherited Members IFeedPerToothOptLimit.GetMinFeedPerTooth_mm() IFeedPerToothOptLimit.GetMaxFeedPerTooth_mm() IMakeXmlSource.MakeXmlSource(string, string) IDuplicate.Duplicate(params object[]) 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) Properties EnableOpt Gets or sets whether optimization is enabled for this cutter. bool EnableOpt { get; set; } Property Value bool" + "summary": "Interface ICutterOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Interface for cutter optimization limits. Combines feed-per-tooth optimization capabilities with duplication and XML serialization support. Inherits from IMakeXmlSource, IFeedPerToothOptLimit, and IDuplicate. public interface ICutterOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate Inherited Members IFeedPerToothOptLimit.GetMinFeedPerTooth_mm() IFeedPerToothOptLimit.GetMaxFeedPerTooth_mm() IMakeXmlSource.MakeXmlSource(string, string, bool) IDuplicate.Duplicate(params object[]) 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) Properties EnableOpt Gets or sets whether optimization is enabled for this cutter. bool EnableOpt { get; set; } Property Value bool" }, "api/Hi.NcOpt.ICutterOptLimitHost.html": { "href": "api/Hi.NcOpt.ICutterOptLimitHost.html", @@ -3192,32 +3302,32 @@ "api/Hi.NcOpt.ICuttingVelocityOptLimit.html": { "href": "api/Hi.NcOpt.ICuttingVelocityOptLimit.html", "title": "Interface ICuttingVelocityOptLimit | HiAPI-C# 2025", - "summary": "Interface ICuttingVelocityOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Interface for cutting velocity optimization limits. Defines methods to get minimum and maximum cutting velocity values. Implements IMakeXmlSource for XML serialization and IDuplicate for object duplication. public interface ICuttingVelocityOptLimit : IMakeXmlSource, IDuplicate Inherited Members IMakeXmlSource.MakeXmlSource(string, string) IDuplicate.Duplicate(params object[]) 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) Methods GetMaxCuttingVelocity_mmds() Gets the maximum cutting velocity in millimeters per second. double GetMaxCuttingVelocity_mmds() Returns double The maximum cutting velocity in millimeters per second. GetMinCuttingVelocity_mmds() Gets the minimum cutting velocity in millimeters per second. double GetMinCuttingVelocity_mmds() Returns double The minimum cutting velocity in millimeters per second." + "summary": "Interface ICuttingVelocityOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Interface for cutting velocity optimization limits. Defines methods to get minimum and maximum cutting velocity values. Implements IMakeXmlSource for XML serialization and IDuplicate for object duplication. public interface ICuttingVelocityOptLimit : IMakeXmlSource, IDuplicate Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) IDuplicate.Duplicate(params object[]) 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) Methods GetMaxCuttingVelocity_mmds() Gets the maximum cutting velocity in millimeters per second. double GetMaxCuttingVelocity_mmds() Returns double The maximum cutting velocity in millimeters per second. GetMinCuttingVelocity_mmds() Gets the minimum cutting velocity in millimeters per second. double GetMinCuttingVelocity_mmds() Returns double The minimum cutting velocity in millimeters per second." }, "api/Hi.NcOpt.IFeedPerToothOptLimit.html": { "href": "api/Hi.NcOpt.IFeedPerToothOptLimit.html", "title": "Interface IFeedPerToothOptLimit | HiAPI-C# 2025", - "summary": "Interface IFeedPerToothOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Interface for feed-per-tooth optimization limits. Defines methods to get minimum and maximum feed per tooth values. Implements IMakeXmlSource for XML serialization and IDuplicate for object duplication. public interface IFeedPerToothOptLimit : IMakeXmlSource, IDuplicate Inherited Members IMakeXmlSource.MakeXmlSource(string, string) IDuplicate.Duplicate(params object[]) 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) Methods GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters." + "summary": "Interface IFeedPerToothOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Interface for feed-per-tooth optimization limits. Defines methods to get minimum and maximum feed per tooth values. Implements IMakeXmlSource for XML serialization and IDuplicate for object duplication. public interface IFeedPerToothOptLimit : IMakeXmlSource, IDuplicate Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) IDuplicate.Duplicate(params object[]) 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) Methods GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters." }, "api/Hi.NcOpt.MillingCutterOptLimit.html": { "href": "api/Hi.NcOpt.MillingCutterOptLimit.html", "title": "Class MillingCutterOptLimit | HiAPI-C# 2025", - "summary": "Class MillingCutterOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents optimization limits for milling cutters. public class MillingCutterOptLimit : ICutterOptLimit, IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache Inheritance object MillingCutterOptLimit Implements ICutterOptLimit IFeedPerToothOptLimit IMakeXmlSource IDuplicate IClearCache 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) Constructors MillingCutterOptLimit() Ctor with null properties. public MillingCutterOptLimit() MillingCutterOptLimit(XElement, string, string, MillingCutter) Initializes a new instance of the MillingCutterOptLimit class from XML. public MillingCutterOptLimit(XElement src, string baseDirectory, string relFile, MillingCutter cutter) Parameters src XElement XML element source. baseDirectory string Base directory. relFile string Relative file path. cutter MillingCutter Milling cutter. Properties EnableLimitByMinimumUncutChipThickness Gets or sets whether to limit by minimum uncut chip thickness. public bool EnableLimitByMinimumUncutChipThickness { get; set; } Property Value bool EnableOpt Gets or sets whether optimization is enabled. public bool EnableOpt { get; set; } Property Value bool MaxFeedPerTooth_mm Gets or sets the maximum feed per tooth in millimeters. public double MaxFeedPerTooth_mm { get; set; } Property Value double MinFeedPerTooth_mm Gets or sets the minimum feed per tooth in millimeters. public double MinFeedPerTooth_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string YieldingSafetyFactor Gets or sets the safety factor for yielding. public double YieldingSafetyFactor { get; set; } Property Value double Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class MillingCutterOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents optimization limits for milling cutters. public class MillingCutterOptLimit : ICutterOptLimit, IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache, IToXElement Inheritance object MillingCutterOptLimit Implements ICutterOptLimit IFeedPerToothOptLimit IMakeXmlSource IDuplicate IClearCache IToXElement 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) Constructors MillingCutterOptLimit() Ctor with null properties. public MillingCutterOptLimit() MillingCutterOptLimit(XElement, string, string, MillingCutter) Initializes a new instance of the MillingCutterOptLimit class from XML. public MillingCutterOptLimit(XElement src, string baseDirectory, string relFile, MillingCutter cutter) Parameters src XElement XML element source. baseDirectory string Base directory. relFile string Relative file path. cutter MillingCutter Milling cutter. Properties EnableLimitByMinimumUncutChipThickness Gets or sets whether to limit by minimum uncut chip thickness. public bool EnableLimitByMinimumUncutChipThickness { get; set; } Property Value bool EnableOpt Gets or sets whether optimization is enabled. public bool EnableOpt { get; set; } Property Value bool MaxFeedPerTooth_mm Gets or sets the maximum feed per tooth in millimeters. public double MaxFeedPerTooth_mm { get; set; } Property Value double MinFeedPerTooth_mm Gets or sets the minimum feed per tooth in millimeters. public double MinFeedPerTooth_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string YieldingSafetyFactor Gets or sets the safety factor for yielding. public double YieldingSafetyFactor { get; set; } Property Value double Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object Remarks res[0] has to be ICutter. GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.NcOpt.NcOptOption.html": { "href": "api/Hi.NcOpt.NcOptOption.html", "title": "Class NcOptOption | HiAPI-C# 2025", - "summary": "Class NcOptOption Namespace Hi.NcOpt Assembly HiMech.dll Represents the optimization options for NC operations. public class NcOptOption : IMakeXmlSource, IEquatable Inheritance object NcOptOption Implements IMakeXmlSource IEquatable Inherited Members object.Equals(object, object) 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) Constructors NcOptOption() Ctor. public NcOptOption() NcOptOption(NcOptOption) Copy Ctor. public NcOptOption(NcOptOption src) Parameters src NcOptOption src NcOptOption(XElement) Initializes a new instance of the NcOptOption class from XML. public NcOptOption(XElement src) Parameters src XElement The XML element containing the option data. Properties CompensationMask Internal Use Only. Gets or sets the compensation mask for axis compensation. public int CompensationMask { get; set; } Property Value int EnableDepthCompensation Gets or sets whether depth compensation is enabled. public bool EnableDepthCompensation { get; set; } Property Value bool EnableDepthSplition Enables or disables depth splitting optimization. public bool EnableDepthSplition { get; set; } Property Value bool EnableForwardCompensation Gets or sets whether forward compensation is enabled. public bool EnableForwardCompensation { get; set; } Property Value bool EnableInterpolation Enables or disables interpolation. public bool EnableInterpolation { get; set; } Property Value bool EnableOpt Enables or disables the optimization process. public bool EnableOpt { get; set; } Property Value bool EnableOptFeedrate Enables or disables feedrate optimization. public bool EnableOptFeedrate { get; set; } Property Value bool EnableSideCompensation Gets or sets whether side compensation is enabled. public bool EnableSideCompensation { get; set; } Property Value bool ExtendedPostDistance_mm Gets or sets the extended post-distance in millimeters. public double ExtendedPostDistance_mm { get; set; } Property Value double ExtendedPreDistance_mm Gets or sets the extended pre-distance in millimeters. public double ExtendedPreDistance_mm { get; set; } Property Value double MaxAcceleration_mmds2 Gets or sets the maximum acceleration in millimeters per second squared. The typical CNC lathe or machining center has an acceleration of 0.2g (2 m/sec2). High speed machines have accelerations up to 2g (20 m/sec2). An arbitrary value 10mm/s2 is chosen for initial value. Note: 600mm/min=10mm/s. public double MaxAcceleration_mmds2 { get; set; } Property Value double MaxFeedrate_mmdmin Gets or sets the maximum feedrate in millimeters per minute. public double MaxFeedrate_mmdmin { get; set; } Property Value double MaxFeedrate_mmds Gets or sets the maximum feedrate in millimeters per second. public double MaxFeedrate_mmds { get; set; } Property Value double MaxJerk_mmds3 Gets or sets the maximum jerk in millimeters per second cubed. public double MaxJerk_mmds3 { get; set; } Property Value double MinFeedrate_mmdmin Gets or sets the minimum feedrate in millimeters per minute. public double MinFeedrate_mmdmin { get; set; } Property Value double MinFeedrate_mmds Gets or sets the minimum feedrate in millimeters per second. public double MinFeedrate_mmds { get; set; } Property Value double PreferedForce_N Gets or sets the preferred force in Newtons. public double PreferedForce_N { get; set; } Property Value double RapidFeed_mmdmin Gets or sets the rapid feed rate in millimeters per minute. public double RapidFeed_mmdmin { get; set; } Property Value double RapidFeed_mmds Gets or sets the rapid feed rate in millimeters per second. public double RapidFeed_mmds { get; set; } Property Value double SpindlePowerSafetyFactor Gets or sets the safety factor for spindle power. public double SpindlePowerSafetyFactor { get; set; } Property Value double SpindleTorqueSafetyFactor Gets or sets the safety factor for spindle torque. public double SpindleTorqueSafetyFactor { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate() Creates a new instance of NcOptOption by duplicating the current instance. public NcOptOption Duplicate() Returns NcOptOption A new NcOptOption instance with the same values as the current instance. Equals(NcOptOption) Indicates whether the current object is equal to another object of the same type. public bool Equals(NcOptOption other) Parameters other NcOptOption An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. GetHashCode() Serves as the default hash function. public override int GetHashCode() Returns int A hash code for the current object. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class NcOptOption Namespace Hi.NcOpt Assembly HiMech.dll Represents the optimization options for NC operations. public class NcOptOption : IMakeXmlSource, IEquatable, IToXElement Inheritance object NcOptOption Implements IMakeXmlSource IEquatable IToXElement Inherited Members object.Equals(object, object) 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) Constructors NcOptOption() Ctor. public NcOptOption() NcOptOption(NcOptOption) Copy Ctor. public NcOptOption(NcOptOption src) Parameters src NcOptOption src NcOptOption(XElement) Initializes a new instance of the NcOptOption class from XML. public NcOptOption(XElement src) Parameters src XElement The XML element containing the option data. Properties CompensationMask Internal Use Only. Gets or sets the compensation mask for axis compensation. public int CompensationMask { get; set; } Property Value int EnableDepthCompensation Gets or sets whether depth compensation is enabled. public bool EnableDepthCompensation { get; set; } Property Value bool EnableDepthSplition Enables or disables depth splitting optimization. public bool EnableDepthSplition { get; set; } Property Value bool EnableForwardCompensation Gets or sets whether forward compensation is enabled. public bool EnableForwardCompensation { get; set; } Property Value bool EnableInterpolation Enables or disables interpolation. public bool EnableInterpolation { get; set; } Property Value bool EnableOpt Enables or disables the optimization process. public bool EnableOpt { get; set; } Property Value bool EnableOptFeedrate Enables or disables feedrate optimization. public bool EnableOptFeedrate { get; set; } Property Value bool EnableSideCompensation Gets or sets whether side compensation is enabled. public bool EnableSideCompensation { get; set; } Property Value bool ExtendedPostDistance_mm Gets or sets the extended post-distance in millimeters. public double ExtendedPostDistance_mm { get; set; } Property Value double ExtendedPreDistance_mm Gets or sets the extended pre-distance in millimeters. public double ExtendedPreDistance_mm { get; set; } Property Value double MaxAcceleration_mmds2 Gets or sets the maximum acceleration in millimeters per second squared. The typical CNC lathe or machining center has an acceleration of 0.2g (2 m/sec2). High speed machines have accelerations up to 2g (20 m/sec2). An arbitrary value 10mm/s2 is chosen for initial value. Note: 600mm/min=10mm/s. public double MaxAcceleration_mmds2 { get; set; } Property Value double MaxFeedrate_mmdmin Gets or sets the maximum feedrate in millimeters per minute. public double MaxFeedrate_mmdmin { get; set; } Property Value double MaxFeedrate_mmds Gets or sets the maximum feedrate in millimeters per second. public double MaxFeedrate_mmds { get; set; } Property Value double MaxJerk_mmds3 Gets or sets the maximum jerk in millimeters per second cubed. public double MaxJerk_mmds3 { get; set; } Property Value double MinFeedrate_mmdmin Gets or sets the minimum feedrate in millimeters per minute. public double MinFeedrate_mmdmin { get; set; } Property Value double MinFeedrate_mmds Gets or sets the minimum feedrate in millimeters per second. public double MinFeedrate_mmds { get; set; } Property Value double PreferedForce_N Gets or sets the preferred force in Newtons. public double PreferedForce_N { get; set; } Property Value double RapidFeed_mmdmin Gets or sets the rapid feed rate in millimeters per minute. public double RapidFeed_mmdmin { get; set; } Property Value double RapidFeed_mmds Gets or sets the rapid feed rate in millimeters per second. public double RapidFeed_mmds { get; set; } Property Value double SpindlePowerSafetyFactor Gets or sets the safety factor for spindle power. public double SpindlePowerSafetyFactor { get; set; } Property Value double SpindleTorqueSafetyFactor Gets or sets the safety factor for spindle torque. public double SpindleTorqueSafetyFactor { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate() Creates a new instance of NcOptOption by duplicating the current instance. public NcOptOption Duplicate() Returns NcOptOption A new NcOptOption instance with the same values as the current instance. Equals(NcOptOption) Indicates whether the current object is equal to another object of the same type. public bool Equals(NcOptOption other) Parameters other NcOptOption An object to compare with this object. Returns bool true if the current object is equal to the other parameter; otherwise, false. 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. 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.NcOpt.NcOptProc.html": { "href": "api/Hi.NcOpt.NcOptProc.html", "title": "Class NcOptProc | HiAPI-C# 2025", - "summary": "Class NcOptProc Namespace Hi.NcOpt Assembly HiNc.dll Provides functionality for optimizing NC programs by modifying feed rates and tool paths. public class NcOptProc : IMakeXmlSource Inheritance object NcOptProc Implements IMakeXmlSource 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) Constructors NcOptProc(SequentialBulkReader) Ctor. public NcOptProc(SequentialBulkReader millingStepLuggageReader) Parameters millingStepLuggageReader SequentialBulkReader NcOptProc(XElement, string, SequentialBulkReader) Ctor. public NcOptProc(XElement src, string baseDirectory, SequentialBulkReader millingStepLuggageReader) Parameters src XElement XML baseDirectory string Base directory path millingStepLuggageReader SequentialBulkReader Milling step luggage reader Properties CoreNum Parallel computation thread num. 0 is special number to use all cores. public static int CoreNum { get; set; } Property Value int FeedSettingGapRatio Gets or sets the ratio used for determining feed setting gaps. public static double FeedSettingGapRatio { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Optimize(ICuttingPara, MachiningSession, LinkedList, NcEnv, List, MachiningToolHouse, IMessageHost, CancellationToken, string) Optimizes NC lines based on cutting parameters and milling steps. public IEnumerable<(NcLine SrcNcLine, NcLine OptNcLine)> Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList srcNcLines, NcEnv ncEnv, List millingSteps, MachiningToolHouse millingToolHouse, IMessageHost messageHost, CancellationToken cancellationToken, string relFileTemplate) Parameters millingPara ICuttingPara The cutting parameters for optimization machiningSession MachiningSession The current machining session srcNcLines LinkedList The source NC lines to optimize ncEnv NcEnv The NC environment settings millingSteps List The list of milling steps millingToolHouse MachiningToolHouse The machining tool house messageHost IMessageHost The message host for logging cancellationToken CancellationToken Cancellation token to cancel the operation relFileTemplate string The relative file template for output Returns IEnumerable<(NcLine SrcNcLine, NcLine OptNcLine)> Enumerable of source and optimized NC line pairs OptimizeToFiles(ICuttingPara, MachiningSession, LinkedList, NcEnv, MachiningToolHouse, ClStrip, string, IMessageHost, CancellationToken, string) Optimizes NC lines and writes the results to files. public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList ncLines, NcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IMessageHost messageHost, CancellationToken cancellationToken, string relFileTemplate = \"Output/Opt-[NcName]\") Parameters millingPara ICuttingPara The cutting parameters for optimization machiningSession MachiningSession The current machining session ncLines LinkedList The NC lines to optimize ncEnv NcEnv The NC environment settings millingToolHouse MachiningToolHouse The machining tool house clStrip ClStrip The cutter location strip baseDirectory string The base directory for output files messageHost IMessageHost The message host for logging cancellationToken CancellationToken Cancellation token to cancel the operation relFileTemplate string The relative file template for output files" + "summary": "Class NcOptProc Namespace Hi.NcOpt Assembly HiNc.dll Provides functionality for optimizing NC programs by modifying feed rates and tool paths. public class NcOptProc : IMakeXmlSource Inheritance object NcOptProc Implements IMakeXmlSource 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) Constructors NcOptProc(SequentialBulkReader) Ctor. public NcOptProc(SequentialBulkReader millingStepLuggageReader) Parameters millingStepLuggageReader SequentialBulkReader NcOptProc(XElement, string, SequentialBulkReader) Ctor. public NcOptProc(XElement src, string baseDirectory, SequentialBulkReader millingStepLuggageReader) Parameters src XElement XML baseDirectory string Base directory path millingStepLuggageReader SequentialBulkReader Milling step luggage reader Properties CoreNum Parallel computation thread num. 0 is special number to use all cores. public static int CoreNum { get; set; } Property Value int FeedSettingGapRatio Gets or sets the ratio used for determining feed setting gaps. public static double FeedSettingGapRatio { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Optimize(ICuttingPara, MachiningSession, LinkedList, NcEnv, List, MachiningToolHouse, IMessageKit, CancellationToken, string) Optimizes NC lines based on cutting parameters and milling steps. public IEnumerable<(NcLine SrcNcLine, NcLine OptNcLine)> Optimize(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList srcNcLines, NcEnv ncEnv, List millingSteps, MachiningToolHouse millingToolHouse, IMessageKit messageHost, CancellationToken cancellationToken, string relFileTemplate) Parameters millingPara ICuttingPara The cutting parameters for optimization machiningSession MachiningSession The current machining session srcNcLines LinkedList The source NC lines to optimize ncEnv NcEnv The NC environment settings millingSteps List The list of milling steps millingToolHouse MachiningToolHouse The machining tool house messageHost IMessageKit The message host for logging cancellationToken CancellationToken Cancellation token to cancel the operation relFileTemplate string The relative file template for output Returns IEnumerable<(NcLine SrcNcLine, NcLine OptNcLine)> Enumerable of source and optimized NC line pairs OptimizeToFiles(ICuttingPara, MachiningSession, LinkedList, NcEnv, MachiningToolHouse, ClStrip, string, IMessageKit, CancellationToken, string) Optimizes NC lines and writes the results to files. public void OptimizeToFiles(ICuttingPara millingPara, MachiningSession machiningSession, LinkedList ncLines, NcEnv ncEnv, MachiningToolHouse millingToolHouse, ClStrip clStrip, string baseDirectory, IMessageKit messageHost, CancellationToken cancellationToken, string relFileTemplate = \"Output/Opt-[NcName]\") Parameters millingPara ICuttingPara The cutting parameters for optimization machiningSession MachiningSession The current machining session ncLines LinkedList The NC lines to optimize ncEnv NcEnv The NC environment settings millingToolHouse MachiningToolHouse The machining tool house clStrip ClStrip The cutter location strip baseDirectory string The base directory for output files messageHost IMessageKit The message host for logging cancellationToken CancellationToken Cancellation token to cancel the operation relFileTemplate string The relative file template for output files" }, "api/Hi.NcOpt.ShapeBasedCutterOptLimit.html": { "href": "api/Hi.NcOpt.ShapeBasedCutterOptLimit.html", "title": "Class ShapeBasedCutterOptLimit | HiAPI-C# 2025", - "summary": "Class ShapeBasedCutterOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents optimization limits based on cutter shape parameters. public class ShapeBasedCutterOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache Inheritance object ShapeBasedCutterOptLimit Implements IFeedPerToothOptLimit IMakeXmlSource IDuplicate IClearCache 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) Constructors ShapeBasedCutterOptLimit(MillingCutter) Initializes a new instance of the ShapeBasedCutterOptLimit class. public ShapeBasedCutterOptLimit(MillingCutter cutter) Parameters cutter MillingCutter The milling cutter. ShapeBasedCutterOptLimit(Func, Func, Func) Initializes a new instance of the ShapeBasedCutterOptLimit class. public ShapeBasedCutterOptLimit(Func fluteNumFunc, Func radiusFunc_mm, Func radialReliefAngleFunc_rad) Parameters fluteNumFunc Func Function to get the number of flutes radiusFunc_mm Func Function to get the radius in millimeters radialReliefAngleFunc_rad Func Function to get the radial relief angle in radians ShapeBasedCutterOptLimit(XElement, string, MillingCutter) Ctor. public ShapeBasedCutterOptLimit(XElement src, string baseDirectory, MillingCutter cutter) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths cutter MillingCutter The milling cutter to use for calculations Properties FluteNum Gets the number of flutes. public int FluteNum { get; } Property Value int FluteNumFunc Gets or sets the function to get the number of flutes. public Func FluteNumFunc { get; set; } Property Value Func MinFeedPerTooth_mm Gets or sets the minimum feed per tooth in millimeters. public double MinFeedPerTooth_mm { get; set; } Property Value double RadialReliefAngleFunc_rad Gets or sets the function to get the radial relief angle in radians. public Func RadialReliefAngleFunc_rad { get; set; } Property Value Func RadialReliefAngle_rad Gets or sets the radial relief angle in radians. public double RadialReliefAngle_rad { get; } Property Value double RadiusFunc_mm Gets or sets the function to get the radius in millimeters. public Func RadiusFunc_mm { get; set; } Property Value Func Radius_mm Gets or sets the radius in millimeters. public double Radius_mm { get; } Property Value double SafetyFactor Gets or sets the safety factor. public double SafetyFactor { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ShapeBasedCutterOptLimit Namespace Hi.NcOpt Assembly HiMech.dll Represents optimization limits based on cutter shape parameters. public class ShapeBasedCutterOptLimit : IFeedPerToothOptLimit, IMakeXmlSource, IDuplicate, IClearCache Inheritance object ShapeBasedCutterOptLimit Implements IFeedPerToothOptLimit IMakeXmlSource IDuplicate IClearCache 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) Constructors ShapeBasedCutterOptLimit(MillingCutter) Initializes a new instance of the ShapeBasedCutterOptLimit class. public ShapeBasedCutterOptLimit(MillingCutter cutter) Parameters cutter MillingCutter The milling cutter. ShapeBasedCutterOptLimit(Func, Func, Func) Initializes a new instance of the ShapeBasedCutterOptLimit class. public ShapeBasedCutterOptLimit(Func fluteNumFunc, Func radiusFunc_mm, Func radialReliefAngleFunc_rad) Parameters fluteNumFunc Func Function to get the number of flutes radiusFunc_mm Func Function to get the radius in millimeters radialReliefAngleFunc_rad Func Function to get the radial relief angle in radians ShapeBasedCutterOptLimit(XElement, string, MillingCutter) Ctor. public ShapeBasedCutterOptLimit(XElement src, string baseDirectory, MillingCutter cutter) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths cutter MillingCutter The milling cutter to use for calculations Properties FluteNum Gets the number of flutes. public int FluteNum { get; } Property Value int FluteNumFunc Gets or sets the function to get the number of flutes. public Func FluteNumFunc { get; set; } Property Value Func MinFeedPerTooth_mm Gets or sets the minimum feed per tooth in millimeters. public double MinFeedPerTooth_mm { get; set; } Property Value double RadialReliefAngleFunc_rad Gets or sets the function to get the radial relief angle in radians. public Func RadialReliefAngleFunc_rad { get; set; } Property Value Func RadialReliefAngle_rad Gets or sets the radial relief angle in radians. public double RadialReliefAngle_rad { get; } Property Value double RadiusFunc_mm Gets or sets the function to get the radius in millimeters. public Func RadiusFunc_mm { get; set; } Property Value Func Radius_mm Gets or sets the radius in millimeters. public double Radius_mm { get; } Property Value double SafetyFactor Gets or sets the safety factor. public double SafetyFactor { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods ClearCache() Clears any cached data held by the implementing object. public void ClearCache() Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object GetMaxFeedPerTooth_mm() Gets the maximum feed per tooth value in millimeters. public double GetMaxFeedPerTooth_mm() Returns double The maximum feed per tooth value in millimeters. GetMinFeedPerTooth_mm() Gets the minimum feed per tooth value in millimeters. public double GetMinFeedPerTooth_mm() Returns double The minimum feed per tooth value in millimeters. 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." }, "api/Hi.NcOpt.html": { "href": "api/Hi.NcOpt.html", @@ -3237,7 +3347,7 @@ "api/Hi.NcStepUtils.INcStepMonitee.html": { "href": "api/Hi.NcStepUtils.INcStepMonitee.html", "title": "Interface INcStepMonitee | HiAPI-C# 2025", - "summary": "Interface INcStepMonitee Namespace Hi.NcStepUtils Assembly HiMech.dll Interface for monitoring NC steps. Provides functionality for acquiring NC step information and managing color guides. Implements IMakeXmlSource for XML serialization. public interface INcStepMonitee : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string) 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) Properties ColorGuide Gets or sets the color guide for visual representation. IColorGuide ColorGuide { get; set; } Property Value IColorGuide Methods AquireNcStep(CancellationToken) Acquires an NC step for a sequence. INcStep0 AquireNcStep(CancellationToken cancellationToken) Parameters cancellationToken CancellationToken The cancellation token to observe while waiting for the task to complete. Returns INcStep0 An instance of INcStep0 representing the acquired NC step." + "summary": "Interface INcStepMonitee Namespace Hi.NcStepUtils Assembly HiMech.dll Interface for monitoring NC steps. Provides functionality for acquiring NC step information and managing color guides. Implements IMakeXmlSource for XML serialization. public interface INcStepMonitee : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Properties ColorGuide Gets or sets the color guide for visual representation. IColorGuide ColorGuide { get; set; } Property Value IColorGuide Methods AquireNcStep(CancellationToken) Acquires an NC step for a sequence. INcStep0 AquireNcStep(CancellationToken cancellationToken) Parameters cancellationToken CancellationToken The cancellation token to observe while waiting for the task to complete. Returns INcStep0 An instance of INcStep0 representing the acquired NC step." }, "api/Hi.NcStepUtils.NcStepUtil.html": { "href": "api/Hi.NcStepUtils.NcStepUtil.html", @@ -3252,17 +3362,22 @@ "api/Hi.Numerical.Acts.ActClArc.html": { "href": "api/Hi.Numerical.Acts.ActClArc.html", "title": "Class ActClArc | HiAPI-C# 2025", - "summary": "Class ActClArc Namespace Hi.Numerical.Acts Assembly HiMech.dll Represents an arc movement action for cutter location. public class ActClArc : IActClMove, IAct Inheritance object ActClArc Implements IActClMove IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ActClArc(ClCircleArc) Initializes a new instance of the ActClArc class. public ActClArc(ClCircleArc path) Parameters path ClCircleArc The circle arc path. Properties ClCircleArc Gets or sets the cutter location circle arc. public ClCircleArc ClCircleArc { get; set; } Property Value ClCircleArc Methods GetClPath() Gets the cutter location path. public IClPath GetClPath() Returns IClPath The cutter location path. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class ActClArc Namespace Hi.Numerical.Acts Assembly HiMech.dll Represents an arc movement action for cutter location. public class ActClArc : IActClMove, IActDuration, IAct Inheritance object ActClArc Implements IActClMove IActDuration IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) ActUtil.GetClSteps(IActClMove, int, IMachiningMotionResolution) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ActClArc(ClCircleArc, TimeSpan) Initializes a new instance of the ActClArc class. public ActClArc(ClCircleArc path, TimeSpan duration) Parameters path ClCircleArc The circle arc path. duration TimeSpan Properties ActDuration Gets or sets the duration of the action. public TimeSpan ActDuration { get; set; } Property Value TimeSpan Remarks The duration represents: The time required to complete the action Should be positive and finite Zero duration indicates an instantaneous action Used for scheduling and timing calculations ClCircleArc Gets or sets the cutter location circle arc. public ClCircleArc ClCircleArc { get; set; } Property Value ClCircleArc Methods GetClPath() Gets the cutter location path. public IClPath GetClPath() Returns IClPath The cutter location path. GetClSteps(IMachiningMotionResolution) public IEnumerable GetClSteps(IMachiningMotionResolution ncResolution) Parameters ncResolution IMachiningMotionResolution Returns IEnumerable ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.Numerical.Acts.ActClLinear.html": { "href": "api/Hi.Numerical.Acts.ActClLinear.html", "title": "Class ActClLinear | HiAPI-C# 2025", - "summary": "Class ActClLinear Namespace Hi.Numerical.Acts Assembly HiMech.dll Represents a linear cutter location movement action. public class ActClLinear : IActClMove, IAct Inheritance object ActClLinear Implements IActClMove IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ActClLinear(ClLinear) Initializes a new instance of the ActClLinear class with the specified path. public ActClLinear(ClLinear path) Parameters path ClLinear The linear cutter location path. Properties ClLinear Gets or sets the linear cutter location path. public ClLinear ClLinear { get; set; } Property Value ClLinear Methods GetClPath() Retrieves the cutter location path. public IClPath GetClPath() Returns IClPath The cutter location path. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class ActClLinear Namespace Hi.Numerical.Acts Assembly HiMech.dll Represents a linear cutter location movement action. public class ActClLinear : IActClMove, IActDuration, IAct Inheritance object ActClLinear Implements IActClMove IActDuration IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) ActUtil.GetClSteps(IActClMove, int, IMachiningMotionResolution) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors ActClLinear(ClLinear, TimeSpan?) Initializes a new instance of the ActClLinear class with the specified path. public ActClLinear(ClLinear path, TimeSpan? duration = null) Parameters path ClLinear The linear cutter location path. duration TimeSpan? ActClLinear(DVec3d, DVec3d, TimeSpan?) public ActClLinear(DVec3d beginCl, DVec3d endCl, TimeSpan? duration = null) Parameters beginCl DVec3d endCl DVec3d duration TimeSpan? Properties ActDuration Gets or sets the duration of the action. public TimeSpan ActDuration { get; set; } Property Value TimeSpan Remarks The duration represents: The time required to complete the action Should be positive and finite Zero duration indicates an instantaneous action Used for scheduling and timing calculations ClLinear Gets or sets the linear cutter location path. public ClLinear ClLinear { get; set; } Property Value ClLinear Methods GetClPath() Retrieves the cutter location path. public IClPath GetClPath() Returns IClPath The cutter location path. GetClSteps(IMachiningMotionResolution) public IEnumerable GetClSteps(IMachiningMotionResolution ncResolution) Parameters ncResolution IMachiningMotionResolution Returns IEnumerable ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + }, + "api/Hi.Numerical.Acts.ActClStep.html": { + "href": "api/Hi.Numerical.Acts.ActClStep.html", + "title": "Class ActClStep | HiAPI-C# 2025", + "summary": "Class ActClStep Namespace Hi.Numerical.Acts Assembly HiMech.dll public class ActClStep : IActMachineStep, IActDuration, IAct Inheritance object ActClStep Implements IActMachineStep IActDuration IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ActClStep(DVec3d, TimeSpan?) Initializes a new instance with the specified cutter location. public ActClStep(DVec3d cl, TimeSpan? timeSpan = null) Parameters cl DVec3d The cutter location vector. timeSpan TimeSpan? Properties ActDuration Gets or sets the duration of the action. public TimeSpan ActDuration { get; set; } Property Value TimeSpan Remarks The duration represents: The time required to complete the action Should be positive and finite Zero duration indicates an instantaneous action Used for scheduling and timing calculations Cl Gets or sets the cutter location vector. public DVec3d Cl { get; set; } Property Value DVec3d Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.Numerical.Acts.ActClTeleport.html": { "href": "api/Hi.Numerical.Acts.ActClTeleport.html", "title": "Class ActClTeleport | HiAPI-C# 2025", - "summary": "Class ActClTeleport Namespace Hi.Numerical.Acts Assembly HiMech.dll Represents a teleport action for cutter location, allowing instant position change without movement. public class ActClTeleport : IAct Inheritance object ActClTeleport Implements IAct 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) Constructors ActClTeleport(DVec3d) Initializes a new instance of the ActClTeleport class with the specified cutter location. public ActClTeleport(DVec3d cl) Parameters cl DVec3d The cutter location vector. Properties Cl Gets or sets the cutter location vector. public DVec3d Cl { get; set; } Property Value DVec3d" + "summary": "Class ActClTeleport Namespace Hi.Numerical.Acts Assembly HiMech.dll Represents a teleport action for cutter location, allowing instant position change without movement. public class ActClTeleport : IActDuration, IAct Inheritance object ActClTeleport Implements IActDuration IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ActClTeleport(DVec3d, TimeSpan?) Initializes a new instance of the ActClTeleport class with the specified cutter location. public ActClTeleport(DVec3d cl, TimeSpan? timeSpan = null) Parameters cl DVec3d The cutter location vector. timeSpan TimeSpan? Properties ActDuration Gets or sets the duration of the action. public TimeSpan ActDuration { get; set; } Property Value TimeSpan Remarks The duration represents: The time required to complete the action Should be positive and finite Zero duration indicates an instantaneous action Used for scheduling and timing calculations Cl Gets or sets the cutter location vector. public DVec3d Cl { get; set; } Property Value DVec3d Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.Numerical.Acts.ActCooling.html": { "href": "api/Hi.Numerical.Acts.ActCooling.html", @@ -3354,10 +3469,15 @@ "title": "Class ActStateRunner | HiAPI-C# 2025", "summary": "Class ActStateRunner Namespace Hi.Numerical.Acts Assembly HiMech.dll Manages the state of numerical control operations during runtime. public class ActStateRunner Inheritance object ActStateRunner 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) Properties Feedrate_mmdmin Last processing Feedrate in mm/min. public double Feedrate_mmdmin { get; set; } Property Value double Feedrate_mmds Last processing Feedrate in mm/sec. public double Feedrate_mmds { get; set; } Property Value double IsCoolantOn Gets or sets a value indicating whether the coolant is turned on. public bool IsCoolantOn { get; set; } Property Value bool SpindleAngle_deg Spindle rotation angle in degrees. public double SpindleAngle_deg { get; set; } Property Value double SpindleAngle_rad Spindle rotation angle in radians. public double SpindleAngle_rad { get; set; } Property Value double SpindleDirection Gets or sets the spindle rotation direction. public SpindleDirection SpindleDirection { get; set; } Property Value SpindleDirection SpindleSpeed_radds Gets or sets the spindle speed in radians per second. public double SpindleSpeed_radds { get; set; } Property Value double SpindleSpeed_rpm Gets or sets the spindle speed in revolutions per minute. public double SpindleSpeed_rpm { get; set; } Property Value double ToolId Gets or sets the current tool identifier. public int ToolId { get; set; } Property Value int WorkTime Accumulated worked time in sec. The value includes last action duration. public TimeSpan WorkTime { get; set; } Property Value TimeSpan Methods ProcAct(IAct) filter the same effect action and run the effective action. public IAct ProcAct(IAct act) Parameters act IAct Returns IAct null if the input act is the same effect action. otherwise, return act. ResetState() Resets all state values to their defaults. public void ResetState()" }, - "api/Hi.Numerical.Acts.ActTooling.html": { - "href": "api/Hi.Numerical.Acts.ActTooling.html", - "title": "Class ActTooling | HiAPI-C# 2025", - "summary": "Class ActTooling Namespace Hi.Numerical.Acts Assembly HiMech.dll Represents a tooling operation act in numerical control operations. This class handles tool changes and related operations in the machining process. public class ActTooling : IActDuration, IActMachineStep, IAct Inheritance object ActTooling Implements IActDuration IActMachineStep IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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 This class is used for: Tool change operations Tool selection and management Tracking tool usage time Managing tool-specific operations The tooling operation includes: Tool identification Change duration tracking Operation validation Constructors ActTooling(int, TimeSpan) Initializes a new instance of the ActTooling class with the specified tool ID and duration. public ActTooling(int toolId, TimeSpan actDuration) Parameters toolId int The identifier of the tool to use. This value: Must be a valid tool magazine position Should correspond to an existing tool Is used for tool selection and validation actDuration TimeSpan The duration of the tooling operation. This represents: Time needed for tool change Should include safety margins Must be non-negative Properties ActDuration Gets or sets the duration of the action. public TimeSpan ActDuration { get; set; } Property Value TimeSpan Remarks The duration represents: The time required to complete the action Should be positive and finite Zero duration indicates an instantaneous action Used for scheduling and timing calculations ToolId Gets or sets the tool identifier. public int ToolId { get; set; } Property Value int Remarks The tool ID: Uniquely identifies a specific tool Used for tool selection and validation Corresponds to the machine's tool magazine positions Should be positive and valid for the machine configuration Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "api/Hi.Numerical.Acts.ActToolingStep.html": { + "href": "api/Hi.Numerical.Acts.ActToolingStep.html", + "title": "Class ActToolingStep | HiAPI-C# 2025", + "summary": "Class ActToolingStep Namespace Hi.Numerical.Acts Assembly HiMech.dll Action of equiping the tool with machining step operation such as collision detection and volume removal. public class ActToolingStep : IActDuration, IActMachineStep, IActTooling, IAct Inheritance object ActToolingStep Implements IActDuration IActMachineStep IActTooling IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ActToolingStep(int, TimeSpan?) Initializes a new instance of the ActToolingStep class with the specified tool ID and duration. public ActToolingStep(int toolId, TimeSpan? actDuration = null) Parameters toolId int The identifier of the tool to use. This value: Must be a valid tool magazine position Should correspond to an existing tool Is used for tool selection and validation actDuration TimeSpan? The duration of the tooling operation. This represents: Time needed for tool change Should include safety margins Must be non-negative Properties ActDuration Gets or sets the duration of the action. public TimeSpan ActDuration { get; set; } Property Value TimeSpan Remarks The duration represents: The time required to complete the action Should be positive and finite Zero duration indicates an instantaneous action Used for scheduling and timing calculations ToolId Gets or sets the tool identifier. public int ToolId { get; set; } Property Value int Remarks The tool ID: Uniquely identifies a specific tool Used for tool selection and validation Corresponds to the machine's tool magazine positions Should be positive and valid for the machine configuration Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + }, + "api/Hi.Numerical.Acts.ActToolingTeleport.html": { + "href": "api/Hi.Numerical.Acts.ActToolingTeleport.html", + "title": "Class ActToolingTeleport | HiAPI-C# 2025", + "summary": "Class ActToolingTeleport Namespace Hi.Numerical.Acts Assembly HiMech.dll Action of Equiping the tool without machining step operation such as collision detection and volume removal. public class ActToolingTeleport : IActTooling, IAct Inheritance object ActToolingTeleport Implements IActTooling IAct Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors ActToolingTeleport(int) Initializes a new instance of the ActToolingTeleport class with the specified tool ID and duration. public ActToolingTeleport(int toolId) Parameters toolId int The identifier of the tool to use. This value: Must be a valid tool magazine position Should correspond to an existing tool Is used for tool selection and validation Properties ToolId Gets or sets the tool identifier. public int ToolId { get; set; } Property Value int Remarks The tool ID: Uniquely identifies a specific tool Used for tool selection and validation Corresponds to the machine's tool magazine positions Should be positive and valid for the machine configuration Methods ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.Numerical.Acts.ActUnknownSkip.html": { "href": "api/Hi.Numerical.Acts.ActUnknownSkip.html", @@ -3367,7 +3487,7 @@ "api/Hi.Numerical.Acts.ActUtil.html": { "href": "api/Hi.Numerical.Acts.ActUtil.html", "title": "Class ActUtil | HiAPI-C# 2025", - "summary": "Class ActUtil Namespace Hi.Numerical.Acts Assembly HiMech.dll Provides utility methods for numerical control actions. public static class ActUtil Inheritance object ActUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetStepNum(SeqPair, ICoordinateConverter, double, IMachiningMotionResolution) Gets the step number for a machine coordinate sequence. public static int GetStepNum(SeqPair mcSeq, ICoordinateConverter coordinateConverter, double toolHeightForComputingStepNum, IMachiningMotionResolution ncResolution) Parameters mcSeq SeqPair The machine coordinate sequence. coordinateConverter ICoordinateConverter The coordinate converter to use. toolHeightForComputingStepNum double The tool height for computing step number. ncResolution IMachiningMotionResolution The machining motion resolution. Returns int The calculated step number. GetStepNumOnPolarInterpolationMode(SeqPair, IMachiningMotionResolution) Gets the step number for a polar interpolation mode. public static int GetStepNumOnPolarInterpolationMode(SeqPair programPolarXczSeq, IMachiningMotionResolution ncResolution) Parameters programPolarXczSeq SeqPair The program polar XCZ sequence. ncResolution IMachiningMotionResolution The machining motion resolution. Returns int The calculated step number. UpdateStepNumByCl(DVec3d, DVec3d, ICoordinateConverter, double, double, ref int) Updates the step number based on cutter location points. public static void UpdateStepNumByCl(DVec3d mcXyzabc0, DVec3d mcXyzabc1, ICoordinateConverter coordinateConverter, double compensationHeight, double linearResolution_mm, ref int stepNum) Parameters mcXyzabc0 DVec3d The starting machine coordinate. mcXyzabc1 DVec3d The ending machine coordinate. coordinateConverter ICoordinateConverter The coordinate converter to use. compensationHeight double The compensation height value. linearResolution_mm double The linear resolution in millimeters. stepNum int The step number to update." + "summary": "Class ActUtil Namespace Hi.Numerical.Acts Assembly HiMech.dll Provides utility methods for numerical control actions. public static class ActUtil Inheritance object ActUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetClSteps(IActClMove, int, IMachiningMotionResolution) public static IEnumerable GetClSteps(this IActClMove actClMove, int stepNum, IMachiningMotionResolution ncResolution) Parameters actClMove IActClMove stepNum int ncResolution IMachiningMotionResolution Returns IEnumerable GetStepNum(SeqPair, ICoordinateConverter, double, IMachiningMotionResolution) Gets the step number for a machine coordinate sequence. public static int GetStepNum(SeqPair mcSeq, ICoordinateConverter coordinateConverter, double toolHeightForComputingStepNum, IMachiningMotionResolution ncResolution) Parameters mcSeq SeqPair The machine coordinate sequence. coordinateConverter ICoordinateConverter The coordinate converter to use. toolHeightForComputingStepNum double The tool height for computing step number. ncResolution IMachiningMotionResolution The machining motion resolution. Returns int The calculated step number. GetStepNumOnPolarInterpolationMode(SeqPair, IMachiningMotionResolution) Gets the step number for a polar interpolation mode. public static int GetStepNumOnPolarInterpolationMode(SeqPair programPolarXczSeq, IMachiningMotionResolution ncResolution) Parameters programPolarXczSeq SeqPair The program polar XCZ sequence. ncResolution IMachiningMotionResolution The machining motion resolution. Returns int The calculated step number. UpdateStepNumByCl(DVec3d, DVec3d, ICoordinateConverter, double, double, ref int) Updates the step number based on cutter location points. public static void UpdateStepNumByCl(DVec3d mcXyzabc0, DVec3d mcXyzabc1, ICoordinateConverter coordinateConverter, double compensationHeight, double linearResolution_mm, ref int stepNum) Parameters mcXyzabc0 DVec3d The starting machine coordinate. mcXyzabc1 DVec3d The ending machine coordinate. coordinateConverter ICoordinateConverter The coordinate converter to use. compensationHeight double The compensation height value. linearResolution_mm double The linear resolution in millimeters. stepNum int The step number to update." }, "api/Hi.Numerical.Acts.IAct.html": { "href": "api/Hi.Numerical.Acts.IAct.html", @@ -3377,7 +3497,7 @@ "api/Hi.Numerical.Acts.IActClMove.html": { "href": "api/Hi.Numerical.Acts.IActClMove.html", "title": "Interface IActClMove | HiAPI-C# 2025", - "summary": "Interface IActClMove Namespace Hi.Numerical.Acts Assembly HiMech.dll Interface for actions that involve cutter location movement. This interface defines the contract for tool path movements in machining operations. public interface IActClMove : IAct 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 This interface is used for: Tool path planning Cutter location trajectory definition Movement coordination Path interpolation Implementations should handle: Path geometry and kinematics Movement constraints Coordinate transformations Tool orientation Methods GetClPath() Retrieves the cutter location path associated with this movement action. IClPath GetClPath() Returns IClPath The cutter location path defining: Movement trajectory Tool positions and orientations Path geometry Movement constraints Remarks The returned path should: Be properly initialized and valid Include all necessary movement parameters Consider machine kinematics constraints Support interpolation if needed" + "summary": "Interface IActClMove Namespace Hi.Numerical.Acts Assembly HiMech.dll Interface for actions that involve cutter location movement. This interface defines the contract for tool path movements in machining operations. public interface IActClMove : IAct Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) ActUtil.GetClSteps(IActClMove, int, IMachiningMotionResolution) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Remarks This interface is used for: Tool path planning Cutter location trajectory definition Movement coordination Path interpolation Implementations should handle: Path geometry and kinematics Movement constraints Coordinate transformations Tool orientation Methods GetClPath() Retrieves the cutter location path associated with this movement action. IClPath GetClPath() Returns IClPath The cutter location path defining: Movement trajectory Tool positions and orientations Path geometry Movement constraints Remarks The returned path should: Be properly initialized and valid Include all necessary movement parameters Consider machine kinematics constraints Support interpolation if needed GetClSteps(IMachiningMotionResolution) IEnumerable GetClSteps(IMachiningMotionResolution ncResolution) Parameters ncResolution IMachiningMotionResolution Returns IEnumerable" }, "api/Hi.Numerical.Acts.IActDuration.html": { "href": "api/Hi.Numerical.Acts.IActDuration.html", @@ -3404,6 +3524,11 @@ "title": "Interface IActSkip | HiAPI-C# 2025", "summary": "Interface IActSkip Namespace Hi.Numerical.Acts Assembly HiMech.dll Interface for actions that should be skipped during normal processing. Acts as a marker interface to identify actions that should not be executed. public interface IActSkip : IAct 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)" }, + "api/Hi.Numerical.Acts.IActTooling.html": { + "href": "api/Hi.Numerical.Acts.IActTooling.html", + "title": "Interface IActTooling | HiAPI-C# 2025", + "summary": "Interface IActTooling Namespace Hi.Numerical.Acts Assembly HiMech.dll public interface IActTooling : IAct 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) Properties ToolId int ToolId { get; set; } Property Value int" + }, "api/Hi.Numerical.Acts.IWorkTimeAttrib.html": { "href": "api/Hi.Numerical.Acts.IWorkTimeAttrib.html", "title": "Interface IWorkTimeAttrib | HiAPI-C# 2025", @@ -3422,7 +3547,7 @@ "api/Hi.Numerical.Acts.html": { "href": "api/Hi.Numerical.Acts.html", "title": "Namespace Hi.Numerical.Acts | HiAPI-C# 2025", - "summary": "Namespace Hi.Numerical.Acts Classes ActClArc Represents an arc movement action for cutter location. ActClLinear Represents a linear cutter location movement action. ActClTeleport Represents a teleport action for cutter location, allowing instant position change without movement. ActCooling Represents a cooling action for machining operations. ActDelay Represents a delay action in machining operations. This class implements a simple time delay in the machining process. ActFeedrate Represents a feedrate action for controlling the speed of machining operations. ActHiddenStateChanged Represents an action that indicates a change in the hidden state of an object. This action is typically skipped during normal processing. ActIntentionalSkip Represents an action that is intentionally skipped during processing. Used to explicitly mark operations that should be bypassed. ActLineBegin Represents the beginning of a line act in numerical control operations. ActLineCsScript Cs Script on one Line. ActLineEnd Represents the end of a line act in numerical control operations. ActLinearClAndLinearMcAbcMcXyzabcContour Represents a combined linear movement in both cutter location and machine coordinates. This class handles synchronized linear interpolation of tool position and orientation. ActMcPolarLinearContour Polar MCZ linear contour. ActMcXyzLinearContour Action of Machine Coordinate XYZABC contour by Machine Coordinate linear interpolation. The ABC values should be identity. ActMcXyzStep Action representing a machine coordinate XYZ step movement. This class handles linear positioning in machine coordinates. ActMcXyzabcOrientableLinearContour Action of Machine Coordinate XYZABC contour by Machine Coordinate orientable linear interpolation. This class handles complex tool movements with both position and orientation control. ActMcXyzabcStep Action of Machine coordinate XYCABC Step. ActRapid Rapid feedrate. ActSpindleSpeed Represents an act that controls the spindle speed in numerical control operations. ActSpiralMcXyzContour Represents a spiral contour movement in machine XYZ coordinates. ActStateRunner Manages the state of numerical control operations during runtime. ActTooling Represents a tooling operation act in numerical control operations. This class handles tool changes and related operations in the machining process. ActUnknownSkip Represents an act that skips unknown operations in numerical control. ActUtil Provides utility methods for numerical control actions. Interfaces IAct Action parsing from NC, CL, NC Steps and etc., for controlling the mechanism and the mechanism simulation process. IActClMove Interface for actions that involve cutter location movement. This interface defines the contract for tool path movements in machining operations. IActDuration Interface for actions that have a specific duration. This interface is used to define actions that take a measurable amount of time to complete. IActMachineStep IActMcXyzContour Interface for actions that represent machine XYZ contours. IActMcXyzabcContour Interface for actions that represent machine XYZABC contours. IActSkip Interface for actions that should be skipped during normal processing. Acts as a marker interface to identify actions that should not be executed. IWorkTimeAttrib Interface for objects that provide both read and write access to work time. Combines the functionality of IWorkTimeGetter and IWorkTimeSetter. IWorkTimeGetter Interface for objects that provide read-only access to work time. This interface is part of the work time tracking system for machining operations. IWorkTimeSetter Interface for objects that provide write-only access to work time. This interface is used for components that need to update work time without reading it." + "summary": "Namespace Hi.Numerical.Acts Classes ActClArc Represents an arc movement action for cutter location. ActClLinear Represents a linear cutter location movement action. ActClStep ActClTeleport Represents a teleport action for cutter location, allowing instant position change without movement. ActCooling Represents a cooling action for machining operations. ActDelay Represents a delay action in machining operations. This class implements a simple time delay in the machining process. ActFeedrate Represents a feedrate action for controlling the speed of machining operations. ActHiddenStateChanged Represents an action that indicates a change in the hidden state of an object. This action is typically skipped during normal processing. ActIntentionalSkip Represents an action that is intentionally skipped during processing. Used to explicitly mark operations that should be bypassed. ActLineBegin Represents the beginning of a line act in numerical control operations. ActLineCsScript Cs Script on one Line. ActLineEnd Represents the end of a line act in numerical control operations. ActLinearClAndLinearMcAbcMcXyzabcContour Represents a combined linear movement in both cutter location and machine coordinates. This class handles synchronized linear interpolation of tool position and orientation. ActMcPolarLinearContour Polar MCZ linear contour. ActMcXyzLinearContour Action of Machine Coordinate XYZABC contour by Machine Coordinate linear interpolation. The ABC values should be identity. ActMcXyzStep Action representing a machine coordinate XYZ step movement. This class handles linear positioning in machine coordinates. ActMcXyzabcOrientableLinearContour Action of Machine Coordinate XYZABC contour by Machine Coordinate orientable linear interpolation. This class handles complex tool movements with both position and orientation control. ActMcXyzabcStep Action of Machine coordinate XYCABC Step. ActRapid Rapid feedrate. ActSpindleSpeed Represents an act that controls the spindle speed in numerical control operations. ActSpiralMcXyzContour Represents a spiral contour movement in machine XYZ coordinates. ActStateRunner Manages the state of numerical control operations during runtime. ActToolingStep Action of equiping the tool with machining step operation such as collision detection and volume removal. ActToolingTeleport Action of Equiping the tool without machining step operation such as collision detection and volume removal. ActUnknownSkip Represents an act that skips unknown operations in numerical control. ActUtil Provides utility methods for numerical control actions. Interfaces IAct Action parsing from NC, CL, NC Steps and etc., for controlling the mechanism and the mechanism simulation process. IActClMove Interface for actions that involve cutter location movement. This interface defines the contract for tool path movements in machining operations. IActDuration Interface for actions that have a specific duration. This interface is used to define actions that take a measurable amount of time to complete. IActMachineStep IActMcXyzContour Interface for actions that represent machine XYZ contours. IActMcXyzabcContour Interface for actions that represent machine XYZABC contours. IActSkip Interface for actions that should be skipped during normal processing. Acts as a marker interface to identify actions that should not be executed. IActTooling IWorkTimeAttrib Interface for objects that provide both read and write access to work time. Combines the functionality of IWorkTimeGetter and IWorkTimeSetter. IWorkTimeGetter Interface for objects that provide read-only access to work time. This interface is part of the work time tracking system for machining operations. IWorkTimeSetter Interface for objects that provide write-only access to work time. This interface is used for components that need to update work time without reading it." }, "api/Hi.Numerical.CncBrand.html": { "href": "api/Hi.Numerical.CncBrand.html", @@ -3437,7 +3562,7 @@ "api/Hi.Numerical.CoordinateEntryDisplayee.html": { "href": "api/Hi.Numerical.CoordinateEntryDisplayee.html", "title": "Class CoordinateEntryDisplayee | HiAPI-C# 2025", - "summary": "Class CoordinateEntryDisplayee Namespace Hi.Numerical Assembly HiUniNc.dll Represents a displayable coordinate entry for CNC programming. public class CoordinateEntryDisplayee : IDisplayee, IExpandToBox3d Inheritance object CoordinateEntryDisplayee Implements IDisplayee IExpandToBox3d 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) Constructors CoordinateEntryDisplayee(Func, Func) Initializes a new instance of the CoordinateEntryDisplayee class. public CoordinateEntryDisplayee(Func ncEnvFunc, Func millingEquipmentSource) Parameters ncEnvFunc Func The function that provides the NcEnv instance. millingEquipmentSource Func The function that provides the machining equipment. Properties HeidenhainCycleDef247Q339 Gets or sets the Heidenhain Cycle Def 247 Q339 value. public int HeidenhainCycleDef247Q339 { get; set; } Property Value int HeidenhainCycleDef7Arg Gets or sets the Heidenhain Cycle Def 7 arguments. public HeidenhainCycleDef7Arg HeidenhainCycleDef7Arg { get; set; } Property Value HeidenhainCycleDef7Arg IsoCoordinateId Gets or sets the ISO coordinate ID. public int IsoCoordinateId { get; set; } Property Value int MillingEquipmentSource Gets or sets the function that provides the machining equipment. public Func MillingEquipmentSource { get; set; } Property Value Func NcEnvFunc Gets or sets the function that provides the NcEnv instance. public Func NcEnvFunc { get; set; } Property Value Func RenderingFlags Gets or sets the rendering flags. public BitArray RenderingFlags { get; set; } Property Value BitArray Remarks cached property. Not output in XML. Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" + "summary": "Class CoordinateEntryDisplayee Namespace Hi.Numerical Assembly HiUniNc.dll Represents a displayable coordinate entry for CNC programming. public class CoordinateEntryDisplayee : IDisplayee, IExpandToBox3d Inheritance object CoordinateEntryDisplayee Implements IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) 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) Constructors CoordinateEntryDisplayee(Func, Func) Initializes a new instance of the CoordinateEntryDisplayee class. public CoordinateEntryDisplayee(Func ncEnvFunc, Func millingEquipmentSource) Parameters ncEnvFunc Func The function that provides the NcEnv instance. millingEquipmentSource Func The function that provides the machining equipment. Properties HeidenhainCycleDef247Q339 Gets or sets the Heidenhain Cycle Def 247 Q339 value. public int HeidenhainCycleDef247Q339 { get; set; } Property Value int HeidenhainCycleDef7Arg Gets or sets the Heidenhain Cycle Def 7 arguments. public HeidenhainCycleDef7Arg HeidenhainCycleDef7Arg { get; set; } Property Value HeidenhainCycleDef7Arg IsoCoordinateId Gets or sets the ISO coordinate ID. public int IsoCoordinateId { get; set; } Property Value int MillingEquipmentSource Gets or sets the function that provides the machining equipment. public Func MillingEquipmentSource { get; set; } Property Value Func NcEnvFunc Gets or sets the function that provides the NcEnv instance. public Func NcEnvFunc { get; set; } Property Value Func RenderingFlags Gets or sets the rendering flags. public BitArray RenderingFlags { get; set; } Property Value BitArray Remarks cached property. Not output in XML. Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box" }, "api/Hi.Numerical.CoordinateEntryRenderingFlag.html": { "href": "api/Hi.Numerical.CoordinateEntryRenderingFlag.html", @@ -3452,7 +3577,7 @@ "api/Hi.Numerical.FilePlayers.NcRunner.html": { "href": "api/Hi.Numerical.FilePlayers.NcRunner.html", "title": "Class NcRunner | HiAPI-C# 2025", - "summary": "Class NcRunner Namespace Hi.Numerical.FilePlayers Assembly HiNc.dll Provides functionality for running and processing NC code lines. public class NcRunner Inheritance object NcRunner 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) Constructors NcRunner(NcEnv, SessionMessageHost) Initializes a new instance of the NcRunner class. public NcRunner(NcEnv ncEnv, SessionMessageHost millingProcessMessage) Parameters ncEnv NcEnv The NC environment settings millingProcessMessage SessionMessageHost The milling process message host Properties FileIndexOnRunCommand Gets the current file index for run commands. public int FileIndexOnRunCommand { get; } Property Value int NcEnv Gets the NC environment settings. public NcEnv NcEnv { get; } Property Value NcEnv NcLines Gets the linked list of NC lines. public LinkedList NcLines { get; } Property Value LinkedList SessionMessageHost External Hosted. public SessionMessageHost SessionMessageHost { get; set; } Property Value SessionMessageHost Methods RunRawNcLines(string, IEnumerable, CancellationToken) Runs raw NC lines and yields NcLine and Act pairs. public IEnumerable<(NcLine NcLine, IAct Act)> RunRawNcLines(string relNcFilePath, IEnumerable lines, CancellationToken cancellationToken) Parameters relNcFilePath string The relative path of the NC file lines IEnumerable The enumerable collection of NC code lines cancellationToken CancellationToken Cancellation token to cancel the operation Returns IEnumerable<(NcLine NcLine, IAct Act)> Enumerable of NcLine and Act pairs RunToLineEnd() Set EnumerablePlayer before use the function. public void RunToLineEnd()" + "summary": "Class NcRunner Namespace Hi.Numerical.FilePlayers Assembly HiNc.dll Provides functionality for running and processing NC code lines. public class NcRunner Inheritance object NcRunner 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) Constructors NcRunner(NcEnv, SessionMessageHost) Initializes a new instance of the NcRunner class. public NcRunner(NcEnv ncEnv, SessionMessageHost millingProcessMessage) Parameters ncEnv NcEnv The NC environment settings millingProcessMessage SessionMessageHost The milling process message host Properties FileIndexOnRunCommand Gets the current file index for run commands. public int FileIndexOnRunCommand { get; } Property Value int NcEnv Gets the NC environment settings. public NcEnv NcEnv { get; set; } Property Value NcEnv NcLines Gets the linked list of NC lines. public LinkedList NcLines { get; } Property Value LinkedList SessionMessageHost External Hosted. public SessionMessageHost SessionMessageHost { get; set; } Property Value SessionMessageHost Methods RunRawNcLines(string, IEnumerable, CancellationToken) Runs raw NC lines and yields NcLine and Act pairs. public IEnumerable<(NcLine NcLine, IAct Act)> RunRawNcLines(string relNcFilePath, IEnumerable lines, CancellationToken cancellationToken) Parameters relNcFilePath string The relative path of the NC file lines IEnumerable The enumerable collection of NC code lines cancellationToken CancellationToken Cancellation token to cancel the operation Returns IEnumerable<(NcLine NcLine, IAct Act)> Enumerable of NcLine and Act pairs RunToLineEnd() Set EnumerablePlayer before use the function. public void RunToLineEnd()" }, "api/Hi.Numerical.FilePlayers.html": { "href": "api/Hi.Numerical.FilePlayers.html", @@ -3464,6 +3589,11 @@ "title": "Class FlexDictionaryUtil | HiAPI-C# 2025", "summary": "Class FlexDictionaryUtil Namespace Hi.Numerical Assembly HiMech.dll Utility for flexible dictionary operations. public static class FlexDictionaryUtil Inheritance object FlexDictionaryUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods CallFlexDictionary(IFlexDictionaryHost) Calls the flex dictionary of the source, initializing it if null. public static Dictionary CallFlexDictionary(this IFlexDictionaryHost src) Parameters src IFlexDictionaryHost The flex dictionary host Returns Dictionary The dictionary from the host Type Parameters T The type of values in the dictionary GetFlexDictionaryBytes(IFlexDictionaryHost, IntegerKeyDictionaryConverter) Gets the flex dictionary as a byte array. public static byte[] GetFlexDictionaryBytes(this IFlexDictionaryHost src, IntegerKeyDictionaryConverter converter) Parameters src IFlexDictionaryHost The flex dictionary host converter IntegerKeyDictionaryConverter The converter for integer keys Returns byte[] Byte array representation of the dictionary Type Parameters T The type of values in the dictionary ReadFlexDictionary(BinaryReader, IntegerKeyDictionaryConverter) Reads a flex dictionary from a binary reader. public static Dictionary ReadFlexDictionary(BinaryReader reader, IntegerKeyDictionaryConverter converter) Parameters reader BinaryReader The binary reader to read from converter IntegerKeyDictionaryConverter The converter for integer keys Returns Dictionary The restored dictionary WriteFlexDictionary(IFlexDictionaryHost, BinaryWriter, IntegerKeyDictionaryConverter) Writes a flex dictionary to a binary writer. public static void WriteFlexDictionary(this IFlexDictionaryHost src, BinaryWriter writer, IntegerKeyDictionaryConverter converter) Parameters src IFlexDictionaryHost The flex dictionary host writer BinaryWriter The binary writer to write to converter IntegerKeyDictionaryConverter The converter for integer keys Type Parameters T The type of values in the dictionary" }, + "api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html": { + "href": "api/Hi.Numerical.HeidenhainCoordinateEntryDisplayee.html", + "title": "Class HeidenhainCoordinateEntryDisplayee | HiAPI-C# 2025", + "summary": "Class HeidenhainCoordinateEntryDisplayee Namespace Hi.Numerical Assembly HiUniNc.dll public class HeidenhainCoordinateEntryDisplayee : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d Inheritance object HeidenhainCoordinateEntryDisplayee Implements IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors HeidenhainCoordinateEntryDisplayee(Func, Func) Initializes a new instance. public HeidenhainCoordinateEntryDisplayee(Func ncEnvFunc, Func millingEquipmentSource) Parameters ncEnvFunc Func The function that provides the NcEnv instance. millingEquipmentSource Func The function that provides the machining equipment. Properties HeidenhainCycleDef247Q339 Gets or sets the Heidenhain Cycle Def 247 Q339 value. public int HeidenhainCycleDef247Q339 { get; set; } Property Value int HeidenhainCycleDef7Arg Gets or sets the Heidenhain Cycle Def 7 arguments. public HeidenhainCycleDef7Arg HeidenhainCycleDef7Arg { get; set; } Property Value HeidenhainCycleDef7Arg MillingEquipmentFunc Gets or sets the function that provides the machining equipment. public Func MillingEquipmentFunc { get; set; } Property Value Func NcEnvFunc Gets or sets the function that provides the NcEnv instance. public Func NcEnvFunc { get; set; } Property Value Func ShowHeidenhainDatumPreset public bool ShowHeidenhainDatumPreset { get; set; } Property Value bool ShowHeidenhainDatumShift public bool ShowHeidenhainDatumShift { get; set; } Property Value bool Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor" + }, "api/Hi.Numerical.IFlexDictionaryHost-1.html": { "href": "api/Hi.Numerical.IFlexDictionaryHost-1.html", "title": "Interface IFlexDictionaryHost | HiAPI-C# 2025", @@ -3489,35 +3619,40 @@ "title": "Interface ISetSpindleSpeed | HiAPI-C# 2025", "summary": "Interface ISetSpindleSpeed Namespace Hi.Numerical Assembly HiGeom.dll Interface for setting spindle speed. public interface ISetSpindleSpeed Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) NumericUtil.SetSpindleSpeed_rpm(ISetSpindleSpeed, double) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods SetSpindleSpeed_radds(double) Sets the spindle speed in radians per second. void SetSpindleSpeed_radds(double spindleSpeed_radds) Parameters spindleSpeed_radds double Spindle speed value in rad/s" }, + "api/Hi.Numerical.IsoCoordinateEntryDisplayee.html": { + "href": "api/Hi.Numerical.IsoCoordinateEntryDisplayee.html", + "title": "Class IsoCoordinateEntryDisplayee | HiAPI-C# 2025", + "summary": "Class IsoCoordinateEntryDisplayee Namespace Hi.Numerical Assembly HiUniNc.dll public class IsoCoordinateEntryDisplayee : IAnchoredDisplayee, IGetAnchor, IGetTopoIndex, IDisplayee, IExpandToBox3d Inheritance object IsoCoordinateEntryDisplayee Implements IAnchoredDisplayee IGetAnchor IGetTopoIndex IDisplayee IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods DispUtil.Display(IDisplayee, Bind, Mat4d) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors IsoCoordinateEntryDisplayee(Func, Func) public IsoCoordinateEntryDisplayee(Func ncEnvFunc, Func millingEquipmentSource) Parameters ncEnvFunc Func millingEquipmentSource Func Properties IsoCoordinateId Gets or sets the ISO coordinate ID. public int IsoCoordinateId { get; set; } Property Value int MillingEquipmentFunc Gets or sets the function that provides the machining equipment. public Func MillingEquipmentFunc { get; set; } Property Value Func NcEnvFunc Gets or sets the function that provides the NcEnv instance. public Func NcEnvFunc { get; set; } Property Value Func Methods Display(Bind) Display function called in DispEngine rendering loop. public void Display(Bind bind) Parameters bind Bind Bind with DispEngine. See Bind. ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor" + }, "api/Hi.Numerical.IsoCoordinateTable.html": { "href": "api/Hi.Numerical.IsoCoordinateTable.html", "title": "Class IsoCoordinateTable | HiAPI-C# 2025", - "summary": "Class IsoCoordinateTable Namespace Hi.Numerical Assembly HiUniNc.dll Coordinate table for NC controller. The dictionary key is 1000times coordinate index (ex. G54 is 54000); the dictionary value is machine coordinate. public class IsoCoordinateTable : Dictionary, IDictionary, ICollection>, IReadOnlyDictionary, IReadOnlyCollection>, IEnumerable>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IMakeXmlSource Inheritance object Dictionary IsoCoordinateTable Implements IDictionary ICollection> IReadOnlyDictionary IReadOnlyCollection> IEnumerable> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable IMakeXmlSource Inherited Members Dictionary.Add(int, Vec3d) Dictionary.Clear() Dictionary.ContainsKey(int) Dictionary.ContainsValue(Vec3d) Dictionary.EnsureCapacity(int) Dictionary.GetAlternateLookup() Dictionary.GetEnumerator() Dictionary.OnDeserialization(object) Dictionary.Remove(int) Dictionary.Remove(int, out Vec3d) Dictionary.TrimExcess() Dictionary.TrimExcess(int) Dictionary.TryAdd(int, Vec3d) Dictionary.TryGetAlternateLookup(out Dictionary.AlternateLookup) Dictionary.TryGetValue(int, out Vec3d) Dictionary.Comparer Dictionary.Count Dictionary.Capacity Dictionary.this[int] Dictionary.Keys Dictionary.Values 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) DictionaryUtil.Retrieve(Dictionary, K, out V, bool) DictionaryUtil.TryGetValueByKeys(IDictionary, IEnumerable, out TValue) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors IsoCoordinateTable() Ctor. public IsoCoordinateTable() IsoCoordinateTable(XElement) Initializes a new instance of the IsoCoordinateTable class from XML. public IsoCoordinateTable(XElement src) Parameters src XElement The XML element containing coordinate data. Fields XName Gets the XML element name for the IsoCoordinateTable. public static string XName Field Value string Methods GetCoordinateString(int) Gets the coordinate string representation for a given coordinate key. public string GetCoordinateString(int coordinateKey) Parameters coordinateKey int The coordinate key to get the string for. Returns string A string representation of the coordinate, e.g. “G54” for key 54000. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class IsoCoordinateTable Namespace Hi.Numerical Assembly HiUniNc.dll Coordinate table for NC controller. The dictionary key is 1000times coordinate index (ex. G54 is 54000); the dictionary value is machine coordinate. public class IsoCoordinateTable : Dictionary, IDictionary, ICollection>, IReadOnlyDictionary, IReadOnlyCollection>, IEnumerable>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IMakeXmlSource Inheritance object Dictionary IsoCoordinateTable Implements IDictionary ICollection> IReadOnlyDictionary IReadOnlyCollection> IEnumerable> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable IMakeXmlSource Inherited Members Dictionary.Add(int, Vec3d) Dictionary.Clear() Dictionary.ContainsKey(int) Dictionary.ContainsValue(Vec3d) Dictionary.EnsureCapacity(int) Dictionary.GetAlternateLookup() Dictionary.GetEnumerator() Dictionary.OnDeserialization(object) Dictionary.Remove(int) Dictionary.Remove(int, out Vec3d) Dictionary.TrimExcess() Dictionary.TrimExcess(int) Dictionary.TryAdd(int, Vec3d) Dictionary.TryGetAlternateLookup(out Dictionary.AlternateLookup) Dictionary.TryGetValue(int, out Vec3d) Dictionary.Comparer Dictionary.Count Dictionary.Capacity Dictionary.this[int] Dictionary.Keys Dictionary.Values 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) DictionaryUtil.Retrieve(Dictionary, K, out V, bool) DictionaryUtil.TryGetValueByKeys(IDictionary, IEnumerable, out TValue) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors IsoCoordinateTable() Ctor. public IsoCoordinateTable() IsoCoordinateTable(XElement) Initializes a new instance of the IsoCoordinateTable class from XML. public IsoCoordinateTable(XElement src) Parameters src XElement The XML element containing coordinate data. Fields XName Gets the XML element name for the IsoCoordinateTable. public static string XName Field Value string Methods GetCoordinateString(int) Gets the coordinate string representation for a given coordinate key. public string GetCoordinateString(int coordinateKey) Parameters coordinateKey int The coordinate key to get the string for. Returns string A string representation of the coordinate, e.g. “G54” for key 54000. 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." }, "api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html": { "href": "api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerCycleMachiningMotionResolution.html", "title": "Class FeedPerCycleMachiningMotionResolution | HiAPI-C# 2025", - "summary": "Class FeedPerCycleMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Automatic resolution by feed per spindle cycle. public class FeedPerCycleMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource Inheritance object FeedPerCycleMachiningMotionResolution Implements IMachiningMotionResolution IMakeXmlSource 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) Constructors FeedPerCycleMachiningMotionResolution() Ctor. public FeedPerCycleMachiningMotionResolution() FeedPerCycleMachiningMotionResolution(XElement) Ctor. public FeedPerCycleMachiningMotionResolution(XElement src) Parameters src XElement XML Properties LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; } Property Value double Remarks setter is for internal usage RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; } Property Value double Remarks setter is for internal usage RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; } Property Value double Remarks setter is for internal usage XName Name for XML IO. public static string XName { get; } Property Value string Methods AdjustResolution(double, double) Adjusts the resolution based on feed rate and spindle speed. public void AdjustResolution(double feedrate_mmds, double spindleSpeed_radds) Parameters feedrate_mmds double Feed rate in mm per second spindleSpeed_radds double Spindle speed in radians per second MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FeedPerCycleMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Automatic resolution by feed per spindle cycle. public class FeedPerCycleMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource, IToXElement Inheritance object FeedPerCycleMachiningMotionResolution Implements IMachiningMotionResolution IMakeXmlSource IToXElement 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) Constructors FeedPerCycleMachiningMotionResolution() Ctor. public FeedPerCycleMachiningMotionResolution() FeedPerCycleMachiningMotionResolution(XElement) Ctor. public FeedPerCycleMachiningMotionResolution(XElement src) Parameters src XElement XML Properties LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; } Property Value double Remarks setter is for internal usage RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; } Property Value double Remarks setter is for internal usage RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; } Property Value double Remarks setter is for internal usage XName Name for XML IO. public static string XName { get; } Property Value string Methods AdjustResolution(double, double) Adjusts the resolution based on feed rate and spindle speed. public void AdjustResolution(double feedrate_mmds, double spindleSpeed_radds) Parameters feedrate_mmds double Feed rate in mm per second spindleSpeed_radds double Spindle speed in radians per second 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html": { "href": "api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothMachiningMotionResolution.html", "title": "Class FeedPerToothMachiningMotionResolution | HiAPI-C# 2025", - "summary": "Class FeedPerToothMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Automatic resolution by feed per tooth. public class FeedPerToothMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource Inheritance object FeedPerToothMachiningMotionResolution Implements IMachiningMotionResolution IMakeXmlSource 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) Constructors FeedPerToothMachiningMotionResolution() Ctor. public FeedPerToothMachiningMotionResolution() Properties EnableCutOnlyOnFlutePeriodIntegralMultiple Gets or sets a value indicating whether cutting should only occur on integral multiples of the flute period. This is a configuration option that affects the cutting behavior. public bool EnableCutOnlyOnFlutePeriodIntegralMultiple { get; set; } Property Value bool LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; } Property Value double Remarks setter is for internal usage RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; set; } Property Value double Remarks setter is for internal usage RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; } Property Value double Remarks setter is for internal usage XName Name for XML IO. public static string XName { get; } Property Value string Methods AdjustResolution(int, double, double) Adjusts the resolution based on flute number, feed rate and spindle speed. public void AdjustResolution(int fluteNum, double feedrate_mmds, double spindleSpeed_radds) Parameters fluteNum int Number of flutes in the cutting tool feedrate_mmds double Feed rate in mm per second spindleSpeed_radds double Spindle speed in radians per second MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FeedPerToothMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Automatic resolution by feed per tooth. public class FeedPerToothMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource, IToXElement Inheritance object FeedPerToothMachiningMotionResolution Implements IMachiningMotionResolution IMakeXmlSource IToXElement 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) Constructors FeedPerToothMachiningMotionResolution() Ctor. public FeedPerToothMachiningMotionResolution() Properties EnableCutOnlyOnFlutePeriodIntegralMultiple Gets or sets a value indicating whether cutting should only occur on integral multiples of the flute period. This is a configuration option that affects the cutting behavior. public bool EnableCutOnlyOnFlutePeriodIntegralMultiple { get; set; } Property Value bool LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; } Property Value double Remarks setter is for internal usage RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; set; } Property Value double Remarks setter is for internal usage RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; } Property Value double Remarks setter is for internal usage XName Name for XML IO. public static string XName { get; } Property Value string Methods AdjustResolution(int, double, double) Adjusts the resolution based on flute number, feed rate and spindle speed. public void AdjustResolution(int fluteNum, double feedrate_mmds, double spindleSpeed_radds) Parameters fluteNum int Number of flutes in the cutting tool feedrate_mmds double Feed rate in mm per second spindleSpeed_radds double Spindle speed in radians per second 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html": { "href": "api/Hi.Numerical.MachiningMotionResolutionUtils.FeedPerToothNcResolution0.html", "title": "Class FeedPerToothNcResolution0 | HiAPI-C# 2025", - "summary": "Class FeedPerToothNcResolution0 Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Automatic resolution by feed per tooth. public class FeedPerToothNcResolution0 : IMachiningMotionResolution, IMakeXmlSource Inheritance object FeedPerToothNcResolution0 Implements IMachiningMotionResolution IMakeXmlSource 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) Constructors FeedPerToothNcResolution0() Ctor. public FeedPerToothNcResolution0() FeedPerToothNcResolution0(XElement) Ctor. public FeedPerToothNcResolution0(XElement src) Parameters src XElement XML Properties LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; } Property Value double Remarks setter is for internal usage MillingToolFluteMap Internal use. MillingToolFluteMap. Transient data. public object MillingToolFluteMap { get; set; } Property Value object RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; set; } Property Value double Remarks setter is for internal usage RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; } Property Value double Remarks setter is for internal usage XName Name for XML IO. public static string XName { get; } Property Value string Methods AdjustResolution(int, double, double) Adjusts the resolution based on flute number, feed rate and spindle speed. public void AdjustResolution(int fluteNum, double feedrate_mmds, double spindleSpeed_radds) Parameters fluteNum int Number of flutes in the cutting tool feedrate_mmds double Feed rate in mm per second spindleSpeed_radds double Spindle speed in radians per second MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FeedPerToothNcResolution0 Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Automatic resolution by feed per tooth. public class FeedPerToothNcResolution0 : IMachiningMotionResolution, IMakeXmlSource, IToXElement Inheritance object FeedPerToothNcResolution0 Implements IMachiningMotionResolution IMakeXmlSource IToXElement 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) Constructors FeedPerToothNcResolution0() Ctor. public FeedPerToothNcResolution0() FeedPerToothNcResolution0(XElement) Ctor. public FeedPerToothNcResolution0(XElement src) Parameters src XElement XML Properties LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; } Property Value double Remarks setter is for internal usage MillingToolFluteMap Internal use. MillingToolFluteMap. Transient data. public object MillingToolFluteMap { get; set; } Property Value object RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; set; } Property Value double Remarks setter is for internal usage RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; } Property Value double Remarks setter is for internal usage XName Name for XML IO. public static string XName { get; } Property Value string Methods AdjustResolution(int, double, double) Adjusts the resolution based on flute number, feed rate and spindle speed. public void AdjustResolution(int fluteNum, double feedrate_mmds, double spindleSpeed_radds) Parameters fluteNum int Number of flutes in the cutting tool feedrate_mmds double Feed rate in mm per second spindleSpeed_radds double Spindle speed in radians per second 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html": { "href": "api/Hi.Numerical.MachiningMotionResolutionUtils.FixedMachiningMotionResolution.html", "title": "Class FixedMachiningMotionResolution | HiAPI-C# 2025", - "summary": "Class FixedMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Represents a fixed machining motion resolution with user-defined values. public class FixedMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource Inheritance object FixedMachiningMotionResolution Implements IMachiningMotionResolution IMakeXmlSource 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) Constructors FixedMachiningMotionResolution() Ctor. public FixedMachiningMotionResolution() FixedMachiningMotionResolution(double, double) Ctor. public FixedMachiningMotionResolution(double linearResolution_mm, double rotaryResolution_deg) Parameters linearResolution_mm double rotaryResolution_deg double FixedMachiningMotionResolution(XElement) Ctor. public FixedMachiningMotionResolution(XElement src) Parameters src XElement XML Properties LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; set; } Property Value double RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; set; } Property Value double RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class FixedMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Represents a fixed machining motion resolution with user-defined values. public class FixedMachiningMotionResolution : IMachiningMotionResolution, IMakeXmlSource, IToXElement Inheritance object FixedMachiningMotionResolution Implements IMachiningMotionResolution IMakeXmlSource IToXElement 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) Constructors FixedMachiningMotionResolution() Ctor. public FixedMachiningMotionResolution() FixedMachiningMotionResolution(double, double) Ctor. public FixedMachiningMotionResolution(double linearResolution_mm, double rotaryResolution_deg) Parameters linearResolution_mm double rotaryResolution_deg double FixedMachiningMotionResolution(XElement) Ctor. public FixedMachiningMotionResolution(XElement src) Parameters src XElement XML Properties LinearResolution_mm Linear axis resolution in millimeter. public double LinearResolution_mm { get; set; } Property Value double RotaryResolution_deg Rotary axis resolution in degree. public double RotaryResolution_deg { get; set; } Property Value double RotaryResolution_rad Rotary axis resolution in radian. public double RotaryResolution_rad { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html": { "href": "api/Hi.Numerical.MachiningMotionResolutionUtils.IMachiningMotionResolution.html", "title": "Interface IMachiningMotionResolution | HiAPI-C# 2025", - "summary": "Interface IMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Interface of Machining Cycle Resolution. public interface IMachiningMotionResolution : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string) 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) Properties LinearResolution_mm Linear axis resolution in millimeter. double LinearResolution_mm { get; } Property Value double RotaryResolution_deg Rotary axis resolution in degree. double RotaryResolution_deg { get; } Property Value double RotaryResolution_rad Rotary axis resolution in radian. double RotaryResolution_rad { get; } Property Value double" + "summary": "Interface IMachiningMotionResolution Namespace Hi.Numerical.MachiningMotionResolutionUtils Assembly HiMech.dll Interface of Machining Cycle Resolution. public interface IMachiningMotionResolution : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Properties LinearResolution_mm Linear axis resolution in millimeter. double LinearResolution_mm { get; } Property Value double RotaryResolution_deg Rotary axis resolution in degree. double RotaryResolution_deg { get; } Property Value double RotaryResolution_rad Rotary axis resolution in radian. double RotaryResolution_rad { get; } Property Value double" }, "api/Hi.Numerical.MachiningMotionResolutionUtils.html": { "href": "api/Hi.Numerical.MachiningMotionResolutionUtils.html", @@ -3532,7 +3667,7 @@ "api/Hi.Numerical.MillingToolOffsetTable.html": { "href": "api/Hi.Numerical.MillingToolOffsetTable.html", "title": "Class MillingToolOffsetTable | HiAPI-C# 2025", - "summary": "Class MillingToolOffsetTable Namespace Hi.Numerical Assembly HiUniNc.dll Offset table for milling tool. The key is tool ID. public class MillingToolOffsetTable : Dictionary, IDictionary, ICollection>, IReadOnlyDictionary, IReadOnlyCollection>, IEnumerable>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IMakeXmlSource Inheritance object Dictionary MillingToolOffsetTable Implements IDictionary ICollection> IReadOnlyDictionary IReadOnlyCollection> IEnumerable> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable IMakeXmlSource Inherited Members Dictionary.Add(int, MillingToolOffsetTableRow) Dictionary.Clear() Dictionary.ContainsKey(int) Dictionary.ContainsValue(MillingToolOffsetTableRow) Dictionary.EnsureCapacity(int) Dictionary.GetAlternateLookup() Dictionary.GetEnumerator() Dictionary.OnDeserialization(object) Dictionary.Remove(int) Dictionary.Remove(int, out MillingToolOffsetTableRow) Dictionary.TrimExcess() Dictionary.TrimExcess(int) Dictionary.TryAdd(int, MillingToolOffsetTableRow) Dictionary.TryGetAlternateLookup(out Dictionary.AlternateLookup) Dictionary.TryGetValue(int, out MillingToolOffsetTableRow) Dictionary.Comparer Dictionary.Count Dictionary.Capacity Dictionary.this[int] Dictionary.Keys Dictionary.Values 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) DictionaryUtil.Retrieve(Dictionary, K, out V, bool) DictionaryUtil.TryGetValueByKeys(IDictionary, IEnumerable, out TValue) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MillingToolOffsetTable() Initializes a new instance of the MillingToolOffsetTable class. public MillingToolOffsetTable() MillingToolOffsetTable(MillingToolOffsetTable) Initializes a new instance of the MillingToolOffsetTable class by copying an existing table. public MillingToolOffsetTable(MillingToolOffsetTable src) Parameters src MillingToolOffsetTable The source table to copy. MillingToolOffsetTable(XElement) Initializes a new instance of the MillingToolOffsetTable class from XML. public MillingToolOffsetTable(XElement src) Parameters src XElement The XML element containing tool offset data. Fields XName Gets the XML element name for the MillingToolOffsetTable. public static string XName Field Value string Methods MakeXmlSource(string, string) Creates an XML representation of this offset table. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for relative paths. relFile string The relative file path. Returns XElement An XML element representing this offset table. UpdateIdealMillingToolOffsetTableByToolHouse(MachiningToolHouse) Updates the ideal tool offsets in this table based on a tool house. public void UpdateIdealMillingToolOffsetTableByToolHouse(MachiningToolHouse millingToolHouse) Parameters millingToolHouse MachiningToolHouse The machining tool house containing tool information." + "summary": "Class MillingToolOffsetTable Namespace Hi.Numerical Assembly HiUniNc.dll Offset table for milling tool. The key is Offset ID (H or D in NC code). public class MillingToolOffsetTable : Dictionary, IDictionary, ICollection>, IReadOnlyDictionary, IReadOnlyCollection>, IEnumerable>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IMakeXmlSource Inheritance object Dictionary MillingToolOffsetTable Implements IDictionary ICollection> IReadOnlyDictionary IReadOnlyCollection> IEnumerable> IDictionary ICollection IEnumerable IDeserializationCallback ISerializable IMakeXmlSource Inherited Members Dictionary.Add(int, MillingToolOffsetTableRow) Dictionary.Clear() Dictionary.ContainsKey(int) Dictionary.ContainsValue(MillingToolOffsetTableRow) Dictionary.EnsureCapacity(int) Dictionary.GetAlternateLookup() Dictionary.GetEnumerator() Dictionary.OnDeserialization(object) Dictionary.Remove(int) Dictionary.Remove(int, out MillingToolOffsetTableRow) Dictionary.TrimExcess() Dictionary.TrimExcess(int) Dictionary.TryAdd(int, MillingToolOffsetTableRow) Dictionary.TryGetAlternateLookup(out Dictionary.AlternateLookup) Dictionary.TryGetValue(int, out MillingToolOffsetTableRow) Dictionary.Comparer Dictionary.Count Dictionary.Capacity Dictionary.this[int] Dictionary.Keys Dictionary.Values 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) DictionaryUtil.Retrieve(Dictionary, K, out V, bool) DictionaryUtil.TryGetValueByKeys(IDictionary, IEnumerable, out TValue) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors MillingToolOffsetTable() Initializes a new instance of the MillingToolOffsetTable class. public MillingToolOffsetTable() MillingToolOffsetTable(MillingToolOffsetTable) Initializes a new instance of the MillingToolOffsetTable class by copying an existing table. public MillingToolOffsetTable(MillingToolOffsetTable src) Parameters src MillingToolOffsetTable The source table to copy. MillingToolOffsetTable(XElement) Initializes a new instance of the MillingToolOffsetTable class from XML. public MillingToolOffsetTable(XElement src) Parameters src XElement The XML element containing tool offset data. Fields XName Gets the XML element name for the MillingToolOffsetTable. public static string XName Field Value string Methods MakeXmlSource(string, string, bool) Creates an XML representation of this offset table. public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly) Parameters baseDirectory string The base directory for relative paths. relFile string The relative file path. exhibitionOnly bool Returns XElement An XML element representing this offset table. UpdateIdealMillingToolOffsetTableByToolHouse(MachiningToolHouse) Updates the ideal tool offsets in this table based on a tool house. public void UpdateIdealMillingToolOffsetTableByToolHouse(MachiningToolHouse millingToolHouse) Parameters millingToolHouse MachiningToolHouse The machining tool house containing tool information." }, "api/Hi.Numerical.MillingToolOffsetTableRow.html": { "href": "api/Hi.Numerical.MillingToolOffsetTableRow.html", @@ -3617,7 +3752,7 @@ "api/Hi.Numerical.NcEnv.html": { "href": "api/Hi.Numerical.NcEnv.html", "title": "Class NcEnv | HiAPI-C# 2025", - "summary": "Class NcEnv Namespace Hi.Numerical Assembly HiUniNc.dll Represents the numerical control environment containing configuration for CNC operations. public class NcEnv : IMakeXmlSource Inheritance object NcEnv Implements IMakeXmlSource 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) Constructors NcEnv(CncBrand) Ctor. public NcEnv(CncBrand cncBrand = CncBrand.Fanuc) Parameters cncBrand CncBrand NcEnv(XElement, string, string) Ctor. public NcEnv(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string The base directory for relative paths. relFile string The relative file path. Properties AttacherAtMcZeroOnTableCoordinate Gets the attacher position at machine zero on table coordinate. public Vec3d AttacherAtMcZeroOnTableCoordinate { get; } Property Value Vec3d CncBrand Gets or sets the CNC brand/controller type. public CncBrand CncBrand { get; set; } Property Value CncBrand CommentSymbol Gets the comment symbol used by the current CNC controller. public string CommentSymbol { get; } Property Value string ConfigurationTable Gets a dictionary of CNC configuration parameters used by the system. public Dictionary ConfigurationTable { get; } Property Value Dictionary CoordinateConverter Gets or sets the coordinate converter used for transformations between different coordinate systems. public ICoordinateConverter CoordinateConverter { get; set; } Property Value ICoordinateConverter EnableArcCornerRadiusCompensation Gets or sets whether arc corner radius compensation is enabled. public bool EnableArcCornerRadiusCompensation { get; set; } Property Value bool EnableIntegerShrinkOnPositionCommand Gets whether integer shrinking is enabled for position commands based on the CNC brand. public bool EnableIntegerShrinkOnPositionCommand { get; } Property Value bool EnableShortestRotary Enables shortest rotary path movement. This option does not affect Heidenhain controllers. For Heidenhain controllers, see Hi.UniNc.Heidenhain.IHeidenhainShortestRotaryPathEnabled, Hi.UniNc.Heidenhain.HeidenhainM126 and Hi.UniNc.Heidenhain.HeidenhainM127. public bool EnableShortestRotary { get; set; } Property Value bool FanucPara5003 Fanuc 5003. These bits are used to specify the type of startup/cancellation of tool radius - tool nose radius compensation. 0: type A; 1: type B; 2,3: type C. Assume always zero. Type A: A compensation vector perpendicular to the block next to the startup block or the block preceding the cancellation block is output. Type B: A compensation vector perpendicular to the startup block or cancellation block and an intersection vector are output. Type C: When the startup block or cancellation block specifies no movement operation, the tool is shifted by the cutter compensation amount in a direction perpendicular to the block next to the startup or the block before cancellation block. public byte FanucPara5003 { get; set; } Property Value byte HeidenhainDatumPresetTable For Heidenhain CYCL DEF 247 Datum Preset. public Dictionary HeidenhainDatumPresetTable { get; } Property Value Dictionary Remarks Datum Preset seems an older settings in heidenhain manual relative to Datum Shift. HeidenhainDatumShiftTable For Heidenhain CYCL DEF 7 Datum Shift. Also called Datum table in heidenhain manual. public Dictionary HeidenhainDatumShiftTable { get; } Property Value Dictionary Remarks Datum Preset seems an older settings in heidenhain manual relative to Datum Shift. HeidenhainMasterAxisChar Gets or sets the Heidenhain master rotary axis as a character (A, B, or C). public char HeidenhainMasterAxisChar { get; set; } Property Value char HeidenhainMasterAxisDir The master axis determines the behaviour of SEQ command. ex. PLANE SPATIAL SPA-77.516 SPB+0 SPC-10.365 STAY SEQ-TABLE ROT The master axis is the 1st rotary axis from the tool, or the last rotary axis from the table(depending on the machine configuration). SEQ+ positions the master axis so that it assumes a positive angle. See: TNC 640 | User's ManualDIN/ISO Programming | 1/2015 p432 public int HeidenhainMasterAxisDir { get; set; } Property Value int HomeMc Home machine coordinate. First reference position. The position may not equal to machine zero in real Fanuc controller. public Vec3d HomeMc { get; set; } Property Value Vec3d IsAxisAExisted Gets whether the A axis exists in the machine configuration. public bool IsAxisAExisted { get; } Property Value bool IsAxisBExisted Gets whether the B axis exists in the machine configuration. public bool IsAxisBExisted { get; } Property Value bool IsAxisCExisted Gets whether the C axis exists in the machine configuration. public bool IsAxisCExisted { get; } Property Value bool IsIdealOffsetDependentOnToolHouse Gets or sets whether the ideal offset depends on tool house position. public bool IsIdealOffsetDependentOnToolHouse { get; set; } Property Value bool IsoCoordinateTable ISO coordinate table. i.e., CoordinateTable For G54 series. public IsoCoordinateTable IsoCoordinateTable { get; set; } Property Value IsoCoordinateTable MaxRotarySpeedABC_degds For safety reason, internal use only. Maximum rotary speed in degds. public Vec3d MaxRotarySpeedABC_degds { get; set; } Property Value Vec3d MaxRotarySpeedABC_radds Maximum rotary speed in rad/s. public Vec3d MaxRotarySpeedABC_radds { get; set; } Property Value Vec3d MaxSpindleSpeed_rpm Gets or sets the maximum spindle speed in revolutions per minute. public double MaxSpindleSpeed_rpm { get; set; } Property Value double MillingToolOffsetTable Gets or sets the milling tool offset table for tool compensation. public MillingToolOffsetTable MillingToolOffsetTable { get; set; } Property Value MillingToolOffsetTable RapidFeedrate_mmdmin Rapid move speed in mm/min. public double RapidFeedrate_mmdmin { get; set; } Property Value double RapidFeedrate_mmds Rapid move speed in mm/s. public double RapidFeedrate_mmds { get; set; } Property Value double RefNcLineOnInit Gets or sets the reference NC line used during initialization. public NcLine RefNcLineOnInit { get; set; } Property Value NcLine SetToolHeightCompensationOnFeatureNormal Gets or sets whether tool height compensation should be applied based on feature normal direction. public bool SetToolHeightCompensationOnFeatureNormal { get; set; } Property Value bool StrokeLimitABC_rad Gets or sets the ABC axis stroke limits in radians. public Box3d StrokeLimitABC_rad { get; set; } Property Value Box3d StrokeLimitXYZ_mm Gets or sets the XYZ axis stroke limits in millimeters. public Box3d StrokeLimitXYZ_mm { get; set; } Property Value Box3d ToolingMc Gets or sets the machine coordinate for tooling operations. Defaults to HomeMc if not explicitly set. public Vec3d ToolingMc { get; set; } Property Value Vec3d ToolingTime Tool changing duration in sec. public TimeSpan ToolingTime { get; set; } Property Value TimeSpan XName Name for XML IO. public static string XName { get; } Property Value string Methods IsAxisExisted(int) Determines whether a specific rotary axis exists in the machine configuration. public bool IsAxisExisted(int dir) Parameters dir int The direction index (0=A, 1=B, 2=C). Returns bool True if the specified axis exists; otherwise, false. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class NcEnv Namespace Hi.Numerical Assembly HiUniNc.dll Represents the numerical control environment containing configuration for CNC operations. public class NcEnv : IMakeXmlSource Inheritance object NcEnv Implements IMakeXmlSource 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) Constructors NcEnv(CncBrand) Ctor. public NcEnv(CncBrand cncBrand = CncBrand.Fanuc) Parameters cncBrand CncBrand NcEnv(XElement, string, string) Ctor. public NcEnv(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string The base directory for relative paths. relFile string The relative file path. Properties AttacherAtMcZeroOnTableCoordinate Gets the attacher position at machine zero on table coordinate. public Vec3d AttacherAtMcZeroOnTableCoordinate { get; } Property Value Vec3d CncBrand Gets or sets the CNC brand/controller type. public CncBrand CncBrand { get; set; } Property Value CncBrand CommentSymbol Gets the comment symbol used by the current CNC controller. public string CommentSymbol { get; } Property Value string ConfigurationTable Gets a dictionary of CNC configuration parameters used by the system. public Dictionary ConfigurationTable { get; } Property Value Dictionary CoordinateConverter Gets or sets the coordinate converter used for transformations between different coordinate systems. public ICoordinateConverter CoordinateConverter { get; set; } Property Value ICoordinateConverter EnableArcCornerRadiusCompensation Gets or sets whether arc corner radius compensation is enabled. public bool EnableArcCornerRadiusCompensation { get; set; } Property Value bool EnableIntegerShrinkOnPositionCommand Gets whether integer shrinking is enabled for position commands based on the CNC brand. public bool EnableIntegerShrinkOnPositionCommand { get; } Property Value bool EnableShortestRotary Enables shortest rotary path movement. This option does not affect Heidenhain controllers. For Heidenhain controllers, see Hi.UniNc.Heidenhain.IHeidenhainShortestRotaryPathEnabled, Hi.UniNc.Heidenhain.HeidenhainM126 and Hi.UniNc.Heidenhain.HeidenhainM127. public bool EnableShortestRotary { get; set; } Property Value bool FanucPara5003 Fanuc 5003. These bits are used to specify the type of startup/cancellation of tool radius - tool nose radius compensation. 0: type A; 1: type B; 2,3: type C. Assume always zero. Type A: A compensation vector perpendicular to the block next to the startup block or the block preceding the cancellation block is output. Type B: A compensation vector perpendicular to the startup block or cancellation block and an intersection vector are output. Type C: When the startup block or cancellation block specifies no movement operation, the tool is shifted by the cutter compensation amount in a direction perpendicular to the block next to the startup or the block before cancellation block. public byte FanucPara5003 { get; set; } Property Value byte HeidenhainDatumPresetTable For Heidenhain CYCL DEF 247 Datum Preset. public Dictionary HeidenhainDatumPresetTable { get; } Property Value Dictionary Remarks Datum Preset seems an older settings in heidenhain manual relative to Datum Shift. HeidenhainDatumShiftTable For Heidenhain CYCL DEF 7 Datum Shift. Also called Datum table in heidenhain manual. public Dictionary HeidenhainDatumShiftTable { get; } Property Value Dictionary Remarks Datum Preset seems an older settings in heidenhain manual relative to Datum Shift. HeidenhainMasterAxisChar Gets or sets the Heidenhain master rotary axis as a character (A, B, or C). public char HeidenhainMasterAxisChar { get; set; } Property Value char HeidenhainMasterAxisDir The master axis determines the behaviour of SEQ command. ex. PLANE SPATIAL SPA-77.516 SPB+0 SPC-10.365 STAY SEQ-TABLE ROT The master axis is the 1st rotary axis from the tool, or the last rotary axis from the table(depending on the machine configuration). SEQ+ positions the master axis so that it assumes a positive angle. See: TNC 640 | User's ManualDIN/ISO Programming | 1/2015 p432 public int HeidenhainMasterAxisDir { get; set; } Property Value int HomeMc Home machine coordinate. First reference position. The position may not equal to machine zero in real Fanuc controller. public Vec3d HomeMc { get; set; } Property Value Vec3d IsAxisAExisted Gets whether the A axis exists in the machine configuration. public bool IsAxisAExisted { get; } Property Value bool IsAxisBExisted Gets whether the B axis exists in the machine configuration. public bool IsAxisBExisted { get; } Property Value bool IsAxisCExisted Gets whether the C axis exists in the machine configuration. public bool IsAxisCExisted { get; } Property Value bool IsIdealOffsetDependentOnToolHouse Gets or sets whether the ideal offset depends on tool house position. public bool IsIdealOffsetDependentOnToolHouse { get; set; } Property Value bool IsoCoordinateTable ISO coordinate table. i.e., CoordinateTable For G54 series. public IsoCoordinateTable IsoCoordinateTable { get; set; } Property Value IsoCoordinateTable MaxRotarySpeedABC_degds For safety reason, internal use only. Maximum rotary speed in degds. public Vec3d MaxRotarySpeedABC_degds { get; set; } Property Value Vec3d MaxRotarySpeedABC_radds Maximum rotary speed in rad/s. public Vec3d MaxRotarySpeedABC_radds { get; set; } Property Value Vec3d MaxSpindleSpeed_rpm Gets or sets the maximum spindle speed in revolutions per minute. public double MaxSpindleSpeed_rpm { get; set; } Property Value double MillingToolOffsetTable Gets or sets the milling tool offset table for tool compensation. public MillingToolOffsetTable MillingToolOffsetTable { get; set; } Property Value MillingToolOffsetTable RapidFeedrate_mmdmin Rapid move speed in mm/min. public double RapidFeedrate_mmdmin { get; set; } Property Value double RapidFeedrate_mmds Rapid move speed in mm/s. public double RapidFeedrate_mmds { get; set; } Property Value double RefNcLineOnInit Gets or sets the reference NC line used during initialization. public NcLine RefNcLineOnInit { get; set; } Property Value NcLine SetToolHeightCompensationOnFeatureNormal Gets or sets whether tool height compensation should be applied based on feature normal direction. public bool SetToolHeightCompensationOnFeatureNormal { get; set; } Property Value bool StrokeLimitAbc_rad Gets or sets the ABC axis stroke limits in radians. public Box3d StrokeLimitAbc_rad { get; set; } Property Value Box3d StrokeLimitXyz_mm Gets or sets the XYZ axis stroke limits in millimeters. public Box3d StrokeLimitXyz_mm { get; set; } Property Value Box3d ToolingMcAbc_deg Gets or sets the rotary machine coordinate for tooling operations. Defaults to HomeMc if not explicitly set. Set to NaN if tooling motion not apply the axis motion. Unit is degree. public Vec3d ToolingMcAbc_deg { get; set; } Property Value Vec3d ToolingMcAbc_rad Gets or sets the rotary machine coordinate for tooling operations. Defaults to HomeMc if not explicitly set. Set to NaN if tooling motion not apply the axis motion. Unit is radian. public Vec3d ToolingMcAbc_rad { get; set; } Property Value Vec3d ToolingMcXyz Gets or sets the translation machine coordinate for tooling operations. Defaults to HomeMc if not explicitly set. Set to NaN if tooling motion not apply the axis motion. public Vec3d ToolingMcXyz { get; set; } Property Value Vec3d ToolingTime Tool changing duration in sec. public TimeSpan ToolingTime { get; set; } Property Value TimeSpan XName Name for XML IO. public static string XName { get; } Property Value string Methods CheckStrokeLimit(DVec3d, IMessageKit) Check stroke limit. public bool CheckStrokeLimit(DVec3d mcXyzabc_mm_rad, IMessageKit messageKit) Parameters mcXyzabc_mm_rad DVec3d messageKit IMessageKit Returns bool Is under stroke limit. IsAxisExisted(int) Determines whether a specific rotary axis exists in the machine configuration. public bool IsAxisExisted(int dir) Parameters dir int The direction index (0=A, 1=B, 2=C). Returns bool True if the specified axis exists; otherwise, false. 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." }, "api/Hi.Numerical.NcFlag.html": { "href": "api/Hi.Numerical.NcFlag.html", @@ -3627,7 +3762,7 @@ "api/Hi.Numerical.NcFlagUtil.html": { "href": "api/Hi.Numerical.NcFlagUtil.html", "title": "Class NcFlagUtil | HiAPI-C# 2025", - "summary": "Class NcFlagUtil Namespace Hi.Numerical Assembly HiUniNc.dll Utility class for working with NC flags and their lifecycle modes. public static class NcFlagUtil Inheritance object NcFlagUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetCompensationHeight(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageHost) Gets the tool height compensation value based on the NC flags and CNC brand. public static double GetCompensationHeight(this BitArray ncFlagBitArray, int H, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageHost messageHost) Parameters ncFlagBitArray BitArray NC flag bit array H int Height offset index millingToolOffsetTable MillingToolOffsetTable Tool offset table cncBrand CncBrand CNC brand messageHost IMessageHost Message host for warnings Returns double Height compensation value GetCompensationRadius(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageHost) Gets the tool radius compensation value from the flag bit array and tool offset table. public static double GetCompensationRadius(this BitArray ncFlagBitArray, int D, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageHost messageHost) Parameters ncFlagBitArray BitArray The bit array of NC flags. D int The tool diameter offset number. millingToolOffsetTable MillingToolOffsetTable The milling tool offset table. cncBrand CncBrand The CNC controller brand. messageHost IMessageHost The message host for reporting warnings or errors. Returns double The compensation radius value. GetCoordinateOffset(bool, int, int, HeidenhainCycleDef7Arg, NcEnv) Gets the coordinate offset based on the CNC controller and coordinate settings. public static Vec3d GetCoordinateOffset(bool hasSiemensG500, int isoCoordinateId, int heidenhainCycleDef247Q339, HeidenhainCycleDef7Arg heidenhainCycleDef7Arg, NcEnv ncEnv) Parameters hasSiemensG500 bool Whether Siemens G500 is active. isoCoordinateId int The ISO coordinate ID. heidenhainCycleDef247Q339 int The Heidenhain cycle def 247 Q339 value. heidenhainCycleDef7Arg HeidenhainCycleDef7Arg The Heidenhain cycle def 7 arguments. ncEnv NcEnv The NC environment. Returns Vec3d The coordinate offset vector. GetFlags(NcLifeCycleMode) Gets all NC flags for a specific lifecycle mode. public static NcFlag[] GetFlags(this NcLifeCycleMode ncLifeCycleMode) Parameters ncLifeCycleMode NcLifeCycleMode The lifecycle mode to get flags for. Returns NcFlag[] An array of NC flags for the specified lifecycle mode. GetHeidenhainCoordinateOffset(int, HeidenhainCycleDef7Arg, NcEnv) Gets the coordinate offset for Heidenhain controllers. public static Vec3d GetHeidenhainCoordinateOffset(int heidenhainCycleDef247Q339, HeidenhainCycleDef7Arg heidenhainCycleDef7Arg, NcEnv ncEnv) Parameters heidenhainCycleDef247Q339 int The preset number for CYCL DEF 247. heidenhainCycleDef7Arg HeidenhainCycleDef7Arg The argument for CYCL DEF 7. ncEnv NcEnv The NC environment. Returns Vec3d The calculated coordinate offset. GetModalNcFlag(BitArray) Gets the modal NC flag of the specified type from the bit array. public static T GetModalNcFlag(this BitArray ncFlagBitArray) where T : Enum Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns T The modal NC flag of the specified type. Type Parameters T The enum type of the modal flag. GetNcFlag(BitArray) Gets the NC flag of the specified type from the bit array. public static T GetNcFlag(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns T The NC flag of the specified type. Type Parameters T The enum type of the NC flag. GetNcFlags(BitArray) Gets all active NC flags from the bit array. public static IEnumerable GetNcFlags(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns IEnumerable An enumerable collection of active NC flags. GetNcFromSyntex(NcGroup03, TVec, TVec) Converts syntactic coordinates to NC coordinates based on the positioning mode. public static TVec GetNcFromSyntex(this NcGroup03 group03Flag, TVec syntexPosition, TVec preProgramPosition) where TVec : IVec, new() Parameters group03Flag NcGroup03 The positioning mode flag syntexPosition TVec Syntactic position from the input preProgramPosition TVec Previous program position Returns TVec Converted NC coordinates Type Parameters TVec Vector type implementing IVec interface GetNcFromSyntex(NcGroup03, TVec, TVec, int, Func, Action) Converts syntactic position to NC position based on the positioning mode (absolute or incremental). public static TVec GetNcFromSyntex(this NcGroup03 group03Flag, TVec syntexPosition, TVec preProgramPosition, int vecSize, Func getter, Action setter) where TVec : new() Parameters group03Flag NcGroup03 The positioning mode flag syntexPosition TVec Syntactic position from the input preProgramPosition TVec Previous program position vecSize int Size of the vector getter Func Function to get value at specified index setter Action Function to set value at specified index Returns TVec Converted NC coordinates Type Parameters TVec Vector type Exceptions InternalException Thrown when group03Flag is not managed GetNcGroupType(NcFlag) Gets the NC group type for the specified NC flag. public static Type GetNcGroupType(NcFlag ncFlag) Parameters ncFlag NcFlag The NC flag to get the group type for. Returns Type The NC group type or null if not found. GetNcLifeCycleMode(NcFlag) Gets the lifecycle mode of the specified NC flag. public static NcLifeCycleMode GetNcLifeCycleMode(this NcFlag flag) Parameters flag NcFlag The NC flag to check. Returns NcLifeCycleMode The lifecycle mode of the flag. GetNcName(NcFlag) Gets the display name of an NC flag. public static string GetNcName(this NcFlag flag) Parameters flag NcFlag The NC flag to get the name of. Returns string The display name of the NC flag. GetNcXyzFromSyntex(NcGroup03, Vec3d, Vec3d) Converts syntactic XYZ coordinates to NC XYZ coordinates based on the positioning mode. public static Vec3d GetNcXyzFromSyntex(this NcGroup03 group03Flag, Vec3d syntexXyz, Vec3d preNcXyz) Parameters group03Flag NcGroup03 The Group03 flag specifying the positioning mode. syntexXyz Vec3d The syntactic XYZ coordinates to convert. preNcXyz Vec3d The previous NC XYZ coordinates, used for incremental positioning. Returns Vec3d The converted NC XYZ coordinates. GetNcXyzabcFromSyntex(NcGroup03, DVec3d, DVec3d) Gets NC XYZABC coordinates from syntactic coordinates based on the positioning mode. public static DVec3d GetNcXyzabcFromSyntex(this NcGroup03 group03Flag, DVec3d syntexXyzabc, DVec3d preNcXyzabc) Parameters group03Flag NcGroup03 The positioning mode flag (G90 or G91). syntexXyzabc DVec3d The syntactic XYZABC coordinates. preNcXyzabc DVec3d The previous NC XYZABC coordinates. Returns DVec3d The calculated NC XYZABC coordinates. GetPlaneDir(NcGroup02) Gets the direction index of the selected plane. public static int GetPlaneDir(this NcGroup02 ncFlag) Parameters ncFlag NcGroup02 The NC plane selection flag (G17, G18, or G19). Returns int The direction index (0=X, 1=Y, 2=Z). GetPlaneNormal(NcGroup02) Gets the normal vector of the selected plane. public static Vec3d GetPlaneNormal(this NcGroup02 ncFlag) Parameters ncFlag NcGroup02 The NC plane selection flag (G17, G18, or G19). Returns Vec3d The normal vector of the plane. GetTiltMat4d(BitArray, ITiltPlaneNcArg, NcGroup02, ICoordinateConverter, out bool?) public static Mat4d GetTiltMat4d(this BitArray ncFlagBitArray, ITiltPlaneNcArg ncArgGroup16, NcGroup02 ncGroup02flagForG68, ICoordinateConverter coordinateConverterForG68p2, out bool? isG68p2Successed) Parameters ncFlagBitArray BitArray ncArgGroup16 ITiltPlaneNcArg ncGroup02flagForG68 NcGroup02 coordinateConverterForG68p2 ICoordinateConverter isG68p2Successed bool? Returns Mat4d GetValue(NcGroup03, double, double) public static double GetValue(this NcGroup03 group03Flag, double v, double preV) Parameters group03Flag NcGroup03 v double value preV double previous value Returns double HasModalFlag(BitArray, out T) Checks if the bit array has a modal flag of the specified type and retrieves it. public static bool HasModalFlag(this BitArray ncFlagBitArray, out T dst) where T : Enum Parameters ncFlagBitArray BitArray The bit array of NC flags. dst T When this method returns, contains the modal flag if found; otherwise, the default value. Returns bool True if a modal flag was found; otherwise, false. Type Parameters T The enum type of the modal flag. IsAbsolutePositioning(BitArray) Checks if the positioning mode is absolute (G90) rather than incremental (G91). public static bool IsAbsolutePositioning(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if absolute positioning is active; otherwise, false. IsFlagActivated(BitArray, NcFlag) Determines whether a specific NC flag is activated in the flag bit array. public static bool IsFlagActivated(this BitArray ncFlagBitArray, NcFlag ncFlag) Parameters ncFlagBitArray BitArray The bit array of NC flags. ncFlag NcFlag The NC flag to check. Returns bool True if the flag is activated; otherwise, false. IsHeightCompensationEnabled(BitArray) Determines whether height compensation is enabled. public static bool IsHeightCompensationEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if height compensation is enabled; otherwise, false. IsOnArcCommand(BitArray) Determines whether an arc command is active. public static bool IsOnArcCommand(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if an arc command is active; otherwise, false. IsRadiusCompensationEnabled(BitArray) Determines whether radius compensation is enabled. public static bool IsRadiusCompensationEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if radius compensation is enabled; otherwise, false. IsRadiusOrHeightCompensationEnabled(BitArray) Determines whether radius or height compensation is enabled. public static bool IsRadiusOrHeightCompensationEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if radius or height compensation is enabled; otherwise, false. IsToolCenterPointManagementEnabled(NcGroup08) obosoleted. use BitArray version instead. Is the flag enabled RTCP (Rotational Tool Center Point) (=Tool Center Point Management, TCPM). Check for NcGroup08. public static bool IsToolCenterPointManagementEnabled(this NcGroup08 flag) Parameters flag NcGroup08 Returns bool IsToolCenterPointManagementEnabled(BitArray) Is the flag enabled RTCP (Rotational Tool Center Point) (=Tool Center Point Management, TCPM). public static bool IsToolCenterPointManagementEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray Returns bool IsToolChanging(BitArray) Determines if a tool change operation is active in the NC flag bit array. public static bool IsToolChanging(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if a tool change is active; otherwise, false. IsToolNormalTiltable(BitArray) Determines whether the tool normal is tiltable based on the flag bit array. public static bool IsToolNormalTiltable(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if the tool normal is tiltable; otherwise, false. ModalExclusiveAssign(BitArray, NcFlag) Modal exclusive assign in the belonging NC Group. public static BitArray ModalExclusiveAssign(this BitArray ncFlagBitArray, NcFlag assigningNcFlag) Parameters ncFlagBitArray BitArray assigningNcFlag NcFlag Returns BitArray ModalExclusiveAssign(BitArray, T) Modal exclusive assign in the belonging NC Group. public static BitArray ModalExclusiveAssign(this BitArray ncFlagBitArray, T assigningNcGroupFlag) where T : struct, Enum Parameters ncFlagBitArray BitArray assigningNcGroupFlag T Returns BitArray Type Parameters T ResetOneShotFlag(BitArray) Resets all one-shot flags in the specified bit array. public static BitArray ResetOneShotFlag(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns BitArray The modified bit array with one-shot flags reset. ToNcFlagString(BitArray) Converts the active NC flags in the bit array to a string representation. public static string ToNcFlagString(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns string A string representation of the active NC flags." + "summary": "Class NcFlagUtil Namespace Hi.Numerical Assembly HiUniNc.dll Utility class for working with NC flags and their lifecycle modes. public static class NcFlagUtil Inheritance object NcFlagUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetCompensationHeight(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageKit) Gets the tool height compensation value based on the NC flags and CNC brand. public static double GetCompensationHeight(this BitArray ncFlagBitArray, int H, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageKit messageHost) Parameters ncFlagBitArray BitArray NC flag bit array H int Height offset index millingToolOffsetTable MillingToolOffsetTable Tool offset table cncBrand CncBrand CNC brand messageHost IMessageKit Message host for warnings Returns double Height compensation value GetCompensationRadius(BitArray, int, MillingToolOffsetTable, CncBrand, IMessageKit) Gets the tool radius compensation value from the flag bit array and tool offset table. public static double GetCompensationRadius(this BitArray ncFlagBitArray, int D, MillingToolOffsetTable millingToolOffsetTable, CncBrand cncBrand, IMessageKit messageHost) Parameters ncFlagBitArray BitArray The bit array of NC flags. D int The tool diameter offset number. millingToolOffsetTable MillingToolOffsetTable The milling tool offset table. cncBrand CncBrand The CNC controller brand. messageHost IMessageKit The message host for reporting warnings or errors. Returns double The compensation radius value. GetCoordinateOffset(bool, int, int, HeidenhainCycleDef7Arg, NcEnv) Gets the coordinate offset based on the CNC controller and coordinate settings. public static Vec3d GetCoordinateOffset(bool hasSiemensG500, int isoCoordinateId, int heidenhainCycleDef247Q339, HeidenhainCycleDef7Arg heidenhainCycleDef7Arg, NcEnv ncEnv) Parameters hasSiemensG500 bool Whether Siemens G500 is active. isoCoordinateId int The ISO coordinate ID. heidenhainCycleDef247Q339 int The Heidenhain cycle def 247 Q339 value. heidenhainCycleDef7Arg HeidenhainCycleDef7Arg The Heidenhain cycle def 7 arguments. ncEnv NcEnv The NC environment. Returns Vec3d The coordinate offset vector. GetFlags(NcLifeCycleMode) Gets all NC flags for a specific lifecycle mode. public static NcFlag[] GetFlags(this NcLifeCycleMode ncLifeCycleMode) Parameters ncLifeCycleMode NcLifeCycleMode The lifecycle mode to get flags for. Returns NcFlag[] An array of NC flags for the specified lifecycle mode. GetHeidenhainCoordinateOffset(int, HeidenhainCycleDef7Arg, NcEnv) Gets the coordinate offset for Heidenhain controllers. public static Vec3d GetHeidenhainCoordinateOffset(int heidenhainCycleDef247Q339, HeidenhainCycleDef7Arg heidenhainCycleDef7Arg, NcEnv ncEnv) Parameters heidenhainCycleDef247Q339 int The preset number for CYCL DEF 247. heidenhainCycleDef7Arg HeidenhainCycleDef7Arg The argument for CYCL DEF 7. ncEnv NcEnv The NC environment. Returns Vec3d The calculated coordinate offset. GetModalNcFlag(BitArray) Gets the modal NC flag of the specified type from the bit array. public static T GetModalNcFlag(this BitArray ncFlagBitArray) where T : Enum Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns T The modal NC flag of the specified type. Type Parameters T The enum type of the modal flag. GetNcFlag(BitArray) Gets the NC flag of the specified type from the bit array. public static T GetNcFlag(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns T The NC flag of the specified type. Type Parameters T The enum type of the NC flag. GetNcFlags(BitArray) Gets all active NC flags from the bit array. public static IEnumerable GetNcFlags(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns IEnumerable An enumerable collection of active NC flags. GetNcFromSyntex(NcGroup03, TVec, TVec) Converts syntactic coordinates to NC coordinates based on the positioning mode. public static TVec GetNcFromSyntex(this NcGroup03 group03Flag, TVec syntexPosition, TVec preProgramPosition) where TVec : IVec, new() Parameters group03Flag NcGroup03 The positioning mode flag syntexPosition TVec Syntactic position from the input preProgramPosition TVec Previous program position Returns TVec Converted NC coordinates Type Parameters TVec Vector type implementing IVec interface GetNcFromSyntex(NcGroup03, TVec, TVec, int, Func, Action) Converts syntactic position to NC position based on the positioning mode (absolute or incremental). public static TVec GetNcFromSyntex(this NcGroup03 group03Flag, TVec syntexPosition, TVec preProgramPosition, int vecSize, Func getter, Action setter) where TVec : new() Parameters group03Flag NcGroup03 The positioning mode flag syntexPosition TVec Syntactic position from the input preProgramPosition TVec Previous program position vecSize int Size of the vector getter Func Function to get value at specified index setter Action Function to set value at specified index Returns TVec Converted NC coordinates Type Parameters TVec Vector type Exceptions InternalException Thrown when group03Flag is not managed GetNcGroupType(NcFlag) Gets the NC group type for the specified NC flag. public static Type GetNcGroupType(NcFlag ncFlag) Parameters ncFlag NcFlag The NC flag to get the group type for. Returns Type The NC group type or null if not found. GetNcLifeCycleMode(NcFlag) Gets the lifecycle mode of the specified NC flag. public static NcLifeCycleMode GetNcLifeCycleMode(this NcFlag flag) Parameters flag NcFlag The NC flag to check. Returns NcLifeCycleMode The lifecycle mode of the flag. GetNcName(NcFlag) Gets the display name of an NC flag. public static string GetNcName(this NcFlag flag) Parameters flag NcFlag The NC flag to get the name of. Returns string The display name of the NC flag. GetNcXyzFromSyntex(NcGroup03, Vec3d, Vec3d) Converts syntactic XYZ coordinates to NC XYZ coordinates based on the positioning mode. public static Vec3d GetNcXyzFromSyntex(this NcGroup03 group03Flag, Vec3d syntexXyz, Vec3d preNcXyz) Parameters group03Flag NcGroup03 The Group03 flag specifying the positioning mode. syntexXyz Vec3d The syntactic XYZ coordinates to convert. preNcXyz Vec3d The previous NC XYZ coordinates, used for incremental positioning. Returns Vec3d The converted NC XYZ coordinates. GetNcXyzabcFromSyntex(NcGroup03, DVec3d, DVec3d) Gets NC XYZABC coordinates from syntactic coordinates based on the positioning mode. public static DVec3d GetNcXyzabcFromSyntex(this NcGroup03 group03Flag, DVec3d syntexXyzabc, DVec3d preNcXyzabc) Parameters group03Flag NcGroup03 The positioning mode flag (G90 or G91). syntexXyzabc DVec3d The syntactic XYZABC coordinates. preNcXyzabc DVec3d The previous NC XYZABC coordinates. Returns DVec3d The calculated NC XYZABC coordinates. GetPlaneDir(NcGroup02) Gets the direction index of the selected plane. public static int GetPlaneDir(this NcGroup02 ncFlag) Parameters ncFlag NcGroup02 The NC plane selection flag (G17, G18, or G19). Returns int The direction index (0=X, 1=Y, 2=Z). GetPlaneNormal(NcGroup02) Gets the normal vector of the selected plane. public static Vec3d GetPlaneNormal(this NcGroup02 ncFlag) Parameters ncFlag NcGroup02 The NC plane selection flag (G17, G18, or G19). Returns Vec3d The normal vector of the plane. GetTiltMat4d(BitArray, ITiltPlaneNcArg, NcGroup02, ICoordinateConverter, out bool?) public static Mat4d GetTiltMat4d(this BitArray ncFlagBitArray, ITiltPlaneNcArg ncArgGroup16, NcGroup02 ncGroup02flagForG68, ICoordinateConverter coordinateConverterForG68p2, out bool? isG68p2Successed) Parameters ncFlagBitArray BitArray ncArgGroup16 ITiltPlaneNcArg ncGroup02flagForG68 NcGroup02 coordinateConverterForG68p2 ICoordinateConverter isG68p2Successed bool? Returns Mat4d GetValue(NcGroup03, double, double) public static double GetValue(this NcGroup03 group03Flag, double v, double preV) Parameters group03Flag NcGroup03 v double value preV double previous value Returns double HasModalFlag(BitArray, out T) Checks if the bit array has a modal flag of the specified type and retrieves it. public static bool HasModalFlag(this BitArray ncFlagBitArray, out T dst) where T : Enum Parameters ncFlagBitArray BitArray The bit array of NC flags. dst T When this method returns, contains the modal flag if found; otherwise, the default value. Returns bool True if a modal flag was found; otherwise, false. Type Parameters T The enum type of the modal flag. IsAbsolutePositioning(BitArray) Checks if the positioning mode is absolute (G90) rather than incremental (G91). public static bool IsAbsolutePositioning(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if absolute positioning is active; otherwise, false. IsFlagActivated(BitArray, NcFlag) Determines whether a specific NC flag is activated in the flag bit array. public static bool IsFlagActivated(this BitArray ncFlagBitArray, NcFlag ncFlag) Parameters ncFlagBitArray BitArray The bit array of NC flags. ncFlag NcFlag The NC flag to check. Returns bool True if the flag is activated; otherwise, false. IsHeightCompensationEnabled(BitArray) Determines whether height compensation is enabled. public static bool IsHeightCompensationEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if height compensation is enabled; otherwise, false. IsOnArcCommand(BitArray) Determines whether an arc command is active. public static bool IsOnArcCommand(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if an arc command is active; otherwise, false. IsRadiusCompensationEnabled(BitArray) Determines whether radius compensation is enabled. public static bool IsRadiusCompensationEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if radius compensation is enabled; otherwise, false. IsRadiusOrHeightCompensationEnabled(BitArray) Determines whether radius or height compensation is enabled. public static bool IsRadiusOrHeightCompensationEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if radius or height compensation is enabled; otherwise, false. IsToolCenterPointManagementEnabled(NcGroup08) obosoleted. use BitArray version instead. Is the flag enabled RTCP (Rotational Tool Center Point) (=Tool Center Point Management, TCPM). Check for NcGroup08. public static bool IsToolCenterPointManagementEnabled(this NcGroup08 flag) Parameters flag NcGroup08 Returns bool IsToolCenterPointManagementEnabled(BitArray) Is the flag enabled RTCP (Rotational Tool Center Point) (=Tool Center Point Management, TCPM). public static bool IsToolCenterPointManagementEnabled(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray Returns bool IsToolChanging(BitArray) Determines if a tool change operation is active in the NC flag bit array. public static bool IsToolChanging(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if a tool change is active; otherwise, false. IsToolNormalTiltable(BitArray) Determines whether the tool normal is tiltable based on the flag bit array. public static bool IsToolNormalTiltable(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns bool True if the tool normal is tiltable; otherwise, false. ModalExclusiveAssign(BitArray, NcFlag) Modal exclusive assign in the belonging NC Group. public static BitArray ModalExclusiveAssign(this BitArray ncFlagBitArray, NcFlag assigningNcFlag) Parameters ncFlagBitArray BitArray assigningNcFlag NcFlag Returns BitArray ModalExclusiveAssign(BitArray, T) Modal exclusive assign in the belonging NC Group. public static BitArray ModalExclusiveAssign(this BitArray ncFlagBitArray, T assigningNcGroupFlag) where T : struct, Enum Parameters ncFlagBitArray BitArray assigningNcGroupFlag T Returns BitArray Type Parameters T ResetOneShotFlag(BitArray) Resets all one-shot flags in the specified bit array. public static BitArray ResetOneShotFlag(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns BitArray The modified bit array with one-shot flags reset. ToNcFlagString(BitArray) Converts the active NC flags in the bit array to a string representation. public static string ToNcFlagString(this BitArray ncFlagBitArray) Parameters ncFlagBitArray BitArray The bit array of NC flags. Returns string A string representation of the active NC flags." }, "api/Hi.Numerical.NcGroup00.html": { "href": "api/Hi.Numerical.NcGroup00.html", @@ -3732,7 +3867,7 @@ "api/Hi.Numerical.NcLine.html": { "href": "api/Hi.Numerical.NcLine.html", "title": "Class NcLine | HiAPI-C# 2025", - "summary": "Class NcLine Namespace Hi.Numerical Assembly HiUniNc.dll Represents a line in the NC program with its associated data and operations. public class NcLine : ISourceCommand, IFileLine, IFileLineIndex, IGetIndexedFileLine, IGetFileLineIndex, IGetSourceCommand Inheritance object NcLine Implements ISourceCommand IFileLine IFileLineIndex IGetIndexedFileLine IGetFileLineIndex IGetSourceCommand Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) NcUtil.IsFlagChanging(NcLine, NcLine, NcFlag) NcUtil.IsFlagChanging(NcLine, NcLine, NcFlag, bool) NcUtil.IsFlagKeeping(NcLine, NcLine, NcFlag, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors NcLine(NcEnv, IndexedFileLine, NcLine, out NcNoteCache, IMessageHost) Ctor from the reference NcLine. public NcLine(NcEnv ncEnv, IndexedFileLine fileLine, NcLine preNcLine, out NcNoteCache ncLineCache, IMessageHost messageHost) Parameters ncEnv NcEnv NC environment fileLine IndexedFileLine file line preNcLine NcLine reference NcLine that this NcLine copy from. If previous NcLine is not null, apply previous NcLine. ncLineCache NcNoteCache Output NC note cache messageHost IMessageHost Message host for warnings NcLine(NcEnv, IMessageHost) Ctor for initial state. public NcLine(NcEnv ncEnv, IMessageHost messageHost) Parameters ncEnv NcEnv messageHost IMessageHost Properties ArcNcArg NC arguments for arc commands. public ArcNcArg ArcNcArg { get; set; } Property Value ArcNcArg CoordinateInterpolationMode Gets the current coordinate interpolation mode (Cartesian or Polar). public CoordinateInterpolationMode CoordinateInterpolationMode { get; } Property Value CoordinateInterpolationMode F F. Feedrate on NC code. Note that this may not be the working feedrate. Some NC codes like G00 and G28 doesnt use F code. public double F { get; set; } Property Value double Remarks According to Fanuc manual, the default F is zero. Feedrate_mmdmin Feedrate on NC code in mm/min. See F. public double Feedrate_mmdmin { get; set; } Property Value double Feedrate_mmds Feedrate on NC code in mm/sec. See F. public double Feedrate_mmds { get; set; } Property Value double FileIndex File Index. Start on 0. public int FileIndex { get; } Property Value int FilePath File path. public string FilePath { get; } Property Value string FlagsText Gets a string representation of the active NC flags for this line. public string FlagsText { get; } Property Value string G28Arg Arguments for G28 commands. public G28Arg G28Arg { get; set; } Property Value G28Arg G52_Xyz Local coordinate system translation. public Vec3d G52_Xyz { get; set; } Property Value Vec3d G54SeriesCoordinateNum1000 Faunc Group14 value. Note that Heidenhain Datum shift is set by DatumTableId. public int G54SeriesCoordinateNum1000 { get; set; } Property Value int Group07NcArg Arguments for Group07 NC commands (tool radius compensation). public Group07NcArg Group07NcArg { get; set; } Property Value Group07NcArg Group07_D Radius compensation ID. Note that in Siemens controller, each tool ID has several D entry. public int Group07_D { get; set; } Property Value int Group08_H Height compensation ID. For Siemens Traori, the value is Tool ID. For Heidenhain, the value is Tool ID. public int Group08_H { get; set; } Property Value int Group09NcArg NC Argument of NC Group09. public Group09NcArg Group09NcArg { get; set; } Property Value Group09NcArg HeidenhainBlockCacheArg Heidenhain block cache arguments for various Heidenhain commands. public IHeidenhainBlockCacheArg HeidenhainBlockCacheArg { get; set; } Property Value IHeidenhainBlockCacheArg HeidenhainCycleDef247Q339 DATUM SETTING DATUM Number. public int HeidenhainCycleDef247Q339 { get; set; } Property Value int HeidenhainCycleDef7Arg Arguments for Heidenhain Cycle Definition 7 (datum shift). public HeidenhainCycleDef7Arg HeidenhainCycleDef7Arg { get; set; } Property Value HeidenhainCycleDef7Arg HeidenhainM140MB HeidenhainM140(Retract the tool) MB value. MB is the retraction height. double.positiveInf is [MB MAX]. One shot command. public double HeidenhainM140MB { get; set; } Property Value double HeidenhainQMacroMap Dictionary mapping Q macro numbers to their string values for Heidenhain controllers. public Dictionary HeidenhainQMacroMap { get; set; } Property Value Dictionary HeidenhainToolAxisDir Direction of the tool axis for Heidenhain controllers. public int HeidenhainToolAxisDir { get; set; } Property Value int IndexedFileLine The file line information associated with this NC line. public IndexedFileLine IndexedFileLine { get; } Property Value IndexedFileLine IsAbsolutePositioning Gets a value indicating whether absolute positioning (G90) is active. public bool IsAbsolutePositioning { get; } Property Value bool IsHeightCompensationEnabled Gets a value indicating whether height compensation is enabled. public bool IsHeightCompensationEnabled { get; } Property Value bool IsOnArcCommand Gets a value indicating whether an arc command (G02 or G03) is active. public bool IsOnArcCommand { get; } Property Value bool IsPathPrepared Gets a value indicating whether the path is prepared (no radius compensation). public bool IsPathPrepared { get; } Property Value bool IsRadiusCompensationEnabled Gets a value indicating whether radius compensation is enabled. public bool IsRadiusCompensationEnabled { get; } Property Value bool IsToolCenterPointManagementEnabled Gets a value indicating whether tool center point management is enabled. public bool IsToolCenterPointManagementEnabled { get; } Property Value bool Line The line. public string Line { get; } Property Value string LineIndex Line Index. Start on 0. public int LineIndex { get; } Property Value int McAbc_rad Machine coordinates in ABC format (radians). public Vec3d McAbc_rad { get; } Property Value Vec3d McXyz Gets or sets the machine coordinate XYZ values. public Vec3d McXyz { get; } Property Value Vec3d McXyzabc Machine coordinate ( with side radius compensation if existed). Point is XYZ. the unit is mm. Normal is ABC. the unit is radian. public DVec3d McXyzabc { get; } Property Value DVec3d NcFlagBitArray Internal Used. public BitArray NcFlagBitArray { get; } Property Value BitArray PausingNcArg public PausingNcArg PausingNcArg { get; set; } Property Value PausingNcArg Remarks Since this is base on OneShot Flag, so here has no copy ctor. PolarEntry Data structure for polar coordinates entry. public PolarEntry PolarEntry { get; set; } Property Value PolarEntry PreparationT Tool ID for preparation. public int PreparationT { get; set; } Property Value int ProgramOrthogonalPlaneNormal The orthogonal plane transform after tilting plane transform. Include G17, G18, G19 and plane of called G12p1. public Vec3d ProgramOrthogonalPlaneNormal { get; } Property Value Vec3d ProgramPos ProgramPos can be cartesian XYZ or polar XCZ with radius-based X, depends on CoordinateInterpolationMode. public Vec3d ProgramPos { get; } Property Value Vec3d ProgramXyz Cartesian Program Position XYZ, Abs Program Position (as G90 position). NC coordinate position is the position processed by modal flags. NC coordinate position is the position after radius compensation. The NC(Program) coordinate position is comprehensible by User. MC NC conversion may raise floating error. The floating error raise the cutting force issue, especially for bottom cutting force. Hence the NC values have to be memorized. public Vec3d ProgramXyz { get; } Property Value Vec3d 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. The error maybe up to 3e-5 in current case. the bounding box size of the case is not large (TT.20230815). Also note that if using Arc command for a complete circle, the begin NC XYZ and the end NC XYZ have to be equaled. Otherwise, it will become only a very small arc rather than the circle. So be care that do not change the NC XYZ if not needed. RadiusCompensationBuf Internal use. public RadiusCompensationBuf RadiusCompensationBuf { get; set; } Property Value RadiusCompensationBuf S S. Spindle speed. public int S { get; set; } Property Value int SpindleSpeed_radds Spindle speed in radian/s. public double SpindleSpeed_radds { get; set; } Property Value double SpindleSpeed_rpm Spindle speed in RPM. public double SpindleSpeed_rpm { get; set; } Property Value double T Current equiped Tool ID. public int T { get; set; } Property Value int TiltPlaneNcArg Arguments related to tilted plane operations. public ITiltPlaneNcArg TiltPlaneNcArg { get; set; } Property Value ITiltPlaneNcArg Methods GetAttacherMat(NcEnv) Gets the attacher transformation matrix for the current machine coordinates. public Mat4d GetAttacherMat(NcEnv ncEnv) Parameters ncEnv NcEnv The NC environment. Returns Mat4d The attacher transformation matrix. GetCompensationHeight(NcEnv, IMessageHost) Gets the tool height compensation value for this NC line. public double GetCompensationHeight(NcEnv ncEnv, IMessageHost messageHost) Parameters ncEnv NcEnv NC environment messageHost IMessageHost Message host for warnings Returns double Height compensation value GetCompensationRadius(CncBrand, MillingToolOffsetTable, IMessageHost) Gets the tool radius compensation value for this NC line. public double GetCompensationRadius(CncBrand cncBrand, MillingToolOffsetTable millingToolOffsetTable, IMessageHost messageHost) Parameters cncBrand CncBrand CNC brand millingToolOffsetTable MillingToolOffsetTable Milling tool offset table messageHost IMessageHost Message host for warnings Returns double Radius compensation value GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex GetG5xCoordinateOffset(NcEnv) Gets the G5x coordinate offset for this NC line. public Vec3d GetG5xCoordinateOffset(NcEnv ncEnv) Parameters ncEnv NcEnv NC environment Returns Vec3d The G5x coordinate offset vector GetIndexedFileLine() Gets the file line associated with this object. public IndexedFileLine GetIndexedFileLine() Returns IndexedFileLine The file line object. GetMcByProgramPos(Vec3d, NcEnv, NcNoteCache, IMessageHost, out Vec3d) Internal Use. public DVec3d GetMcByProgramPos(Vec3d programPos, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageHost messageHost, out Vec3d programXyz) Parameters programPos Vec3d ncEnv NcEnv ncLineCache NcNoteCache messageHost IMessageHost programXyz Vec3d Returns DVec3d GetProgramXyzabc(NcEnv, DVec3d, out bool?, IMessageHost) Gets the program XYZABC coordinates from machine coordinates. public DVec3d GetProgramXyzabc(NcEnv ncEnv, DVec3d mcXyzabc, out bool? isG68p2Successed, IMessageHost messageHost) Parameters ncEnv NcEnv The NC environment. mcXyzabc DVec3d The machine coordinates. isG68p2Successed bool? Output parameter indicating whether G68.2 coordinate conversion was successful. messageHost IMessageHost The message host for logging. Returns DVec3d The program XYZABC coordinates. GetSourceCommand() Gets the source command associated with this instance. public ISourceCommand GetSourceCommand() Returns ISourceCommand The source command object. GetTiltMat4d(NcEnv, out Mat4d) Internal Use Only. public bool? GetTiltMat4d(NcEnv ncEnv, out Mat4d tableToFeatureTransform) Parameters ncEnv NcEnv NC environment. tableToFeatureTransform Mat4d Transform from NC to Table without tool compensation and linear coordinate offset (such as G55,G56..). Returns bool? True if G68.2 is successfully applied, false if not, and null if not applicable. HasSyntexXyz(NcEnv) Determines whether the line contains syntactic XYZ coordinates. public bool HasSyntexXyz(NcEnv ncEnv) Parameters ncEnv NcEnv NC environment Returns bool True if syntactic XYZ coordinates are present; otherwise, false. RebuildByMc(NcEnv, DVec3d, NcNoteCache, IMessageHost) Internal Use Only. For NC opt. public void RebuildByMc(NcEnv ncEnv, DVec3d mc, NcNoteCache ncLineCache, IMessageHost messageHost) Parameters ncEnv NcEnv NC environment. mc DVec3d MC coordinates. ncLineCache NcNoteCache NC line cache. messageHost IMessageHost Message host for logging and reporting. RebuildByProgramXyz(NcEnv, Vec3d, NcNoteCache, IMessageHost) Internal Use Only. For NC opt. public void RebuildByProgramXyz(NcEnv ncEnv, Vec3d programXyz, NcNoteCache ncNoteCache, IMessageHost messageHost) Parameters ncEnv NcEnv NC environment. programXyz Vec3d Program XYZ coordinates. ncNoteCache NcNoteCache NC note cache. messageHost IMessageHost Message host for logging and reporting. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class NcLine Namespace Hi.Numerical Assembly HiUniNc.dll Represents a line in the NC program with its associated data and operations. public class NcLine : ISourceCommand, IFileLine, IFileLineIndex, IGetIndexedFileLine, IGetFileLineIndex, IGetSourceCommand Inheritance object NcLine Implements ISourceCommand IFileLine IFileLineIndex IGetIndexedFileLine IGetFileLineIndex IGetSourceCommand Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Extension Methods DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) NcUtil.IsFlagChanging(NcLine, NcLine, NcFlag) NcUtil.IsFlagChanging(NcLine, NcLine, NcFlag, bool) NcUtil.IsFlagKeeping(NcLine, NcLine, NcFlag, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors NcLine(NcEnv, IndexedFileLine, NcLine, out NcNoteCache, IMessageKit) Ctor from the reference NcLine. public NcLine(NcEnv ncEnv, IndexedFileLine fileLine, NcLine preNcLine, out NcNoteCache ncLineCache, IMessageKit messageHost) Parameters ncEnv NcEnv NC environment fileLine IndexedFileLine file line preNcLine NcLine reference NcLine that this NcLine copy from. If previous NcLine is not null, apply previous NcLine. ncLineCache NcNoteCache Output NC note cache messageHost IMessageKit Message host for warnings NcLine(NcEnv, IMessageKit) Ctor for initial state. public NcLine(NcEnv ncEnv, IMessageKit messageHost) Parameters ncEnv NcEnv messageHost IMessageKit Properties ArcNcArg NC arguments for arc commands. public ArcNcArg ArcNcArg { get; set; } Property Value ArcNcArg CoordinateInterpolationMode Gets the current coordinate interpolation mode (Cartesian or Polar). public CoordinateInterpolationMode CoordinateInterpolationMode { get; } Property Value CoordinateInterpolationMode F F. Feedrate on NC code. Note that this may not be the working feedrate. Some NC codes like G00 and G28 doesnt use F code. public double F { get; set; } Property Value double Remarks According to Fanuc manual, the default F is zero. Feedrate_mmdmin Feedrate on NC code in mm/min. See F. public double Feedrate_mmdmin { get; set; } Property Value double Feedrate_mmds Feedrate on NC code in mm/sec. See F. public double Feedrate_mmds { get; set; } Property Value double FileIndex File Index. Start on 0. public int FileIndex { get; } Property Value int FileNo [Present(\"File Number\", \"FileNo\", PhysicsUnit.None, \"G\")] public int FileNo { get; } Property Value int FilePath File path. [Present(\"File\", \"File\", PhysicsUnit.None, \"G\")] public string FilePath { get; } Property Value string FlagsText Gets a string representation of the active NC flags for this line. public string FlagsText { get; } Property Value string G28Arg Arguments for G28 commands. public G28Arg G28Arg { get; set; } Property Value G28Arg G52_Xyz Local coordinate system translation. public Vec3d G52_Xyz { get; set; } Property Value Vec3d G54SeriesCoordinateNum1000 Faunc Group14 value. Note that Heidenhain Datum shift is set by DatumTableId. public int G54SeriesCoordinateNum1000 { get; set; } Property Value int Group07NcArg Arguments for Group07 NC commands (tool radius compensation). public Group07NcArg Group07NcArg { get; set; } Property Value Group07NcArg Group07_D Radius compensation ID. Note that in Siemens controller, each tool ID has several D entry. public int Group07_D { get; set; } Property Value int Group08_H Height compensation ID. For Siemens Traori, the value is Tool ID. For Heidenhain, the value is Tool ID. public int Group08_H { get; set; } Property Value int Group09NcArg NC Argument of NC Group09. public Group09NcArg Group09NcArg { get; set; } Property Value Group09NcArg HeidenhainBlockCacheArg Heidenhain block cache arguments for various Heidenhain commands. public IHeidenhainBlockCacheArg HeidenhainBlockCacheArg { get; set; } Property Value IHeidenhainBlockCacheArg HeidenhainCycleDef247Q339 DATUM SETTING DATUM Number. public int HeidenhainCycleDef247Q339 { get; set; } Property Value int HeidenhainCycleDef7Arg Arguments for Heidenhain Cycle Definition 7 (datum shift). public HeidenhainCycleDef7Arg HeidenhainCycleDef7Arg { get; set; } Property Value HeidenhainCycleDef7Arg HeidenhainM140MB HeidenhainM140(Retract the tool) MB value. MB is the retraction height. double.positiveInf is [MB MAX]. One shot command. public double HeidenhainM140MB { get; set; } Property Value double HeidenhainQMacroMap Dictionary mapping Q macro numbers to their string values for Heidenhain controllers. public Dictionary HeidenhainQMacroMap { get; set; } Property Value Dictionary HeidenhainToolAxisDir Direction of the tool axis for Heidenhain controllers. public int HeidenhainToolAxisDir { get; set; } Property Value int IndexedFileLine The file line information associated with this NC line. public IndexedFileLine IndexedFileLine { get; } Property Value IndexedFileLine IsAbsolutePositioning Gets a value indicating whether absolute positioning (G90) is active. public bool IsAbsolutePositioning { get; } Property Value bool IsHeightCompensationEnabled Gets a value indicating whether height compensation is enabled. public bool IsHeightCompensationEnabled { get; } Property Value bool IsOnArcCommand Gets a value indicating whether an arc command (G02 or G03) is active. public bool IsOnArcCommand { get; } Property Value bool IsPathPrepared Gets a value indicating whether the path is prepared (no radius compensation). public bool IsPathPrepared { get; } Property Value bool IsRadiusCompensationEnabled Gets a value indicating whether radius compensation is enabled. public bool IsRadiusCompensationEnabled { get; } Property Value bool IsToolCenterPointManagementEnabled Gets a value indicating whether tool center point management is enabled. public bool IsToolCenterPointManagementEnabled { get; } Property Value bool Line The line. [Present(\"Line\", \"Line\", PhysicsUnit.None, \"G\")] public string Line { get; } Property Value string LineIndex Line Index. Start on 0. public int LineIndex { get; } Property Value int LineNo [Present(\"Line Number\", \"LineNo\", PhysicsUnit.None, \"G\")] public int LineNo { get; } Property Value int McAbc_deg public Vec3d McAbc_deg { get; set; } Property Value Vec3d McAbc_rad Machine coordinates in ABC format (radians). public Vec3d McAbc_rad { get; } Property Value Vec3d McXyz Gets or sets the machine coordinate XYZ values. public Vec3d McXyz { get; } Property Value Vec3d McXyzabc Machine coordinate ( with side radius compensation if existed). Point is XYZ. the unit is mm. Normal is ABC. the unit is radian. public DVec3d McXyzabc { get; } Property Value DVec3d NcFlagBitArray Internal Used. public BitArray NcFlagBitArray { get; } Property Value BitArray PausingNcArg public PausingNcArg PausingNcArg { get; set; } Property Value PausingNcArg Remarks Since this is base on OneShot Flag, so here has no copy ctor. PolarEntry Data structure for polar coordinates entry. public PolarEntry PolarEntry { get; set; } Property Value PolarEntry PreparationT Tool ID for preparation. public int PreparationT { get; set; } Property Value int ProgramOrthogonalPlaneNormal The orthogonal plane transform after tilting plane transform. Include G17, G18, G19 and plane of called G12p1. public Vec3d ProgramOrthogonalPlaneNormal { get; } Property Value Vec3d ProgramPos ProgramPos can be cartesian XYZ or polar XCZ with radius-based X, depends on CoordinateInterpolationMode. public Vec3d ProgramPos { get; } Property Value Vec3d ProgramXyz Cartesian Program Position XYZ, Abs Program Position (as G90 position). NC coordinate position is the position processed by modal flags. NC coordinate position is the position after radius compensation. The NC(Program) coordinate position is comprehensible by User. MC NC conversion may raise floating error. The floating error raise the cutting force issue, especially for bottom cutting force. Hence the NC values have to be memorized. public Vec3d ProgramXyz { get; } Property Value Vec3d 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. The error maybe up to 3e-5 in current case. the bounding box size of the case is not large (TT.20230815). Also note that if using Arc command for a complete circle, the begin NC XYZ and the end NC XYZ have to be equaled. Otherwise, it will become only a very small arc rather than the circle. So be care that do not change the NC XYZ if not needed. RadiusCompensationBuf Internal use. public RadiusCompensationBuf RadiusCompensationBuf { get; set; } Property Value RadiusCompensationBuf S S. Spindle speed. public int S { get; set; } Property Value int SpindleSpeed_radds Spindle speed in radian/s. public double SpindleSpeed_radds { get; set; } Property Value double SpindleSpeed_rpm Spindle speed in RPM. public double SpindleSpeed_rpm { get; set; } Property Value double T Current equiped Tool ID. public int T { get; set; } Property Value int TiltPlaneNcArg Arguments related to tilted plane operations. public ITiltPlaneNcArg TiltPlaneNcArg { get; set; } Property Value ITiltPlaneNcArg Methods GetAttacherMat(NcEnv) Gets the attacher transformation matrix for the current machine coordinates. public Mat4d GetAttacherMat(NcEnv ncEnv) Parameters ncEnv NcEnv The NC environment. Returns Mat4d The attacher transformation matrix. GetCompensationHeight(NcEnv, IMessageKit) Gets the tool height compensation value for this NC line. public double GetCompensationHeight(NcEnv ncEnv, IMessageKit messageHost) Parameters ncEnv NcEnv NC environment messageHost IMessageKit Message host for warnings Returns double Height compensation value GetCompensationRadius(CncBrand, MillingToolOffsetTable, IMessageKit) Gets the tool radius compensation value for this NC line. public double GetCompensationRadius(CncBrand cncBrand, MillingToolOffsetTable millingToolOffsetTable, IMessageKit messageHost) Parameters cncBrand CncBrand CNC brand millingToolOffsetTable MillingToolOffsetTable Milling tool offset table messageHost IMessageKit Message host for warnings Returns double Radius compensation value GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex GetG5xCoordinateOffset(NcEnv) Gets the G5x coordinate offset for this NC line. public Vec3d GetG5xCoordinateOffset(NcEnv ncEnv) Parameters ncEnv NcEnv NC environment Returns Vec3d The G5x coordinate offset vector GetIndexedFileLine() Gets the file line associated with this object. public IndexedFileLine GetIndexedFileLine() Returns IndexedFileLine The file line object. GetMcByProgramPos(Vec3d, NcEnv, NcNoteCache, IMessageKit, out Vec3d) Internal Use. public DVec3d GetMcByProgramPos(Vec3d programPos, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageKit messageHost, out Vec3d programXyz) Parameters programPos Vec3d ncEnv NcEnv ncLineCache NcNoteCache messageHost IMessageKit programXyz Vec3d Returns DVec3d GetProgramXyzabc(NcEnv, DVec3d, out bool?, IMessageKit) Gets the program XYZABC coordinates from machine coordinates. public DVec3d GetProgramXyzabc(NcEnv ncEnv, DVec3d mcXyzabc, out bool? isG68p2Successed, IMessageKit messageHost) Parameters ncEnv NcEnv The NC environment. mcXyzabc DVec3d The machine coordinates. isG68p2Successed bool? Output parameter indicating whether G68.2 coordinate conversion was successful. messageHost IMessageKit The message host for logging. Returns DVec3d The program XYZABC coordinates. GetSourceCommand() Gets the source command associated with this instance. public ISourceCommand GetSourceCommand() Returns ISourceCommand The source command object. GetTiltMat4d(NcEnv, out Mat4d) Internal Use Only. public bool? GetTiltMat4d(NcEnv ncEnv, out Mat4d tableToFeatureTransform) Parameters ncEnv NcEnv NC environment. tableToFeatureTransform Mat4d Transform from NC to Table without tool compensation and linear coordinate offset (such as G55,G56..). Returns bool? True if G68.2 is successfully applied, false if not, and null if not applicable. HasSyntexXyz(NcEnv) Determines whether the line contains syntactic XYZ coordinates. public bool HasSyntexXyz(NcEnv ncEnv) Parameters ncEnv NcEnv NC environment Returns bool True if syntactic XYZ coordinates are present; otherwise, false. RebuildByMc(NcEnv, DVec3d, NcNoteCache, IMessageKit) Internal Use Only. For NC opt. public void RebuildByMc(NcEnv ncEnv, DVec3d mc, NcNoteCache ncLineCache, IMessageKit messageHost) Parameters ncEnv NcEnv NC environment. mc DVec3d MC coordinates. ncLineCache NcNoteCache NC line cache. messageHost IMessageKit Message host for logging and reporting. RebuildByProgramXyz(NcEnv, Vec3d, NcNoteCache, IMessageKit) Internal Use Only. For NC opt. public void RebuildByProgramXyz(NcEnv ncEnv, Vec3d programXyz, NcNoteCache ncNoteCache, IMessageKit messageHost) Parameters ncEnv NcEnv NC environment. programXyz Vec3d Program XYZ coordinates. ncNoteCache NcNoteCache NC note cache. messageHost IMessageKit Message host for logging and reporting. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.Numerical.NcNameAttribute.html": { "href": "api/Hi.Numerical.NcNameAttribute.html", @@ -3747,7 +3882,7 @@ "api/Hi.Numerical.NcProc.html": { "href": "api/Hi.Numerical.NcProc.html", "title": "Class NcProc | HiAPI-C# 2025", - "summary": "Class NcProc Namespace Hi.Numerical Assembly HiUniNc.dll Provides processing utilities for NC programming. public static class NcProc Inheritance object NcProc Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetActs(NcEnv, SeqPair, IMessageHost) Gets the acts from a sequence pair of NcLines public static IEnumerable GetActs(NcEnv ncEnv, SeqPair ncLineSeq, IMessageHost messageHost) Parameters ncEnv NcEnv The numerical control environment ncLineSeq SeqPair The sequence pair of NcLines messageHost IMessageHost The message host for logging Returns IEnumerable Enumerable of acts GetActs(NcEnv, NcLine, NcLine, IMessageHost) Gets the acts from a pair of NcLines public static IEnumerable GetActs(NcEnv ncEnv, NcLine preNcLine, NcLine curNcLine, IMessageHost messageHost) Parameters ncEnv NcEnv The numerical control environment preNcLine NcLine The previous NcLine curNcLine NcLine The current NcLine messageHost IMessageHost The message host for logging Returns IEnumerable Enumerable of acts GetActs(NcEnv, LinkedListNode, IMessageHost) Gets the acts from a linked list node containing an NcLine public static IEnumerable GetActs(NcEnv ncEnv, LinkedListNode ncLineNode, IMessageHost messageHost) Parameters ncEnv NcEnv The numerical control environment ncLineNode LinkedListNode The linked list node containing the NcLine messageHost IMessageHost The message host for logging Returns IEnumerable Enumerable of acts" + "summary": "Class NcProc Namespace Hi.Numerical Assembly HiUniNc.dll Provides processing utilities for NC programming. public static class NcProc Inheritance object NcProc Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods GetActs(NcEnv, SeqPair, IMessageKit) Gets the acts from a sequence pair of NcLines public static IEnumerable GetActs(NcEnv ncEnv, SeqPair ncLineSeq, IMessageKit messageHost) Parameters ncEnv NcEnv The numerical control environment ncLineSeq SeqPair The sequence pair of NcLines messageHost IMessageKit The message host for logging Returns IEnumerable Enumerable of acts GetActs(NcEnv, NcLine, NcLine, IMessageKit) Gets the acts from a pair of NcLines public static IEnumerable GetActs(NcEnv ncEnv, NcLine preNcLine, NcLine curNcLine, IMessageKit messageHost) Parameters ncEnv NcEnv The numerical control environment preNcLine NcLine The previous NcLine curNcLine NcLine The current NcLine messageHost IMessageKit The message host for logging Returns IEnumerable Enumerable of acts GetActs(NcEnv, LinkedListNode, IMessageKit) Gets the acts from a linked list node containing an NcLine public static IEnumerable GetActs(NcEnv ncEnv, LinkedListNode ncLineNode, IMessageKit messageHost) Parameters ncEnv NcEnv The numerical control environment ncLineNode LinkedListNode The linked list node containing the NcLine messageHost IMessageKit The message host for logging Returns IEnumerable Enumerable of acts" }, "api/Hi.Numerical.NcStepFileOutputKit.html": { "href": "api/Hi.Numerical.NcStepFileOutputKit.html", @@ -3757,7 +3892,7 @@ "api/Hi.Numerical.NcStepMonitor.html": { "href": "api/Hi.Numerical.NcStepMonitor.html", "title": "Class NcStepMonitor | HiAPI-C# 2025", - "summary": "Class NcStepMonitor Namespace Hi.Numerical Assembly HiMech.dll Monitors NC steps and provides functionality for step tracking and control. public class NcStepMonitor : IMakeXmlSource Inheritance object NcStepMonitor Implements IMakeXmlSource 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) Constructors NcStepMonitor() Initializes a new instance of the NcStepMonitor class. public NcStepMonitor() NcStepMonitor(XElement, string, IColorGuide) Initializes a new instance of the NcStepMonitor class from XML. public NcStepMonitor(XElement src, string baseDirectory, IColorGuide colorGuide) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. colorGuide IColorGuide The color guide instance. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties EnableReAsignWorkTimeFromBeginingTime If true, set WorkTime by controller; Otherwise, set WorkTime from the first run of Hi.Numerical.INcStepMonitee.AquireNcStep to the current run. public bool EnableReAsignWorkTimeFromBeginingTime { get; set; } Property Value bool IgnoreRepeatedStep Gets or sets a value indicating whether repeated steps should be ignored. public bool IgnoreRepeatedStep { get; set; } Property Value bool IsRunning Gets a value indicating whether the monitoring task is currently running. public bool IsRunning { get; } Property Value bool IsSaveNcStepProviderOnXElement Gets or sets a value indicating whether the NcStepMonitee should be saved in XML. public bool IsSaveNcStepProviderOnXElement { get; set; } Property Value bool NcStepMonitee Gets or sets the NC step monitee instance. public INcStepMonitee NcStepMonitee { get; set; } Property Value INcStepMonitee Period Gets or sets the monitoring period. public TimeSpan Period { get; set; } Property Value TimeSpan Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Reset() Resets the monitor. public void Reset() Start() Starts the monitoring task. public void Start() Stop() Stops the monitoring task. public void Stop() Events BeginOnRunningTaskEventHandler Event raised when the monitoring task begins running. public event EventHandler BeginOnRunningTaskEventHandler Event Type EventHandler EndOnRunningTaskEventHandler Event raised when the monitoring task ends running. public event EventHandler EndOnRunningTaskEventHandler Event Type EventHandler ExceptionEventHandler Event raised when an exception occurs during monitoring. public event EventHandler ExceptionEventHandler Event Type EventHandler ResetedEventHandler Event raised when the monitor is reset. public event EventHandler ResetedEventHandler Event Type EventHandler StepAccptedEventHandler Event raised when a step is accepted by the monitor. public event EventHandler StepAccptedEventHandler Event Type EventHandler" + "summary": "Class NcStepMonitor Namespace Hi.Numerical Assembly HiMech.dll Monitors NC steps and provides functionality for step tracking and control. public class NcStepMonitor : IMakeXmlSource Inheritance object NcStepMonitor Implements IMakeXmlSource 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) Constructors NcStepMonitor() Initializes a new instance of the NcStepMonitor class. public NcStepMonitor() NcStepMonitor(XElement, string, IColorGuide) Initializes a new instance of the NcStepMonitor class from XML. public NcStepMonitor(XElement src, string baseDirectory, IColorGuide colorGuide) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. colorGuide IColorGuide The color guide instance. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties EnableReAsignWorkTimeFromBeginingTime If true, set WorkTime by controller; Otherwise, set WorkTime from the first run of Hi.Numerical.INcStepMonitee.AquireNcStep to the current run. public bool EnableReAsignWorkTimeFromBeginingTime { get; set; } Property Value bool IgnoreRepeatedStep Gets or sets a value indicating whether repeated steps should be ignored. public bool IgnoreRepeatedStep { get; set; } Property Value bool IsRunning Gets a value indicating whether the monitoring task is currently running. public bool IsRunning { get; } Property Value bool IsSaveNcStepProviderOnXElement Gets or sets a value indicating whether the NcStepMonitee should be saved in XML. public bool IsSaveNcStepProviderOnXElement { get; set; } Property Value bool NcStepMonitee Gets or sets the NC step monitee instance. public INcStepMonitee NcStepMonitee { get; set; } Property Value INcStepMonitee Period Gets or sets the monitoring period. public TimeSpan Period { get; set; } Property Value TimeSpan Methods 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. Reset() Resets the monitor. public void Reset() Start() Starts the monitoring task. public void Start() Stop() Stops the monitoring task. public void Stop() Events BeginOnRunningTaskEventHandler Event raised when the monitoring task begins running. public event EventHandler BeginOnRunningTaskEventHandler Event Type EventHandler EndOnRunningTaskEventHandler Event raised when the monitoring task ends running. public event EventHandler EndOnRunningTaskEventHandler Event Type EventHandler ExceptionEventHandler Event raised when an exception occurs during monitoring. public event EventHandler ExceptionEventHandler Event Type EventHandler ResetedEventHandler Event raised when the monitor is reset. public event EventHandler ResetedEventHandler Event Type EventHandler StepAccptedEventHandler Event raised when a step is accepted by the monitor. public event EventHandler StepAccptedEventHandler Event Type EventHandler" }, "api/Hi.Numerical.NcUtil.html": { "href": "api/Hi.Numerical.NcUtil.html", @@ -3787,27 +3922,27 @@ "api/Hi.Numerical.RadiusCompensationBuf.html": { "href": "api/Hi.Numerical.RadiusCompensationBuf.html", "title": "Class RadiusCompensationBuf | HiAPI-C# 2025", - "summary": "Class RadiusCompensationBuf Namespace Hi.Numerical Assembly HiUniNc.dll Buffer for radius compensation operations in numerical control public class RadiusCompensationBuf Inheritance object RadiusCompensationBuf Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors RadiusCompensationBuf() Initializes a new instance of the RadiusCompensationBuf class. public RadiusCompensationBuf() Properties CenterProgramPos For arc command only. public Vec3d CenterProgramPos { get; set; } Property Value Vec3d CompensatedPosOnProgramCoordinate Program Pos at certain NcLine. Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1) XCZ. public Vec3d CompensatedPosOnProgramCoordinate { get; set; } Property Value Vec3d TransientBeginMc For arc command only. public DVec3d TransientBeginMc { get; set; } Property Value DVec3d TransientBeginProgramPos For arc command only. public Vec3d TransientBeginProgramPos { get; set; } Property Value Vec3d TransientEndMc For arc command only. public DVec3d TransientEndMc { get; set; } Property Value DVec3d TransientEndProgramPos For arc command only. public Vec3d TransientEndProgramPos { get; set; } Property Value Vec3d Methods ResolveRadiusCompensation(LinkedListNode, NcEnv, NcNoteCache, IMessageHost) Resolves radius compensation for the given node. public static bool ResolveRadiusCompensation(LinkedListNode srcNode, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageHost messageHost) Parameters srcNode LinkedListNode The source node to resolve radius compensation for. ncEnv NcEnv The numerical control environment. ncLineCache NcNoteCache The NC line cache for storing messages. messageHost IMessageHost The message host for reporting issues. Returns bool True if radius compensation was resolved; otherwise, false. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." + "summary": "Class RadiusCompensationBuf Namespace Hi.Numerical Assembly HiUniNc.dll Buffer for radius compensation operations in numerical control public class RadiusCompensationBuf Inheritance object RadiusCompensationBuf Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) 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) Constructors RadiusCompensationBuf() Initializes a new instance of the RadiusCompensationBuf class. public RadiusCompensationBuf() Properties CenterProgramPos For arc command only. public Vec3d CenterProgramPos { get; set; } Property Value Vec3d CompensatedPosOnProgramCoordinate Program Pos at certain NcLine. Program Pos can be Cartesian XYZ or Polar Coordinate Interpolation Mode (G12.1) XCZ. public Vec3d CompensatedPosOnProgramCoordinate { get; set; } Property Value Vec3d TransientBeginMc For arc command only. public DVec3d TransientBeginMc { get; set; } Property Value DVec3d TransientBeginProgramPos For arc command only. public Vec3d TransientBeginProgramPos { get; set; } Property Value Vec3d TransientEndMc For arc command only. public DVec3d TransientEndMc { get; set; } Property Value DVec3d TransientEndProgramPos For arc command only. public Vec3d TransientEndProgramPos { get; set; } Property Value Vec3d Methods ResolveRadiusCompensation(LinkedListNode, NcEnv, NcNoteCache, IMessageKit) Resolves radius compensation for the given node. public static bool ResolveRadiusCompensation(LinkedListNode srcNode, NcEnv ncEnv, NcNoteCache ncLineCache, IMessageKit messageHost) Parameters srcNode LinkedListNode The source node to resolve radius compensation for. ncEnv NcEnv The numerical control environment. ncLineCache NcNoteCache The NC line cache for storing messages. messageHost IMessageKit The message host for reporting issues. Returns bool True if radius compensation was resolved; otherwise, false. ToString() Returns a string that represents the current object. public override string ToString() Returns string A string that represents the current object." }, "api/Hi.Numerical.SpindleDirection.html": { "href": "api/Hi.Numerical.SpindleDirection.html", "title": "Enum SpindleDirection | HiAPI-C# 2025", "summary": "Enum SpindleDirection Namespace Hi.Numerical Assembly HiGeom.dll Enumeration of spindle rotation directions. public enum SpindleDirection Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) NumericUtil.IsRotating(SpindleDirection) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields CCW = 2 Counter-clockwise rotation (M04 command). CW = 1 Clockwise rotation (M03 command). STOP = 0 Spindle is stopped (M05 command). UnDefined = 3 Undefined direction state." }, - "api/Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html": { - "href": "api/Hi.Numerical.StepSelectionUtils.BoundAnchorMode.html", - "title": "Enum BoundAnchorMode | HiAPI-C# 2025", - "summary": "Enum BoundAnchorMode Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Defines the mode for anchoring boundaries when selecting steps. public enum BoundAnchorMode Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields FirstTouch = 4 Anchor at the first touch point. LastTouch = 8 Anchor at the last touch point. LineBegin = 1 Anchor at the beginning of a line. LineEnd = 2 Anchor at the end of a line. Undefined = 0 Undefined anchor mode." + "api/Hi.Numerical.StepSelectionUtils.AnchorMode.html": { + "href": "api/Hi.Numerical.StepSelectionUtils.AnchorMode.html", + "title": "Enum AnchorMode | HiAPI-C# 2025", + "summary": "Enum AnchorMode Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Defines the mode for anchoring boundaries when selecting steps. public enum AnchorMode Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields FirstTouch = 4 Anchor at the first touch point. LastTouch = 8 Anchor at the last touch point. LineBegin = 1 Anchor at the beginning of a line. LineEnd = 2 Anchor at the end of a line. Undefined = 0 Undefined anchor mode." }, "api/Hi.Numerical.StepSelectionUtils.BoundSelector.html": { "href": "api/Hi.Numerical.StepSelectionUtils.BoundSelector.html", "title": "Class BoundSelector | HiAPI-C# 2025", - "summary": "Class BoundSelector Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Mark on source command line for managing step. public class BoundSelector : IFileLineIndex, IGetFileLineIndex, IMakeXmlSource Inheritance object BoundSelector Implements IFileLineIndex IGetFileLineIndex IMakeXmlSource 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) Constructors BoundSelector(BoundAnchorMode, IStepShift, FileLineIndex, int) Initializes a new instance of the BoundSelector class. public BoundSelector(BoundAnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex) Parameters anchorMode BoundAnchorMode The anchor mode for the bound. shift IStepShift The step shift to apply. fileLineIndex FileLineIndex The file line index. boundStepIndex int The step index at the boundary. BoundSelector(XElement, string) Ctor. public BoundSelector(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties BoundStepIndex If locale on begin, the step index should be the first step of the line; if locale on end, the step index should be the last step of the line. i.e. the index is inclusive. public int BoundStepIndex { get; set; } Property Value int FileIndex File Index. Start on 0. public int FileIndex { get; set; } Property Value int FileLineIndex Gets or sets the file line index. public FileLineIndex FileLineIndex { get; set; } Property Value FileLineIndex FileNo Gets or sets the file number. public int FileNo { get; set; } Property Value int KeyAnchorMode Gets or sets the key anchor mode that determines how the boundary is anchored. public BoundAnchorMode KeyAnchorMode { get; set; } Property Value BoundAnchorMode LineIndex Line Index. Start on 0. public int LineIndex { get; set; } Property Value int LineNo Gets or sets the line number. public int LineNo { get; set; } Property Value int Shift Gets or sets the shift to apply to the step index. public IStepShift Shift { get; set; } Property Value IStepShift XName Name for XML IO. public static string XName { get; } Property Value string Methods GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class BoundSelector Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Mark on source command line for managing step. public class BoundSelector : IFileLineIndex, IGetFileLineIndex, IMakeXmlSource Inheritance object BoundSelector Implements IFileLineIndex IGetFileLineIndex IMakeXmlSource 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) Constructors BoundSelector(AnchorMode, IStepShift, FileLineIndex, int) Initializes a new instance of the BoundSelector class. public BoundSelector(AnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex) Parameters anchorMode AnchorMode The anchor mode for the bound. shift IStepShift The step shift to apply. fileLineIndex FileLineIndex The file line index. boundStepIndex int The step index at the boundary. BoundSelector(XElement, string) Ctor. public BoundSelector(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties BoundStepIndex If locale on begin, the step index should be the first step of the line; if locale on end, the step index should be the last step of the line. i.e. the index is inclusive. public int BoundStepIndex { get; set; } Property Value int FileIndex File Index. Start on 0. public int FileIndex { get; set; } Property Value int FileLineIndex Gets or sets the file line index. public FileLineIndex FileLineIndex { get; set; } Property Value FileLineIndex FileNo Gets or sets the file number. public int FileNo { get; set; } Property Value int KeyAnchorMode Gets or sets the key anchor mode that determines how the boundary is anchored. public AnchorMode KeyAnchorMode { get; set; } Property Value AnchorMode LineIndex Line Index. Start on 0. public int LineIndex { get; set; } Property Value int LineNo Gets or sets the line number. public int LineNo { get; set; } Property Value int Shift Gets or sets the shift to apply to the step index. public IStepShift Shift { get; set; } Property Value IStepShift XName Name for XML IO. public static string XName { get; } Property Value string Methods GetFileLineIndex() Get FileLineIndex. public FileLineIndex GetFileLineIndex() Returns FileLineIndex FileLineIndex 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." }, "api/Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html": { "href": "api/Hi.Numerical.StepSelectionUtils.BoundSelectorHost.html", "title": "Class BoundSelectorHost | HiAPI-C# 2025", - "summary": "Class BoundSelectorHost Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Hosts bound selectors and manages step sections within a CL strip. public class BoundSelectorHost : IMakeXmlSource Inheritance object BoundSelectorHost Implements IMakeXmlSource 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) Constructors BoundSelectorHost() Initializes a new instance of the BoundSelectorHost class. public BoundSelectorHost() BoundSelectorHost(XElement, string) Ctor. public BoundSelectorHost(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties XName Name for XML IO. public static string XName { get; } Property Value string Methods Begin(string, BoundAnchorMode, IStepShift, FileLineIndex, int) Marks the beginning of a step section with the specified key and parameters. public void Begin(string key, BoundAnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex) Parameters key string The key identifying the step section. anchorMode BoundAnchorMode The anchor mode for the bound. shift IStepShift The step shift to apply. fileLineIndex FileLineIndex The file line index. boundStepIndex int The step index at the boundary. Begin(string, BoundSelector) Marks the beginning of a step section with the specified key. public void Begin(string key, BoundSelector beginMark) Parameters key string The key identifying the step section. beginMark BoundSelector The bound selector marking the beginning. Clear() Clears all unclosed sections and bound selector bundles. public void Clear() End(string, BoundAnchorMode, IStepShift, FileLineIndex, int) Marks the end of a step section with the specified key and parameters. public void End(string key, BoundAnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex) Parameters key string The key identifying the step section. anchorMode BoundAnchorMode The anchor mode for the bound. shift IStepShift The step shift to apply. fileLineIndex FileLineIndex The file line index. boundStepIndex int The step index at the boundary. End(string, BoundSelector) Marks the end of a step section with the specified key. public void End(string key, BoundSelector endMark) Parameters key string The key identifying the step section. endMark BoundSelector The bound selector marking the end. GetKeyToStepSectionDictionary(ClStrip) Gets a dictionary mapping keys to their corresponding step section ranges in the CL strip. public Dictionary> GetKeyToStepSectionDictionary(ClStrip clStrip) Parameters clStrip ClStrip The CL strip containing the steps. Returns Dictionary> A dictionary mapping keys to step section ranges. GetStepSection(string, ClStrip) Gets the step section range for the specified key in the CL strip. public Range GetStepSection(string key, ClStrip clStrip) Parameters key string The key identifying the step section. clStrip ClStrip The CL strip containing the steps. Returns Range The step section range, or null if the key is not found. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class BoundSelectorHost Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Hosts bound selectors and manages step sections within a CL strip. public class BoundSelectorHost : IMakeXmlSource Inheritance object BoundSelectorHost Implements IMakeXmlSource 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) Constructors BoundSelectorHost() Initializes a new instance of the BoundSelectorHost class. public BoundSelectorHost() BoundSelectorHost(XElement, string) Ctor. public BoundSelectorHost(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties XName Name for XML IO. public static string XName { get; } Property Value string Methods Begin(string, AnchorMode, IStepShift, FileLineIndex, int) Marks the beginning of a step section with the specified key and parameters. public void Begin(string key, AnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex) Parameters key string The key identifying the step section. anchorMode AnchorMode The anchor mode for the bound. shift IStepShift The step shift to apply. fileLineIndex FileLineIndex The file line index. boundStepIndex int The step index at the boundary. Begin(string, BoundSelector) Marks the beginning of a step section with the specified key. public void Begin(string key, BoundSelector beginMark) Parameters key string The key identifying the step section. beginMark BoundSelector The bound selector marking the beginning. Clear() Clears all unclosed sections and bound selector bundles. public void Clear() End(string, AnchorMode, IStepShift, FileLineIndex, int) Marks the end of a step section with the specified key and parameters. public void End(string key, AnchorMode anchorMode, IStepShift shift, FileLineIndex fileLineIndex, int boundStepIndex) Parameters key string The key identifying the step section. anchorMode AnchorMode The anchor mode for the bound. shift IStepShift The step shift to apply. fileLineIndex FileLineIndex The file line index. boundStepIndex int The step index at the boundary. End(string, BoundSelector) Marks the end of a step section with the specified key. public void End(string key, BoundSelector endMark) Parameters key string The key identifying the step section. endMark BoundSelector The bound selector marking the end. GetKeyToStepSectionDictionary(ClStrip) Gets a dictionary mapping keys to their corresponding step section ranges in the CL strip. public Dictionary> GetKeyToStepSectionDictionary(ClStrip clStrip) Parameters clStrip ClStrip The CL strip containing the steps. Returns Dictionary> A dictionary mapping keys to step section ranges. GetStepSection(string, ClStrip) Gets the step section range for the specified key in the CL strip. public Range GetStepSection(string key, ClStrip clStrip) Parameters key string The key identifying the step section. clStrip ClStrip The CL strip containing the steps. Returns Range The step section range, or null if the key is not found. 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." }, "api/Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale.html": { "href": "api/Hi.Numerical.StepSelectionUtils.BoundSelectorPair.BoundLocale.html", @@ -3817,12 +3952,12 @@ "api/Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html": { "href": "api/Hi.Numerical.StepSelectionUtils.BoundSelectorPair.html", "title": "Class BoundSelectorPair | HiAPI-C# 2025", - "summary": "Class BoundSelectorPair Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Represents a pair of bound selectors defining the beginning and end of a step section. public class BoundSelectorPair : IMakeXmlSource Inheritance object BoundSelectorPair Implements IMakeXmlSource 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) Constructors BoundSelectorPair(BoundSelector, BoundSelector) Initializes a new instance of the BoundSelectorPair class with specified begin and end bound selectors. public BoundSelectorPair(BoundSelector begin, BoundSelector end) Parameters begin BoundSelector The beginning bound selector. end BoundSelector The ending bound selector. BoundSelectorPair(XElement, string) Ctor. public BoundSelectorPair(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties Begin Gets the beginning bound selector. public BoundSelector Begin { get; } Property Value BoundSelector End Gets the ending bound selector. public BoundSelector End { get; } Property Value BoundSelector XName Name for XML IO. public static string XName { get; } Property Value string Methods GetStepSectionBound(BoundLocale) Gets the bound selector for the specified location. public BoundSelector GetStepSectionBound(BoundSelectorPair.BoundLocale locale) Parameters locale BoundSelectorPair.BoundLocale The location of the bound to retrieve. Returns BoundSelector The bound selector at the specified location. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class BoundSelectorPair Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Represents a pair of bound selectors defining the beginning and end of a step section. public class BoundSelectorPair : IMakeXmlSource Inheritance object BoundSelectorPair Implements IMakeXmlSource 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) Constructors BoundSelectorPair(BoundSelector, BoundSelector) Initializes a new instance of the BoundSelectorPair class with specified begin and end bound selectors. public BoundSelectorPair(BoundSelector begin, BoundSelector end) Parameters begin BoundSelector The beginning bound selector. end BoundSelector The ending bound selector. BoundSelectorPair(XElement, string) Ctor. public BoundSelectorPair(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties Begin Gets the beginning bound selector. public BoundSelector Begin { get; } Property Value BoundSelector End Gets the ending bound selector. public BoundSelector End { get; } Property Value BoundSelector XName Name for XML IO. public static string XName { get; } Property Value string Methods GetStepSectionBound(BoundLocale) Gets the bound selector for the specified location. public BoundSelector GetStepSectionBound(BoundSelectorPair.BoundLocale locale) Parameters locale BoundSelectorPair.BoundLocale The location of the bound to retrieve. Returns BoundSelector The bound selector at the specified location. 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." }, "api/Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html": { "href": "api/Hi.Numerical.StepSelectionUtils.BoundSelectorStepSectionBundle.html", "title": "Class BoundSelectorStepSectionBundle | HiAPI-C# 2025", - "summary": "Class BoundSelectorStepSectionBundle Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Represents a bundle containing a boundary selector pair and the corresponding step section range. public class BoundSelectorStepSectionBundle : IMakeXmlSource Inheritance object BoundSelectorStepSectionBundle Implements IMakeXmlSource 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) Constructors BoundSelectorStepSectionBundle(BoundSelectorPair, Range) Initializes a new instance of the BoundSelectorStepSectionBundle class with the specified boundary selector pair and step section. public BoundSelectorStepSectionBundle(BoundSelectorPair boundSelectorPair, Range stepSection) Parameters boundSelectorPair BoundSelectorPair The boundary selector pair. stepSection Range The step section range. BoundSelectorStepSectionBundle(XElement, string) Ctor. public BoundSelectorStepSectionBundle(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties BoundSelectorPair Gets or sets the boundary selector pair that defines the step section. public BoundSelectorPair BoundSelectorPair { get; set; } Property Value BoundSelectorPair XName Name for XML IO. public static string XName { get; } Property Value string Methods BuildStepSection(ClStrip) Builds the step section range from the CL strip using the boundary selector pair. public Range BuildStepSection(ClStrip clStrip) Parameters clStrip ClStrip The CL strip to build the step section from. Returns Range The built step section range. CallStepSection(ClStrip) Gets the existing step section or builds it if it doesn't exist. public Range CallStepSection(ClStrip clStrip) Parameters clStrip ClStrip The CL strip to use for building the step section if needed. Returns Range The step section range. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class BoundSelectorStepSectionBundle Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Represents a bundle containing a boundary selector pair and the corresponding step section range. public class BoundSelectorStepSectionBundle : IMakeXmlSource Inheritance object BoundSelectorStepSectionBundle Implements IMakeXmlSource 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) Constructors BoundSelectorStepSectionBundle(BoundSelectorPair, Range) Initializes a new instance of the BoundSelectorStepSectionBundle class with the specified boundary selector pair and step section. public BoundSelectorStepSectionBundle(BoundSelectorPair boundSelectorPair, Range stepSection) Parameters boundSelectorPair BoundSelectorPair The boundary selector pair. stepSection Range The step section range. BoundSelectorStepSectionBundle(XElement, string) Ctor. public BoundSelectorStepSectionBundle(XElement src, string baseDirectory) Parameters src XElement XML source element baseDirectory string Base directory for resolving relative paths Properties BoundSelectorPair Gets or sets the boundary selector pair that defines the step section. public BoundSelectorPair BoundSelectorPair { get; set; } Property Value BoundSelectorPair XName Name for XML IO. public static string XName { get; } Property Value string Methods BuildStepSection(ClStrip) Builds the step section range from the CL strip using the boundary selector pair. public Range BuildStepSection(ClStrip clStrip) Parameters clStrip ClStrip The CL strip to build the step section from. Returns Range The built step section range. CallStepSection(ClStrip) Gets the existing step section or builds it if it doesn't exist. public Range CallStepSection(ClStrip clStrip) Parameters clStrip ClStrip The CL strip to use for building the step section if needed. Returns Range The step section range. 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." }, "api/Hi.Numerical.StepSelectionUtils.BoundSelectorUtil.html": { "href": "api/Hi.Numerical.StepSelectionUtils.BoundSelectorUtil.html", @@ -3832,22 +3967,22 @@ "api/Hi.Numerical.StepSelectionUtils.DistanceShift.html": { "href": "api/Hi.Numerical.StepSelectionUtils.DistanceShift.html", "title": "Class DistanceShift | HiAPI-C# 2025", - "summary": "Class DistanceShift Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll A step shift implementation that shifts based on distance along the tool path. public class DistanceShift : IStepShift, IMakeXmlSource Inheritance object DistanceShift Implements IStepShift IMakeXmlSource 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) Constructors DistanceShift(double) Constructor with specified distance shift in millimeters. public DistanceShift(double distanceShift_mm) Parameters distanceShift_mm double The distance to shift in millimeters. DistanceShift(XElement) Ctor. public DistanceShift(XElement src) Parameters src XElement XML Properties DistanceShift_mm The distance to shift in millimeters. public double DistanceShift_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods GetShiftedStepIndex(ClStrip, int) Gets the shifted step index based on distance along the tool path. public int GetShiftedStepIndex(ClStrip host, int originalStepIndex) Parameters host ClStrip The CL strip hosting the steps. originalStepIndex int The original step index to shift from. Returns int The shifted step index after applying the distance shift. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class DistanceShift Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll A step shift implementation that shifts based on distance along the tool path. public class DistanceShift : IStepShift, IMakeXmlSource Inheritance object DistanceShift Implements IStepShift IMakeXmlSource 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) Constructors DistanceShift(double) Constructor with specified distance shift in millimeters. public DistanceShift(double distanceShift_mm) Parameters distanceShift_mm double The distance to shift in millimeters. DistanceShift(XElement) Ctor. public DistanceShift(XElement src) Parameters src XElement XML Properties DistanceShift_mm The distance to shift in millimeters. public double DistanceShift_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods GetShiftedStepIndex(ClStrip, int) Gets the shifted step index based on distance along the tool path. public int GetShiftedStepIndex(ClStrip host, int originalStepIndex) Parameters host ClStrip The CL strip hosting the steps. originalStepIndex int The original step index to shift from. Returns int The shifted step index after applying the distance shift. 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." }, "api/Hi.Numerical.StepSelectionUtils.IStepShift.html": { "href": "api/Hi.Numerical.StepSelectionUtils.IStepShift.html", "title": "Interface IStepShift | HiAPI-C# 2025", - "summary": "Interface IStepShift Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Interface for defining step shift behavior. public interface IStepShift : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string) 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) Methods GetShiftedStepIndex(ClStrip, int) Gets the shifted step index based on the original step index. int GetShiftedStepIndex(ClStrip host, int originalStepIndex) Parameters host ClStrip The CL strip hosting the steps. originalStepIndex int The original step index to shift from. Returns int The shifted step index." + "summary": "Interface IStepShift Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Interface for defining step shift behavior. public interface IStepShift : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Methods GetShiftedStepIndex(ClStrip, int) Gets the shifted step index based on the original step index. int GetShiftedStepIndex(ClStrip host, int originalStepIndex) Parameters host ClStrip The CL strip hosting the steps. originalStepIndex int The original step index to shift from. Returns int The shifted step index." }, "api/Hi.Numerical.StepSelectionUtils.TimeShift.html": { "href": "api/Hi.Numerical.StepSelectionUtils.TimeShift.html", "title": "Class TimeShift | HiAPI-C# 2025", - "summary": "Class TimeShift Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Represents a time-based shift operation for machining steps. This class provides functionality to shift step indices based on time offsets. public class TimeShift : IStepShift, IMakeXmlSource Inheritance object TimeShift Implements IStepShift IMakeXmlSource 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) Constructors TimeShift(TimeSpan, bool) Initializes a new instance of the TimeShift class with the specified parameters. public TimeShift(TimeSpan timeShift, bool isBackward) Parameters timeShift TimeSpan The amount of time to shift. isBackward bool True to shift backward in time, false to shift forward. TimeShift(XElement) Initializes a new instance of the TimeShift class from XML. public TimeShift(XElement src) Parameters src XElement The XML element containing the time shift configuration. Properties IsBackward Gets or sets a value indicating whether the shift is backward in time. When true, shifts steps earlier in time; when false, shifts steps later in time. public bool IsBackward { get; set; } Property Value bool ShiftTimeSpan Gets or sets the amount of time to shift. public TimeSpan ShiftTimeSpan { get; set; } Property Value TimeSpan XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string Remarks This name is used as the XML tag when serializing/deserializing TimeShift instances. The value is the unqualified name of the class (TimeShift). Methods GetShiftedStepIndex(ClStrip, int) Gets the shifted step index based on the original index and the time shift configuration. public int GetShiftedStepIndex(ClStrip host, int originalStepIndex) Parameters host ClStrip The cutter location strip containing the steps. originalStepIndex int The original step index to shift. Returns int The shifted step index, or -1 if the shift results in an invalid index. MakeXmlSource(string, string) Creates an XML representation of this time shift configuration. public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths (not used). relFile string The relative file path (not used). Returns XElement An XML element containing the time shift configuration." + "summary": "Class TimeShift Namespace Hi.Numerical.StepSelectionUtils Assembly HiMech.dll Represents a time-based shift operation for machining steps. This class provides functionality to shift step indices based on time offsets. public class TimeShift : IStepShift, IMakeXmlSource Inheritance object TimeShift Implements IStepShift IMakeXmlSource 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) Constructors TimeShift(TimeSpan, bool) Initializes a new instance of the TimeShift class with the specified parameters. public TimeShift(TimeSpan timeShift, bool isBackward) Parameters timeShift TimeSpan The amount of time to shift. isBackward bool True to shift backward in time, false to shift forward. TimeShift(XElement) Initializes a new instance of the TimeShift class from XML. public TimeShift(XElement src) Parameters src XElement The XML element containing the time shift configuration. Properties IsBackward Gets or sets a value indicating whether the shift is backward in time. When true, shifts steps earlier in time; when false, shifts steps later in time. public bool IsBackward { get; set; } Property Value bool ShiftTimeSpan Gets or sets the amount of time to shift. public TimeSpan ShiftTimeSpan { get; set; } Property Value TimeSpan XName Gets the XML element name used for serialization. public static string XName { get; } Property Value string Remarks This name is used as the XML tag when serializing/deserializing TimeShift instances. The value is the unqualified name of the class (TimeShift). Methods GetShiftedStepIndex(ClStrip, int) Gets the shifted step index based on the original index and the time shift configuration. public int GetShiftedStepIndex(ClStrip host, int originalStepIndex) Parameters host ClStrip The cutter location strip containing the steps. originalStepIndex int The original step index to shift. Returns int The shifted step index, or -1 if the shift results in an invalid index. 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." }, "api/Hi.Numerical.StepSelectionUtils.html": { "href": "api/Hi.Numerical.StepSelectionUtils.html", "title": "Namespace Hi.Numerical.StepSelectionUtils | HiAPI-C# 2025", - "summary": "Namespace Hi.Numerical.StepSelectionUtils Classes BoundSelector Mark on source command line for managing step. BoundSelectorHost Hosts bound selectors and manages step sections within a CL strip. BoundSelectorPair Represents a pair of bound selectors defining the beginning and end of a step section. BoundSelectorStepSectionBundle Represents a bundle containing a boundary selector pair and the corresponding step section range. BoundSelectorUtil Utility class for selecting steps within boundaries in a CL strip. DistanceShift A step shift implementation that shifts based on distance along the tool path. TimeShift Represents a time-based shift operation for machining steps. This class provides functionality to shift step indices based on time offsets. Interfaces IStepShift Interface for defining step shift behavior. Enums BoundAnchorMode Defines the mode for anchoring boundaries when selecting steps. BoundSelectorPair.BoundLocale Defines the location of a bound within the pair." + "summary": "Namespace Hi.Numerical.StepSelectionUtils Classes BoundSelector Mark on source command line for managing step. BoundSelectorHost Hosts bound selectors and manages step sections within a CL strip. BoundSelectorPair Represents a pair of bound selectors defining the beginning and end of a step section. BoundSelectorStepSectionBundle Represents a bundle containing a boundary selector pair and the corresponding step section range. BoundSelectorUtil Utility class for selecting steps within boundaries in a CL strip. DistanceShift A step shift implementation that shifts based on distance along the tool path. TimeShift Represents a time-based shift operation for machining steps. This class provides functionality to shift step indices based on time offsets. Interfaces IStepShift Interface for defining step shift behavior. Enums AnchorMode Defines the mode for anchoring boundaries when selecting steps. BoundSelectorPair.BoundLocale Defines the location of a bound within the pair." }, "api/Hi.Numerical.SubStringKit.ActivationMode.html": { "href": "api/Hi.Numerical.SubStringKit.ActivationMode.html", @@ -3872,12 +4007,12 @@ "api/Hi.Numerical.Xyzabc.CodeXyzabcChain.html": { "href": "api/Hi.Numerical.Xyzabc.CodeXyzabcChain.html", "title": "Class CodeXyzabcChain | HiAPI-C# 2025", - "summary": "Class CodeXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll IXyzabcChain Composed by ChainCode. On purpose of easy XML hand management. public class CodeXyzabcChain : IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource Inheritance object CodeXyzabcChain Implements IXyzabcChain IGetXyzabcChain ISolidMachiningChain IMachiningChain IGetAsmb IGetTopoIndex IGetRootAnchor IGetSolidMachiningChain IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CodeXyzabcChain(string, bool) Initializes a new instance of the CodeXyzabcChain class. public CodeXyzabcChain(string chainCode = \"[O][Z][C][w];[O][Y][X][B][S][t]\", bool isVertical = true) Parameters chainCode string Chain code of machine tool. Must contain at least base, tool buckle and table buckle, where the code is O,t and w, respectively. The other available members: S is spindle. X,Y and Z are translational motion component. A,B and C are rotational motion component. The codes should be all uppercases. isVertical bool Whether the machine is in vertical configuration Examples The chain code of a three axis machine tool can be defined by \"[O][Z][w];[O][Y][X][S][t]\". The chain code of a five axis machine tool can be defined by \"[O][Z][C][w];[O][Y][X][B][S][t]\". CodeXyzabcChain(XElement, string, string) Initializes a new instance of the CodeXyzabcChain class from XML. public CodeXyzabcChain(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Properties AnchorToSolid Gets or sets the dictionary mapping anchors to solids for display purposes. public Dictionary AnchorToSolid { get; set; } Property Value Dictionary Asmb Gets the assembly instance. public Asmb Asmb { get; } Property Value Asmb ChainBegin Gets the chain begin anchor. public Anchor ChainBegin { get; } Property Value Anchor ChainCode ChainCode is the chain code of machine tool. Each machine tool component is represented by a word embraced by brackets. Must contain at least base, tool buckle and table buckle, where the code is O,t and w, respectively. The other available members: S is spindle. X,Y and Z are translational motion component. A,B and C are rotational motion component. public string ChainCode { get; } Property Value string ChainEnd Gets the chain end anchor. public Anchor ChainEnd { get; } Property Value Anchor CodeToAnc Gets the dictionary mapping component codes to anchors. public Dictionary CodeToAnc { get; } Property Value Dictionary ComponentCodes_O2T Gets the list of component codes from root to tool buckle. public List ComponentCodes_O2T { get; } Property Value List ComponentCodes_O2W Gets the list of component codes from root to table buckle. public List ComponentCodes_O2W { get; } Property Value List IsVertical Set the machine to vertical; otherwise, set to horizontal. public bool IsVertical { get; } Property Value bool McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] RootAnchor Gets the root anchor of the XYZABC chain. public Anchor RootAnchor { get; } Property Value Anchor TableBuckleTransformer Gets the table buckle transformer. public IStaticTransformer TableBuckleTransformer { get; set; } Property Value IStaticTransformer ToolBuckleTransformer Gets or sets the static transformer for the tool buckle. public IStaticTransformer ToolBuckleTransformer { get; set; } Property Value IStaticTransformer TransformerA Gets the A-axis transformer. public DynamicRotation TransformerA { get; } Property Value DynamicRotation TransformerB Gets the B-axis transformer. public DynamicRotation TransformerB { get; } Property Value DynamicRotation TransformerC Gets the C-axis transformer. public DynamicRotation TransformerC { get; } Property Value DynamicRotation TransformerX Gets the X-axis transformer. public DynamicTranslation TransformerX { get; } Property Value DynamicTranslation TransformerY Gets the Y-axis transformer. public DynamicTranslation TransformerY { get; } Property Value DynamicTranslation TransformerZ Gets the Z-axis transformer. public DynamicTranslation TransformerZ { get; } Property Value DynamicTranslation XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolidMachiningChain() Get ISolidMachiningChain. public ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain ISolidMachiningChain GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CodeXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll IXyzabcChain Composed by ChainCode. On purpose of easy XML hand management. public class CodeXyzabcChain : IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource Inheritance object CodeXyzabcChain Implements IXyzabcChain IGetXyzabcChain IMachiningChain IGetAsmb IGetAnchor IGetTopoIndex IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors CodeXyzabcChain(string, bool) Initializes a new instance of the CodeXyzabcChain class. public CodeXyzabcChain(string chainCode = \"[O][Z][C][w];[O][Y][X][B][S][t]\", bool isVertical = true) Parameters chainCode string Chain code of machine tool. Must contain at least base, tool buckle and table buckle, where the code is O,t and w, respectively. The other available members: S is spindle. X,Y and Z are translational motion component. A,B and C are rotational motion component. The codes should be all uppercases. isVertical bool Whether the machine is in vertical configuration Examples The chain code of a three axis machine tool can be defined by \"[O][Z][w];[O][Y][X][S][t]\". The chain code of a five axis machine tool can be defined by \"[O][Z][C][w];[O][Y][X][B][S][t]\". CodeXyzabcChain(XElement, string, string) Initializes a new instance of the CodeXyzabcChain class from XML. public CodeXyzabcChain(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Properties AnchorToSolid Gets or sets the dictionary mapping anchors to solids for display purposes. public Dictionary AnchorToSolid { get; set; } Property Value Dictionary Asmb Gets the assembly instance. public Asmb Asmb { get; } Property Value Asmb ChainBegin Gets the chain begin anchor. public Anchor ChainBegin { get; } Property Value Anchor ChainCode ChainCode is the chain code of machine tool. Each machine tool component is represented by a word embraced by brackets. Must contain at least base, tool buckle and table buckle, where the code is O,t and w, respectively. The other available members: S is spindle. X,Y and Z are translational motion component. A,B and C are rotational motion component. public string ChainCode { get; } Property Value string ChainEnd Gets the chain end anchor. public Anchor ChainEnd { get; } Property Value Anchor CodeToAnc Gets the dictionary mapping component codes to anchors. public Dictionary CodeToAnc { get; } Property Value Dictionary ComponentCodes_O2T Gets the list of component codes from root to tool buckle. public List ComponentCodes_O2T { get; } Property Value List ComponentCodes_O2W Gets the list of component codes from root to table buckle. public List ComponentCodes_O2W { get; } Property Value List IsVertical Set the machine to vertical; otherwise, set to horizontal. public bool IsVertical { get; } Property Value bool McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] RootAnchor Gets the root anchor of the XYZABC chain. public Anchor RootAnchor { get; } Property Value Anchor TableBuckleTransformer Gets the table buckle transformer. public IStaticTransformer TableBuckleTransformer { get; set; } Property Value IStaticTransformer ToolBuckleTransformer Gets or sets the static transformer for the tool buckle. public IStaticTransformer ToolBuckleTransformer { get; set; } Property Value IStaticTransformer TransformerA Gets the A-axis transformer. public DynamicRotation TransformerA { get; } Property Value DynamicRotation TransformerB Gets the B-axis transformer. public DynamicRotation TransformerB { get; } Property Value DynamicRotation TransformerC Gets the C-axis transformer. public DynamicRotation TransformerC { get; } Property Value DynamicRotation TransformerX Gets the X-axis transformer. public DynamicTranslation TransformerX { get; } Property Value DynamicTranslation TransformerY Gets the Y-axis transformer. public DynamicTranslation TransformerY { get; } Property Value DynamicTranslation TransformerZ Gets the Z-axis transformer. public DynamicTranslation TransformerZ { get; } Property Value DynamicTranslation XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain 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." }, "api/Hi.Numerical.Xyzabc.GeneralXyzabcChain.html": { "href": "api/Hi.Numerical.Xyzabc.GeneralXyzabcChain.html", "title": "Class GeneralXyzabcChain | HiAPI-C# 2025", - "summary": "Class GeneralXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Represents a general XYZABC chain that can be constructed from a general mechanism. public class GeneralXyzabcChain : IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource Inheritance object GeneralXyzabcChain Implements IXyzabcChain IGetXyzabcChain ISolidMachiningChain IMachiningChain IGetAsmb IGetTopoIndex IGetRootAnchor IGetSolidMachiningChain IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeneralXyzabcChain(GeneralMechanism) Initializes a new instance of the GeneralXyzabcChain class with the specified general mechanism. public GeneralXyzabcChain(GeneralMechanism generalMechanism) Parameters generalMechanism GeneralMechanism The general mechanism to use for the chain. GeneralXyzabcChain(XElement, string) Initializes a new instance of the GeneralXyzabcChain class from XML. public GeneralXyzabcChain(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Properties Asmb Asmb. public Asmb Asmb { get; } Property Value Asmb GeneralMechanismFile Gets or sets the file path for the general mechanism. public string GeneralMechanismFile { get; set; } Property Value string McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] TableBuckleTransformer Gets or sets the static transformer for the table buckle. public IStaticTransformer TableBuckleTransformer { get; set; } Property Value IStaticTransformer ToolBuckleTransformer Gets or sets the static transformer for the tool buckle. public IStaticTransformer ToolBuckleTransformer { get; set; } Property Value IStaticTransformer TransformerA Transformer A. public DynamicRotation TransformerA { get; } Property Value DynamicRotation TransformerB Transformer B. public DynamicRotation TransformerB { get; } Property Value DynamicRotation TransformerC Transformer C. public DynamicRotation TransformerC { get; } Property Value DynamicRotation TransformerX Transformer X. public DynamicTranslation TransformerX { get; } Property Value DynamicTranslation TransformerY Transformer Y. public DynamicTranslation TransformerY { get; } Property Value DynamicTranslation TransformerZ Transformer Z. public DynamicTranslation TransformerZ { get; } Property Value DynamicTranslation XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolidMachiningChain() Get ISolidMachiningChain. public ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain ISolidMachiningChain GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state UpdateByMechanism() Updates the XYZABC chain components based on the current general mechanism. public void UpdateByMechanism()" + "summary": "Class GeneralXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Represents a general XYZABC chain that can be constructed from a general mechanism. public class GeneralXyzabcChain : IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, IMakeXmlSource Inheritance object GeneralXyzabcChain Implements IXyzabcChain IGetXyzabcChain IMachiningChain IGetAsmb IGetAnchor IGetTopoIndex IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d IMakeXmlSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Constructors GeneralXyzabcChain(GeneralMechanism) Initializes a new instance of the GeneralXyzabcChain class with the specified general mechanism. public GeneralXyzabcChain(GeneralMechanism generalMechanism) Parameters generalMechanism GeneralMechanism The general mechanism to use for the chain. GeneralXyzabcChain(XElement, string) Initializes a new instance of the GeneralXyzabcChain class from XML. public GeneralXyzabcChain(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Properties Asmb Asmb. public Asmb Asmb { get; } Property Value Asmb GeneralMechanismFile Gets or sets the file path for the general mechanism. public string GeneralMechanismFile { get; set; } Property Value string McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] TableBuckleTransformer Gets or sets the static transformer for the table buckle. public IStaticTransformer TableBuckleTransformer { get; set; } Property Value IStaticTransformer ToolBuckleTransformer Gets or sets the static transformer for the tool buckle. public IStaticTransformer ToolBuckleTransformer { get; set; } Property Value IStaticTransformer TransformerA Transformer A. public DynamicRotation TransformerA { get; } Property Value DynamicRotation TransformerB Transformer B. public DynamicRotation TransformerB { get; } Property Value DynamicRotation TransformerC Transformer C. public DynamicRotation TransformerC { get; } Property Value DynamicRotation TransformerX Transformer X. public DynamicTranslation TransformerX { get; } Property Value DynamicTranslation TransformerY Transformer Y. public DynamicTranslation TransformerY { get; } Property Value DynamicTranslation TransformerZ Transformer Z. public DynamicTranslation TransformerZ { get; } Property Value DynamicTranslation XName Gets the XML element name for serialization. public static string XName { get; } Property Value string Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain 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. UpdateByMechanism() Updates the XYZABC chain components based on the current general mechanism. public void UpdateByMechanism()" }, "api/Hi.Numerical.Xyzabc.ICoordinateConverter.html": { "href": "api/Hi.Numerical.Xyzabc.ICoordinateConverter.html", @@ -3897,22 +4032,22 @@ "api/Hi.Numerical.Xyzabc.IXyzabcChain.html": { "href": "api/Hi.Numerical.Xyzabc.IXyzabcChain.html", "title": "Interface IXyzabcChain | HiAPI-C# 2025", - "summary": "Interface IXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll A single chain contains subset transformers of {X,Y,Z,A,B,C} . public interface IXyzabcChain : IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d Inherited Members IGetXyzabcChain.GetXyzabcChain() IMachiningChain.GetTableBuckle() IMachiningChain.GetToolBuckle() IMachiningChain.McCodes IMachiningChain.McTransformers IGetAsmb.GetAsmb() IGetRootAnchor.GetRootAnchor() IGetSolidMachiningChain.GetSolidMachiningChain() IMakeXmlSource.MakeXmlSource(string, string) IGetAnchorToSolidDictionary.GetAnchorToSolidDictionary() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods GetTransformerA() Get transformer A. DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z" + "summary": "Interface IXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll A single chain contains subset transformers of {X,Y,Z,A,B,C} . public interface IXyzabcChain : IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d Inherited Members IGetXyzabcChain.GetXyzabcChain() IMachiningChain.GetTableBuckle() IMachiningChain.GetToolBuckle() IMachiningChain.McCodes IMachiningChain.McTransformers IGetAsmb.GetAsmb() IGetAnchor.GetAnchor() IMakeXmlSource.MakeXmlSource(string, string, bool) IGetAnchorToSolidDictionary.GetAnchorToSolidDictionary() IGetAnchoredDisplayeeList.GetAnchoredDisplayeeList() IExpandToBox3d.ExpandToBox3d(Box3d) Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) DuplicateUtil.TryDuplicate(TSelf, params object[]) InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Methods GetTransformerA() Get transformer A. DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z" }, "api/Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html": { "href": "api/Hi.Numerical.Xyzabc.ReflectedXyzabcChain.html", "title": "Class ReflectedXyzabcChain | HiAPI-C# 2025", - "summary": "Class ReflectedXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Cloned CodeXyzabcChain. public class ReflectedXyzabcChain : IXyzabcChain, IGetXyzabcChain, ISolidMachiningChain, IMachiningChain, IGetAsmb, IGetTopoIndex, IGetRootAnchor, IGetSolidMachiningChain, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d Inheritance object ReflectedXyzabcChain Implements IXyzabcChain IGetXyzabcChain ISolidMachiningChain IMachiningChain IGetAsmb IGetTopoIndex IGetRootAnchor IGetSolidMachiningChain IMakeXmlSource IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) 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) Constructors ReflectedXyzabcChain(IXyzabcChain) Creates a reflected XYZABC chain from a source chain. public ReflectedXyzabcChain(IXyzabcChain src) Parameters src IXyzabcChain The source XYZABC chain. Properties AnchorToSolid Dictionary mapping anchors to solids. public Dictionary AnchorToSolid { get; set; } Property Value Dictionary Asmb The assembly. public Asmb Asmb { get; } Property Value Asmb ChainBegin The beginning anchor of the chain. public Anchor ChainBegin { get; } Property Value Anchor ChainEnd The ending anchor of the chain. public Anchor ChainEnd { get; } Property Value Anchor McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] RootAnchor The root anchor. public Anchor RootAnchor { get; } Property Value Anchor SourceChain Source. public IXyzabcChain SourceChain { get; } Property Value IXyzabcChain TopoReflection Topology reflection. public TopoReflection TopoReflection { get; } Property Value TopoReflection TransformerA The A-axis transformer. public DynamicRotation TransformerA { get; } Property Value DynamicRotation TransformerB The B-axis transformer. public DynamicRotation TransformerB { get; } Property Value DynamicRotation TransformerC The C-axis transformer. public DynamicRotation TransformerC { get; } Property Value DynamicRotation TransformerX The X-axis transformer. public DynamicTranslation TransformerX { get; } Property Value DynamicTranslation TransformerY The Y-axis transformer. public DynamicTranslation TransformerY { get; } Property Value DynamicTranslation TransformerZ The Z-axis transformer. public DynamicTranslation TransformerZ { get; } Property Value DynamicTranslation XName Name for XML serialization. public static string XName { get; } Property Value string Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetRootAnchor() Get root anchor. public Anchor GetRootAnchor() Returns Anchor root anchor. GetSolidMachiningChain() Get ISolidMachiningChain. public ISolidMachiningChain GetSolidMachiningChain() Returns ISolidMachiningChain ISolidMachiningChain GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ReflectedXyzabcChain Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Cloned CodeXyzabcChain. public class ReflectedXyzabcChain : IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d Inheritance object ReflectedXyzabcChain Implements IXyzabcChain IGetXyzabcChain IMachiningChain IGetAsmb IGetAnchor IGetTopoIndex IMakeXmlSource IGetAnchorToSolidDictionary IGetAnchoredDisplayeeList IExpandToBox3d Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) XyzabcUtil.GenerateCollisionIndexPairs(IXyzabcChain) XyzabcUtil.GetMc(IXyzabcChain, out DVec3d) XyzabcUtil.GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) XyzabcUtil.GetMcAbc_rad(IXyzabcChain, out Abc) XyzabcUtil.GetMcXyzabc(IXyzabcChain) XyzabcUtil.GetNp(IXyzabcChain) XyzabcUtil.GetTransformationMat4d(IXyzabcChain) XyzabcUtil.SetMc(IXyzabcChain, DVec3d) XyzabcUtil.SetMc(IXyzabcChain, Vec3d) XyzabcUtil.SetMc(IXyzabcChain, double, double, double) XyzabcUtil.SetMc(IXyzabcChain, double, double, double, double, double, double) XyzabcUtil.SetMcAbc_rad(IXyzabcChain, Vec3d) 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) Constructors ReflectedXyzabcChain(IXyzabcChain) Creates a reflected XYZABC chain from a source chain. public ReflectedXyzabcChain(IXyzabcChain src) Parameters src IXyzabcChain The source XYZABC chain. Properties AnchorToSolid Dictionary mapping anchors to solids. public Dictionary AnchorToSolid { get; set; } Property Value Dictionary Asmb The assembly. public Asmb Asmb { get; } Property Value Asmb ChainBegin The beginning anchor of the chain. public Anchor ChainBegin { get; } Property Value Anchor ChainEnd The ending anchor of the chain. public Anchor ChainEnd { get; } Property Value Anchor McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] RootAnchor The root anchor. public Anchor RootAnchor { get; } Property Value Anchor SourceChain Source. public IXyzabcChain SourceChain { get; } Property Value IXyzabcChain TopoReflection Topology reflection. public TopoReflection TopoReflection { get; } Property Value TopoReflection TransformerA The A-axis transformer. public DynamicRotation TransformerA { get; } Property Value DynamicRotation TransformerB The B-axis transformer. public DynamicRotation TransformerB { get; } Property Value DynamicRotation TransformerC The C-axis transformer. public DynamicRotation TransformerC { get; } Property Value DynamicRotation TransformerX The X-axis transformer. public DynamicTranslation TransformerX { get; } Property Value DynamicTranslation TransformerY The Y-axis transformer. public DynamicTranslation TransformerY { get; } Property Value DynamicTranslation TransformerZ The Z-axis transformer. public DynamicTranslation TransformerZ { get; } Property Value DynamicTranslation XName Name for XML serialization. public static string XName { get; } Property Value string Methods ExpandToBox3d(Box3d) Expands the destination box. This function is usually used to compute the bounding box of elements. public void ExpandToBox3d(Box3d dst) Parameters dst Box3d Destination box GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAnchoredDisplayeeList() Gets a list of anchored displayable objects. public List GetAnchoredDisplayeeList() Returns List A list of IAnchoredDisplayee objects GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. GetTransformerA() Get transformer A. public DynamicRotation GetTransformerA() Returns DynamicRotation transformer A GetTransformerB() Get transformer B. public DynamicRotation GetTransformerB() Returns DynamicRotation transformer B GetTransformerC() Get transformer C. public DynamicRotation GetTransformerC() Returns DynamicRotation transformer C GetTransformerX() Get transformer X. public DynamicTranslation GetTransformerX() Returns DynamicTranslation transformer X GetTransformerY() Get transformer Y. public DynamicTranslation GetTransformerY() Returns DynamicTranslation transformer Y GetTransformerZ() Get transformer Z. public DynamicTranslation GetTransformerZ() Returns DynamicTranslation transformer Z GetXyzabcChain() Get IXyzabcChain. public IXyzabcChain GetXyzabcChain() Returns IXyzabcChain IXyzabcChain 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." }, "api/Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html": { "href": "api/Hi.Numerical.Xyzabc.SimpleChainCoordinateConverter.html", "title": "Class SimpleChainCoordinateConverter | HiAPI-C# 2025", - "summary": "Class SimpleChainCoordinateConverter Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Provides coordinate conversion functionality for a simple chain configuration. public class SimpleChainCoordinateConverter : ICoordinateConverter, IMakeXmlSource Inheritance object SimpleChainCoordinateConverter Implements ICoordinateConverter IMakeXmlSource 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) Constructors SimpleChainCoordinateConverter() Initializes a new instance of the SimpleChainCoordinateConverter class. public SimpleChainCoordinateConverter() SimpleChainCoordinateConverter(string) Initializes a new instance of the SimpleChainCoordinateConverter class with a specified chain code. public SimpleChainCoordinateConverter(string chainCode) Parameters chainCode string The chain code defining the coordinate system. SimpleChainCoordinateConverter(XElement) Initializes a new instance of the SimpleChainCoordinateConverter class from an XML element. public SimpleChainCoordinateConverter(XElement src) Parameters src XElement The XML element containing the converter configuration. Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Properties ChainCode ChainCode of machine tool. Must contain at least base, tool buckle and table buckle, where the code is O,T and W, respectively. The other available members: S is spindle. X,Y and Z are translational motion component. A,B and C are rotational motion component. The codes should be all uppercases. public string ChainCode { get; set; } Property Value string Methods AttacherPnToMc(DVec3d, out bool) tool attacher NP (Normal and Point) to machine coordinate. The NP is from table buckle to tool attacher. public DVec3d AttacherPnToMc(DVec3d np, out bool isConverted) Parameters np DVec3d isConverted bool is conversion succeed Returns DVec3d machine coordinate IsAxisAExisted() Is rotary A existed. public bool IsAxisAExisted() Returns bool Is rotary A existed. IsAxisBExisted() Is rotary B existed. public bool IsAxisBExisted() Returns bool Is rotary B existed. IsAxisCExisted() Is rotary C existed. public bool IsAxisCExisted() Returns bool Is rotary C existed. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state McAbcToTiltMat(Vec3d) Converts machine ABC coordinates to a tilt matrix. public Mat4d McAbcToTiltMat(Vec3d mcAbc_rad) Parameters mcAbc_rad Vec3d The machine ABC coordinates in radians Returns Mat4d The tilt matrix McToAttacherMat(DVec3d) Converts machine coordinates to an attacher matrix. public Mat4d McToAttacherMat(DVec3d mc) Parameters mc DVec3d Returns Mat4d The attacher matrix McToAttacherPn(DVec3d) Machine coordinate to tool attacher NP (Normal and Point). The NP is from table buckle to tool attacher. public DVec3d McToAttacherPn(DVec3d mc) Parameters mc DVec3d Returns DVec3d tool attacher Pn (Point and Normal) TiltMatToMcAbc(Mat4d, out Vec3d) Converts a tilt matrix to machine ABC coordinates. public bool TiltMatToMcAbc(Mat4d tiltMat, out Vec3d mcAbc_rad) Parameters tiltMat Mat4d The tilt matrix to convert mcAbc_rad Vec3d Output parameter that will contain the machine ABC coordinates in radians Returns bool Whether the conversion was successful" + "summary": "Class SimpleChainCoordinateConverter Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Provides coordinate conversion functionality for a simple chain configuration. public class SimpleChainCoordinateConverter : ICoordinateConverter, IToXElement Inheritance object SimpleChainCoordinateConverter Implements ICoordinateConverter IToXElement 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) Constructors SimpleChainCoordinateConverter() Initializes a new instance of the SimpleChainCoordinateConverter class. public SimpleChainCoordinateConverter() SimpleChainCoordinateConverter(string) Initializes a new instance of the SimpleChainCoordinateConverter class with a specified chain code. public SimpleChainCoordinateConverter(string chainCode) Parameters chainCode string The chain code defining the coordinate system. SimpleChainCoordinateConverter(XElement) Initializes a new instance of the SimpleChainCoordinateConverter class from an XML element. public SimpleChainCoordinateConverter(XElement src) Parameters src XElement The XML element containing the converter configuration. Fields XName Gets the XML element name used for serialization. public static string XName Field Value string Properties ChainCode ChainCode of machine tool. Must contain at least base, tool buckle and table buckle, where the code is O,T and W, respectively. The other available members: S is spindle. X,Y and Z are translational motion component. A,B and C are rotational motion component. The codes should be all uppercases. public string ChainCode { get; set; } Property Value string Methods AttacherPnToMc(DVec3d, out bool) tool attacher NP (Normal and Point) to machine coordinate. The NP is from table buckle to tool attacher. public DVec3d AttacherPnToMc(DVec3d np, out bool isConverted) Parameters np DVec3d isConverted bool is conversion succeed Returns DVec3d machine coordinate IsAxisAExisted() Is rotary A existed. public bool IsAxisAExisted() Returns bool Is rotary A existed. IsAxisBExisted() Is rotary B existed. public bool IsAxisBExisted() Returns bool Is rotary B existed. IsAxisCExisted() Is rotary C existed. public bool IsAxisCExisted() Returns bool Is rotary C existed. MakeXmlSource(string, string) public XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string relFile string Returns XElement McAbcToTiltMat(Vec3d) Converts machine ABC coordinates to a tilt matrix. public Mat4d McAbcToTiltMat(Vec3d mcAbc_rad) Parameters mcAbc_rad Vec3d The machine ABC coordinates in radians Returns Mat4d The tilt matrix McToAttacherMat(DVec3d) Converts machine coordinates to an attacher matrix. public Mat4d McToAttacherMat(DVec3d mc) Parameters mc DVec3d Returns Mat4d The attacher matrix McToAttacherPn(DVec3d) Machine coordinate to tool attacher NP (Normal and Point). The NP is from table buckle to tool attacher. public DVec3d McToAttacherPn(DVec3d mc) Parameters mc DVec3d Returns DVec3d tool attacher Pn (Point and Normal) TiltMatToMcAbc(Mat4d, out Vec3d) Converts a tilt matrix to machine ABC coordinates. public bool TiltMatToMcAbc(Mat4d tiltMat, out Vec3d mcAbc_rad) Parameters tiltMat Mat4d The tilt matrix to convert mcAbc_rad Vec3d Output parameter that will contain the machine ABC coordinates in radians Returns bool Whether the conversion was successful ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html": { "href": "api/Hi.Numerical.Xyzabc.XyzabcChainMillingCoordinateConverter.html", "title": "Class XyzabcChainMillingCoordinateConverter | HiAPI-C# 2025", - "summary": "Class XyzabcChainMillingCoordinateConverter Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Provides coordinate conversion functionality for XYZABC chain milling operations. public class XyzabcChainMillingCoordinateConverter : ICoordinateConverter, IMakeXmlSource Inheritance object XyzabcChainMillingCoordinateConverter Implements ICoordinateConverter IMakeXmlSource 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) Constructors XyzabcChainMillingCoordinateConverter(IXyzabcChain) Initializes a new instance of the XyzabcChainMillingCoordinateConverter class. public XyzabcChainMillingCoordinateConverter(IXyzabcChain chain) Parameters chain IXyzabcChain The XYZABC chain instance. Exceptions ArgumentNullException Thrown when chain is null. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties XyzabcSolver Gets the XYZABC solver instance. public XyzabcSolver XyzabcSolver { get; } Property Value XyzabcSolver Methods AttacherPnToMc(DVec3d, out bool) tool attacher NP (Normal and Point) to machine coordinate. The NP is from table buckle to tool attacher. public DVec3d AttacherPnToMc(DVec3d np, out bool isConverted) Parameters np DVec3d isConverted bool is conversion succeed Returns DVec3d machine coordinate IsAxisAExisted() Is rotary A existed. public bool IsAxisAExisted() Returns bool Is rotary A existed. IsAxisBExisted() Is rotary B existed. public bool IsAxisBExisted() Returns bool Is rotary B existed. IsAxisCExisted() Is rotary C existed. public bool IsAxisCExisted() Returns bool Is rotary C existed. MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state McAbcToTiltMat(Vec3d) Converts machine ABC coordinates to a tilt matrix. public Mat4d McAbcToTiltMat(Vec3d mcAbc_rad) Parameters mcAbc_rad Vec3d The machine ABC coordinates in radians Returns Mat4d The tilt matrix McToAttacherMat(DVec3d) Converts machine coordinates to an attacher matrix. public Mat4d McToAttacherMat(DVec3d mc) Parameters mc DVec3d Returns Mat4d The attacher matrix McToAttacherPn(DVec3d) Machine coordinate to tool attacher NP (Normal and Point). The NP is from table buckle to tool attacher. public DVec3d McToAttacherPn(DVec3d mc) Parameters mc DVec3d Returns DVec3d tool attacher Pn (Point and Normal) TiltMatToMcAbc(Mat4d, out Vec3d) Converts a tilt matrix to machine ABC coordinates. public bool TiltMatToMcAbc(Mat4d tiltMat, out Vec3d mcAbc_rad) Parameters tiltMat Mat4d The tilt matrix to convert mcAbc_rad Vec3d Output parameter that will contain the machine ABC coordinates in radians Returns bool Whether the conversion was successful" + "summary": "Class XyzabcChainMillingCoordinateConverter Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Provides coordinate conversion functionality for XYZABC chain milling operations. public class XyzabcChainMillingCoordinateConverter : ICoordinateConverter, IMakeXmlSource Inheritance object XyzabcChainMillingCoordinateConverter Implements ICoordinateConverter IMakeXmlSource 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) Constructors XyzabcChainMillingCoordinateConverter(IXyzabcChain) Initializes a new instance of the XyzabcChainMillingCoordinateConverter class. public XyzabcChainMillingCoordinateConverter(IXyzabcChain chain) Parameters chain IXyzabcChain The XYZABC chain instance. Exceptions ArgumentNullException Thrown when chain is null. Fields XName Gets the XML element name for serialization. public static string XName Field Value string Properties XyzabcSolver Gets the XYZABC solver instance. public XyzabcSolver XyzabcSolver { get; } Property Value XyzabcSolver Methods AttacherPnToMc(DVec3d, out bool) tool attacher NP (Normal and Point) to machine coordinate. The NP is from table buckle to tool attacher. public DVec3d AttacherPnToMc(DVec3d np, out bool isConverted) Parameters np DVec3d isConverted bool is conversion succeed Returns DVec3d machine coordinate IsAxisAExisted() Is rotary A existed. public bool IsAxisAExisted() Returns bool Is rotary A existed. IsAxisBExisted() Is rotary B existed. public bool IsAxisBExisted() Returns bool Is rotary B existed. IsAxisCExisted() Is rotary C existed. public bool IsAxisCExisted() Returns bool Is rotary C existed. 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. McAbcToTiltMat(Vec3d) Converts machine ABC coordinates to a tilt matrix. public Mat4d McAbcToTiltMat(Vec3d mcAbc_rad) Parameters mcAbc_rad Vec3d The machine ABC coordinates in radians Returns Mat4d The tilt matrix McToAttacherMat(DVec3d) Converts machine coordinates to an attacher matrix. public Mat4d McToAttacherMat(DVec3d mc) Parameters mc DVec3d Returns Mat4d The attacher matrix McToAttacherPn(DVec3d) Machine coordinate to tool attacher NP (Normal and Point). The NP is from table buckle to tool attacher. public DVec3d McToAttacherPn(DVec3d mc) Parameters mc DVec3d Returns DVec3d tool attacher Pn (Point and Normal) TiltMatToMcAbc(Mat4d, out Vec3d) Converts a tilt matrix to machine ABC coordinates. public bool TiltMatToMcAbc(Mat4d tiltMat, out Vec3d mcAbc_rad) Parameters tiltMat Mat4d The tilt matrix to convert mcAbc_rad Vec3d Output parameter that will contain the machine ABC coordinates in radians Returns bool Whether the conversion was successful" }, "api/Hi.Numerical.Xyzabc.XyzabcSolver.html": { "href": "api/Hi.Numerical.Xyzabc.XyzabcSolver.html", @@ -3922,7 +4057,7 @@ "api/Hi.Numerical.Xyzabc.XyzabcUtil.html": { "href": "api/Hi.Numerical.Xyzabc.XyzabcUtil.html", "title": "Class XyzabcUtil | HiAPI-C# 2025", - "summary": "Class XyzabcUtil Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Utility of XYZABC device. public static class XyzabcUtil Inheritance object XyzabcUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods BuildAnchorToSolid(Dictionary, List, Dictionary) Builds a dictionary mapping anchors to solids. public static void BuildAnchorToSolid(this Dictionary dstAnchorToSolidDictionary, List anchors, Dictionary keyToSolid) Parameters dstAnchorToSolidDictionary Dictionary The destination dictionary to populate anchors List List of anchors keyToSolid Dictionary Dictionary mapping anchor names to solids GenerateCollisionIndexPairs(IXyzabcChain) Generate collision index pairs for the XYZABC chain. public static List GenerateCollisionIndexPairs(this IXyzabcChain xyzabcChain) Parameters xyzabcChain IXyzabcChain The XYZABC chain Returns List List of collision index pairs GetMc(IXyzabcChain, out DVec3d) Get machine coordinates. public static void GetMc(this IXyzabcChain device, out DVec3d mc) Parameters device IXyzabcChain The XYZABC device mc DVec3d Output machine coordinate as DVec3d GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) Get machine coordinates. The output value set to NAN if the corresponding transformer does not exist. public static void GetMc(this IXyzabcChain device, out double mcX, out double mcY, out double mcZ, out double mcA, out double mcB, out double mcC) Parameters device IXyzabcChain device mcX double machine coordinate X mcY double machine coordinate Y mcZ double machine coordinate Z mcA double machine coordinate A mcB double machine coordinate B mcC double machine coordinate C GetMcAbc_rad(IXyzabcChain, out Abc) Get machine coordinates. The output value set to NAN if the corresponding transformer does not exist. public static void GetMcAbc_rad(this IXyzabcChain device, out Abc mcAbc_rad) Parameters device IXyzabcChain device mcAbc_rad Abc Output machine coordinates ABC in radians GetMcXyzabc(IXyzabcChain) Get machine coordinates as DVec3d. public static DVec3d GetMcXyzabc(this IXyzabcChain device) Parameters device IXyzabcChain The XYZABC device Returns DVec3d Machine coordinate as DVec3d GetNp(IXyzabcChain) Get normal and position from Hi.Numerical.Xyzabc.IXyzabcChain.GetChainBegin to Hi.Numerical.Xyzabc.IXyzabcChain.GetChainEnd. public static DVec3d GetNp(this IXyzabcChain src) Parameters src IXyzabcChain src Returns DVec3d normal and position GetTransformationMat4d(IXyzabcChain) Get transformation matrix from Hi.Numerical.Xyzabc.IXyzabcChain.GetChainBegin to Hi.Numerical.Xyzabc.IXyzabcChain.GetChainEnd. public static Mat4d GetTransformationMat4d(this IXyzabcChain src) Parameters src IXyzabcChain src Returns Mat4d transformation matrix SetMc(IXyzabcChain, DVec3d) Set machine coordinate. public static void SetMc(this IXyzabcChain device, DVec3d mc) Parameters device IXyzabcChain device mc DVec3d machine coordinate SetMc(IXyzabcChain, Vec3d) Set machine coordinate. public static void SetMc(this IXyzabcChain device, Vec3d mcXyz) Parameters device IXyzabcChain device mcXyz Vec3d Machine coordinate XYZ SetMc(IXyzabcChain, double, double, double) Set machine coordinate. The input value do no effect if the corresponding transformer does not exist. public static void SetMc(this IXyzabcChain device, double mcX, double mcY, double mcZ) Parameters device IXyzabcChain device mcX double machine coordinate X mcY double machine coordinate Y mcZ double machine coordinate Z SetMc(IXyzabcChain, double, double, double, double, double, double) Set machine coordinate. The input value do no effect if the corresponding transformer does not exist. public static void SetMc(this IXyzabcChain device, double mcX, double mcY, double mcZ, double mcA, double mcB, double mcC) Parameters device IXyzabcChain device mcX double machine coordinate X mcY double machine coordinate Y mcZ double machine coordinate Z mcA double machine coordinate A mcB double machine coordinate B mcC double machine coordinate C SetMcAbc_rad(IXyzabcChain, Vec3d) Set machine coordinate. The input value do no effect if the corresponding transformer does not exist. public static void SetMcAbc_rad(this IXyzabcChain device, Vec3d mcAbc_rad) Parameters device IXyzabcChain device mcAbc_rad Vec3d Machine coordinate ABC in radians" + "summary": "Class XyzabcUtil Namespace Hi.Numerical.Xyzabc Assembly HiMech.dll Utility of XYZABC device. public static class XyzabcUtil Inheritance object XyzabcUtil Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods BuildAnchorToSolid(Dictionary, List, Dictionary) Builds a dictionary mapping anchors to solids. public static void BuildAnchorToSolid(this Dictionary dstAnchorToSolidDictionary, List anchors, Dictionary keyToSolid) Parameters dstAnchorToSolidDictionary Dictionary The destination dictionary to populate anchors List List of anchors keyToSolid Dictionary Dictionary mapping anchor names to solids GenerateCollisionIndexPairs(IXyzabcChain) Generate collision index pairs for the XYZABC chain. public static List GenerateCollisionIndexPairs(this IXyzabcChain xyzabcChain) Parameters xyzabcChain IXyzabcChain The XYZABC chain Returns List List of collision index pairs GetMc(IXyzabcChain, out DVec3d) Get machine coordinates. public static void GetMc(this IXyzabcChain device, out DVec3d mc) Parameters device IXyzabcChain The XYZABC device mc DVec3d Output machine coordinate as DVec3d GetMc(IXyzabcChain, out double, out double, out double, out double, out double, out double) Get machine coordinates. The output value set to NAN if the corresponding transformer does not exist. public static void GetMc(this IXyzabcChain device, out double mcX, out double mcY, out double mcZ, out double mcA, out double mcB, out double mcC) Parameters device IXyzabcChain device mcX double machine coordinate X mcY double machine coordinate Y mcZ double machine coordinate Z mcA double machine coordinate A (rad) mcB double machine coordinate B (rad) mcC double machine coordinate C (rad) GetMcAbc_rad(IXyzabcChain, out Abc) Get machine coordinates. The output value set to NAN if the corresponding transformer does not exist. public static void GetMcAbc_rad(this IXyzabcChain device, out Abc mcAbc_rad) Parameters device IXyzabcChain device mcAbc_rad Abc Output machine coordinates ABC in radians GetMcXyzabc(IXyzabcChain) Get machine coordinates as DVec3d. public static DVec3d GetMcXyzabc(this IXyzabcChain device) Parameters device IXyzabcChain The XYZABC device Returns DVec3d Machine coordinate as DVec3d. ABC in rad. GetNp(IXyzabcChain) Get normal and position from Hi.Numerical.Xyzabc.IXyzabcChain.GetChainBegin to Hi.Numerical.Xyzabc.IXyzabcChain.GetChainEnd. public static DVec3d GetNp(this IXyzabcChain src) Parameters src IXyzabcChain src Returns DVec3d normal and position GetTransformationMat4d(IXyzabcChain) Get transformation matrix from Hi.Numerical.Xyzabc.IXyzabcChain.GetChainBegin to Hi.Numerical.Xyzabc.IXyzabcChain.GetChainEnd. public static Mat4d GetTransformationMat4d(this IXyzabcChain src) Parameters src IXyzabcChain src Returns Mat4d transformation matrix SetMc(IXyzabcChain, DVec3d) Set machine coordinate. public static void SetMc(this IXyzabcChain device, DVec3d mc) Parameters device IXyzabcChain device mc DVec3d machine coordinate SetMc(IXyzabcChain, Vec3d) Set machine coordinate. public static void SetMc(this IXyzabcChain device, Vec3d mcXyz) Parameters device IXyzabcChain device mcXyz Vec3d Machine coordinate XYZ SetMc(IXyzabcChain, double, double, double) Set machine coordinate. The input value do no effect if the corresponding transformer does not exist. public static void SetMc(this IXyzabcChain device, double mcX, double mcY, double mcZ) Parameters device IXyzabcChain device mcX double machine coordinate X mcY double machine coordinate Y mcZ double machine coordinate Z SetMc(IXyzabcChain, double, double, double, double, double, double) Set machine coordinate. The input value do no effect if the corresponding transformer does not exist. public static void SetMc(this IXyzabcChain device, double mcX, double mcY, double mcZ, double mcA, double mcB, double mcC) Parameters device IXyzabcChain device mcX double machine coordinate X mcY double machine coordinate Y mcZ double machine coordinate Z mcA double machine coordinate A mcB double machine coordinate B mcC double machine coordinate C SetMcAbc_rad(IXyzabcChain, Vec3d) Set machine coordinate. The input value do no effect if the corresponding transformer does not exist. public static void SetMcAbc_rad(this IXyzabcChain device, Vec3d mcAbc_rad) Parameters device IXyzabcChain device mcAbc_rad Vec3d Machine coordinate ABC in radians" }, "api/Hi.Numerical.Xyzabc.html": { "href": "api/Hi.Numerical.Xyzabc.html", @@ -3932,7 +4067,7 @@ "api/Hi.Numerical.html": { "href": "api/Hi.Numerical.html", "title": "Namespace Hi.Numerical | HiAPI-C# 2025", - "summary": "Namespace Hi.Numerical Classes CoordinateEntryDisplayee Represents a displayable coordinate entry for CNC programming. FlexDictionaryUtil Utility for flexible dictionary operations. IsoCoordinateTable Coordinate table for NC controller. The dictionary key is 1000times coordinate index (ex. G54 is 54000); the dictionary value is machine coordinate. MechNcUtil NC Utility. MillingToolOffsetTable Offset table for milling tool. The key is tool ID. MillingToolOffsetTableRow Raw of MillingToolOffsetTable NcComment Represents a comment in NC code. NcEnv Represents the numerical control environment containing configuration for CNC operations. NcFlagUtil Utility class for working with NC flags and their lifecycle modes. NcGroupAttribute NC Group Attribute. NcLifeCycleAttribute Attribute to specify the lifecycle mode of an NC flag. NcLine Represents a line in the NC program with its associated data and operations. NcNameAttribute Attribute used to define a name for NC flags and other enumeration fields. NcNoteCache Cache for notes and warnings generated during NC line parsing. NcProc Provides processing utilities for NC programming. NcStepFileOutputKit Kit for outputting NC steps to CSV files. NcStepMonitor Monitors NC steps and provides functionality for step tracking and control. NcUtil Utility class for working with NC code. NumericUtil Utility class for numeric operations and unit conversions. PolarEntry The class for G12.1 Polar mode. In G12.1 Polar mode, NC code applies (X,C) as (linear axis, hypothetical axis). XC, YA, ZB are available. RadiusCompensationBuf Buffer for radius compensation operations in numerical control SubStringKit Utility class for extracting and manipulating substrings based on specific activation patterns. ToolConfigNotFoundException Exception thrown when a tool configuration cannot be found. Interfaces IFlexDictionaryHost Interface of FlexDictionary. Provider of additional quantity source. IGetFeedrate Interface for retrieving feedrate information. IGetSpindleSpeed Interface for retrieving spindle speed and direction information. ISetFeedrate Interface for setting feedrate information. ISetSpindleSpeed Interface for setting spindle speed. Enums CncBrand Represents different CNC controller brands supported by the system. CommentMarkEnum Enumeration of different comment mark types used in NC code. CoordinateEntryRenderingFlag Flags that control how coordinate entries are rendered. CoordinateInterpolationMode Defines the coordinate interpolation mode for NC operations. NcFlag NC Flag. NcGroup00 NcGroup enum. GCode Group00. Include G04,G52,G53,G53p1,SiemensSupa. NcGroup01 NcGroup enum. For linear move mode: G00 or G01. G00 is rapid move. G01 is linear cut. G02 is CW cut; G03 is CCW cut. NcGroup02 NcGroup enum. Plane selection. Include G17,G18,G19. NcGroup03 NcGroup enum. Absolute(G90) or increment(G91) coordinate. NcGroup05 NcGroup enum. For feedrate. NcGroup06 NcGroup enum. Group of unit. In mm or in inch. NcGroup07 NcGroup enum. Left or right compensation for tool radius, etc.. See G40, G41, G42 for available compensation modes. NcGroup08 NcGroup enum. Tool length compensation, etc.. G43,G43p4,G44,G49,SiemensTraori,SiemensTrafoof,HeidenhainM128,HeidenhainM129. NcGroup09 NcGroup enum. Canned cycle. NcGroup10 NcGroup enum. Canned cycle return point. G98,G99. NcGroup14 NcGroup enum. Coordinate system. Such as G54Series. NcGroup16 NcGroup enum. Rotation plane related. Interface of get transformation. Heidenhain equivalent group is NcGroupHeidenhainPlane. NcGroup21 NcGroup enum. Polar coordinate interpolation mode. NcGroupHeidenhainM107M108 NcGroup enum. Heidenhain group. Enable or disable Suppress error message for replacement tools with oversize. NcGroupHeidenhainPlane Heidenhain Group Plane related. ISO equivalent group is NcGroup16. NcGroupHeidenhainShortestRotaryPath NcGroup enum. Heidenhain group. shortest rotary state. HeidenhainM126,HeidenhainM127 NcGroupSpindleRotation NcGroup enum. Spindle rotation control. See SpindleStop, SpindleCw, SpindleCcw for available rotation modes. NcLifeCycleMode Defines the lifecycle mode of NC commands. NcWarningSceneEnum Defines scene types for NC warnings. PolarEntry.PolarModeDirEnum Polar coordinate interpolation mode direction. YA,ZB has not implemented yet. SpindleDirection Enumeration of spindle rotation directions. SubStringKit.ActivationMode Defines the mode of activation for substring extraction." + "summary": "Namespace Hi.Numerical Classes CoordinateEntryDisplayee Represents a displayable coordinate entry for CNC programming. FlexDictionaryUtil Utility for flexible dictionary operations. HeidenhainCoordinateEntryDisplayee IsoCoordinateEntryDisplayee IsoCoordinateTable Coordinate table for NC controller. The dictionary key is 1000times coordinate index (ex. G54 is 54000); the dictionary value is machine coordinate. MechNcUtil NC Utility. MillingToolOffsetTable Offset table for milling tool. The key is Offset ID (H or D in NC code). MillingToolOffsetTableRow Raw of MillingToolOffsetTable NcComment Represents a comment in NC code. NcEnv Represents the numerical control environment containing configuration for CNC operations. NcFlagUtil Utility class for working with NC flags and their lifecycle modes. NcGroupAttribute NC Group Attribute. NcLifeCycleAttribute Attribute to specify the lifecycle mode of an NC flag. NcLine Represents a line in the NC program with its associated data and operations. NcNameAttribute Attribute used to define a name for NC flags and other enumeration fields. NcNoteCache Cache for notes and warnings generated during NC line parsing. NcProc Provides processing utilities for NC programming. NcStepFileOutputKit Kit for outputting NC steps to CSV files. NcStepMonitor Monitors NC steps and provides functionality for step tracking and control. NcUtil Utility class for working with NC code. NumericUtil Utility class for numeric operations and unit conversions. PolarEntry The class for G12.1 Polar mode. In G12.1 Polar mode, NC code applies (X,C) as (linear axis, hypothetical axis). XC, YA, ZB are available. RadiusCompensationBuf Buffer for radius compensation operations in numerical control SubStringKit Utility class for extracting and manipulating substrings based on specific activation patterns. ToolConfigNotFoundException Exception thrown when a tool configuration cannot be found. Interfaces IFlexDictionaryHost Interface of FlexDictionary. Provider of additional quantity source. IGetFeedrate Interface for retrieving feedrate information. IGetSpindleSpeed Interface for retrieving spindle speed and direction information. ISetFeedrate Interface for setting feedrate information. ISetSpindleSpeed Interface for setting spindle speed. Enums CncBrand Represents different CNC controller brands supported by the system. CommentMarkEnum Enumeration of different comment mark types used in NC code. CoordinateEntryRenderingFlag Flags that control how coordinate entries are rendered. CoordinateInterpolationMode Defines the coordinate interpolation mode for NC operations. NcFlag NC Flag. NcGroup00 NcGroup enum. GCode Group00. Include G04,G52,G53,G53p1,SiemensSupa. NcGroup01 NcGroup enum. For linear move mode: G00 or G01. G00 is rapid move. G01 is linear cut. G02 is CW cut; G03 is CCW cut. NcGroup02 NcGroup enum. Plane selection. Include G17,G18,G19. NcGroup03 NcGroup enum. Absolute(G90) or increment(G91) coordinate. NcGroup05 NcGroup enum. For feedrate. NcGroup06 NcGroup enum. Group of unit. In mm or in inch. NcGroup07 NcGroup enum. Left or right compensation for tool radius, etc.. See G40, G41, G42 for available compensation modes. NcGroup08 NcGroup enum. Tool length compensation, etc.. G43,G43p4,G44,G49,SiemensTraori,SiemensTrafoof,HeidenhainM128,HeidenhainM129. NcGroup09 NcGroup enum. Canned cycle. NcGroup10 NcGroup enum. Canned cycle return point. G98,G99. NcGroup14 NcGroup enum. Coordinate system. Such as G54Series. NcGroup16 NcGroup enum. Rotation plane related. Interface of get transformation. Heidenhain equivalent group is NcGroupHeidenhainPlane. NcGroup21 NcGroup enum. Polar coordinate interpolation mode. NcGroupHeidenhainM107M108 NcGroup enum. Heidenhain group. Enable or disable Suppress error message for replacement tools with oversize. NcGroupHeidenhainPlane Heidenhain Group Plane related. ISO equivalent group is NcGroup16. NcGroupHeidenhainShortestRotaryPath NcGroup enum. Heidenhain group. shortest rotary state. HeidenhainM126,HeidenhainM127 NcGroupSpindleRotation NcGroup enum. Spindle rotation control. See SpindleStop, SpindleCw, SpindleCcw for available rotation modes. NcLifeCycleMode Defines the lifecycle mode of NC commands. NcWarningSceneEnum Defines scene types for NC warnings. PolarEntry.PolarModeDirEnum Polar coordinate interpolation mode direction. YA,ZB has not implemented yet. SpindleDirection Enumeration of spindle rotation directions. SubStringKit.ActivationMode Defines the mode of activation for substring extraction." }, "api/Hi.PanelModels.HiKey.html": { "href": "api/Hi.PanelModels.HiKey.html", @@ -4042,17 +4177,17 @@ "api/Hi.Physics.CoatingMaterial.html": { "href": "api/Hi.Physics.CoatingMaterial.html", "title": "Class CoatingMaterial | HiAPI-C# 2025", - "summary": "Class CoatingMaterial Namespace Hi.Physics Assembly HiMech.dll Represents a coating material used in cutting tools. public class CoatingMaterial : CutterMaterial, ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote Inheritance object CutterMaterial CoatingMaterial Implements ISurfaceMaterial IStructureMaterial IMakeXmlSource IDuplicate INameNote Inherited Members CutterMaterial.Name CutterMaterial.Note CutterMaterial.ElasticModulus_GPa CutterMaterial.PoissonRatio CutterMaterial.TensileStrength_MPa CutterMaterial.ThermalExpansionCoefficient_dMK CutterMaterial.HeatConductivity_WdmK CutterMaterial.HeatConductivity_WdmmK CutterMaterial.HeatCapacity_JdgK CutterMaterial.Density_gdm3 CutterMaterial.Density_gdcm3 CutterMaterial.Density_gdmm3 CutterMaterial.MeltingTemperature_K CutterMaterial.FusionLatentHeat_Jdg CutterMaterial.FrictionCoefficient CutterMaterial.TemperatureVsHardnessCurve CutterMaterial.TemperatureVsWearCoefficientCurve CutterMaterial.WC CutterMaterial.WC_Co6_800nm 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) Constructors CoatingMaterial() Initializes a new instance of the CoatingMaterial class. public CoatingMaterial() CoatingMaterial(CoatingMaterial) Initializes a new instance of the CoatingMaterial class by copying from another instance. public CoatingMaterial(CoatingMaterial src) Parameters src CoatingMaterial The source coating material to copy from. CoatingMaterial(XElement) Initializes a new instance of the CoatingMaterial class from XML data. public CoatingMaterial(XElement src) Parameters src XElement The XML element containing coating material data. Properties DefaultFrictionCoefficient Gets the default friction coefficient for coating materials. public static double DefaultFrictionCoefficient { get; } Property Value double PreferedThickness_mm Gets or sets the preferred thickness of the coating in millimeters. public double PreferedThickness_mm { get; set; } Property Value double PreferedThickness_um Gets or sets the preferred thickness of the coating in micrometers. public double PreferedThickness_um { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) public object Duplicate(params object[] res) Parameters res object[] Returns object MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public override XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CoatingMaterial Namespace Hi.Physics Assembly HiMech.dll Represents a coating material used in cutting tools. public class CoatingMaterial : CutterMaterial, ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote, IToXElement Inheritance object CutterMaterial CoatingMaterial Implements ISurfaceMaterial IStructureMaterial IMakeXmlSource IDuplicate INameNote IToXElement Inherited Members CutterMaterial.Name CutterMaterial.Note CutterMaterial.ElasticModulus_GPa CutterMaterial.PoissonRatio CutterMaterial.TensileStrength_MPa CutterMaterial.ThermalExpansionCoefficient_dMK CutterMaterial.HeatConductivity_WdmK CutterMaterial.HeatConductivity_WdmmK CutterMaterial.HeatCapacity_JdgK CutterMaterial.Density_gdm3 CutterMaterial.Density_gdcm3 CutterMaterial.Density_gdmm3 CutterMaterial.MeltingTemperature_K CutterMaterial.FusionLatentHeat_Jdg CutterMaterial.FrictionCoefficient CutterMaterial.TemperatureVsHardnessCurve CutterMaterial.TemperatureVsWearCoefficientCurve CutterMaterial.WC CutterMaterial.WC_Co6_800nm 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) Constructors CoatingMaterial() Initializes a new instance of the CoatingMaterial class. public CoatingMaterial() CoatingMaterial(CoatingMaterial) Initializes a new instance of the CoatingMaterial class by copying from another instance. public CoatingMaterial(CoatingMaterial src) Parameters src CoatingMaterial The source coating material to copy from. CoatingMaterial(XElement) Initializes a new instance of the CoatingMaterial class from XML data. public CoatingMaterial(XElement src) Parameters src XElement The XML element containing coating material data. Properties DefaultFrictionCoefficient Gets the default friction coefficient for coating materials. public static double DefaultFrictionCoefficient { get; } Property Value double PreferedThickness_mm Gets or sets the preferred thickness of the coating in millimeters. public double PreferedThickness_mm { get; set; } Property Value double PreferedThickness_um Gets or sets the preferred thickness of the coating in micrometers. public double PreferedThickness_um { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) public object Duplicate(params object[] res) Parameters res object[] Returns object MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public override 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. ToXElement() Get the XElement to represent the object. public override XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Physics.CoolantHeatCondition.html": { "href": "api/Hi.Physics.CoolantHeatCondition.html", "title": "Class CoolantHeatCondition | HiAPI-C# 2025", - "summary": "Class CoolantHeatCondition Namespace Hi.Physics Assembly HiMech.dll Represents the heat condition parameters for coolant in machining operations. public class CoolantHeatCondition : IMakeXmlSource Inheritance object CoolantHeatCondition Implements IMakeXmlSource 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) Constructors CoolantHeatCondition() Initializes a new instance of the CoolantHeatCondition class. public CoolantHeatCondition() CoolantHeatCondition(XElement) Initializes a new instance of the CoolantHeatCondition class from XML data. public CoolantHeatCondition(XElement src) Parameters src XElement The XML element containing coolant heat condition data. Properties CoolantConvectionCoefficient_Wdm2K Gets or sets the coolant heat transfer coefficient in Watts per square meter per Kelvin. public double CoolantConvectionCoefficient_Wdm2K { get; set; } Property Value double Remarks Common value: forced air: 10~500; coolant: 1e3~1e4 (ref by “Effects of coolant on temperature distribution in metal machining”, 1988) coolant: 1e3 (ref by “Modeling heat transfer in die milling”, 2014) CoolantConvectionCoefficient_Wdmm2K Gets or sets the coolant heat transfer coefficient in Watts per square millimeter per Kelvin. public double CoolantConvectionCoefficient_Wdmm2K { get; set; } Property Value double CoolantTemperature_C Gets or sets the coolant temperature in Celsius. public double CoolantTemperature_C { get; set; } Property Value double CoolantTemperature_K Gets or sets the coolant temperature in Kelvin. public double CoolantTemperature_K { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CoolantHeatCondition Namespace Hi.Physics Assembly HiMech.dll Represents the heat condition parameters for coolant in machining operations. public class CoolantHeatCondition : IMakeXmlSource Inheritance object CoolantHeatCondition Implements IMakeXmlSource 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) Constructors CoolantHeatCondition() Initializes a new instance of the CoolantHeatCondition class. public CoolantHeatCondition() CoolantHeatCondition(XElement) Initializes a new instance of the CoolantHeatCondition class from XML data. public CoolantHeatCondition(XElement src) Parameters src XElement The XML element containing coolant heat condition data. Properties CoolantConvectionCoefficient_Wdm2K Gets or sets the coolant heat transfer coefficient in Watts per square meter per Kelvin. public double CoolantConvectionCoefficient_Wdm2K { get; set; } Property Value double Remarks Common value: forced air: 10~500; coolant: 1e3~1e4 (ref by “Effects of coolant on temperature distribution in metal machining”, 1988) coolant: 1e3 (ref by “Modeling heat transfer in die milling”, 2014) CoolantConvectionCoefficient_Wdmm2K Gets or sets the coolant heat transfer coefficient in Watts per square millimeter per Kelvin. public double CoolantConvectionCoefficient_Wdmm2K { get; set; } Property Value double CoolantTemperature_C Gets or sets the coolant temperature in Celsius. public double CoolantTemperature_C { get; set; } Property Value double CoolantTemperature_K Gets or sets the coolant temperature in Kelvin. public double CoolantTemperature_K { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.Physics.CutterMaterial.html": { "href": "api/Hi.Physics.CutterMaterial.html", "title": "Class CutterMaterial | HiAPI-C# 2025", - "summary": "Class CutterMaterial Namespace Hi.Physics Assembly HiMech.dll Represents a cutter material with physical and thermal properties. public class CutterMaterial : ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote Inheritance object CutterMaterial Implements ISurfaceMaterial IStructureMaterial IMakeXmlSource IDuplicate INameNote Derived CoatingMaterial 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) Constructors CutterMaterial() Default constructor. public CutterMaterial() CutterMaterial(CutterMaterial) Creates a new cutter material as a copy of an existing one. public CutterMaterial(CutterMaterial src) Parameters src CutterMaterial The source material to copy from. CutterMaterial(XElement) Ctor. public CutterMaterial(XElement src) Parameters src XElement XML Properties Density_gdcm3 Gets or sets the density in grams per cubic centimeter. public double Density_gdcm3 { get; set; } Property Value double Density_gdm3 Density in g/dm³. public double Density_gdm3 { get; set; } Property Value double Density_gdmm3 Density in g/mm³. public double Density_gdmm3 { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals. public double ElasticModulus_GPa { get; set; } Property Value double FrictionCoefficient Gets or sets the friction coefficient of the surface material. public double FrictionCoefficient { get; set; } Property Value double FusionLatentHeat_Jdg Latent Heat of Fusion. public double FusionLatentHeat_Jdg { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the heat capacity in Joules per gram-Kelvin. public double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in Watts per meter-Kelvin. public double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Heat transfer coefficient in W/(mm·K). public double HeatConductivity_WdmmK { get; set; } Property Value double MeltingTemperature_K public double MeltingTemperature_K { get; set; } Property Value double Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string PoissonRatio public double PoissonRatio { get; set; } Property Value double TemperatureVsHardnessCurve Temperature versus hardness curve data. public List TemperatureVsHardnessCurve { get; set; } Property Value List TemperatureVsWearCoefficientCurve Temperature(K) vs WearCoefficient. Unit of WearCoefficient: 1e-6 (non-unit). public List TemperatureVsWearCoefficientCurve { get; set; } Property Value List TensileStrength_MPa public double TensileStrength_MPa { get; set; } Property Value double ThermalExpansionCoefficient_dMK public double ThermalExpansionCoefficient_dMK { get; set; } Property Value double WC General condition of WC (Tungsten Carbide). public static CutterMaterial WC { get; } Property Value CutterMaterial WC_Co6_800nm WC-Co6 with 800nm grain size properties. public static CutterMaterial WC_Co6_800nm { get; } Property Value CutterMaterial XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class CutterMaterial Namespace Hi.Physics Assembly HiMech.dll Represents a cutter material with physical and thermal properties. public class CutterMaterial : ISurfaceMaterial, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote, IToXElement Inheritance object CutterMaterial Implements ISurfaceMaterial IStructureMaterial IMakeXmlSource IDuplicate INameNote IToXElement Derived CoatingMaterial 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) Constructors CutterMaterial() Default constructor. public CutterMaterial() CutterMaterial(CutterMaterial) Creates a new cutter material as a copy of an existing one. public CutterMaterial(CutterMaterial src) Parameters src CutterMaterial The source material to copy from. CutterMaterial(XElement) Ctor. public CutterMaterial(XElement src) Parameters src XElement XML Properties Density_gdcm3 Gets or sets the density in grams per cubic centimeter. public double Density_gdcm3 { get; set; } Property Value double Density_gdm3 Density in g/dm³. public double Density_gdm3 { get; set; } Property Value double Density_gdmm3 Density in g/mm³. public double Density_gdmm3 { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals. public double ElasticModulus_GPa { get; set; } Property Value double FrictionCoefficient Gets or sets the friction coefficient of the surface material. public double FrictionCoefficient { get; set; } Property Value double FusionLatentHeat_Jdg Latent Heat of Fusion. public double FusionLatentHeat_Jdg { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the heat capacity in Joules per gram-Kelvin. public double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in Watts per meter-Kelvin. public double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Heat transfer coefficient in W/(mm·K). public double HeatConductivity_WdmmK { get; set; } Property Value double MeltingTemperature_K public double MeltingTemperature_K { get; set; } Property Value double Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string PoissonRatio public double PoissonRatio { get; set; } Property Value double TemperatureVsHardnessCurve Temperature versus hardness curve data. public List TemperatureVsHardnessCurve { get; set; } Property Value List TemperatureVsWearCoefficientCurve Temperature(K) vs WearCoefficient. Unit of WearCoefficient: 1e-6 (non-unit). public List TemperatureVsWearCoefficientCurve { get; set; } Property Value List TensileStrength_MPa public double TensileStrength_MPa { get; set; } Property Value double ThermalExpansionCoefficient_dMK public double ThermalExpansionCoefficient_dMK { get; set; } Property Value double WC General condition of WC (Tungsten Carbide). public static CutterMaterial WC { get; } Property Value CutterMaterial WC_Co6_800nm WC-Co6 with 800nm grain size properties. public static CutterMaterial WC_Co6_800nm { get; } Property Value CutterMaterial XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. ToXElement() Get the XElement to represent the object. public virtual XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Physics.IGetThermalLayerList.html": { "href": "api/Hi.Physics.IGetThermalLayerList.html", @@ -4062,7 +4197,7 @@ "api/Hi.Physics.IStructureMaterial.html": { "href": "api/Hi.Physics.IStructureMaterial.html", "title": "Interface IStructureMaterial | HiAPI-C# 2025", - "summary": "Interface IStructureMaterial Namespace Hi.Physics Assembly HiMech.dll Interface for structure materials with thermal properties. public interface IStructureMaterial : IMakeXmlSource, IDuplicate, INameNote Inherited Members IMakeXmlSource.MakeXmlSource(string, string) IDuplicate.Duplicate(params object[]) INameNote.Name INameNote.Note 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) Properties Density_gdcm3 Gets or sets the density in grams per cubic centimeter. double Density_gdcm3 { get; set; } Property Value double Density_gdmm3 Gets or sets the density in grams per cubic millimeter. double Density_gdmm3 { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals. double ElasticModulus_GPa { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the heat capacity in Joules per gram-Kelvin. double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in Watts per meter-Kelvin. double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Gets or sets the heat transfer coefficient in Watts per millimeter-Kelvin. double HeatConductivity_WdmmK { get; set; } Property Value double ThermalDiffusivity_mm2dsK Gets the thermal diffusivity in square millimeters per second-Kelvin. double ThermalDiffusivity_mm2dsK { get; } Property Value double" + "summary": "Interface IStructureMaterial Namespace Hi.Physics Assembly HiMech.dll Interface for structure materials with thermal properties. public interface IStructureMaterial : IMakeXmlSource, IDuplicate, INameNote Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) IDuplicate.Duplicate(params object[]) INameNote.Name INameNote.Note 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) Properties Density_gdcm3 Gets or sets the density in grams per cubic centimeter. double Density_gdcm3 { get; set; } Property Value double Density_gdmm3 Gets or sets the density in grams per cubic millimeter. double Density_gdmm3 { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals. double ElasticModulus_GPa { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the heat capacity in Joules per gram-Kelvin. double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in Watts per meter-Kelvin. double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Gets or sets the heat transfer coefficient in Watts per millimeter-Kelvin. double HeatConductivity_WdmmK { get; set; } Property Value double ThermalDiffusivity_mm2dsK Gets the thermal diffusivity in square millimeters per second-Kelvin. double ThermalDiffusivity_mm2dsK { get; } Property Value double" }, "api/Hi.Physics.ISuccessivePhysicsBriefAccessor.html": { "href": "api/Hi.Physics.ISuccessivePhysicsBriefAccessor.html", @@ -4072,7 +4207,7 @@ "api/Hi.Physics.ISurfaceMaterial.html": { "href": "api/Hi.Physics.ISurfaceMaterial.html", "title": "Interface ISurfaceMaterial | HiAPI-C# 2025", - "summary": "Interface ISurfaceMaterial Namespace Hi.Physics Assembly HiMech.dll Interface for materials that can be used on surfaces. public interface ISurfaceMaterial : IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote Inherited Members IStructureMaterial.HeatConductivity_WdmK IStructureMaterial.HeatConductivity_WdmmK IStructureMaterial.HeatCapacity_JdgK IStructureMaterial.Density_gdcm3 IStructureMaterial.Density_gdmm3 IStructureMaterial.ThermalDiffusivity_mm2dsK IStructureMaterial.ElasticModulus_GPa IMakeXmlSource.MakeXmlSource(string, string) IDuplicate.Duplicate(params object[]) INameNote.Name INameNote.Note 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) Properties FrictionCoefficient Gets or sets the friction coefficient of the surface material. double FrictionCoefficient { get; set; } Property Value double" + "summary": "Interface ISurfaceMaterial Namespace Hi.Physics Assembly HiMech.dll Interface for materials that can be used on surfaces. public interface ISurfaceMaterial : IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote Inherited Members IStructureMaterial.HeatConductivity_WdmK IStructureMaterial.HeatConductivity_WdmmK IStructureMaterial.HeatCapacity_JdgK IStructureMaterial.Density_gdcm3 IStructureMaterial.Density_gdmm3 IStructureMaterial.ThermalDiffusivity_mm2dsK IStructureMaterial.ElasticModulus_GPa IMakeXmlSource.MakeXmlSource(string, string, bool) IDuplicate.Duplicate(params object[]) INameNote.Name INameNote.Note 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) Properties FrictionCoefficient Gets or sets the friction coefficient of the surface material. double FrictionCoefficient { get; set; } Property Value double" }, "api/Hi.Physics.ITimeGetter.html": { "href": "api/Hi.Physics.ITimeGetter.html", @@ -4092,7 +4227,7 @@ "api/Hi.Physics.StructureMaterial.html": { "href": "api/Hi.Physics.StructureMaterial.html", "title": "Class StructureMaterial | HiAPI-C# 2025", - "summary": "Class StructureMaterial Namespace Hi.Physics Assembly HiMech.dll Represents a material with physical and thermal properties used in structural analysis. public class StructureMaterial : IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote Inheritance object StructureMaterial Implements IStructureMaterial IMakeXmlSource IDuplicate INameNote 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) Constructors StructureMaterial() Default constructor. public StructureMaterial() StructureMaterial(StructureMaterial) Creates a new cutter material as a copy of an existing one. public StructureMaterial(StructureMaterial src) Parameters src StructureMaterial The source material to copy from. StructureMaterial(XElement) Ctor. public StructureMaterial(XElement src) Parameters src XElement XML Properties AlloySteel42CrMo Gets a predefined 42CrMo alloy steel material commonly used for milling cutter bodies. public static StructureMaterial AlloySteel42CrMo { get; } Property Value StructureMaterial Density_gdcm3 Gets or sets the density in grams per cubic centimeter. public double Density_gdcm3 { get; set; } Property Value double Density_gdm3 Density in g/dm³. public double Density_gdm3 { get; set; } Property Value double Density_gdmm3 Density in g/mm³. public double Density_gdmm3 { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals. public double ElasticModulus_GPa { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the heat capacity in Joules per gram-Kelvin. public double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in Watts per meter-Kelvin. public double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Heat transfer coefficient in W/(mm·K). public double HeatConductivity_WdmmK { get; set; } Property Value double Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string PoissonRatio public double PoissonRatio { get; set; } Property Value double TensileStrength_MPa public double TensileStrength_MPa { get; set; } Property Value double ThermalExpansionCoefficient_dMK public double ThermalExpansionCoefficient_dMK { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object MakeXmlSource(string, string) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual XElement MakeXmlSource(string baseDirectory, string relFile) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class StructureMaterial Namespace Hi.Physics Assembly HiMech.dll Represents a material with physical and thermal properties used in structural analysis. public class StructureMaterial : IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote, IToXElement Inheritance object StructureMaterial Implements IStructureMaterial IMakeXmlSource IDuplicate INameNote IToXElement 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) Constructors StructureMaterial() Default constructor. public StructureMaterial() StructureMaterial(StructureMaterial) Creates a new cutter material as a copy of an existing one. public StructureMaterial(StructureMaterial src) Parameters src StructureMaterial The source material to copy from. StructureMaterial(XElement) Ctor. public StructureMaterial(XElement src) Parameters src XElement XML Properties AlloySteel42CrMo Gets a predefined 42CrMo alloy steel material commonly used for milling cutter bodies. public static StructureMaterial AlloySteel42CrMo { get; } Property Value StructureMaterial Density_gdcm3 Gets or sets the density in grams per cubic centimeter. public double Density_gdcm3 { get; set; } Property Value double Density_gdm3 Density in g/dm³. public double Density_gdm3 { get; set; } Property Value double Density_gdmm3 Density in g/mm³. public double Density_gdmm3 { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals. public double ElasticModulus_GPa { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the heat capacity in Joules per gram-Kelvin. public double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in Watts per meter-Kelvin. public double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Heat transfer coefficient in W/(mm·K). public double HeatConductivity_WdmmK { get; set; } Property Value double Name Gets or sets the name of the object. public string Name { get; set; } Property Value string Note Gets or sets the descriptive note for the object. public string Note { get; set; } Property Value string PoissonRatio public double PoissonRatio { get; set; } Property Value double TensileStrength_MPa public double TensileStrength_MPa { get; set; } Property Value double ThermalExpansionCoefficient_dMK public double ThermalExpansionCoefficient_dMK { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object MakeXmlSource(string, string, bool) Creates an XML representation of the object. This method may also generate additional resources such as related files. public virtual 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. ToXElement() Get the XElement to represent the object. public XElement ToXElement() Returns XElement XElement to represent the object." }, "api/Hi.Physics.TemperatureUtil.html": { "href": "api/Hi.Physics.TemperatureUtil.html", @@ -4107,7 +4242,7 @@ "api/Hi.Physics.ThermalLayer1D.html": { "href": "api/Hi.Physics.ThermalLayer1D.html", "title": "Class ThermalLayer1D | HiAPI-C# 2025", - "summary": "Class ThermalLayer1D Namespace Hi.Physics Assembly HiMech.dll Represents a one-dimensional thermal layer for heat transfer calculations. public class ThermalLayer1D : IMakeXmlSource Inheritance object ThermalLayer1D Implements IMakeXmlSource 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) Constructors ThermalLayer1D() Initializes a new instance of the ThermalLayer1D class. public ThermalLayer1D() ThermalLayer1D(IStructureMaterial, double) Initializes a new instance of the ThermalLayer1D class with the specified material and length. public ThermalLayer1D(IStructureMaterial material, double length_mm) Parameters material IStructureMaterial The thermal material of this layer. length_mm double The length of this layer in millimeters. ThermalLayer1D(ThermalLayer1D) Initializes a new instance of the ThermalLayer1D class by copying from another instance. public ThermalLayer1D(ThermalLayer1D src) Parameters src ThermalLayer1D The source thermal layer to copy from. ThermalLayer1D(XElement, string, string) Initializes a new instance of the ThermalLayer1D class from XML data. public ThermalLayer1D(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing thermal layer data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Properties Length_mm Gets or sets the length of this thermal layer in millimeters. public double Length_mm { get; set; } Property Value double Length_um Gets or sets the length of this thermal layer in micrometers. public double Length_um { get; set; } Property Value double Material Gets or sets the thermal material of this layer. public IStructureMaterial Material { get; set; } Property Value IStructureMaterial XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class ThermalLayer1D Namespace Hi.Physics Assembly HiMech.dll Represents a one-dimensional thermal layer for heat transfer calculations. public class ThermalLayer1D : IMakeXmlSource Inheritance object ThermalLayer1D Implements IMakeXmlSource 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) Constructors ThermalLayer1D() Initializes a new instance of the ThermalLayer1D class. public ThermalLayer1D() ThermalLayer1D(IStructureMaterial, double) Initializes a new instance of the ThermalLayer1D class with the specified material and length. public ThermalLayer1D(IStructureMaterial material, double length_mm) Parameters material IStructureMaterial The thermal material of this layer. length_mm double The length of this layer in millimeters. ThermalLayer1D(ThermalLayer1D) Initializes a new instance of the ThermalLayer1D class by copying from another instance. public ThermalLayer1D(ThermalLayer1D src) Parameters src ThermalLayer1D The source thermal layer to copy from. ThermalLayer1D(XElement, string, string) Initializes a new instance of the ThermalLayer1D class from XML data. public ThermalLayer1D(XElement src, string baseDirectory, string relFile) Parameters src XElement The XML element containing thermal layer data. baseDirectory string The base directory for resolving relative paths. relFile string The relative file path. Properties Length_mm Gets or sets the length of this thermal layer in millimeters. public double Length_mm { get; set; } Property Value double Length_um Gets or sets the length of this thermal layer in micrometers. public double Length_um { get; set; } Property Value double Material Gets or sets the thermal material of this layer. public IStructureMaterial Material { get; set; } Property Value IStructureMaterial XName Name for XML IO. public static string XName { get; } Property Value string Methods 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." }, "api/Hi.Physics.TimeSeriesUtil.html": { "href": "api/Hi.Physics.TimeSeriesUtil.html", @@ -4122,7 +4257,7 @@ "api/Hi.Physics.WorkpieceMaterial.html": { "href": "api/Hi.Physics.WorkpieceMaterial.html", "title": "Class WorkpieceMaterial | HiAPI-C# 2025", - "summary": "Class WorkpieceMaterial Namespace Hi.Physics Assembly HiMech.dll Represents the physical and mechanical properties of a workpiece material. public class WorkpieceMaterial : IPreferredFileName, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote Inheritance object WorkpieceMaterial Implements IPreferredFileName IStructureMaterial IMakeXmlSource IDuplicate INameNote 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) Constructors WorkpieceMaterial() Ctor. public WorkpieceMaterial() WorkpieceMaterial(XElement, string) Ctor. public WorkpieceMaterial(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties Al6061T6 General condition of Al6061T6. public static WorkpieceMaterial Al6061T6 { get; } Property Value WorkpieceMaterial CompressiveYieldStrength_MPa Gets or sets the compressive yield strength in megapascals (MPa). public double CompressiveYieldStrength_MPa { get; set; } Property Value double Density_gdcm3 Gets or sets the density in grams per cubic centimeter (g/cm³). public double Density_gdcm3 { get; set; } Property Value double Density_gdm3 Gets or sets the density in grams per cubic decimeter (g/dm³). public double Density_gdm3 { get; set; } Property Value double Density_gdmm3 Gets or sets the density in grams per cubic millimeter (g/mm³). public double Density_gdmm3 { get; set; } Property Value double EffectiveDepthForElogation_mm Gets or sets the effective depth for elongation in millimeters (mm). public double EffectiveDepthForElogation_mm { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals (GPa). public double ElasticModulus_GPa { get; set; } Property Value double ElogationRaioAtBreak Gets or sets the elongation ratio at break point. public double ElogationRaioAtBreak { get; set; } Property Value double FusionLatentHeat_Jdg Gets or sets the latent heat of fusion in joules per gram (J/g). public double FusionLatentHeat_Jdg { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the specific heat capacity in joules per gram per Kelvin (J/g·K). public double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in watts per decimeter per Kelvin (W/dm·K). public double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Gets or sets the heat conductivity in watts per millimeter per Kelvin (W/mm·K). This is a conversion of HeatConductivity_WdmK with a factor of 1/1000. public double HeatConductivity_WdmmK { get; set; } Property Value double MeltingTemperature_C Gets or sets the melting temperature in Celsius (°C). public double MeltingTemperature_C { get; set; } Property Value double MeltingTemperature_K Gets or sets the melting temperature in Kelvin (K). public double MeltingTemperature_K { get; set; } Property Value double Name Gets or sets the name of the material. public string Name { get; set; } Property Value string Note Gets or sets additional notes about the material. public string Note { get; set; } Property Value string PoissonRatio Gets or sets the Poisson's ratio of the material. public double PoissonRatio { get; set; } Property Value double PreferredFileName Gets or sets the preferred file name for this object when generating or saving files. public string PreferredFileName { get; set; } Property Value string TensileYieldStrength_MPa Gets or sets the tensile yield strength in megapascals (MPa). public double TensileYieldStrength_MPa { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original object MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "summary": "Class WorkpieceMaterial Namespace Hi.Physics Assembly HiMech.dll Represents the physical and mechanical properties of a workpiece material. public class WorkpieceMaterial : IPreferredFileName, IStructureMaterial, IMakeXmlSource, IDuplicate, INameNote Inheritance object WorkpieceMaterial Implements IPreferredFileName IStructureMaterial IMakeXmlSource IDuplicate INameNote 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) Constructors WorkpieceMaterial() Ctor. public WorkpieceMaterial() WorkpieceMaterial(XElement, string) Ctor. public WorkpieceMaterial(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory path for resolving relative paths Properties Al6061T6 General condition of Al6061T6. public static WorkpieceMaterial Al6061T6 { get; } Property Value WorkpieceMaterial CompressiveYieldStrength_MPa Gets or sets the compressive yield strength in megapascals (MPa). public double CompressiveYieldStrength_MPa { get; set; } Property Value double Density_gdcm3 Gets or sets the density in grams per cubic centimeter (g/cm³). public double Density_gdcm3 { get; set; } Property Value double Density_gdm3 Gets or sets the density in grams per cubic decimeter (g/dm³). public double Density_gdm3 { get; set; } Property Value double Density_gdmm3 Gets or sets the density in grams per cubic millimeter (g/mm³). public double Density_gdmm3 { get; set; } Property Value double EffectiveDepthForElogation_mm Gets or sets the effective depth for elongation in millimeters (mm). public double EffectiveDepthForElogation_mm { get; set; } Property Value double ElasticModulus_GPa Gets or sets the elastic modulus in gigapascals (GPa). public double ElasticModulus_GPa { get; set; } Property Value double ElogationRaioAtBreak Gets or sets the elongation ratio at break point. public double ElogationRaioAtBreak { get; set; } Property Value double FusionLatentHeat_Jdg Gets or sets the latent heat of fusion in joules per gram (J/g). public double FusionLatentHeat_Jdg { get; set; } Property Value double HeatCapacity_JdgK Gets or sets the specific heat capacity in joules per gram per Kelvin (J/g·K). public double HeatCapacity_JdgK { get; set; } Property Value double HeatConductivity_WdmK Gets or sets the heat transfer coefficient in watts per decimeter per Kelvin (W/dm·K). public double HeatConductivity_WdmK { get; set; } Property Value double HeatConductivity_WdmmK Gets or sets the heat conductivity in watts per millimeter per Kelvin (W/mm·K). This is a conversion of HeatConductivity_WdmK with a factor of 1/1000. public double HeatConductivity_WdmmK { get; set; } Property Value double MeltingTemperature_C Gets or sets the melting temperature in Celsius (°C). public double MeltingTemperature_C { get; set; } Property Value double MeltingTemperature_K Gets or sets the melting temperature in Kelvin (K). public double MeltingTemperature_K { get; set; } Property Value double Name Gets or sets the name of the material. public string Name { get; set; } Property Value string Note Gets or sets additional notes about the material. public string Note { get; set; } Property Value string PoissonRatio Gets or sets the Poisson's ratio of the material. public double PoissonRatio { get; set; } Property Value double PreferredFileName Gets or sets the preferred file name for this object when generating or saving files. public string PreferredFileName { get; set; } Property Value string TensileYieldStrength_MPa Gets or sets the tensile yield strength in megapascals (MPa). public double TensileYieldStrength_MPa { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods Duplicate(params object[]) Creates a deep copy of the object, excluding any source file references. public object Duplicate(params object[] res) Parameters res object[] Optional parameters that may be needed during the duplication process Returns object A new instance that is a deep copy of the original 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." }, "api/Hi.Physics.html": { "href": "api/Hi.Physics.html", @@ -4144,95 +4279,115 @@ "title": "Namespace Hi.ScriptApiUtils | HiAPI-C# 2025", "summary": "Namespace Hi.ScriptApiUtils Classes JsAceAttribute Attribute for JavaScript Ace editor integration. Interfaces ICsScriptApi Interface for C# scripting API functionality." }, - "api/Hi.ShellCommandUtils.CommandEntry.html": { - "href": "api/Hi.ShellCommandUtils.CommandEntry.html", - "title": "Class CommandEntry | HiAPI-C# 2025", - "summary": "Class CommandEntry Namespace Hi.ShellCommandUtils Assembly HiNc.dll Represents a command entry with enabled state in a command list. public class CommandEntry : IMakeXmlSource Inheritance object CommandEntry Implements IMakeXmlSource 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) Constructors CommandEntry(IShellCommand) Creates a new command entry with the specified command. public CommandEntry(IShellCommand command) Parameters command IShellCommand The command to associate with this entry. CommandEntry(XElement, string) Creates a new command entry from XML. public CommandEntry(XElement src, string baseDirectory) Parameters src XElement Source XML element. baseDirectory string Base directory for relative paths. Properties Command Gets or sets the command associated with this entry. public IShellCommand Command { get; set; } Property Value IShellCommand IsEnabled Gets or sets whether this command entry is enabled. public bool IsEnabled { get; set; } Property Value bool Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state" + "api/Hi.ShellCommands.EnablingWrapper.html": { + "href": "api/Hi.ShellCommands.EnablingWrapper.html", + "title": "Class EnablingWrapper | HiAPI-C# 2025", + "summary": "Class EnablingWrapper Namespace Hi.ShellCommands Assembly HiNc.dll public class EnablingWrapper : IShellCommand, IMakeXmlSource Inheritance object EnablingWrapper Implements IShellCommand IMakeXmlSource 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) Constructors EnablingWrapper() Ctor. public EnablingWrapper() EnablingWrapper(IShellCommand) public EnablingWrapper(IShellCommand command) Parameters command IShellCommand EnablingWrapper(XElement, string, string, params object[]) Ctor. public EnablingWrapper(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory for relative paths relFile string Relative file path res object[] Properties Command public IShellCommand Command { get; set; } Property Value IShellCommand IsEnabled public bool IsEnabled { get; set; } Property Value bool XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.GeomDiffCommand.html": { - "href": "api/Hi.ShellCommandUtils.GeomDiffCommand.html", + "api/Hi.ShellCommands.GeomDiffCommand.html": { + "href": "api/Hi.ShellCommands.GeomDiffCommand.html", "title": "Class GeomDiffCommand | HiAPI-C# 2025", - "summary": "Class GeomDiffCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command for calculating geometric differences between workpieces. public class GeomDiffCommand : IShellCommand, IMakeXmlSource Inheritance object GeomDiffCommand Implements IShellCommand IMakeXmlSource 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) Constructors GeomDiffCommand() Default constructor. public GeomDiffCommand() GeomDiffCommand(XElement, string) Ctor. public GeomDiffCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for relative paths. Fields ConstDisplayName Display name constant for this command. public const string ConstDisplayName = \"Geometry Difference\" Field Value string Properties DetectRadius_mm Detection radius in millimeters. public double DetectRadius_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class GeomDiffCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for calculating geometric differences between workpieces. public class GeomDiffCommand : IShellCommand, IMakeXmlSource Inheritance object GeomDiffCommand Implements IShellCommand IMakeXmlSource 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) Constructors GeomDiffCommand() Default constructor. public GeomDiffCommand() GeomDiffCommand(XElement, string) Ctor. public GeomDiffCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for relative paths. Fields ConstDisplayName Display name constant for this command. public const string ConstDisplayName = \"Geometry Difference\" Field Value string Properties DetectRadius_mm Detection radius in millimeters. public double DetectRadius_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.IShellCommand.html": { - "href": "api/Hi.ShellCommandUtils.IShellCommand.html", + "api/Hi.ShellCommands.IShellCommand.html": { + "href": "api/Hi.ShellCommands.IShellCommand.html", "title": "Interface IShellCommand | HiAPI-C# 2025", - "summary": "Interface IShellCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Interface for commands that can be executed in a milling course. public interface IShellCommand : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string) 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) Methods Run(ShellApi) Runs the command using the provided script API. IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Interface IShellCommand Namespace Hi.ShellCommands Assembly HiNc.dll Interface for commands that can be executed in a milling course. public interface IShellCommand : IMakeXmlSource Inherited Members IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Methods Run(RuntimeController) Runs the command using the provided script API. IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.Lang.html": { - "href": "api/Hi.ShellCommandUtils.Lang.html", + "api/Hi.ShellCommands.ITitleCommand.html": { + "href": "api/Hi.ShellCommands.ITitleCommand.html", + "title": "Interface ITitleCommand | HiAPI-C# 2025", + "summary": "Interface ITitleCommand Namespace Hi.ShellCommands Assembly HiNc.dll IShellCommand with title. public interface ITitleCommand : IShellCommand, IMakeXmlSource Inherited Members IShellCommand.Run(RuntimeController) IMakeXmlSource.MakeXmlSource(string, string, bool) 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) Methods GetCommandTitle() string GetCommandTitle() Returns string" + }, + "api/Hi.ShellCommands.Lang.html": { + "href": "api/Hi.ShellCommands.Lang.html", "title": "Class Lang | HiAPI-C# 2025", - "summary": "Class Lang Namespace Hi.ShellCommandUtils Assembly HiNc.dll Language package class for command flow. public class Lang Inheritance object Lang 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)" + "summary": "Class Lang Namespace Hi.ShellCommands Assembly HiNc.dll Language package class for command flow. public class Lang Inheritance object Lang 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)" }, - "api/Hi.ShellCommandUtils.ListCommand.html": { - "href": "api/Hi.ShellCommandUtils.ListCommand.html", + "api/Hi.ShellCommands.ListCommand.html": { + "href": "api/Hi.ShellCommands.ListCommand.html", "title": "Class ListCommand | HiAPI-C# 2025", - "summary": "Class ListCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll A command that contains and executes a list of other commands. public class ListCommand : IShellCommand, IMakeXmlSource Inheritance object ListCommand Implements IShellCommand IMakeXmlSource 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) Constructors ListCommand() Default constructor. public ListCommand() ListCommand(XElement, string, string) Ctor. public ListCommand(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string Base directory for relative paths. relFile string Relative file path. Properties CommandEntryList Command List. The item in list is null capable. public List CommandEntryList { get; set; } Property Value List XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class ListCommand Namespace Hi.ShellCommands Assembly HiNc.dll A command that contains and executes a list of other commands. public class ListCommand : ITitleCommand, IShellCommand, IMakeXmlSource Inheritance object ListCommand Implements ITitleCommand IShellCommand IMakeXmlSource 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) Constructors ListCommand() Default constructor. public ListCommand() ListCommand(XElement, string, string, params object[]) Ctor. public ListCommand(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory for relative paths. relFile string Relative file path. res object[] Properties CommandEntryList Command List. The item in list is null capable. public List CommandEntryList { get; set; } Property Value List XName Name for XML IO. public static string XName { get; } Property Value string Methods GetCommandTitle() public string GetCommandTitle() Returns string 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.MachiningMotionResolutionCommand.html": { - "href": "api/Hi.ShellCommandUtils.MachiningMotionResolutionCommand.html", + "api/Hi.ShellCommands.MachiningMotionResolutionCommand.html": { + "href": "api/Hi.ShellCommands.MachiningMotionResolutionCommand.html", "title": "Class MachiningMotionResolutionCommand | HiAPI-C# 2025", - "summary": "Class MachiningMotionResolutionCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command for setting machining motion resolution for the milling process. public class MachiningMotionResolutionCommand : IShellCommand, IMakeXmlSource Inheritance object MachiningMotionResolutionCommand Implements IShellCommand IMakeXmlSource 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) Constructors MachiningMotionResolutionCommand() Ctor. public MachiningMotionResolutionCommand() MachiningMotionResolutionCommand(XElement, string, string) Ctor. public MachiningMotionResolutionCommand(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths relFile string Relative file path Properties MachiningMotionResolution Main content. Machining Cycle Resolution. public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class MachiningMotionResolutionCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for setting machining motion resolution for the milling process. public class MachiningMotionResolutionCommand : IShellCommand, IMakeXmlSource Inheritance object MachiningMotionResolutionCommand Implements IShellCommand IMakeXmlSource 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) Constructors MachiningMotionResolutionCommand() Ctor. public MachiningMotionResolutionCommand() MachiningMotionResolutionCommand(XElement, string, string) Ctor. public MachiningMotionResolutionCommand(XElement src, string baseDirectory, string relFile) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths relFile string Relative file path Properties MachiningMotionResolution Main content. Machining Cycle Resolution. public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.NcCodeCommand.html": { - "href": "api/Hi.ShellCommandUtils.NcCodeCommand.html", + "api/Hi.ShellCommands.NcCodeCommand.html": { + "href": "api/Hi.ShellCommands.NcCodeCommand.html", "title": "Class NcCodeCommand | HiAPI-C# 2025", - "summary": "Class NcCodeCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command for executing NC code directly. public class NcCodeCommand : IShellCommand, IMakeXmlSource Inheritance object NcCodeCommand Implements IShellCommand IMakeXmlSource 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) Constructors NcCodeCommand(XElement, string) Ctor. public NcCodeCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties FileNameAlternative Alternative file name for the NC code file. public string FileNameAlternative { get; set; } Property Value string NcText The NC code text content. public string NcText { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class NcCodeCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for executing NC code directly. public class NcCodeCommand : ITitleCommand, IShellCommand, IMakeXmlSource Inheritance object NcCodeCommand Implements ITitleCommand IShellCommand IMakeXmlSource 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) Constructors NcCodeCommand() Ctor. public NcCodeCommand() NcCodeCommand(string) public NcCodeCommand(string nc) Parameters nc string NcCodeCommand(XElement, string) Ctor. public NcCodeCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties NcText The NC code text content. public string NcText { get; set; } Property Value string Title Title. Alternative file name for the NC code file. public string Title { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetCommandTitle() public string GetCommandTitle() Returns string 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.NcFileCommand.html": { - "href": "api/Hi.ShellCommandUtils.NcFileCommand.html", + "api/Hi.ShellCommands.NcFileCommand.html": { + "href": "api/Hi.ShellCommands.NcFileCommand.html", "title": "Class NcFileCommand | HiAPI-C# 2025", - "summary": "Class NcFileCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command for executing NC code from a file. public class NcFileCommand : IShellCommand, IMakeXmlSource Inheritance object NcFileCommand Implements IShellCommand IMakeXmlSource 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) Constructors NcFileCommand() Default constructor. public NcFileCommand() NcFileCommand(XElement, string) Ctor. public NcFileCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties NcFile Path to the NC file. public string NcFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class NcFileCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for executing NC code from a file. public class NcFileCommand : ITitleCommand, IShellCommand, IMakeXmlSource Inheritance object NcFileCommand Implements ITitleCommand IShellCommand IMakeXmlSource 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) Constructors NcFileCommand() Default constructor. public NcFileCommand() NcFileCommand(string) public NcFileCommand(string ncFile) Parameters ncFile string NcFileCommand(XElement, string) Ctor. public NcFileCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties NcFile Path to the NC file. public string NcFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetCommandTitle() public string GetCommandTitle() Returns string 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.NcFileListCommand.html": { - "href": "api/Hi.ShellCommandUtils.NcFileListCommand.html", + "api/Hi.ShellCommands.NcFileListCommand.html": { + "href": "api/Hi.ShellCommands.NcFileListCommand.html", "title": "Class NcFileListCommand | HiAPI-C# 2025", - "summary": "Class NcFileListCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command for executing multiple NC files sequentially. public class NcFileListCommand : IShellCommand, IMakeXmlSource Inheritance object NcFileListCommand Implements IShellCommand IMakeXmlSource 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) Constructors NcFileListCommand() Default constructor. public NcFileListCommand() NcFileListCommand(XElement, string) Ctor. public NcFileListCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties NcFileList List of NC files to execute. public List NcFileList { get; set; } Property Value List XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class NcFileListCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for executing multiple NC files sequentially. public class NcFileListCommand : IShellCommand, IMakeXmlSource Inheritance object NcFileListCommand Implements IShellCommand IMakeXmlSource 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) Constructors NcFileListCommand() Default constructor. public NcFileListCommand() NcFileListCommand(XElement, string) Ctor. public NcFileListCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties NcFileList List of NC files to execute. public List NcFileList { get; set; } Property Value List XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.OptimizeToFilesCommand.html": { - "href": "api/Hi.ShellCommandUtils.OptimizeToFilesCommand.html", + "api/Hi.ShellCommands.NcOptOptionCommand.html": { + "href": "api/Hi.ShellCommands.NcOptOptionCommand.html", + "title": "Class NcOptOptionCommand | HiAPI-C# 2025", + "summary": "Class NcOptOptionCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for NC optimization options. public class NcOptOptionCommand : ITitleCommand, IShellCommand, IMakeXmlSource Inheritance object NcOptOptionCommand Implements ITitleCommand IShellCommand IMakeXmlSource 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) Constructors NcOptOptionCommand() Ctor. public NcOptOptionCommand() NcOptOptionCommand(XElement, string, string, params object[]) Ctor. public NcOptOptionCommand(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory for relative paths relFile string Relative file path res object[] Properties NcOptOption public NcOptOption NcOptOption { get; set; } Property Value NcOptOption XName Name for XML IO. public static string XName { get; } Property Value string Methods GetCommandTitle() public string GetCommandTitle() Returns string 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + }, + "api/Hi.ShellCommands.OptimizeToFilesCommand.html": { + "href": "api/Hi.ShellCommands.OptimizeToFilesCommand.html", "title": "Class OptimizeToFilesCommand | HiAPI-C# 2025", - "summary": "Class OptimizeToFilesCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command to call OptimizeToFiles(string). public class OptimizeToFilesCommand : IShellCommand, IMakeXmlSource Inheritance object OptimizeToFilesCommand Implements IShellCommand IMakeXmlSource 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) Constructors OptimizeToFilesCommand() Default constructor. public OptimizeToFilesCommand() OptimizeToFilesCommand(XElement, string) Ctor. public OptimizeToFilesCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFileTemplate Template for the relative file path. public string RelFileTemplate { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class OptimizeToFilesCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command to call OptimizeToFiles(string). public class OptimizeToFilesCommand : IShellCommand, IMakeXmlSource Inheritance object OptimizeToFilesCommand Implements IShellCommand IMakeXmlSource 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) Constructors OptimizeToFilesCommand() Default constructor. public OptimizeToFilesCommand() OptimizeToFilesCommand(XElement, string) Ctor. public OptimizeToFilesCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFileTemplate Template for the relative file path. public string RelFileTemplate { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum.html": { - "href": "api/Hi.ShellCommandUtils.RecordRuntimeGeomActionEnum.html", + "api/Hi.ShellCommands.PostExecutionCommand.html": { + "href": "api/Hi.ShellCommands.PostExecutionCommand.html", + "title": "Class PostExecutionCommand | HiAPI-C# 2025", + "summary": "Class PostExecutionCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for post-execution actions after NC command running. public class PostExecutionCommand : ITitleCommand, IShellCommand, IMakeXmlSource Inheritance object PostExecutionCommand Implements ITitleCommand IShellCommand IMakeXmlSource 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) Constructors PostExecutionCommand() Ctor. public PostExecutionCommand() PostExecutionCommand(XElement, string, string, params object[]) Ctor. public PostExecutionCommand(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory for relative paths relFile string Relative file path res object[] Properties EnableGeomDiff public bool EnableGeomDiff { get; set; } Property Value bool EnableOptimizeToFiles public bool EnableOptimizeToFiles { get; set; } Property Value bool EnableWriteRuntimeGeom public bool EnableWriteRuntimeGeom { get; set; } Property Value bool EnableWriteShotFiles public bool EnableWriteShotFiles { get; set; } Property Value bool EnableWriteStepFiles public bool EnableWriteStepFiles { get; set; } Property Value bool GeomDiffDetectRadius_mm public double GeomDiffDetectRadius_mm { get; set; } Property Value double OptimizationFileTemplate public string OptimizationFileTemplate { get; set; } Property Value string RuntimeGeomFilePath public string RuntimeGeomFilePath { get; set; } Property Value string ShotFileTemplate public string ShotFileTemplate { get; set; } Property Value string ShotFileTimeResolution_ms public double ShotFileTimeResolution_ms { get; set; } Property Value double StepFileTemplate public string StepFileTemplate { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetCommandTitle() public string GetCommandTitle() Returns string 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + }, + "api/Hi.ShellCommands.PreSettingCommand.html": { + "href": "api/Hi.ShellCommands.PreSettingCommand.html", + "title": "Class PreSettingCommand | HiAPI-C# 2025", + "summary": "Class PreSettingCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for pre-settings before NC command running. public class PreSettingCommand : ITitleCommand, IShellCommand, IMakeXmlSource Inheritance object PreSettingCommand Implements ITitleCommand IShellCommand IMakeXmlSource 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) Constructors PreSettingCommand() Ctor. public PreSettingCommand() PreSettingCommand(XElement, string, string, params object[]) Ctor. public PreSettingCommand(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory for relative paths relFile string Relative file path res object[] Properties EnableCollisionDetection public bool EnableCollisionDetection { get; set; } Property Value bool EnablePauseOnFailure public bool EnablePauseOnFailure { get; set; } Property Value bool EnablePhysics public bool EnablePhysics { get; set; } Property Value bool EnableReadRuntimeGeom public bool EnableReadRuntimeGeom { get; set; } Property Value bool MachiningMotionResolution public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution MachiningResolution_mm public double MachiningResolution_mm { get; set; } Property Value double RuntimeGeomFile public string RuntimeGeomFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GetCommandTitle() public string GetCommandTitle() Returns string 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + }, + "api/Hi.ShellCommands.RecordRuntimeGeomActionEnum.html": { + "href": "api/Hi.ShellCommands.RecordRuntimeGeomActionEnum.html", "title": "Enum RecordRuntimeGeomActionEnum | HiAPI-C# 2025", - "summary": "Enum RecordRuntimeGeomActionEnum Namespace Hi.ShellCommandUtils Assembly HiNc.dll Action of the RecordRuntimeGeomCommand. public enum RecordRuntimeGeomActionEnum Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields NoAction = 0 No action. Read = 1 Read runtime geometry from file. ReadOnFirstOrWrite = 3 If file existed and no motion has ran before, read the runtime geometry; otherwise, write the current geometry into file. Write = 2 Write runtime geometry to file." + "summary": "Enum RecordRuntimeGeomActionEnum Namespace Hi.ShellCommands Assembly HiNc.dll Action of the RecordRuntimeGeomCommand. public enum RecordRuntimeGeomActionEnum Extension Methods InvokeUtil.SelfInvoke(TSrc, Action) InvokeUtil.SelfInvoke(TSrc, Func) MaskUtil.GetMaskedValue(T, T, bool) MaskUtil.SetMask(ref T, T, bool) ColorUtil.GetGloomyColor(object, double, double) NameUtil.GetSelectionName(object) StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool) LockUtil.Lock(object) Fields NoAction = 0 No action. Read = 1 Read runtime geometry from file. ReadOnFirstOrWrite = 3 If file existed and no motion has ran before, read the runtime geometry; otherwise, write the current geometry into file. Write = 2 Write runtime geometry to file." }, - "api/Hi.ShellCommandUtils.RecordRuntimeGeomCommand.html": { - "href": "api/Hi.ShellCommandUtils.RecordRuntimeGeomCommand.html", + "api/Hi.ShellCommands.RecordRuntimeGeomCommand.html": { + "href": "api/Hi.ShellCommands.RecordRuntimeGeomCommand.html", "title": "Class RecordRuntimeGeomCommand | HiAPI-C# 2025", - "summary": "Class RecordRuntimeGeomCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command for recording runtime geometry to/from file. public class RecordRuntimeGeomCommand : IShellCommand, IMakeXmlSource Inheritance object RecordRuntimeGeomCommand Implements IShellCommand IMakeXmlSource 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) Constructors RecordRuntimeGeomCommand() Default constructor. public RecordRuntimeGeomCommand() RecordRuntimeGeomCommand(XElement, string) Ctor. public RecordRuntimeGeomCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties MainActionEnum Main action to perform (read, write, or conditional). public RecordRuntimeGeomActionEnum MainActionEnum { get; set; } Property Value RecordRuntimeGeomActionEnum RelFile Relative file path. public string RelFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class RecordRuntimeGeomCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for recording runtime geometry to/from file. public class RecordRuntimeGeomCommand : IShellCommand, IMakeXmlSource Inheritance object RecordRuntimeGeomCommand Implements IShellCommand IMakeXmlSource 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) Constructors RecordRuntimeGeomCommand() Default constructor. public RecordRuntimeGeomCommand() RecordRuntimeGeomCommand(XElement, string) Ctor. public RecordRuntimeGeomCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties MainActionEnum Main action to perform (read, write, or conditional). public RecordRuntimeGeomActionEnum MainActionEnum { get; set; } Property Value RecordRuntimeGeomActionEnum RelFile Relative file path. public string RelFile { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.RuntimeCommand.html": { - "href": "api/Hi.ShellCommandUtils.RuntimeCommand.html", - "title": "Class RuntimeCommand | HiAPI-C# 2025", - "summary": "Class RuntimeCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Represents a shell command that can be executed at runtime. public class RuntimeCommand : IShellCommand, IMakeXmlSource Inheritance object RuntimeCommand Implements IShellCommand IMakeXmlSource 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) Constructors RuntimeCommand() Initializes a new instance of the RuntimeCommand class. public RuntimeCommand() RuntimeCommand(Action) Initializes a new instance of the RuntimeCommand class with the specified action. public RuntimeCommand(Action action) Parameters action Action The action to execute when this command is run. Properties Action Gets or sets the action to execute when this command is run. public Action Action { get; set; } Property Value Action XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Remarks The content of runtime command can not be saved. Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi shellApi) Parameters shellApi ShellApi Returns IEnumerable Sequence of actions to be executed." - }, - "api/Hi.ShellCommandUtils.ScriptCommand.html": { - "href": "api/Hi.ShellCommandUtils.ScriptCommand.html", + "api/Hi.ShellCommands.ScriptCommand.html": { + "href": "api/Hi.ShellCommands.ScriptCommand.html", "title": "Class ScriptCommand | HiAPI-C# 2025", - "summary": "Class ScriptCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command for executing C# scripts in the milling process. public class ScriptCommand : IShellCommand, IMakeXmlSource, IGetSelectionName Inheritance object ScriptCommand Implements IShellCommand IMakeXmlSource IGetSelectionName 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) Constructors ScriptCommand() Ctor. public ScriptCommand() ScriptCommand(XElement, string) Ctor. public ScriptCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties ScriptText The script text content. public string ScriptText { get; set; } Property Value string ScriptTitle Title or name of the script. public string ScriptTitle { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GenTemplateCommand() Generates a template script command with default values. public static ScriptCommand GenTemplateCommand() Returns ScriptCommand A new ScriptCommand with template values GetSelectionName() Gets a name that can be used for selection in UI or other contexts. public string GetSelectionName() Returns string The selection name for this object MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed. Run(ShellApi, string) Runs a specified script with the given script API. public IEnumerable Run(ShellApi scriptApi, string scriptText) Parameters scriptApi ShellApi The milling course script API scriptText string The script text to run Returns IEnumerable Enumerable of actions to perform" + "summary": "Class ScriptCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command for executing C# scripts in the milling process. public class ScriptCommand : ITitleCommand, IShellCommand, IMakeXmlSource, IGetSelectionName Inheritance object ScriptCommand Implements ITitleCommand IShellCommand IMakeXmlSource IGetSelectionName 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) Constructors ScriptCommand() Ctor. public ScriptCommand() ScriptCommand(XElement, string) Ctor. public ScriptCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties ExecutionTemplate public static ScriptCommand ExecutionTemplate { get; } Property Value ScriptCommand OptimizationConfigurationTemplate public static ScriptCommand OptimizationConfigurationTemplate { get; } Property Value ScriptCommand PreSettingTemplate public static ScriptCommand PreSettingTemplate { get; } Property Value ScriptCommand ScriptText The script text content. public string ScriptText { get; set; } Property Value string ScriptTitle Title or name of the script. public string ScriptTitle { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods GenTemplateCommand() Generates a template script command with default values. public static ScriptCommand GenTemplateCommand() Returns ScriptCommand A new ScriptCommand with template values GetCommandTitle() public string GetCommandTitle() Returns string GetSelectionName() Gets a name that can be used for selection in UI or other contexts. public string GetSelectionName() Returns string The selection name for this 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed. Run(RuntimeController, string) Runs a specified script with the given script API. public IEnumerable Run(RuntimeController scriptApi, string scriptText) Parameters scriptApi RuntimeController The milling course script API scriptText string The script text to run Returns IEnumerable Enumerable of actions to perform" }, - "api/Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand.html": { - "href": "api/Hi.ShellCommandUtils.WriteRuntimeGeomToStlCommand.html", + "api/Hi.ShellCommands.SimpleSessionCommand.html": { + "href": "api/Hi.ShellCommands.SimpleSessionCommand.html", + "title": "Class SimpleSessionCommand | HiAPI-C# 2025", + "summary": "Class SimpleSessionCommand Namespace Hi.ShellCommands Assembly HiNc.dll public class SimpleSessionCommand : IShellCommand, IMakeXmlSource Inheritance object SimpleSessionCommand Implements IShellCommand IMakeXmlSource 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) Constructors SimpleSessionCommand() Ctor. public SimpleSessionCommand() SimpleSessionCommand(XElement, string, string, params object[]) Ctor. public SimpleSessionCommand(XElement src, string baseDirectory, string relFile, params object[] res) Parameters src XElement XML baseDirectory string Base directory for relative paths relFile string Relative file path res object[] Properties EnableCollisionDetection public bool EnableCollisionDetection { get; set; } Property Value bool EnableGeomDiff public bool EnableGeomDiff { get; set; } Property Value bool EnableOptimizeToFiles public bool EnableOptimizeToFiles { get; set; } Property Value bool EnablePauseOnFailure public bool EnablePauseOnFailure { get; set; } Property Value bool EnableReadRuntimeGeom public bool EnableReadRuntimeGeom { get; set; } Property Value bool EnableWriteRuntimeGeom public bool EnableWriteRuntimeGeom { get; set; } Property Value bool EnableWriteShotFiles public bool EnableWriteShotFiles { get; set; } Property Value bool EnableWriteStepFiles public bool EnableWriteStepFiles { get; set; } Property Value bool GeomDiffDetectRadius_mm public double GeomDiffDetectRadius_mm { get; set; } Property Value double MachiningMotionResolution public IMachiningMotionResolution MachiningMotionResolution { get; set; } Property Value IMachiningMotionResolution MachiningResolution_mm public double MachiningResolution_mm { get; set; } Property Value double NcCommandList Middle command list. Mainly for NC commands. Because of the design idea is for simplicity, only expect the wrapper content to be NcFileCommand or NcCodeCommand or ScriptCommand. public List NcCommandList { get; set; } Property Value List NcOptOption public NcOptOption NcOptOption { get; set; } Property Value NcOptOption OptimizationFileTemplate public string OptimizationFileTemplate { get; set; } Property Value string RuntimeGeomFile public string RuntimeGeomFile { get; set; } Property Value string RuntimeGeomFileTemplate public string RuntimeGeomFileTemplate { get; set; } Property Value string ShotFileTemplate public string ShotFileTemplate { get; set; } Property Value string ShotFileTimeResolution_ms public double ShotFileTimeResolution_ms { get; set; } Property Value double StepFileTemplate public string StepFileTemplate { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + }, + "api/Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html": { + "href": "api/Hi.ShellCommands.WriteRuntimeGeomToStlCommand.html", "title": "Class WriteRuntimeGeomToStlCommand | HiAPI-C# 2025", - "summary": "Class WriteRuntimeGeomToStlCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command to call Hi.MillingProcs.MachiningProjectCsScriptApi.WriteRuntimeGeomToStl. public class WriteRuntimeGeomToStlCommand : IShellCommand, IMakeXmlSource Inheritance object WriteRuntimeGeomToStlCommand Implements IShellCommand IMakeXmlSource 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) Constructors WriteRuntimeGeomToStlCommand() Default constructor. public WriteRuntimeGeomToStlCommand() WriteRuntimeGeomToStlCommand(XElement, string) Ctor. public WriteRuntimeGeomToStlCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFile Relative path for the output STL file. public string RelFile { get; set; } Property Value string Resolution_mm Resolution in millimeters for STL generation. public double Resolution_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class WriteRuntimeGeomToStlCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command to call Hi.MillingProcs.MachiningProjectCsScriptApi.WriteRuntimeGeomToStl. public class WriteRuntimeGeomToStlCommand : IShellCommand, IMakeXmlSource Inheritance object WriteRuntimeGeomToStlCommand Implements IShellCommand IMakeXmlSource 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) Constructors WriteRuntimeGeomToStlCommand() Default constructor. public WriteRuntimeGeomToStlCommand() WriteRuntimeGeomToStlCommand(XElement, string) Ctor. public WriteRuntimeGeomToStlCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFile Relative path for the output STL file. public string RelFile { get; set; } Property Value string Resolution_mm Resolution in millimeters for STL generation. public double Resolution_mm { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.WriteShotFilesCommand.html": { - "href": "api/Hi.ShellCommandUtils.WriteShotFilesCommand.html", + "api/Hi.ShellCommands.WriteShotFilesCommand.html": { + "href": "api/Hi.ShellCommands.WriteShotFilesCommand.html", "title": "Class WriteShotFilesCommand | HiAPI-C# 2025", - "summary": "Class WriteShotFilesCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command to call WriteShotFiles(string, double). public class WriteShotFilesCommand : IShellCommand, IMakeXmlSource Inheritance object WriteShotFilesCommand Implements IShellCommand IMakeXmlSource 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) Constructors WriteShotFilesCommand() Default constructor. public WriteShotFilesCommand() WriteShotFilesCommand(XElement, string) Ctor. public WriteShotFilesCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFileTemplate Template for the relative file path where shot files will be written. public string RelFileTemplate { get; set; } Property Value string TimeResolution_ms Time resolution in milliseconds for shot data sampling. public double TimeResolution_ms { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class WriteShotFilesCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command to call WriteShotFiles(string, double). public class WriteShotFilesCommand : IShellCommand, IMakeXmlSource Inheritance object WriteShotFilesCommand Implements IShellCommand IMakeXmlSource 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) Constructors WriteShotFilesCommand() Default constructor. public WriteShotFilesCommand() WriteShotFilesCommand(XElement, string) Ctor. public WriteShotFilesCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFileTemplate Template for the relative file path where shot files will be written. public string RelFileTemplate { get; set; } Property Value string TimeResolution_ms Time resolution in milliseconds for shot data sampling. public double TimeResolution_ms { get; set; } Property Value double XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.WriteStepFilesCommand.html": { - "href": "api/Hi.ShellCommandUtils.WriteStepFilesCommand.html", + "api/Hi.ShellCommands.WriteStepFilesCommand.html": { + "href": "api/Hi.ShellCommands.WriteStepFilesCommand.html", "title": "Class WriteStepFilesCommand | HiAPI-C# 2025", - "summary": "Class WriteStepFilesCommand Namespace Hi.ShellCommandUtils Assembly HiNc.dll Command to call WriteStepFiles(string). public class WriteStepFilesCommand : IShellCommand, IMakeXmlSource Inheritance object WriteStepFilesCommand Implements IShellCommand IMakeXmlSource 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) Constructors WriteStepFilesCommand() Default constructor. public WriteStepFilesCommand() WriteStepFilesCommand(XElement, string) Ctor. public WriteStepFilesCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFileTemplate Template for the relative file path where step files will be written. public string RelFileTemplate { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state Run(ShellApi) Runs the command using the provided script API. public IEnumerable Run(ShellApi scriptApi) Parameters scriptApi ShellApi Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." + "summary": "Class WriteStepFilesCommand Namespace Hi.ShellCommands Assembly HiNc.dll Command to call WriteStepFiles(string). public class WriteStepFilesCommand : IShellCommand, IMakeXmlSource Inheritance object WriteStepFilesCommand Implements IShellCommand IMakeXmlSource 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) Constructors WriteStepFilesCommand() Default constructor. public WriteStepFilesCommand() WriteStepFilesCommand(XElement, string) Ctor. public WriteStepFilesCommand(XElement src, string baseDirectory) Parameters src XElement XML baseDirectory string Base directory for resolving relative paths Properties RelFileTemplate Template for the relative file path where step files will be written. public string RelFileTemplate { get; set; } Property Value string XName Name for XML IO. public static string XName { get; } Property Value string Methods 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. Run(RuntimeController) Runs the command using the provided script API. public IEnumerable Run(RuntimeController scriptApi) Parameters scriptApi RuntimeController Script API for executing milling commands. Returns IEnumerable Sequence of actions to be executed." }, - "api/Hi.ShellCommandUtils.html": { - "href": "api/Hi.ShellCommandUtils.html", - "title": "Namespace Hi.ShellCommandUtils | HiAPI-C# 2025", - "summary": "Namespace Hi.ShellCommandUtils Classes CommandEntry Represents a command entry with enabled state in a command list. GeomDiffCommand Command for calculating geometric differences between workpieces. Lang Language package class for command flow. ListCommand A command that contains and executes a list of other commands. MachiningMotionResolutionCommand Command for setting machining motion resolution for the milling process. NcCodeCommand Command for executing NC code directly. NcFileCommand Command for executing NC code from a file. NcFileListCommand Command for executing multiple NC files sequentially. OptimizeToFilesCommand Command to call OptimizeToFiles(string). RecordRuntimeGeomCommand Command for recording runtime geometry to/from file. RuntimeCommand Represents a shell command that can be executed at runtime. ScriptCommand Command for executing C# scripts in the milling process. WriteRuntimeGeomToStlCommand Command to call Hi.MillingProcs.MachiningProjectCsScriptApi.WriteRuntimeGeomToStl. WriteShotFilesCommand Command to call WriteShotFiles(string, double). WriteStepFilesCommand Command to call WriteStepFiles(string). Interfaces IShellCommand Interface for commands that can be executed in a milling course. Enums RecordRuntimeGeomActionEnum Action of the RecordRuntimeGeomCommand." + "api/Hi.ShellCommands.html": { + "href": "api/Hi.ShellCommands.html", + "title": "Namespace Hi.ShellCommands | HiAPI-C# 2025", + "summary": "Namespace Hi.ShellCommands Classes EnablingWrapper GeomDiffCommand Command for calculating geometric differences between workpieces. Lang Language package class for command flow. ListCommand A command that contains and executes a list of other commands. MachiningMotionResolutionCommand Command for setting machining motion resolution for the milling process. NcCodeCommand Command for executing NC code directly. NcFileCommand Command for executing NC code from a file. NcFileListCommand Command for executing multiple NC files sequentially. NcOptOptionCommand Command for NC optimization options. OptimizeToFilesCommand Command to call OptimizeToFiles(string). PostExecutionCommand Command for post-execution actions after NC command running. PreSettingCommand Command for pre-settings before NC command running. RecordRuntimeGeomCommand Command for recording runtime geometry to/from file. ScriptCommand Command for executing C# scripts in the milling process. SimpleSessionCommand WriteRuntimeGeomToStlCommand Command to call Hi.MillingProcs.MachiningProjectCsScriptApi.WriteRuntimeGeomToStl. WriteShotFilesCommand Command to call WriteShotFiles(string, double). WriteStepFilesCommand Command to call WriteStepFiles(string). Interfaces IShellCommand Interface for commands that can be executed in a milling course. ITitleCommand IShellCommand with title. Enums RecordRuntimeGeomActionEnum Action of the RecordRuntimeGeomCommand." }, "api/Hi.Test.TestCollision.html": { "href": "api/Hi.Test.TestCollision.html", @@ -4339,6 +4494,26 @@ "title": "Namespace Hi.Vibrations | HiAPI-C# 2025", "summary": "Namespace Hi.Vibrations Classes AngularVelocityUtil Provides utility methods for working with angular velocity. ForceAccelAmpPhase Represents amplitude and phase information for force and acceleration in vibration analysis. ForceAccelFourierSeries Represents Fourier series data for force and acceleration measurements in three dimensions. ForceAccelShot Represents a data point containing force, acceleration, and moment measurements at a specific time. ForceAccelUtil Utility class for force and acceleration data processing. VibrationUtil Utility class for vibration analysis and processing. WAmpPhase Represents amplitude and phase information with angular velocity. WAmpPhaseXyzTransformation Represents amplitude and phase information with angular velocity for XYZ transformations. Interfaces IAngularVelocityOwner Provides functionality for objects that have an angular velocity property." }, + "api/Hi.Webapi.Hubs.RenderingHub.html": { + "href": "api/Hi.Webapi.Hubs.RenderingHub.html", + "title": "Class RenderingHub | HiAPI-C# 2025", + "summary": "Class RenderingHub Namespace Hi.Webapi.Hubs Assembly Hi.Webapi.dll SignalR Hub 用於處理渲染畫布的實時通信 public class RenderingHub : Hub, IDisposable Inheritance object Hub RenderingHub Implements IDisposable Inherited Members Hub.OnConnectedAsync() Hub.Dispose(bool) Hub.Dispose() Hub.Clients Hub.Context Hub.Groups 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) Constructors RenderingHub(RenderingService, ILogger) public RenderingHub(RenderingService renderingService, ILogger logger) Parameters renderingService RenderingService logger ILogger Methods HandleKeyDown(string, string, bool, bool, bool) 處理鍵盤按下事件 public Task HandleKeyDown(string key, string code, bool ctrlKey, bool shiftKey, bool altKey) Parameters key string code string ctrlKey bool shiftKey bool altKey bool Returns Task HandleKeyUp(string, string, bool, bool, bool) 處理鍵盤釋放事件 public Task HandleKeyUp(string key, string code, bool ctrlKey, bool shiftKey, bool altKey) Parameters key string code string ctrlKey bool shiftKey bool altKey bool Returns Task HandleMouseDown(double, double, int) 處理鼠標按下事件 public Task HandleMouseDown(double x, double y, int button) Parameters x double y double button int Returns Task HandleMouseMove(double, double, int) 處理鼠標移動事件 public Task HandleMouseMove(double x, double y, int buttonMask) Parameters x double y double buttonMask int Returns Task HandleMouseUp(double, double, int) 處理鼠標釋放事件 public Task HandleMouseUp(double x, double y, int button) Parameters x double y double button int Returns Task HandleMouseWheel(double, double, double, double, string) 處理鼠標滾輪事件 public Task HandleMouseWheel(double x, double y, double deltaX, double deltaY, string browserBrand = \"chrome\") Parameters x double y double deltaX double deltaY double browserBrand string Returns Task HandleResize(int, int) 處理窗口大小變化 public Task HandleResize(int width, int height) Parameters width int height int Returns Task HandleTouchDown(int, double, double) 處理觸摸按下事件 public Task HandleTouchDown(int pointerId, double x, double y) Parameters pointerId int x double y double Returns Task HandleTouchMove(int, double, double) 處理觸摸移動事件 public Task HandleTouchMove(int pointerId, double x, double y) Parameters pointerId int x double y double Returns Task HandleTouchUp(int) 處理觸摸釋放事件 public Task HandleTouchUp(int pointerId) Parameters pointerId int Returns Task HandleVisibilityChange(string) 處理可見性變化 public Task HandleVisibilityChange(string visibilityState) Parameters visibilityState string Returns Task InitializeCanvas(int, int) 客戶端連接時初始化渲染引擎 public Task InitializeCanvas(int width, int height) Parameters width int height int Returns Task OnDisconnectedAsync(Exception) 客戶端斷開連接時清理資源 public override Task OnDisconnectedAsync(Exception exception) Parameters exception Exception Returns Task SetView(string) 設置視圖 public Task SetView(string viewType) Parameters viewType string Returns Task" + }, + "api/Hi.Webapi.Hubs.html": { + "href": "api/Hi.Webapi.Hubs.html", + "title": "Namespace Hi.Webapi.Hubs | HiAPI-C# 2025", + "summary": "Namespace Hi.Webapi.Hubs Classes RenderingHub SignalR Hub 用於處理渲染畫布的實時通信" + }, + "api/Hi.Webapi.Services.RenderingService.html": { + "href": "api/Hi.Webapi.Services.RenderingService.html", + "title": "Class RenderingService | HiAPI-C# 2025", + "summary": "Class RenderingService Namespace Hi.Webapi.Services Assembly Hi.Webapi.dll 管理 DispEngine 實例和渲染操作的服務 public class RenderingService : IDisposable Inheritance object RenderingService Implements 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) Constructors RenderingService(ILogger) public RenderingService(ILogger logger) Parameters logger ILogger Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() GetActiveEngineCount() 獲取當前活動的引擎數量 public int GetActiveEngineCount() Returns int GetOrCreateEngine(string) 創建或獲取一個 DispEngine 實例 public DispEngine GetOrCreateEngine(string sessionId) Parameters sessionId string Returns DispEngine RemoveEngine(string) 移除指定的 DispEngine public bool RemoveEngine(string sessionId) Parameters sessionId string Returns bool" + }, + "api/Hi.Webapi.Services.html": { + "href": "api/Hi.Webapi.Services.html", + "title": "Namespace Hi.Webapi.Services | HiAPI-C# 2025", + "summary": "Namespace Hi.Webapi.Services Classes RenderingService 管理 DispEngine 實例和渲染操作的服務" + }, "api/Hi.WinForm.Disp.RenderingCanvas.html": { "href": "api/Hi.WinForm.Disp.RenderingCanvas.html", "title": "Class RenderingCanvas | HiAPI-C# 2025", @@ -4369,10 +4544,20 @@ "title": "Namespace Hi.Wpf.Disp | HiAPI-C# 2025", "summary": "Namespace Hi.Wpf.Disp Classes RenderingCanvas Provides a WPF rendering canvas for 3D visualization of HiAPI components. Handles user interactions, rendering, and integration with the DispEngine system. RenderingWindow Window for 3D rendering." }, + "api/HiMachining.Milling.ClMillingDevice.html": { + "href": "api/HiMachining.Milling.ClMillingDevice.html", + "title": "Class ClMillingDevice | HiAPI-C# 2025", + "summary": "Class ClMillingDevice Namespace HiMachining.Milling Assembly HiMech.dll A milling device driven by CL(Cutter Location). public class ClMillingDevice : IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary Inheritance object ClMillingDevice Implements IMachiningChain IGetAsmb IGetAnchor IGetTopoIndex IMakeXmlSource IGetAnchorToSolidDictionary Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Extension Methods MachiningChainUtil.GetMcCodeTransformerDictionary(IMachiningChain) TopoUtil.Display(IGetAnchor, Bind, Dictionary) TopoUtil.ExpandToBox3d(IGetAnchor, Box3d, Dictionary) 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) Constructors ClMillingDevice() Ctor. public ClMillingDevice() ClMillingDevice(XElement, string) Initializes a new instance from XML. public ClMillingDevice(XElement src, string baseDirectory) Parameters src XElement The XML source element. baseDirectory string The base directory for resolving relative paths. Properties Cl public DVec3d Cl { get; set; } Property Value DVec3d KeyBranch public Branch KeyBranch { get; } Property Value Branch KeyTransformer An ITransformer driven by Cl. public DynamicFreeform KeyTransformer { get; set; } Property Value DynamicFreeform MachiningEquipmentGetter Runtime property. For managing CL. public Func MachiningEquipmentGetter { get; set; } Property Value Func MainAsmb Main MainAsmb of this device. public Asmb MainAsmb { get; } Property Value Asmb McCodes Gets the machine coordinate code sequence for decoding the MC array. public string[] McCodes { get; } Property Value string[] McTransformers Gets the machine coordinate transformers. public IDynamicRegular[] McTransformers { get; } Property Value IDynamicRegular[] TableBuckle Table buckle. public Anchor TableBuckle { get; } Property Value Anchor ToolBuckle Tool buckle. public Anchor ToolBuckle { get; } Property Value Anchor XName Name of XML element. public static string XName { get; } Property Value string Methods GetAnchor() Get key anchor. (i.e. root anchor) public Anchor GetAnchor() Returns Anchor key anchor GetAnchorToSolidDictionary() Gets a dictionary that maps Anchor objects to their corresponding Solid objects. public Dictionary GetAnchorToSolidDictionary() Returns Dictionary A dictionary where keys are anchors and values are their associated solids. GetAsmb() Gets the key asmb. public Asmb GetAsmb() Returns Asmb The key asmb. GetTableBuckle() Gets the table buckle anchor point. public IGetAnchor GetTableBuckle() Returns IGetAnchor The table buckle anchor point. GetToolBuckle() Gets the tool buckle anchor point. public IGetAnchor GetToolBuckle() Returns IGetAnchor The tool buckle anchor point. 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." + }, + "api/HiMachining.Milling.html": { + "href": "api/HiMachining.Milling.html", + "title": "Namespace HiMachining.Milling | HiAPI-C# 2025", + "summary": "Namespace HiMachining.Milling Classes ClMillingDevice A milling device driven by CL(Cutter Location)." + }, "api/HiNc.Grpcs.MachiningProjectGrpcServer.html": { "href": "api/HiNc.Grpcs.MachiningProjectGrpcServer.html", "title": "Class MachiningProjectGrpcServer | HiAPI-C# 2025", - "summary": "Class MachiningProjectGrpcServer Namespace HiNc.Grpcs Assembly HiNc.dll Server for exposing machining project functionality via gRPC. public class MachiningProjectGrpcServer : IDisposable, IMakeXmlSource Inheritance object MachiningProjectGrpcServer Implements IDisposable IMakeXmlSource 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) Constructors MachiningProjectGrpcServer(MachiningProject) Initializes a new instance of the MachiningProjectGrpcServer class. public MachiningProjectGrpcServer(MachiningProject millingCourse) Parameters millingCourse MachiningProject The machining project to expose via gRPC MachiningProjectGrpcServer(XElement, MachiningProject) Initializes a new instance of the MachiningProjectGrpcServer class from XML. public MachiningProjectGrpcServer(XElement src, MachiningProject millingCourse) Parameters src XElement XML source element millingCourse MachiningProject The machining project to expose via gRPC Properties IsServiceRunning Gets whether the service is currently running. public bool IsServiceRunning { get; } Property Value bool ServicePort Gets or sets the port used by the gRPC service. public int ServicePort { get; set; } Property Value int WebApplication Gets the web application instance for the gRPC server. public WebApplication WebApplication { get; } Property Value WebApplication XName Name for XML IO. public static string XName { get; } Property Value string Methods 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 MakeXmlSource(string, string) 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) Parameters baseDirectory string The base directory for resolving relative paths relFile string The relative file path for the XML source Returns XElement An XML element representing the object's state StartAsync() Starts the gRPC server asynchronously. public Task StartAsync() Returns Task A task representing the asynchronous operation StopAsync() Stops the gRPC server asynchronously. public Task StopAsync() Returns Task A task representing the asynchronous operation" + "summary": "Class MachiningProjectGrpcServer Namespace HiNc.Grpcs Assembly HiNc.dll Server for exposing machining project functionality via gRPC. public class MachiningProjectGrpcServer : IDisposable, IMakeXmlSource Inheritance object MachiningProjectGrpcServer Implements IDisposable IMakeXmlSource 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) Constructors MachiningProjectGrpcServer(MachiningProject) Initializes a new instance of the MachiningProjectGrpcServer class. public MachiningProjectGrpcServer(MachiningProject millingCourse) Parameters millingCourse MachiningProject The machining project to expose via gRPC MachiningProjectGrpcServer(XElement, MachiningProject) Initializes a new instance of the MachiningProjectGrpcServer class from XML. public MachiningProjectGrpcServer(XElement src, MachiningProject millingCourse) Parameters src XElement XML source element millingCourse MachiningProject The machining project to expose via gRPC Properties IsServiceRunning Gets whether the service is currently running. public bool IsServiceRunning { get; } Property Value bool ServicePort Gets or sets the port used by the gRPC service. public int ServicePort { get; set; } Property Value int WebApplication Gets the web application instance for the gRPC server. public WebApplication WebApplication { get; } Property Value WebApplication XName Name for XML IO. public static string XName { get; } Property Value string Methods 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 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. StartAsync() Starts the gRPC server asynchronously. public Task StartAsync() Returns Task A task representing the asynchronous operation StopAsync() Stops the gRPC server asynchronously. public Task StopAsync() Returns Task A task representing the asynchronous operation" }, "api/HiNc.Grpcs.html": { "href": "api/HiNc.Grpcs.html", @@ -4439,53 +4624,343 @@ "title": "Namespace numerical | HiAPI-C# 2025", "summary": "Namespace numerical Classes Empty GrpcCsvRowDictionary GrpcNcStep NumericalReflection Holder for reflection information generated from UniversalNcs/numerical.proto NumericalService NumericalService.NumericalServiceBase Base class for server-side implementations of NumericalService NumericalService.NumericalServiceClient Client for NumericalService UniversalNcReflection Holder for reflection information generated from UniversalNcs/universal_nc.proto UniversalNcService UniversalNcService.UniversalNcServiceBase Base class for server-side implementations of UniversalNcService UniversalNcService.UniversalNcServiceClient Client for UniversalNcService" }, - "brief/developer-doc/basic/mechanism/Topo/index.html": { - "href": "brief/developer-doc/basic/mechanism/Topo/index.html", + "brief/dev-doc/basic/common/xml-io.html": { + "href": "brief/dev-doc/basic/common/xml-io.html", + "title": "About XML IO | HiAPI-C# 2025", + "summary": "About XML IO The XML IO design pattern in Hi Framework is based on IMakeXmlSource interface and XFactory class. This pattern provides a standardized way to serialize and deserialize objects to and from XML format. Don't serialize the runtime member object like Func or Action 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. Core Components IMakeXmlSource Interface The IMakeXmlSource interface defines the contract for objects that can be serialized to XML format. It contains a single method MakeXmlSource. XFactory Registration Every class implementing IMakeXmlSource must: Define a static XName property matching the class name Register itself in the static constructor using XFactory.Regs.Add Implement XML serialization and deserialization logic For example, see BallApt: static BallApt() { // Register to the . XFactory.Regs.Add(XName, (xml,baseDirectory,relFile, res) => new BallApt(xml)); } Implementation Patterns Simple Value Objects See BallApt implementation: /// /// Name for XML IO. /// public static string XName => nameof(BallApt); /// /// Ctor. /// /// XML public BallApt(XElement src) { Diameter_mm = double.Parse(src.Element(\"D\").Value); FluteHeight_mm = double.Parse(src.Element(\"FluteH\").Value); } /// public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly) => ToXElement(); /// public XElement ToXElement() { return new XElement(XName, new XElement(\"D\", Diameter_mm), new XElement(\"FluteH\", FluteHeight_mm) ); } Complex Data Structures See SpindleCapability implementation: /// /// Name for XML IO. /// public static string XName => nameof(SpindleCapability); /// /// Initializes a new instance of the class. /// /// The XML element containing spindle data. /// The base directory for resolving relative paths. /// Additional resolution parameters. public SpindleCapability(XElement src, string baseDirectory, params object[] res) { this.SetNameNote(src); if (src.Element(nameof(EnergyEfficiency)) != null) EnergyEfficiency = XmlConvert.ToDouble( src.Element(nameof(EnergyEfficiency)).Value); src.Element(nameof(WorkingTemperatureUpperBoundary_C))?.SelfInvoke( e => WorkingTemperatureUpperBoundary_C = XmlConvert.ToDouble(e.Value)); src.Element(nameof(GearShiftSpindleSpeed_rpm))?.Value?.SelfInvoke( s => GearShiftSpindleSpeed_rpm = string.IsNullOrEmpty(s) ? null : XmlConvert.ToDouble(s)); if (src.Element(nameof(DryRunFrictionPowerCoefficient_mWdrpm)) != null) DryRunFrictionPowerCoefficient_mWdrpm = XmlConvert.ToDouble( src.Element(nameof(DryRunFrictionPowerCoefficient_mWdrpm)).Value); if (src.Element(nameof(DryRunWindagePowerCoefficient_pWdrpm3)) != null) DryRunWindagePowerCoefficient_pWdrpm3 = XmlConvert.ToDouble( src.Element(nameof(DryRunWindagePowerCoefficient_pWdrpm3)).Value); if (src.Element(\"SpindleSpeedToPowerContours\") != null) //for legacy WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW = src.Element(\"SpindleSpeedToPowerContours\").Elements(\"Contour\") .ToDictionary( contourElem => { double r = XmlConvert.ToDouble(contourElem.Attribute(\"InsistentRatio\")?.Value); //600s=10mins return r ==1?double.PositiveInfinity:(r * 600); }, contourElem => contourElem.Elements(\"SpindleSpeedToPower\").Select( elem => new Vec2d( XmlConvert.ToDouble(elem.Element(\"SpindleSpeed-RPM\").Value) / 60, XmlConvert.ToDouble(elem.Element(\"Power-kW\").Value))) .ToList()); src.Element(\"WorkableDurationToSpindleSpeedPowerContoursDictionary\") ?.SelfInvoke(dicElem => { WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW = dicElem.Elements(\"Contour\") .ToDictionary( contourElem => XmlConvert.ToDouble( contourElem.Attribute(\"WorkableDuration-min\")?.Value), contourElem => contourElem.Elements(\"SpindleSpeedToPower\").Select( elem => new Vec2d( XmlConvert.ToDouble(elem.Element(\"SpindleSpeed-RPM\").Value) / 60, XmlConvert.ToDouble(elem.Element(\"Power-kW\").Value))) .ToList()); }); if (src.Element(\"SpindleSpeedToTorqueContours\") != null) //for legacy WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm = src.Element(\"SpindleSpeedToTorqueContours\").Elements(\"Contour\") .ToDictionary( contourElem => { double r = XmlConvert.ToDouble(contourElem.Attribute(\"InsistentRatio\")?.Value); //600s=10mins return r == 1 ? double.PositiveInfinity : (r * 600); }, contourElem => contourElem.Elements(\"SpindleSpeedToTorque\").Select( elem => new Vec2d( XmlConvert.ToDouble(elem.Element(\"SpindleSpeed-RPM\").Value) / 60, XmlConvert.ToDouble(elem.Element(\"Torque-Nm\").Value))) .ToList()); src.Element(\"WorkableDurationToSpindleSpeedTorqueContoursDictionary\") ?.SelfInvoke(dicElem => { //MessageUtil.WriteLine($\"dicElem: {dicElem}\"); WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm = dicElem.Elements(\"Contour\").ToDictionary( contourElem => XmlConvert.ToDouble( contourElem.Attribute(\"WorkableDuration-min\")?.Value), contourElem => contourElem.Elements(\"SpindleSpeedToTorque\").Select( elem => new Vec2d( XmlConvert.ToDouble(elem.Element(\"SpindleSpeed-RPM\").Value) / 60, XmlConvert.ToDouble(elem.Element(\"Torque-Nm\").Value))) .ToList()); //MessageUtil.WriteLine($\"keys: {string.Join(',',WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm.Select(e=>e.Key))}\"); }); //for legacy compatible. if (src.Element(\"SpindleSpeedToPower--RPM-to-kW\") != null) InfInsistentSpindleSpeedToPower_cycleDs_kW = src.Element(\"SpindleSpeedToPower--RPM-to-kW\").Elements() .Select(elem => new Vec2d(XmlConvert.ToDouble(elem.Attribute( \"SpindleSpeed-RPM\").Value) / 60, XmlConvert.ToDouble(elem.Value))).ToList(); //for legacy compatible. if (src.Element(\"SpindleSpeedToTorque--RPM-to-Nm\") != null) InfInsistentSpindleSpeedToTorque_cycleDs_Nm = src.Element(\"SpindleSpeedToTorque--RPM-to-Nm\").Elements() .Select(elem => new Vec2d(XmlConvert.ToDouble(elem.Attribute( \"SpindleSpeed-RPM\").Value) / 60, XmlConvert.ToDouble(elem.Value))).ToList(); } /// public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly) { return new XElement(XName, this.GetNameNoteXElementList(), new XElement(nameof(EnergyEfficiency), EnergyEfficiency), new XElement(nameof(GearShiftSpindleSpeed_rpm), GearShiftSpindleSpeed_rpm), new XElement(nameof(DryRunFrictionPowerCoefficient_mWdrpm), DryRunFrictionPowerCoefficient_mWdrpm), new XElement(nameof(DryRunWindagePowerCoefficient_pWdrpm3), DryRunWindagePowerCoefficient_pWdrpm3), new XElement(\"WorkableDurationToSpindleSpeedPowerContoursDictionary\", WorkableDurationToSpindleSpeedPowerContoursDictionary_min_cycleDs_kW.OrderBy(entry => entry.Key) .Select(entry => new XElement(\"Contour\", new XAttribute(\"WorkableDuration-min\", entry.Key), entry.Value.Select(entry => new XElement(\"SpindleSpeedToPower\", new XElement(\"SpindleSpeed-RPM\", entry.X * 60), new XElement(\"Power-kW\", entry.Y))))) ), new XElement(\"WorkableDurationToSpindleSpeedTorqueContoursDictionary\", WorkableDurationToSpindleSpeedTorqueContoursDictionary_min_cycleDs_Nm.OrderBy(entry => entry.Key) .Select(entry => new XElement(\"Contour\", new XAttribute(\"WorkableDuration-min\", entry.Key), entry.Value.Select(entry => new XElement(\"SpindleSpeedToTorque\", new XElement(\"SpindleSpeed-RPM\", entry.X * 60), new XElement(\"Torque-Nm\", entry.Y))))) ) ); } Best Practices XName: Always define static XName property matching the class name Registration: Register in static constructor using XFactory.Regs.Add Error Handling: Use appropriate GenMode Legacy Support: Maintain backward compatibility when needed Documentation: Include XML comments for properties and methods Generation Modes The GenMode enumeration provides: None Catch Rebase Default Common Usage Patterns Simple Object Generation: var obj = XFactory.Gen(xmlElement, baseDir, null, GenMode.Default); File-Based Generation: var obj = XFactory.GenByFile(baseDir, relativeFile, GenMode.Default); XML Source and File Generation: var xmlSourceAndFile = XFactory.GenXmlSourceAndFile(xmlElement, baseDir, null, GenMode.Default); Hierarchical Object Generation: var childObj = XFactory.GenByChild(parentElement, baseDir, null, GenMode.Default);" + }, + "brief/dev-doc/basic/geom/basic-geometry.html": { + "href": "brief/dev-doc/basic/geom/basic-geometry.html", + "title": "Geometry Objects | HiAPI-C# 2025", + "summary": "Geometry Objects IGetStl is the base interface for all geometry objects in HiAPI, providing unified STL support. Several common geometry types are available: Basic Geometrys Box3d Cylindroid Stl StlFile Management Geometrys TransformationGeom GeomCombination See Transformations for TransformationGeom. GeneralTransform StaticRotation StaticTranslation Note All coordinate values use standard units (millimeters, radians) Example Usage using System; using System.Collections.Generic; using Hi.Geom; using Hi.Mech.Topo; namespace Sample.Geom { /// /// Demonstrates the creation and manipulation of geometric objects in HiAPI. /// Shows how to create and transform various geometry types including boxes, cylindroids, and STL files. /// /// /// ### Source Code /// [!code-csharp[SampleCode](~/../Hi.Sample/Geom/DemoBuildGeom.cs)] /// public static class DemoBuildGeom { /// /// Generates a collection of geometric objects for demonstration purposes. /// Creates various geometry types including boxes, cylindroids, STL files, and transformed geometries. /// /// A list of geometries implementing the IGetStl interface public static List GenGeoms() { Box3d box = new Box3d(0, 0, -50, 70, 50, 0); Cylindroid cylindroid = new Cylindroid([ new PairZr(0,12),new PairZr(20,12), new PairZr(20,16),new PairZr(30,16)]); Stl stl = new Stl(\"geom.stl\"); StlFile stlFile = new StlFile(\"geom.stl\"); TransformationGeom transformationGeom = new TransformationGeom() { Transformer = new GeneralTransform(1, new StaticRotation(new Vec3d(0, 0, 1), MathUtil.ToRad(15), new Vec3d(0, 0, 0)), new StaticTranslation(new Vec3d(0, 0, 0))), Geom = stl }; GeomCombination geomCombination = new GeomCombination(stlFile, transformationGeom); return new List([box, cylindroid, stl, stlFile, transformationGeom]); } } }" + }, + "brief/dev-doc/basic/mechanism/Topo/index.html": { + "href": "brief/dev-doc/basic/mechanism/Topo/index.html", "title": "Kinematic Topology | HiAPI-C# 2025", "summary": "Kinematic Topology The Kinematic Topology is composed of three elemental classes: Anchor, Branch and Asmb. Basic Elements Anchors and Branches Anchor object contains a cartesian coordinate. It can be a mechanical component or a flag. Branch object is a directional link between two Anchor objects. It contains the ITransformer object. The ITransformer object contains a coordinate transformation matrix. As shown in the following sketch: Assembly Management Asmb (Assembly) provides organization and management of Anchors. An Assembly can contain both Anchors and other Assemblies. Key features include: Grouping related Anchors together Managing coordinate transformations Providing display and indexing functions Supporting hierarchical structure Kinematic Chain Example The following figure shows a kinematic chain of a non-orthogonal 5-axis machine tool: Each Anchor represents a component: Axis components: X, Y, Z, B, C Base components: O (base1), O* (base2) Tool components: S (spindle), T (tool body), T* (tool flute) Workpiece: W The relative transform between two Anchors is calculated by multiplying the transform matrices along the Branch. For example, the transform matrix from W to T is: \\[ 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} \\] This matrix can be obtained using GetMat4d(IGetAnchor, IGetAnchor)." }, - "brief/developer-doc/basic/mechanism/index.html": { - "href": "brief/developer-doc/basic/mechanism/index.html", + "brief/dev-doc/basic/mechanism/index.html": { + "href": "brief/dev-doc/basic/mechanism/index.html", "title": "HiAPI Mechanics Overview | HiAPI-C# 2025", - "summary": "Mechanism Topology HiAPI Mechanism Topology provides basic functionality for assembling mechanical structures and simulating their motions. It allows you to build kinematic models of milling machines and similar mechanical structures through a topology-based approach. Core Concepts Kinematic Topology Kinematic Topology is the core concept of this module, which describes the motion relationships between mechanical components. With Kinematic Topology, you can: Define mechanical structures and motion relationships Calculate forward and inverse kinematics Display component positions and orientations Conduct collision detection Main Modules Topology - Kinematic topology structure, including assembly management and chain definition Transformers - Coordinate transformation and motion transformation API References Hi.Mech.Topo - Core topology functionality Asmb - Assembly-related functionality Branch - Chain-related functionality Examples Please refer to the examples in each sub-section to learn how to use these features to build your applications." + "summary": "Mechanism Topology HiAPI Mechanism Topology provides basic functionality for assembling mechanical structures and simulating their motions. It allows you to build kinematic models of milling machines and similar mechanical structures through a topology-based approach. Core Concepts Kinematic Topology Kinematic Topology is the core concept of this module, which describes the motion relationships between mechanical components. With Kinematic Topology, you can: Define mechanical structures and motion relationships Calculate forward and inverse kinematics Display component positions and orientations Conduct collision detection Main Modules Topology - Kinematic topology structure, including assembly management and chain definition Transformers - Coordinate transformation and motion transformation Render Topology - Rendering with topology structure and anchored display API References Hi.Mech.Topo - Core topology functionality Asmb - Assembly-related functionality Branch - Chain-related functionality Examples Please refer to the examples in each sub-section to learn how to use these features to build your applications." }, - "brief/developer-doc/basic/mechanism/transformers/index.html": { - "href": "brief/developer-doc/basic/mechanism/transformers/index.html", + "brief/dev-doc/basic/mechanism/render-topology/index.html": { + "href": "brief/dev-doc/basic/mechanism/render-topology/index.html", + "title": "Render Topology | HiAPI-C# 2025", + "summary": "Render Topology Read Kinematic Topology Rendering for the prerequisite. A Asmb is a group to render its descendent Anchors. Several ways to render with the topology: Render by Anchoring Matrix Map Render by Anchored Displayee Render by Anchoring Matrix Map Render by Anchored Displayee Inherit IAnchoredDisplayee or apply AnchoredDisplayee to Asmb.Display(). Inherit ITopoDisplayee to manage the object with Asmb and plural anchors . The base logic is also by the anchoring matrix. Here is some class and function wrapping the logic. The sample code shows the topology rendering for a MillingTool editing helper: using Hi.Common; using Hi.Common.Messages; using Hi.Disp; using Hi.Disp.Flag; using Hi.Geom; using Hi.Mech.Topo; using Hi.Milling.Cutters; using Hi.NcMech.Holders; using System; using System.Collections.Generic; namespace Hi.Milling.MillingTools { public class MillingToolEditorDisplayee : ITopoDisplayee, IClearCache { public Func MillingToolGetter { get; set; } public MillingTool MillingTool => MillingToolGetter?.Invoke(); public bool ShowCutter { get; set; } = true; public bool ShowHolder { get; set; } = true; public MillingCutterEditorDisplayee MillingCutterEditorDisplayee { get; } = new MillingCutterEditorDisplayee(); public HolderEditorDisplayee HolderEditorDisplayee { get; } = new HolderEditorDisplayee(); /// public List GetAnchoredDisplayeeList() { var dst = new List(); var millingTool = MillingTool; if (millingTool == null) return dst; if (ShowCutter) { var cutter = millingTool.Cutter; if (cutter is MillingCutter millingCutter) { //MessageKit.AddMessage($\"MillingTool.Cutter: {MillingTool?.Cutter?.GetHashCode()}\"); MillingCutterEditorDisplayee.MillingCutterSourceFunc = () => MillingTool?.Cutter as MillingCutter; dst.Add(MillingCutterEditorDisplayee); } else if(cutter!=null) dst.Add(cutter); } if (ShowHolder) { HolderEditorDisplayee.Holder = millingTool.Holder; dst.Add(HolderEditorDisplayee); } return dst; } /// public void Display(Bind bind) { bind.PushCoveringPixelMode(); DimensionBar.Display(bind, \"mm\"); bind.ModelMatStack.Pop(); TopoDisplayeeUtil.Display(this, bind); } /// public void ExpandToBox3d(Box3d dst) { TopoDisplayeeUtil.ExpandToBox3d(this, dst); } /// public Asmb GetAsmb() => MillingTool?.Asmb; /// public Anchor GetAnchor() => MillingTool?.GetAnchor(); /// public void ClearCache() { MillingCutterEditorDisplayee?.ClearCache(); } } }" + }, + "brief/dev-doc/basic/mechanism/transformers/index.html": { + "href": "brief/dev-doc/basic/mechanism/transformers/index.html", "title": "Handle Transform Matrix by ITransformer | HiAPI-C# 2025", - "summary": "Handle Transform Matrix by ITransformer ITransformer 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. Several common used interface and class are implemented from ITransformer. The inheritance is shown: IStaticTransformer NoTransform StaticTranslation StaticRotation StaticFreeform IDynamicTransformer IDynamicRegular DynamicTranslation DynamicRotation DynamicFreeform IStaticTransformer is transformer with constant matrix. NoTransform, StaticTranslation and StaticRotation contains transform matrix of identity, translate and rotate respectively. StaticFreeform contains a arbitrary constant transform matrix. The transform matrix of StaticTranslation is: \\[ M_{StaticTranslate}= \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ Trans.x & Trans.y & Trans.z & 1 \\end{bmatrix} \\] The transform matrix of StaticRotation and DynamicRotation is: \\[ M_{Rotate}= \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ -Pivot.x & -Pivot.y & -Pivot.z & 1 \\end{bmatrix} \\cdot \\\\\\\\ \\begin{bmatrix} Rot_{00}(axis,rad) & Rot_{01}(axis,rad) & Rot_{02}(axis,rad) & 0 \\\\\\\\ Rot_{10}(axis,rad) & Rot_{11}(axis,rad) & Rot_{12}(axis,rad) & 0 \\\\\\\\ Rot_{20}(axis,rad) & Rot_{21}(axis,rad) & Rot_{22}(axis,rad) & 0 \\\\\\\\ 0 & 0 & 0 & 1 \\end{bmatrix} \\cdot \\\\\\\\ \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ Pivot.x & Pivot.y & Pivot.z & 1 \\end{bmatrix} \\] Where Pivot is the position of the rotation axis. Tip 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. IDynamicTransformer is transformer with inconstant transform matrix. IDynamicRegular has a property Step, implied that the transform matrix is one parameter driven. GetSteps(IDynamicRegular[]) and SetSteps(IDynamicRegular[], double[]) provide easy handle of an array of IDynamicRegular objects. The transform matrix of DynamicTranslation is: \\[ M_{DynamicTranslate}= \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ Trans.x \\cdot Step & Trans.y \\cdot Step & Trans.z \\cdot Step & 1 \\end{bmatrix} \\] Note In convention, Trans should be normalized." + "summary": "Handle Transform Matrix by ITransformer ITransformer 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. Several common used interface and class are implemented from ITransformer. The inheritance is shown: IStaticTransformer NoTransform StaticTranslation StaticRotation StaticFreeform GeneralTransform IDynamicTransformer IDynamicRegular DynamicTranslation DynamicRotation DynamicFreeform IStaticTransformer is transformer with constant matrix. NoTransform, StaticTranslation and StaticRotation contains transform matrix of identity, translate and rotate respectively. StaticFreeform contains a arbitrary constant transform matrix. The transform matrix of StaticTranslation is: \\[ M_{StaticTranslate}= \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ Trans.x & Trans.y & Trans.z & 1 \\end{bmatrix} \\] The transform matrix of StaticRotation and DynamicRotation is: \\[ M_{Rotate}= \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ -Pivot.x & -Pivot.y & -Pivot.z & 1 \\end{bmatrix} \\cdot \\\\\\\\ \\begin{bmatrix} Rot_{00}(axis,rad) & Rot_{01}(axis,rad) & Rot_{02}(axis,rad) & 0 \\\\\\\\ Rot_{10}(axis,rad) & Rot_{11}(axis,rad) & Rot_{12}(axis,rad) & 0 \\\\\\\\ Rot_{20}(axis,rad) & Rot_{21}(axis,rad) & Rot_{22}(axis,rad) & 0 \\\\\\\\ 0 & 0 & 0 & 1 \\end{bmatrix} \\cdot \\\\\\\\ \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ Pivot.x & Pivot.y & Pivot.z & 1 \\end{bmatrix} \\] Where Pivot is the position of the rotation axis. Tip 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. IDynamicTransformer is transformer with inconstant transform matrix. IDynamicRegular has a property Step, implied that the transform matrix is one parameter driven. GetSteps(IDynamicRegular[]) and SetSteps(IDynamicRegular[], double[]) provide easy handle of an array of IDynamicRegular objects. The transform matrix of DynamicTranslation is: \\[ M_{DynamicTranslate}= \\begin{bmatrix} 1 & 0 & 0 & 0 \\\\\\\\ 0 & 1 & 0 & 0 \\\\\\\\ 0 & 0 & 1 & 0 \\\\\\\\ Trans.x \\cdot Step & Trans.y \\cdot Step & Trans.z \\cdot Step & 1 \\end{bmatrix} \\] Note In convention, Trans should be normalized." }, - "brief/developer-doc/basic/rendering/drawing/index.html": { - "href": "brief/developer-doc/basic/rendering/drawing/index.html", + "brief/dev-doc/basic/rendering/drawing/index.html": { + "href": "brief/dev-doc/basic/rendering/drawing/index.html", "title": "Using Hi.Disp.Drawing | HiAPI-C# 2025", "summary": "Using Hi.Disp.Drawing The Drawing class is the most fundamental and efficient rendering unit that allows you to draw points, lines, and surfaces within the DispEngine. Understanding Drawing Structure Looking at the constructor Drawing(double[], Stamp, int) helps explain its structure: The double[] array contains batch data for rendering, composed of one or more data groups of consistent length Each data group's length is determined by the Stamp parameter Each data group describes a single vertex Data Components A data group can contain up to four types of information: Information Abbreviation Description Size Vertex V The position of the point (x, y, z) 3 doubles Normal N The normal vector affecting light reflection (Nx, Ny, Nz) 3 doubles Color C RGB color values ranging from 0 to 1 3 doubles Pick ID P A single double value converted from an integer for selection operations 1 double The Stamp enumeration combines these abbreviations to create these possible stamps: {V, NV, CV, CNV, PV, PNV, PCV, PCNV}. Important Notes: The Vertex (V) is mandatory, which is why V appears in every Stamp option Normal vectors (N) are typically used for 3D graphics to create a sense of depth through lighting Color (C) uses three double values (R, G, B) in the range of 0 to 1 Pick ID (P) is used for graphical selection operations Data Structure Example If Stamp is V, each data group consists of 3 double values (x, y, z) If Stamp is PCV, each data group consists of 1(P) + 3(C) + 3(V) = 7 double values Rendering Mode The glmode parameter is an OpenGL constant that specifies the drawing mode. You can search for “OpenGL Primitives” online to see illustrations of these modes. Example Usage // Creating a simple line strip with three vertices double[] vertices = new double[] { 0, 0, 0, // First point at origin 1, 0, 0, // Second point along X-axis 0, 0, 1 // Third point along Z-axis }; // Create drawing object using the vertices var drawing = new Drawing(vertices, Stamp.V, (int)OpenGL.GL_LINE_STRIP); This example creates three vertices with only position information (V), so each vertex has just xyz coordinates. The drawing mode is set to LineStrip. Performance Considerations Note After a Drawing object is created, its source data is stored in GPU memory. Regardless of the amount of data, the CPU processing load when calling Display(Bind) remains consistent. This means displaying 100 points with one Drawing object is approximately 100 times faster than using 100 separate Drawing objects to display 100 individual points. Composing Multiple IDisplayee Objects A common pattern is to combine multiple IDisplayee objects, including Drawing objects: public class MyCompositeDisplayee : IDisplayee { private readonly List _displayees = new List(); public MyCompositeDisplayee() { // Create a grid drawing _displayees.Add(CreateGridDrawing()); // Create an axes drawing _displayees.Add(CreateAxesDrawing()); // Add other custom drawings _displayees.Add(CreateCustomDrawing()); } private Drawing CreateGridDrawing() { // Code to create a grid double[] gridVertices = new double[/* grid data */]; return new Drawing(gridVertices, Stamp.CV, (int)OpenGL.GL_LINES); } private Drawing CreateAxesDrawing() { // Create colored axes double[] axesData = new double[] { // Red X-axis (with color) 1, 0, 0, 0, 0, 0, // Red color, origin 1, 0, 0, 1, 0, 0, // Red color, x-axis end // Green Y-axis (with color) 0, 1, 0, 0, 0, 0, // Green color, origin 0, 1, 0, 0, 1, 0, // Green color, y-axis end // Blue Z-axis (with color) 0, 0, 1, 0, 0, 0, // Blue color, origin 0, 0, 1, 0, 0, 1 // Blue color, z-axis end }; return new Drawing(axesData, Stamp.CV, (int)OpenGL.GL_LINES); } public void Display(Bind bind) { // Render all contained displayees foreach (var displayee in _displayees) { displayee.Display(bind); } } public void ExpandToBox3d(Box3d box) { // Update bounding box based on all displayees foreach (var displayee in _displayees) { displayee.ExpandToBox3d(box); } } } Creating Common Shapes Here are some examples of creating common shapes using the Drawing class: Creating Points // Create an array of points double[] pointData = new double[] { 0, 0, 0, // Point 1 1, 1, 1, // Point 2 2, 0, 0, // Point 3 0, 2, 0 // Point 4 }; // Create a Drawing for points var pointDrawing = new Drawing(pointData, Stamp.V, (int)OpenGL.GL_POINTS); Creating Lines // Create line segments (pairs of vertices) double[] lineData = new double[] { 0, 0, 0, 1, 1, 0, // Line 1: (0,0,0) to (1,1,0) 2, 0, 0, 2, 2, 0 // Line 2: (2,0,0) to (2,2,0) }; // Create a Drawing for lines var lineDrawing = new Drawing(lineData, Stamp.V, (int)OpenGL.GL_LINES); Creating Triangles // Create triangles (triplets of vertices) double[] triangleData = new double[] { // Triangle 1 0, 0, 0, // Vertex 1 1, 0, 0, // Vertex 2 0, 1, 0 // Vertex 3 }; // Create a Drawing for triangles var triangleDrawing = new Drawing(triangleData, Stamp.V, (int)OpenGL.GL_TRIANGLES); See Also DispEngine IDisplayee DispList" }, - "brief/developer-doc/basic/rendering/index.html": { - "href": "brief/developer-doc/basic/rendering/index.html", + "brief/dev-doc/basic/rendering/index.html": { + "href": "brief/dev-doc/basic/rendering/index.html", "title": "Rendering with HiAPI | HiAPI-C# 2025", "summary": "Rendering with HiAPI This section covers the rendering capabilities of HiAPI, focusing on how to create and display visual content in your applications. Overview HiAPI provides a powerful rendering system built around the DispEngine and IDisplayee interface. This system enables you to: Create and render 3D and 2D graphics Implement interactive user interfaces Achieve high-performance rendering across multiple platforms Handle touch, mouse, and keyboard input uniformly Key Components The HiAPI rendering system consists of several key components: DispEngine: The core rendering engine that processes displayees and handles user interaction IDisplayee: The interface for renderable objects Drawing: A fundamental rendering unit for creating basic geometric elements RenderingCanvas: UI controls for different frameworks that host the DispEngine Sections Topic Description Using RenderingCanvas with DispEngine Learn how to use the RenderingCanvas component in your applications Building Your Own Rendering Canvas Understand how to implement custom rendering components Drawing Learn how to use the Drawing class to create basic geometric elements Basic Rendering Workflow The typical workflow for rendering with HiAPI follows these steps: Create Displayees: Implement IDisplayee or use existing implementations like Drawing Configure DispEngine: Create and initialize a DispEngine with your displayees UI Integration: Use RenderingCanvas components to display the rendered content in your UI Handle Input: Process user interactions through the DispEngine's input handling methods This pattern works consistently across all supported UI frameworks, allowing you to develop cross-platform applications with a unified codebase. See Also DispEngine IDisplayee Drawing DispList" }, - "brief/developer-doc/basic/rendering/rendering-canvas/custom-implementation.html": { - "href": "brief/developer-doc/basic/rendering/rendering-canvas/custom-implementation.html", + "brief/dev-doc/basic/rendering/rendering-canvas/custom-implementation.html": { + "href": "brief/dev-doc/basic/rendering/rendering-canvas/custom-implementation.html", "title": "Building Your Own Rendering Canvas | HiAPI-C# 2025", - "summary": "Building Your Own Rendering Canvas This guide provides detailed implementation information for creating your own RenderingCanvas using the DispEngine. By understanding these implementation details, you can customize the rendering component for specific application needs or create implementations for other UI frameworks. Note For Windows Applications: If you are developing for Windows systems, it is recommended to directly use the existing RenderingCanvas implementations in the Hi.WinForm or Hi.Wpf packages, rather than creating your own. These implementations are fully tested, optimized, and maintained. The implementation details provided in this document are primarily for educational purposes or for developers who need to port RenderingCanvas to other platforms/frameworks. Basic DispEngine Usage The DispEngine is designed to display objects that implement the IDisplayee interface. This is the fundamental purpose of DispEngine - to render displayable objects. IDisplayee Implementation To create renderable content, implement the IDisplayee interface: public class MyCustomDisplayee : IDisplayee { public void Display(Bind bind) { // Drawing code using the bind object } public void ExpandToBox3d(Box3d box) { // Update bounding box for view calculations } } Using Displayees with DispEngine There are multiple ways to provide displayees to a DispEngine: // Create DispEngine with a single displayee var engine = new DispEngine(myDisplayee); // Create DispEngine with multiple displayees var engine = new DispEngine(displayee1, displayee2, displayee3); // Change the displayee after creation engine.Displayee = newDisplayee; // Use DispList to group multiple displayees var displayList = new DispList(displayee1, displayee2); engine.Displayee = displayList; Core Implementation Pattern When implementing a custom RenderingCanvas for a UI platform, follow these key steps: Initialize UI Component - Set up the UI control properties and event handling Configure DispEngine - Create and properly initialize the DispEngine instance Set Up Rendering Pipeline - Implement buffer swapping mechanism for visualization Handle User Input - Map platform-specific input events to DispEngine methods Manage Component Lifecycle - Ensure proper resource management and cleanup Let's examine the actual implementations in WinForm and WPF frameworks to understand these patterns in practice. WinForm Implementation Details The WinForm implementation in Hi.WinForm combines Windows Forms controls with the DispEngine rendering system. Core Properties and Fields Here are the essential properties and fields defined in the WinForm implementation: /// /// . /// public DispEngine DispEngine { get; } // Constants and structures for WM_TOUCH private const int WM_TOUCH = 0x0240; private const int TOUCHEVENTF_MOVE = 0x0001; private const int TOUCHEVENTF_DOWN = 0x0002; private const int TOUCHEVENTF_UP = 0x0004; [StructLayout(LayoutKind.Sequential)] private struct TOUCHINPUT { public int x; public int y; public IntPtr hSource; public int dwID; public int dwFlags; public int dwMask; public int dwTime; public IntPtr dwExtraInfo; public int cxContact; public int cyContact; } [DllImport(\"user32.dll\")] private static extern bool RegisterTouchWindow(IntPtr hWnd, uint ulFlags); [DllImport(\"user32.dll\")] private static extern bool GetTouchInputInfo(IntPtr hTouchInput, int cInputs, [In, Out] TOUCHINPUT[] pInputs, int cbSize); [DllImport(\"user32.dll\")] private static extern void CloseTouchInputHandle(IntPtr lParam); Initialization The initialization code sets up event handlers and creates the DispEngine: /// /// Ctor. /// /// displayees public unsafe RenderingCanvas(params IDisplayee[] displayees) { // Configure the control's visual styles SetStyle(ControlStyles.Selectable, true); SetStyle(ControlStyles.OptimizedDoubleBuffer, false); SetStyle(ControlStyles.ContainerControl, false); SetStyle(ControlStyles.ResizeRedraw, false); DoubleBuffered = true; InitializeComponent(); Dock = DockStyle.Fill; // Connect event handlers for user input and window events this.Resize += RenderingCanvas_Resize; this.VisibleChanged += RenderingCanvas_VisibleChanged; this.MouseMove += RenderingCanvas_MouseMove; this.MouseDown += RenderingCanvas_MouseDown; this.MouseUp += RenderingCanvas_MouseUp; this.MouseWheel += RenderingCanvas_MouseWheel; this.KeyDown += RenderingCanvas_KeyDown; this.KeyUp += RenderingCanvas_KeyUp; // Add focus event handler this.GotFocus += RenderingCanvas_GotFocus; this.HandleCreated += OnHandleCreated; // Enable touch input and click events for the control this.SetStyle(ControlStyles.StandardClick, true); this.SetStyle(ControlStyles.StandardDoubleClick, true); this.TabStop = true; // Initialize the DispEngine with provided displayees DispEngine = new DispEngine(displayees); DispEngine.BackgroundColor = new Vec3d(0.1, 0.1, 0.5); DispEngine.BackgroundOpacity = 0.1; DispEngine.SetViewToHomeView(); DispEngine.ImageRequestAfterBufferSwapped += DispEngine_ImageRequestAfterBufferSwapped; // Set initial size and start the rendering engine this.Size = new System.Drawing.Size(500, 300); DispEngine.Start(this.ClientSize.Width, this.ClientSize.Height); } Rendering Pipeline The rendering pipeline processes images from DispEngine and displays them: private unsafe void DispEngine_ImageRequestAfterBufferSwapped(byte* bgra_unsignedbyte_pixels, int w, int h) { // Create a bitmap from the raw pixel data provided by DispEngine Bitmap bitmap; bitmap = new Bitmap(new Bitmap(w, h, w * 4, PixelFormat.Format32bppArgb, new IntPtr(bgra_unsignedbyte_pixels))); // Update the background image and dispose the previous one Image pre = this.BackgroundImage; this.BackgroundImage = bitmap; pre?.Dispose(); } Input Handling Windows Message Handling for Touch WinForm implementation intercepts Windows touch messages and forwards them to DispEngine: protected override void WndProc(ref Message m) { if (m.Msg == WM_TOUCH) { HandleTouchInput(m.WParam, m.LParam); return; } base.WndProc(ref m); } private void OnHandleCreated(object sender, EventArgs e) { // Register window to receive touch messages RegisterTouchWindow(this.Handle, 0); } private void HandleTouchInput(IntPtr wParam, IntPtr lParam) { int inputCount = wParam.ToInt32(); TOUCHINPUT[] inputs = new TOUCHINPUT[inputCount]; if (!GetTouchInputInfo(lParam, inputCount, inputs, Marshal.SizeOf(typeof(TOUCHINPUT)))) return; try { for (int i = 0; i < inputCount; i++) { TOUCHINPUT ti = inputs[i]; int touchId = ti.dwID; // Convert touch coordinates to client coordinates Point touchPoint = PointToClient(new Point(ti.x / 100, ti.y / 100)); if ((ti.dwFlags & TOUCHEVENTF_DOWN) != 0) { // Touch down event DispEngine.TouchDown(touchId, touchPoint.X, touchPoint.Y); this.Focus(); } else if ((ti.dwFlags & TOUCHEVENTF_MOVE) != 0) { // Touch move event DispEngine.TouchMove(touchId, touchPoint.X, touchPoint.Y); } else if ((ti.dwFlags & TOUCHEVENTF_UP) != 0) { // Touch up event DispEngine.TouchUp(touchId); } } } finally { CloseTouchInputHandle(lParam); } } The key aspect is mapping Windows touch events to DispEngine's touch API: // Inside HandleTouchInput method if ((ti.dwFlags & TOUCHEVENTF_DOWN) != 0) { // Touch down event - delegate to DispEngine DispEngine.TouchDown(touchId, touchPoint.X, touchPoint.Y); this.Focus(); } else if ((ti.dwFlags & TOUCHEVENTF_MOVE) != 0) { // Touch move event - delegate to DispEngine DispEngine.TouchMove(touchId, touchPoint.X, touchPoint.Y); } else if ((ti.dwFlags & TOUCHEVENTF_UP) != 0) { // Touch up event - delegate to DispEngine DispEngine.TouchUp(touchId); } Mouse Events private void RenderingCanvas_MouseMove(object sender, MouseEventArgs e) { // Update mouse position and handle drag transforms DispEngine.MouseMove(e.Location.X, e.Location.Y); DispEngine.MouseDragTransform(e.Location.X, e.Location.Y, new mouse_button_table__transform_view_by_mouse_drag_t() { LEFT_BUTTON = (long)MouseButtons.Left, RIGHT_BUTTON = (long)MouseButtons.Right }); } private void RenderingCanvas_MouseDown(object sender, MouseEventArgs e) { // Handle mouse button press DispEngine.MouseButtonDown((long)e.Button); this.Focus(); } private void RenderingCanvas_MouseUp(object sender, MouseEventArgs e) { // Handle mouse button release DispEngine.MouseButtonUp((long)e.Button); } private void RenderingCanvas_MouseWheel(object sender, MouseEventArgs e) { // Handle mouse wheel for zoom operations DispEngine.MouseWheel(0, e.Delta / 120); DispEngine.MouseWheelTransform(0, e.Delta / 120); } Keyboard Events /// protected override bool IsInputKey(Keys keyData) { //since in default, arrow does not trigger key event(keyDown and keyUp). return true; } private void RenderingCanvas_KeyDown(object sender, KeyEventArgs e) { Focus(); DispEngine.KeyDown((long)e.KeyData); // Map specific keys for view transformation long key = (long)e.KeyData; if (key == (long)Keys.LShiftKey || key == (long)Keys.RShiftKey || key == (long)Keys.ShiftKey) key = (long)Keys.Shift; DispEngine.KeyDownTransform(key, new key_table__transform_view_by_key_pressing_t() { HOME = (long)Keys.Home, PAGE_UP = (long)Keys.PageUp, PAGE_DOWN = (long)Keys.PageDown, F1 = (long)Keys.F1, F2 = (long)Keys.F2, F3 = (long)Keys.F3, F4 = (long)Keys.F4, SHIFT = (long)Keys.Shift, ARROW_LEFT = (long)Keys.Left, ARROW_RIGHT = (long)Keys.Right, ARROW_DOWN = (long)Keys.Down, ARROW_UP = (long)Keys.Up }); } private void RenderingCanvas_KeyUp(object sender, KeyEventArgs e) { DispEngine.KeyUp((long)e.KeyData); } Lifecycle Management Window event handling ensures proper state management: private void RenderingCanvas_Resize(object sender, EventArgs e) { // Notify DispEngine of size changes DispEngine.Resize(this.ClientSize.Width, this.ClientSize.Height); } private void RenderingCanvas_VisibleChanged(object sender, EventArgs e) { // Update visibility state in DispEngine DispEngine.IsVisible = this.Visible; } Resource Cleanup /// /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) { if (disposing && (components != null)) { // Dispose the DispEngine to free resources DispEngine.Dispose(); components.Dispose(); } base.Dispose(disposing); } WPF Implementation Details The WPF implementation uses WPF-specific controls and mechanisms but follows the same core pattern. Core Properties /// /// The DispEngine instance that handles rendering and user interactions /// public DispEngine DispEngine { get; } = new DispEngine(); /// /// Internal container for rendering content /// private UserControl DisplayerPane { get; } /// /// Dictionary to store touch point information /// private Dictionary TouchingPointsMap { get; } = new Dictionary(); /// /// Dictionary to store previous positions of touch points /// private Dictionary PreviousTouchingPointsMap { get; } = new Dictionary(); Initialization /// /// Initializes a new instance of the RenderingCanvas /// public RenderingCanvas() { DispEngine.BackgroundColor = new Vec3d(0.1, 0.1, 0.5); DispEngine.BackgroundOpacity = 0.1; // Configure the main control properties HorizontalAlignment = HorizontalAlignment.Stretch; VerticalAlignment = VerticalAlignment.Stretch; Focusable = true; KeyboardNavigation.SetDirectionalNavigation(this, KeyboardNavigationMode.Cycle); DataContextChanged += CanvasDataContextChanged; // Create and configure the display pane DisplayerPane = new UserControl(); DisplayerPane.HorizontalAlignment = HorizontalAlignment.Stretch; DisplayerPane.VerticalAlignment = VerticalAlignment.Stretch; DisplayerPane.Focusable = true; DisplayerPane.IsTabStop = true; // Connect event handlers for user input and window events DisplayerPane.SizeChanged += RenderingCanvas_SizeChanged; DisplayerPane.MouseMove += RenderingCanvas_MouseMove; DisplayerPane.MouseDown += RenderingCanvas_MouseDown; DisplayerPane.MouseUp += RenderingCanvas_MouseUp; DisplayerPane.MouseWheel += RenderingCanvas_MouseWheel; DisplayerPane.KeyDown += RenderingCanvas_KeyDown; DisplayerPane.KeyUp += RenderingCanvas_KeyUp; DisplayerPane.Loaded += RenderingCanvas_Loaded; DisplayerPane.Unloaded += RenderingCanvas_Unloaded; DisplayerPane.IsVisibleChanged += DisplayerPane_IsVisibleChanged; // Add touch event handlers DisplayerPane.TouchDown += RenderingCanvas_TouchDown; DisplayerPane.TouchMove += RenderingCanvas_TouchMove; DisplayerPane.TouchUp += RenderingCanvas_TouchUp; // Enable touch support this.IsManipulationEnabled = true; // Add the display pane to this control's content Content = DisplayerPane; } Rendering Pipeline /// /// Handles the buffer swapped event from DispEngine /// private unsafe void RenderingCanvas_BufferSwapped(byte* data, int w, int h) { if (data == null) return; // Copy pixel data from DispEngine int n = w * h * 4; byte[] arr = new byte[n]; for (int i = 0; i < n; i++) arr[i] = data[i]; // Update UI on the UI thread DisplayerPane.Dispatcher.InvokeAsync(() => { BitmapSource bitmap = BitmapSource.Create(w, h, 1, 1, PixelFormats.Bgra32, null, arr, w * 4); DisplayerPane.Background = new ImageBrush(bitmap); }); } /// /// Handles the size changed event /// private void RenderingCanvas_SizeChanged(object sender, SizeChangedEventArgs e) { // Notify DispEngine of size changes DispEngine.Resize((int)DisplayerPane.RenderSize.Width, (int)DisplayerPane.RenderSize.Height); } /// /// Handles visibility changes /// private unsafe void DisplayerPane_IsVisibleChanged(object sender, DependencyPropertyChangedEventArgs e) { // Update visibility state in DispEngine DispEngine.IsVisible = IsVisible; } Mouse and Keyboard Handling /// /// Helper method to get mouse button mask /// internal static HiMouseButtonMask GetMouseButtonMask(MouseDevice device) { HiMouseButtonMask mouseButtonMask = 0; mouseButtonMask.SetLeftPressed(device.LeftButton == MouseButtonState.Pressed); mouseButtonMask.SetMiddlePressed(device.MiddleButton == MouseButtonState.Pressed); mouseButtonMask.SetRightPressed(device.RightButton == MouseButtonState.Pressed); mouseButtonMask.SetXButton1Pressed(device.XButton1 == MouseButtonState.Pressed); mouseButtonMask.SetXButton2Pressed(device.XButton2 == MouseButtonState.Pressed); return mouseButtonMask; } /// /// Handles the mouse wheel event /// private void RenderingCanvas_MouseWheel(object sender, MouseWheelEventArgs e) { // Handle mouse wheel for zoom operations DispEngine.MouseWheel(0, e.Delta / 120); DispEngine.MouseWheelTransform(0, e.Delta / 120); } /// /// Handles the mouse up event /// private void RenderingCanvas_MouseUp(object sender, MouseButtonEventArgs e) { // Handle mouse button release DispEngine.MouseButtonUp((long)e.ChangedButton); (sender as UIElement)?.ReleaseMouseCapture(); } /// /// Handles the mouse down event /// private void RenderingCanvas_MouseDown(object sender, MouseButtonEventArgs e) { // Handle mouse button press DispEngine.MouseButtonDown((long)e.ChangedButton); DisplayerPane.Focus(); (sender as UIElement)?.CaptureMouse(); } /// /// Handles the mouse move event /// private void RenderingCanvas_MouseMove(object sender, MouseEventArgs e) { // Update mouse position and handle drag transforms Point p = e.GetPosition(DisplayerPane); DispEngine.MouseMove((int)p.X, (int)p.Y); DispEngine.MouseDragTransform((int)p.X, (int)p.Y, new mouse_button_table__transform_view_by_mouse_drag_t() { LEFT_BUTTON = (long)MouseButton.Left, RIGHT_BUTTON = (long)MouseButton.Right }); } /// /// Handles the key up event /// private void RenderingCanvas_KeyUp(object sender, KeyEventArgs e) { DispEngine.KeyUp((long)e.Key); } /// /// Handles the key down event /// private void RenderingCanvas_KeyDown(object sender, KeyEventArgs e) { DispEngine.KeyDown((long)e.Key); // Map specific keys for view transformation long key = (long)e.Key; if (key == (long)Key.RightShift) key = (long)Key.LeftShift; DispEngine.KeyDownTransform(key, new key_table__transform_view_by_key_pressing_t() { HOME = (long)Key.Home, PAGE_UP = (long)Key.PageUp, PAGE_DOWN = (long)Key.PageDown, F1 = (long)Key.F1, F2 = (long)Key.F2, F3 = (long)Key.F3, F4 = (long)Key.F4, SHIFT = (long)Key.LeftShift, ARROW_LEFT = (long)Key.Left, ARROW_RIGHT = (long)Key.Right, ARROW_DOWN = (long)Key.Down, ARROW_UP = (long)Key.Up }); } Lifecycle Management /// /// Handles window state changes (maximize, minimize, etc.) /// private unsafe void RenderingCanvas_StateChanged(object sender, EventArgs e) { switch ((sender as Window).WindowState) { case WindowState.Maximized: DispEngine.IsVisible = true; break; case WindowState.Minimized: DispEngine.IsVisible = false; break; case WindowState.Normal: DispEngine.IsVisible = true; break; } } /// /// Handles data context changes /// private unsafe void CanvasDataContextChanged(object sender, DependencyPropertyChangedEventArgs e) { DispEngine pre = e.OldValue as DispEngine; DispEngine cur = e.NewValue as DispEngine; //child's binding event is triggered after IsVisible event and Load event. if (pre != null) //this section will never occur if the datacontext not set twice. { pre.Terminate(); pre.ImageRequestAfterBufferSwapped -= RenderingCanvas_BufferSwapped; } if (cur != null) { cur.ImageRequestAfterBufferSwapped += RenderingCanvas_BufferSwapped; cur.Start((int)DisplayerPane.RenderSize.Width, (int)DisplayerPane.RenderSize.Height); cur.IsVisible = IsVisible; } } /// /// Reference to the current window containing this control /// private Window currentWindow; /// /// Gets or sets the current window, connecting or disconnecting state change events /// Window CurrentWindow { get => currentWindow; set { if (currentWindow != null) currentWindow.StateChanged -= RenderingCanvas_StateChanged; currentWindow = value; if (currentWindow != null) currentWindow.StateChanged += RenderingCanvas_StateChanged; } } /// /// Handles the loaded event /// private unsafe void RenderingCanvas_Loaded(object sender, RoutedEventArgs e) { // Get the window containing this control CurrentWindow = Window.GetWindow(this); // Set up DispEngine rendering DispEngine.ImageRequestAfterBufferSwapped -= RenderingCanvas_BufferSwapped; DispEngine.ImageRequestAfterBufferSwapped += RenderingCanvas_BufferSwapped; DispEngine.Start((int)DisplayerPane.RenderSize.Width, (int)DisplayerPane.RenderSize.Height); DispEngine.IsVisible = IsVisible; } /// /// Handles the unloaded event /// private unsafe void RenderingCanvas_Unloaded(object sender, RoutedEventArgs e) { DispEngine.IsVisible = IsVisible; DispEngine.ImageRequestAfterBufferSwapped -= RenderingCanvas_BufferSwapped; CurrentWindow = null; } Resource Cleanup /// /// Flag to track disposed state /// private bool disposedValue; /// /// Disposes managed resources /// protected virtual void Dispose(bool disposing) { if (!disposedValue) { if (disposing) { // Dispose the DispEngine to free resources DispEngine.Dispose(); } disposedValue = true; } } /// /// Public dispose method to free resources /// public void Dispose() { // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method Dispose(disposing: true); GC.SuppressFinalize(this); } Core DispEngine Integration Patterns 1. Initialization Sequence // Create DispEngine (optionally with displayees) var engine = new DispEngine(displayees); // Set up image buffer callback engine.ImageRequestAfterBufferSwapped += OnBufferSwapped; // Initialize with canvas size engine.Start(width, height); // Set initial view (optional) engine.SetViewToHomeView(); 2. Render Loop The rendering process follows this pattern: DispEngine processes IDisplayee objects Buffer is swapped and callback is triggered UI framework renders the buffer to screen User input triggers view updates Process repeats 3. Complete User Input Mapping All user interactions must be mapped to DispEngine methods: User Action DispEngine Method Mouse move MouseMove(int, int) Mouse drag MouseDragTransform(int, int, mouse_button_table__transform_view_by_mouse_drag_t) Mouse button MouseButtonDown(long) / MouseButtonUp(long) Mouse wheel MouseWheel(int, int) and MouseWheelTransform(int, int, double) Key press KeyDown(long) / KeyUp(long) and KeyDownTransform(long, key_table__transform_view_by_key_pressing_t) Touch events TouchDown(int, int, int) / TouchMove(int, int, int) / TouchUp(int) 4. Proper Resource Cleanup Resource management is critical for proper operation: // In dispose method DispEngine.ImageRequestAfterBufferSwapped -= OnBufferSwapped; DispEngine.Terminate(); DispEngine.Dispose(); Advanced Implementation Considerations When creating custom implementations, consider these aspects: View Manipulation Use SketchView to directly access or modify the view matrix: // Get current view matrix Mat4d currentView = engine.SketchView; // Apply custom rotation Mat4d rotation = Mat4d.RotateX(Math.PI/4); engine.SketchView = currentView * rotation; See Also DispEngine IDisplayee Vec2d Mat4d" + "summary": "Building Your Own Rendering Canvas This guide provides detailed implementation information for creating your own RenderingCanvas using the DispEngine. By understanding these implementation details, you can customize the rendering component for specific application needs or create implementations for other UI frameworks. Note For Windows Applications: If you are developing for Windows systems, it is recommended to directly use the existing RenderingCanvas implementations in the Hi.WinForm or Hi.Wpf packages, rather than creating your own. These implementations are fully tested, optimized, and maintained. For Webapi Applications: Using Hi.Webapi. The implementation details provided in this document are primarily for educational purposes or for developers who need to port RenderingCanvas to other platforms/frameworks. Basic DispEngine Usage The DispEngine is designed to display objects that implement the IDisplayee interface. This is the fundamental purpose of DispEngine - to render displayable objects. Assign IDisplayee to DispEngine.Displayee. Core Implementation Pattern When implementing a custom RenderingCanvas for a UI platform, follow these key steps: Initialize UI Component - Set up the UI control properties and event handling Configure DispEngine - Create and properly initialize the DispEngine instance Set Up Rendering Pipeline - Implement buffer swapping mechanism for visualization Handle User Input - Map platform-specific input events to DispEngine methods Manage Component Lifecycle - Ensure proper resource management and cleanup Let's examine the actual implementations in WinForm and WPF frameworks to understand these patterns in practice. WinForm Implementation Details The WinForm implementation in Hi.WinForm combines Windows Forms controls with the DispEngine rendering system. Core Properties and Fields Here are the essential properties and fields defined in the WinForm implementation: /// /// . /// public DispEngine DispEngine { get; } // Constants and structures for WM_TOUCH private const int WM_TOUCH = 0x0240; private const int TOUCHEVENTF_MOVE = 0x0001; private const int TOUCHEVENTF_DOWN = 0x0002; private const int TOUCHEVENTF_UP = 0x0004; [StructLayout(LayoutKind.Sequential)] private struct TOUCHINPUT { public int x; public int y; public IntPtr hSource; public int dwID; public int dwFlags; public int dwMask; public int dwTime; public IntPtr dwExtraInfo; public int cxContact; public int cyContact; } [DllImport(\"user32.dll\")] private static extern bool RegisterTouchWindow(IntPtr hWnd, uint ulFlags); [DllImport(\"user32.dll\")] private static extern bool GetTouchInputInfo(IntPtr hTouchInput, int cInputs, [In, Out] TOUCHINPUT[] pInputs, int cbSize); [DllImport(\"user32.dll\")] private static extern void CloseTouchInputHandle(IntPtr lParam); Initialization The initialization code sets up event handlers and creates the DispEngine: /// /// Ctor. /// /// displayees public unsafe RenderingCanvas(params IDisplayee[] displayees) { // Configure the control's visual styles SetStyle(ControlStyles.Selectable, true); SetStyle(ControlStyles.OptimizedDoubleBuffer, false); SetStyle(ControlStyles.ContainerControl, false); SetStyle(ControlStyles.ResizeRedraw, false); DoubleBuffered = true; InitializeComponent(); Dock = DockStyle.Fill; // Connect event handlers for user input and window events this.Resize += RenderingCanvas_Resize; this.VisibleChanged += RenderingCanvas_VisibleChanged; this.MouseMove += RenderingCanvas_MouseMove; this.MouseDown += RenderingCanvas_MouseDown; this.MouseUp += RenderingCanvas_MouseUp; this.MouseWheel += RenderingCanvas_MouseWheel; this.KeyDown += RenderingCanvas_KeyDown; this.KeyUp += RenderingCanvas_KeyUp; // Add focus event handler this.GotFocus += RenderingCanvas_GotFocus; this.HandleCreated += OnHandleCreated; // Enable touch input and click events for the control this.SetStyle(ControlStyles.StandardClick, true); this.SetStyle(ControlStyles.StandardDoubleClick, true); this.TabStop = true; // Initialize the DispEngine with provided displayees DispEngine = new DispEngine(displayees); DispEngine.BackgroundColor = new Vec3d(0.1, 0.1, 0.5); DispEngine.BackgroundOpacity = 0.1; DispEngine.SetViewToHomeView(); DispEngine.ImageRequestAfterBufferSwapped += DispEngine_ImageRequestAfterBufferSwapped; // Set initial size and start the rendering engine this.Size = new System.Drawing.Size(500, 300); DispEngine.Start(this.ClientSize.Width, this.ClientSize.Height); } Rendering Pipeline The rendering pipeline processes images from DispEngine and displays them: private unsafe void DispEngine_ImageRequestAfterBufferSwapped(byte* bgra_unsignedbyte_pixels, int w, int h) { // Create a bitmap from the raw pixel data provided by DispEngine Bitmap bitmap; bitmap = new Bitmap(new Bitmap(w, h, w * 4, PixelFormat.Format32bppArgb, new IntPtr(bgra_unsignedbyte_pixels))); // Update the background image and dispose the previous one Image pre = this.BackgroundImage; this.BackgroundImage = bitmap; pre?.Dispose(); } Input Handling Windows Message Handling for Touch WinForm implementation intercepts Windows touch messages and forwards them to DispEngine: protected override void WndProc(ref Message m) { if (m.Msg == WM_TOUCH) { HandleTouchInput(m.WParam, m.LParam); return; } base.WndProc(ref m); } private void OnHandleCreated(object sender, EventArgs e) { // Register window to receive touch messages RegisterTouchWindow(this.Handle, 0); } private void HandleTouchInput(IntPtr wParam, IntPtr lParam) { int inputCount = wParam.ToInt32(); TOUCHINPUT[] inputs = new TOUCHINPUT[inputCount]; if (!GetTouchInputInfo(lParam, inputCount, inputs, Marshal.SizeOf(typeof(TOUCHINPUT)))) return; try { for (int i = 0; i < inputCount; i++) { TOUCHINPUT ti = inputs[i]; int touchId = ti.dwID; // Convert touch coordinates to client coordinates Point touchPoint = PointToClient(new Point(ti.x / 100, ti.y / 100)); if ((ti.dwFlags & TOUCHEVENTF_DOWN) != 0) { // Touch down event DispEngine.TouchDown(touchId, touchPoint.X, touchPoint.Y); this.Focus(); } else if ((ti.dwFlags & TOUCHEVENTF_MOVE) != 0) { // Touch move event DispEngine.TouchMove(touchId, touchPoint.X, touchPoint.Y); } else if ((ti.dwFlags & TOUCHEVENTF_UP) != 0) { // Touch up event DispEngine.TouchUp(touchId); } } } finally { CloseTouchInputHandle(lParam); } } The key aspect is mapping Windows touch events to DispEngine's touch API: // Inside HandleTouchInput method if ((ti.dwFlags & TOUCHEVENTF_DOWN) != 0) { // Touch down event - delegate to DispEngine DispEngine.TouchDown(touchId, touchPoint.X, touchPoint.Y); this.Focus(); } else if ((ti.dwFlags & TOUCHEVENTF_MOVE) != 0) { // Touch move event - delegate to DispEngine DispEngine.TouchMove(touchId, touchPoint.X, touchPoint.Y); } else if ((ti.dwFlags & TOUCHEVENTF_UP) != 0) { // Touch up event - delegate to DispEngine DispEngine.TouchUp(touchId); } Mouse Events private void RenderingCanvas_MouseMove(object sender, MouseEventArgs e) { // Update mouse position and handle drag transforms DispEngine.MouseMove(e.Location.X, e.Location.Y); DispEngine.MouseDragTransform(e.Location.X, e.Location.Y, new mouse_button_table__transform_view_by_mouse_drag_t() { LEFT_BUTTON = (long)MouseButtons.Left, RIGHT_BUTTON = (long)MouseButtons.Right }); } private void RenderingCanvas_MouseDown(object sender, MouseEventArgs e) { // Handle mouse button press DispEngine.MouseButtonDown((long)e.Button); this.Focus(); } private void RenderingCanvas_MouseUp(object sender, MouseEventArgs e) { // Handle mouse button release DispEngine.MouseButtonUp((long)e.Button); } private void RenderingCanvas_MouseWheel(object sender, MouseEventArgs e) { // Handle mouse wheel for zoom operations DispEngine.MouseWheel(0, e.Delta / 120); DispEngine.MouseWheelTransform(0, e.Delta / 120); } Keyboard Events /// protected override bool IsInputKey(Keys keyData) { //since in default, arrow does not trigger key event(keyDown and keyUp). return true; } private void RenderingCanvas_KeyDown(object sender, KeyEventArgs e) { Focus(); DispEngine.KeyDown((long)e.KeyData); // Map specific keys for view transformation long key = (long)e.KeyData; if (key == (long)Keys.LShiftKey || key == (long)Keys.RShiftKey || key == (long)Keys.ShiftKey) key = (long)Keys.Shift; DispEngine.KeyDownTransform(key, new key_table__transform_view_by_key_pressing_t() { HOME = (long)Keys.Home, PAGE_UP = (long)Keys.PageUp, PAGE_DOWN = (long)Keys.PageDown, F1 = (long)Keys.F1, F2 = (long)Keys.F2, F3 = (long)Keys.F3, F4 = (long)Keys.F4, SHIFT = (long)Keys.Shift, ARROW_LEFT = (long)Keys.Left, ARROW_RIGHT = (long)Keys.Right, ARROW_DOWN = (long)Keys.Down, ARROW_UP = (long)Keys.Up }); } private void RenderingCanvas_KeyUp(object sender, KeyEventArgs e) { DispEngine.KeyUp((long)e.KeyData); } Lifecycle Management Window event handling ensures proper state management: private void RenderingCanvas_Resize(object sender, EventArgs e) { // Notify DispEngine of size changes DispEngine.Resize(this.ClientSize.Width, this.ClientSize.Height); } private void RenderingCanvas_VisibleChanged(object sender, EventArgs e) { // Update visibility state in DispEngine DispEngine.IsVisible = this.Visible; } Resource Cleanup /// /// Clean up any resources being used. /// /// true if managed resources should be disposed; otherwise, false. protected override void Dispose(bool disposing) { if (disposing && (components != null)) { // Dispose the DispEngine to free resources DispEngine.Dispose(); components.Dispose(); } base.Dispose(disposing); } WPF Implementation Details The WPF implementation uses WPF-specific controls and mechanisms but follows the same core pattern. Core Properties /// /// The DispEngine instance that handles rendering and user interactions /// public DispEngine DispEngine { get; } = new DispEngine(); /// /// Internal container for rendering content /// private UserControl DisplayerPane { get; } /// /// Dictionary to store touch point information /// private Dictionary TouchingPointsMap { get; } = new Dictionary(); /// /// Dictionary to store previous positions of touch points /// private Dictionary PreviousTouchingPointsMap { get; } = new Dictionary(); Initialization /// /// Initializes a new instance of the RenderingCanvas /// public RenderingCanvas() { DispEngine.BackgroundColor = new Vec3d(0.1, 0.1, 0.5); DispEngine.BackgroundOpacity = 0.1; // Configure the main control properties HorizontalAlignment = HorizontalAlignment.Stretch; VerticalAlignment = VerticalAlignment.Stretch; Focusable = true; KeyboardNavigation.SetDirectionalNavigation(this, KeyboardNavigationMode.Cycle); DataContextChanged += CanvasDataContextChanged; // Create and configure the display pane DisplayerPane = new UserControl(); DisplayerPane.HorizontalAlignment = HorizontalAlignment.Stretch; DisplayerPane.VerticalAlignment = VerticalAlignment.Stretch; DisplayerPane.Focusable = true; DisplayerPane.IsTabStop = true; // Connect event handlers for user input and window events DisplayerPane.SizeChanged += RenderingCanvas_SizeChanged; DisplayerPane.MouseMove += RenderingCanvas_MouseMove; DisplayerPane.MouseDown += RenderingCanvas_MouseDown; DisplayerPane.MouseUp += RenderingCanvas_MouseUp; DisplayerPane.MouseWheel += RenderingCanvas_MouseWheel; DisplayerPane.KeyDown += RenderingCanvas_KeyDown; DisplayerPane.KeyUp += RenderingCanvas_KeyUp; DisplayerPane.Loaded += RenderingCanvas_Loaded; DisplayerPane.Unloaded += RenderingCanvas_Unloaded; DisplayerPane.IsVisibleChanged += DisplayerPane_IsVisibleChanged; // Add touch event handlers DisplayerPane.TouchDown += RenderingCanvas_TouchDown; DisplayerPane.TouchMove += RenderingCanvas_TouchMove; DisplayerPane.TouchUp += RenderingCanvas_TouchUp; // Enable touch support this.IsManipulationEnabled = true; // Initialize power management InitializePowerManagement(); // Add the display pane to this control's content Content = DisplayerPane; } Rendering Pipeline private byte[] PreImageBgra { get; set; } /// /// Handles the buffer swapped event from DispEngine /// private unsafe void RenderingCanvas_BufferSwapped(byte* data, int w, int h) { if (data == null) return; //since the treatment is different from Razor version, //the image checking mechanism cannot be set in DispEngine. Span bgra = new Span(data, w * h * 4); if (PreImageBgra != null && bgra.SequenceEqual(PreImageBgra)) return; PreImageBgra = bgra.ToArray(); // Copy pixel data from DispEngine int n = w * h * 4; byte[] arr = new byte[n]; for (int i = 0; i < n; i++) arr[i] = data[i]; // Update UI on the UI thread DisplayerPane.Dispatcher.InvokeAsync(() => { BitmapSource bitmap = BitmapSource.Create(w, h, 1, 1, PixelFormats.Bgra32, null, arr, w * 4); DisplayerPane.Background = new ImageBrush(bitmap); }); } /// /// Handles the size changed event /// private void RenderingCanvas_SizeChanged(object sender, SizeChangedEventArgs e) { // Notify DispEngine of size changes DispEngine.Resize((int)DisplayerPane.RenderSize.Width, (int)DisplayerPane.RenderSize.Height); } /// /// Handles visibility changes /// private unsafe void DisplayerPane_IsVisibleChanged(object sender, DependencyPropertyChangedEventArgs e) { // Update visibility state in DispEngine DispEngine.IsVisible = IsVisible; } Mouse and Keyboard Handling /// /// Helper method to get mouse button mask /// internal static HiMouseButtonMask GetMouseButtonMask(MouseDevice device) { HiMouseButtonMask mouseButtonMask = 0; mouseButtonMask.SetLeftPressed(device.LeftButton == MouseButtonState.Pressed); mouseButtonMask.SetMiddlePressed(device.MiddleButton == MouseButtonState.Pressed); mouseButtonMask.SetRightPressed(device.RightButton == MouseButtonState.Pressed); mouseButtonMask.SetXButton1Pressed(device.XButton1 == MouseButtonState.Pressed); mouseButtonMask.SetXButton2Pressed(device.XButton2 == MouseButtonState.Pressed); return mouseButtonMask; } /// /// Handles the mouse wheel event /// private void RenderingCanvas_MouseWheel(object sender, MouseWheelEventArgs e) { // Handle mouse wheel for zoom operations DispEngine.MouseWheel(0, e.Delta / 120); DispEngine.MouseWheelTransform(0, e.Delta / 120); } /// /// Handles the mouse up event /// private void RenderingCanvas_MouseUp(object sender, MouseButtonEventArgs e) { // Handle mouse button release DispEngine.MouseButtonUp((long)e.ChangedButton); (sender as UIElement)?.ReleaseMouseCapture(); } /// /// Handles the mouse down event /// private void RenderingCanvas_MouseDown(object sender, MouseButtonEventArgs e) { // Handle mouse button press DispEngine.MouseButtonDown((long)e.ChangedButton); DisplayerPane.Focus(); (sender as UIElement)?.CaptureMouse(); } /// /// Handles the mouse move event /// private void RenderingCanvas_MouseMove(object sender, MouseEventArgs e) { // Update mouse position and handle drag transforms Point p = e.GetPosition(DisplayerPane); DispEngine.MouseMove((int)p.X, (int)p.Y); DispEngine.MouseDragTransform((int)p.X, (int)p.Y, new mouse_button_table__transform_view_by_mouse_drag_t() { LEFT_BUTTON = (long)MouseButton.Left, RIGHT_BUTTON = (long)MouseButton.Right }); } /// /// Handles the key up event /// private void RenderingCanvas_KeyUp(object sender, KeyEventArgs e) { DispEngine.KeyUp((long)e.Key); } /// /// Handles the key down event /// private void RenderingCanvas_KeyDown(object sender, KeyEventArgs e) { DispEngine.KeyDown((long)e.Key); // Map specific keys for view transformation long key = (long)e.Key; if (key == (long)Key.RightShift) key = (long)Key.LeftShift; DispEngine.KeyDownTransform(key, new key_table__transform_view_by_key_pressing_t() { HOME = (long)Key.Home, PAGE_UP = (long)Key.PageUp, PAGE_DOWN = (long)Key.PageDown, F1 = (long)Key.F1, F2 = (long)Key.F2, F3 = (long)Key.F3, F4 = (long)Key.F4, SHIFT = (long)Key.LeftShift, ARROW_LEFT = (long)Key.Left, ARROW_RIGHT = (long)Key.Right, ARROW_DOWN = (long)Key.Down, ARROW_UP = (long)Key.Up }); } Lifecycle Management /// /// Handles window state changes (maximize, minimize, etc.) /// private unsafe void RenderingCanvas_StateChanged(object sender, EventArgs e) { switch ((sender as Window).WindowState) { case WindowState.Maximized: DispEngine.IsVisible = true; break; case WindowState.Minimized: DispEngine.IsVisible = false; break; case WindowState.Normal: DispEngine.IsVisible = true; break; } } /// /// Handles data context changes /// private unsafe void CanvasDataContextChanged(object sender, DependencyPropertyChangedEventArgs e) { DispEngine pre = e.OldValue as DispEngine; DispEngine cur = e.NewValue as DispEngine; //child's binding event is triggered after IsVisible event and Load event. if (pre != null) //this section will never occur if the datacontext not set twice. { pre.Terminate(); pre.ImageRequestAfterBufferSwapped -= RenderingCanvas_BufferSwapped; } if (cur != null) { cur.ImageRequestAfterBufferSwapped += RenderingCanvas_BufferSwapped; cur.Start((int)DisplayerPane.RenderSize.Width, (int)DisplayerPane.RenderSize.Height); cur.IsVisible = IsVisible; } } /// /// Reference to the current window containing this control /// private Window currentWindow; /// /// Gets or sets the current window, connecting or disconnecting state change events /// Window CurrentWindow { get => currentWindow; set { if (currentWindow != null) currentWindow.StateChanged -= RenderingCanvas_StateChanged; currentWindow = value; if (currentWindow != null) currentWindow.StateChanged += RenderingCanvas_StateChanged; } } /// /// Handles the loaded event /// private unsafe void RenderingCanvas_Loaded(object sender, RoutedEventArgs e) { // Get the window containing this control CurrentWindow = Window.GetWindow(this); // Set up DispEngine rendering DispEngine.ImageRequestAfterBufferSwapped -= RenderingCanvas_BufferSwapped; DispEngine.ImageRequestAfterBufferSwapped += RenderingCanvas_BufferSwapped; DispEngine.Start((int)DisplayerPane.RenderSize.Width, (int)DisplayerPane.RenderSize.Height); DispEngine.IsVisible = IsVisible; } /// /// Handles the unloaded event /// private unsafe void RenderingCanvas_Unloaded(object sender, RoutedEventArgs e) { DispEngine.IsVisible = IsVisible; DispEngine.ImageRequestAfterBufferSwapped -= RenderingCanvas_BufferSwapped; CurrentWindow = null; } Resource Cleanup /// /// Flag to track disposed state /// private bool disposedValue; /// /// Disposes managed resources /// protected virtual void Dispose(bool disposing) { if (!disposedValue) { if (disposing) { // Unsubscribe from power events SystemEvents.PowerModeChanged -= SystemEvents_PowerModeChanged; // Dispose the DispEngine to free resources DispEngine.Dispose(); } disposedValue = true; } } /// /// Public dispose method to free resources /// public void Dispose() { // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method Dispose(disposing: true); GC.SuppressFinalize(this); } Core DispEngine Integration Patterns 1. Initialization Sequence // Create DispEngine (optionally with displayees) var engine = new DispEngine(displayees); // Set up image buffer callback engine.ImageRequestAfterBufferSwapped += OnBufferSwapped; // Initialize with canvas size engine.Start(width, height); // Set initial view (optional) engine.SetViewToHomeView(); 2. Render Loop The rendering process follows this pattern: DispEngine processes IDisplayee objects Buffer is swapped and callback is triggered UI framework renders the buffer to screen User input triggers view updates Process repeats 3. Complete User Input Mapping All user interactions must be mapped to DispEngine methods: User Action DispEngine Method Mouse move MouseMove(int, int) Mouse drag MouseDragTransform(int, int, mouse_button_table__transform_view_by_mouse_drag_t) Mouse button MouseButtonDown(long) / MouseButtonUp(long) Mouse wheel MouseWheel(int, int) and MouseWheelTransform(int, int, double) Key press KeyDown(long) / KeyUp(long) and KeyDownTransform(long, key_table__transform_view_by_key_pressing_t) Touch events TouchDown(int, int, int) / TouchMove(int, int, int) / TouchUp(int) 4. Proper Resource Cleanup Resource management is critical for proper operation: // In dispose method DispEngine.ImageRequestAfterBufferSwapped -= OnBufferSwapped; DispEngine.Terminate(); DispEngine.Dispose(); Advanced Implementation Considerations When creating custom implementations, consider these aspects: View Manipulation Use SketchView to directly access or modify the view matrix: // Get current view matrix Mat4d currentView = engine.SketchView; // Apply custom rotation Mat4d rotation = Mat4d.RotateX(Math.PI/4); engine.SketchView = currentView * rotation; See Also DispEngine IDisplayee Vec2d Mat4d" }, - "brief/developer-doc/basic/rendering/rendering-canvas/index.html": { - "href": "brief/developer-doc/basic/rendering/rendering-canvas/index.html", + "brief/dev-doc/basic/rendering/rendering-canvas/index.html": { + "href": "brief/dev-doc/basic/rendering/rendering-canvas/index.html", "title": "Using RenderingCanvas with DispEngine | HiAPI-C# 2025", - "summary": "Using RenderingCanvas with DispEngine The RenderingCanvas is the primary UI component for displaying and interacting with 3D content across different platforms. This section explains how to use it with the DispEngine to create cross-platform applications. Overview The RenderingCanvas class is available in frameworks: Hi.WinForm for Windows Forms applications Hi.Wpf for WPF applications All implementations share a common architecture centered around the DispEngine class, enabling consistent rendering and interaction across platforms. Core Concept: DispEngine and IDisplayee At the heart of the rendering system is the relationship between DispEngine and IDisplayee: DispEngine: The rendering engine that manages the OpenGL context and handles user interaction IDisplayee: The interface that defines objects that can be rendered by the DispEngine This relationship is fundamental - the primary purpose of DispEngine is to render IDisplayee objects. graph TD A[RenderingCanvas UI Component] --> B[DispEngine] B --> C[Rendering Pipeline] B --> D[Input Handling] B --> E[View Manipulation] F[IDisplayee Objects] -->|Rendered by| B Working with IDisplayee Objects implementing IDisplayee define what gets rendered. Typically, you'll use Drawing objects or compose multiple IDisplayee objects together: // Create a composite displayee public class MyCompositeDisplayee : IDisplayee { private List _displayees = new List(); public MyCompositeDisplayee() { // Add various displayees _displayees.Add(new AxesDisplayee()); _displayees.Add(new ModelDisplayee()); } public void Display(Bind bind) { // Render all contained displayees foreach (var displayee in _displayees) { displayee.Display(bind); } } public void ExpandToBox3d(Box3d box) { // Update bounding box based on all displayees foreach (var displayee in _displayees) { displayee.ExpandToBox3d(box); } } } Multiple displayees can be combined using DispList: // Combine multiple displayees var displayList = new DispList(); displayList.Add(myModel); displayList.Add(myAnnotations); displayList.Add(myCoordinateSystem); // Pass to DispEngine engine.Displayee = displayList; For more detailed information on creating displayees with Drawing, see the Drawing section. Basic Usage WinForm Implementation // Create a new instance with displayee objects using Hi.WinForm.Disp; // Create displayee object var displayee = new MyCompositeDisplayee(); // Initialize canvas with the displayee var canvas = new RenderingCanvas(displayee); // Access the DispEngine for direct manipulation DispEngine engine = canvas.DispEngine; // Add to a form myForm.Controls.Add(canvas); WPF Implementation // Create a new instance using Hi.Wpf.Disp; // Create displayee object var displayee = new MyCompositeDisplayee(); // Initialize the canvas var canvas = new RenderingCanvas(); // Set displayee objects through the DispEngine canvas.DispEngine.Displayee = displayee; // Add to a container myGrid.Children.Add(canvas); Switching Displayees at Runtime You can dynamically change what's being displayed: // Switch to a different displayee renderingCanvas.DispEngine.Displayee = alternativeDisplayee; // Or update a DispList var displayList = new DispList(); if (showModel) displayList.Add(modelDisplayee); if (showGrid) displayList.Add(gridDisplayee); renderingCanvas.DispEngine.Displayee = displayList; Key Features of DispEngine The DispEngine provides cross-platform support for: Rendering Pipeline Management Handles buffer swapping and image generation Manages GPU resources efficiently Input Handling Mouse/pointer events (move, click, drag) Keyboard navigation Touch gestures (pinch, rotate, pan) View Manipulation Camera positioning and orientation Standard views (front, top, isometric, etc.) Zoom, pan, and rotate operations DisplayeeObjects Management Renders IDisplayee implementations Manages visibility and drawing state Touch and Gesture Support The DispEngine centralizes touch handling across all platforms with a unified API that supports: Single-finger pan Two-finger rotate and scale Multi-finger specialized operations The touch API is designed to be simple for UI implementations to use. Platform-specific UI components only need to capture touch events and forward them to the DispEngine. Basic Touch API Example // When a touch point is detected DispEngine.TouchDown(touchId, x, y); // When a touch point moves DispEngine.TouchMove(touchId, x, y); // When a touch point is released DispEngine.TouchUp(touchId); Common Operations // Accessing DispEngine (works on all platforms) var engine = renderingCanvas.DispEngine; // Set to standard views engine.SetViewToHomeView(); engine.SetViewToFrontView(); // Manual camera manipulation engine.Translate(dx, dy); engine.Rotate(deltaX, deltaY); // Resize handling engine.Resize(width, height); Implementation Details For detailed implementation information, including: Full source code examples Implementation details for each platform Advanced touch handling Custom implementation guidance See the Building Your Own RenderingCanvas guide. See Also DispEngine IDisplayee DispList Drawing Building Your Own RenderingCanvas" + "summary": "Using RenderingCanvas with DispEngine The RenderingCanvas is the primary UI component for displaying and interacting with 3D content across different platforms. This section explains how to use it with the DispEngine to create cross-platform applications. Overview The RenderingCanvas class is available in frameworks: Hi.WinForm for Windows Forms applications Hi.Wpf for WPF applications Hi.Webapi for Webapi applications All implementations share a common architecture centered around the DispEngine class, enabling consistent rendering and interaction across platforms. Core Concept: DispEngine and IDisplayee At the heart of the rendering system is the relationship between DispEngine and IDisplayee: DispEngine: The rendering engine that manages the OpenGL context and handles user interaction IDisplayee: The interface that defines objects that can be rendered by the DispEngine This relationship is fundamental - the purpose of DispEngine is to render IDisplayee objects. graph TD A[IDisplayee Objects] -->|Rendered by| B B[DispEngine] <--> C[RenderingCanvas UI Component] Working with IDisplayee Objects implementing IDisplayee define what gets rendered. Typically, you'll use Drawing objects or compose multiple IDisplayee objects together: // Create a composite displayee public class MyCompositeDisplayee : IDisplayee { private List _displayees = new List(); public MyCompositeDisplayee() { // Add various displayees _displayees.Add(new AxesDisplayee()); _displayees.Add(new ModelDisplayee()); } public void Display(Bind bind) { // Render all contained displayees foreach (var displayee in _displayees) { displayee.Display(bind); } } public void ExpandToBox3d(Box3d box) { // Update bounding box based on all displayees foreach (var displayee in _displayees) { displayee.ExpandToBox3d(box); } } } For more detailed information on creating displayees with Drawing, see the Drawing section. Basic Usage Apply Hi.WinForm // Create a new instance with displayee objects using Hi.WinForm.Disp; // Create displayee object var displayee = new MyCompositeDisplayee(); // Initialize canvas with the displayee var canvas = new RenderingCanvas(displayee); // Access the DispEngine for direct manipulation DispEngine engine = canvas.DispEngine; // Add to a form myForm.Controls.Add(canvas); Apply Hi.WPF // Create a new instance using Hi.Wpf.Disp; // Create displayee object var displayee = new MyCompositeDisplayee(); // Initialize the canvas var canvas = new RenderingCanvas(); // Set displayee objects through the DispEngine canvas.DispEngine.Displayee = displayee; // Add to a container myGrid.Children.Add(canvas); Apply Hi.Webapi See Using Rendering Canvas By Hi.Webapi. Switching Displayees at Runtime You can dynamically change what's being displayed: // Switch to a different displayee renderingCanvas.DispEngine.Displayee = alternativeDisplayee; // Or update a DispList var displayList = new DispList(); if (showModel) displayList.Add(modelDisplayee); if (showGrid) displayList.Add(gridDisplayee); renderingCanvas.DispEngine.Displayee = displayList; Key Features of DispEngine The DispEngine provides cross-platform support for: Handles buffer swapping and image generation Mouse/pointer events Keyboard navigation Touch gestures Zoom, pan, and rotate operations Resize and Visibility changed. Camera positioning and orientation Standard views (front, top, isometric, etc.) Renders IDisplayee implementations Touch and Gesture Support The DispEngine centralizes touch handling across all platforms with a unified API that supports: Single-finger pan Two-finger rotate and scale Multi-finger specialized operations The touch API is designed to be simple for UI implementations to use. Platform-specific UI components only need to capture touch events and forward them to the DispEngine. Common Operations // Accessing DispEngine (works on all platforms) var engine = renderingCanvas.DispEngine; // Set to standard views engine.SetViewToHomeView(); engine.SetViewToFrontView(); // Manual camera manipulation engine.Translate(dx, dy); engine.Rotate(deltaX, deltaY); // Resize handling engine.Resize(width, height); Implementation Details For detailed implementation information, including: Full source code examples Implementation details for each platform Advanced touch handling Custom implementation guidance See the Building Your Own RenderingCanvas guide. See Also DispEngine IDisplayee DispList Drawing Building Your Own RenderingCanvas" }, - "brief/developer-doc/getting-started/index.html": { - "href": "brief/developer-doc/getting-started/index.html", + "brief/dev-doc/basic/rendering/rendering-canvas/webapi-rendering-canvas.html": { + "href": "brief/dev-doc/basic/rendering/rendering-canvas/webapi-rendering-canvas.html", + "title": "Using Rendering Canvas By Hi.Webapi | HiAPI-C# 2025", + "summary": "Using Rendering Canvas By Hi.Webapi Hi.Webapi git repo: The Rendering Canvas implementation is located on the Hi.Webapi project (SeeHiAPI Overview to get git repository): wwwroot/disp/rendering-canvas.js Pure js implementation. wwwroot/disp/rendering-canvas-vue.js vue implementation. wwwroot/disp/rendering-canvas.css Usage Demonstration by Hi.Sample.Webapi Project The usage is illustrated by the sample code in Hi.Sample.Webapi project (SeeHiAPI Overview to get git repository). The project applies Hi.Webapi nuget package (SeeHiAPI Overview to get git repository). Following pathes are based on the Hi.Sample.Webapi project. A sample GUI to controll the rendering view wwwroot/disp/rendering-canvas-view-dropdown.js Set Rendering Content (IDisplayee) to the Rendering Canvas Controllers/RenderingController.cs Component Usage wwwroot/demo.html apply rendering-canvas.js from Hi.Webapi package. wwwroot/demo-vue.html apply rendering-canvas-vue.js from Hi.Webapi package. wwwroot/demo-plain-inline.html Hard code implementation without re-using js file." + }, + "brief/dev-doc/build-hinc/controller/index.html": { + "href": "brief/dev-doc/build-hinc/controller/index.html", + "title": "Controller Page | HiAPI-C# 2025", + "summary": "Controller Page The Controller Page is responsible for configuring and managing the CNC controller settings for the machine tool. Key Models The key models used by the Controller Page are: NcEnv MachiningProjectDisplayee The MachiningProjectDisplayee contains IsoCoordinateEntryDisplayee and HeidenhainCoordinateEntryDisplayee. They are used in this GUI. Connection with Main Panel The Controller Page is activated through the Main Panel's Environment menu. It retrieves the MachiningProject from the Main Panel and updates the model. Layout Controller Page Management Panel Head Line Object Management Menu Button file extension is NcEnv The pointed Editor Panel is Management Tabs Panel Title Label Management Tabs Panel Coordinate Table Tab ISO Coordinate Table Panel NcEnv.IsoCoordinateTable Display (Note that The XYZ is not sortable on the table.) Datum Preset Table Tab (Only visible for Heidenhain controllers) HeidenhainDatumPresetTable Panel (Note that The XYZ is not sortable on the table.) Show Datum Preset Toggle Button for HeidenhainCoordinateEntryDisplayee Datum Shift Table Tab (Only visible for Heidenhain controllers) (Note that The XYZ is not sortable on the table.) HeidenhainDatumShiftTable Panel Show Datum Shift Toggle Button for HeidenhainCoordinateEntryDisplayee Offset Table Tab MillingToolOffsetTable Panel Set Ideal Offset Dependent on Tool House Checkbox Machine Tab RapidFeedrate_mmdmin Settings ToolingTime Settings Linear Axis Limits Table StrokeLimitXyz_mm Min and Max for X, Y, Z Rotary Axis Table StrokeLimitAbc_rad Min and Max for A, B, C MaxRotarySpeedABC_radds for A, B, C Brand Tab CncBrand Selection Dropdown Syntec Fanuc Heidenhain Siemens Brand-specific Settings Panel (content varies based on selected brand) Config Tab SetToolHeightCompensationOnFeatureNormal Setting EnableShortestRotary Setting Viewer Panel Viewer Toolbar RenderingCanvas Tool Bar Rendering Items SubMenu See Rendering Items SubMenu from Player extended RenderingCanvas Tool Bar. RenderingCanvas The DispEngine.Displayee is MachiningProjectDisplayee Tip 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. Apply SetViewToIsometricView() on initialization if Viewer Panel has enabled. Tip Add a resizable splitter between the Manage Panel and Viewer Panel to allow users to customize the interface layout according to their needs. Behavior ISO Coordinate Table The ISO coordinate table allows users to edit and manage coordinates for the IsoCoordinateTable. Each entry consists of: An index identifier X, Y, Z coordinate values Action buttons to set the entry to program zero or machine zero Datum Preset and Shift Tables (Heidenhain) These tables are specific to Heidenhain controllers and provide interfaces for: Setting datum preset positions in HeidenhainDatumPresetTable Configuring datum shifts in HeidenhainDatumShiftTable Visualizing selected datum in the 3D viewer with HeidenhainCoordinateEntryDisplayee Offset Table Manages tool offsets with the following capabilities: Display and edit ideal radius and height values in MillingToolOffsetTable Configure radial and axial wear values Option to automatically set ideal offset based on the MachiningToolHouse configuration Add new tool offset entries (when not using tool house dependency) Machine Configuration Controls machine-specific settings: RapidFeedrate_mmdmin (mm/min) ToolingTime (seconds) Stroke limits (minimum and maximum) for linear axes (StrokeLimitXyz_mm) Stroke limits and maximum speeds for rotary axes (StrokeLimitAbc_rad and MaxRotarySpeedABC_radds) Brand Selection Allows switching between different CNC controller brands via CncBrand: Syntec Fanuc Heidenhain Siemens Each brand may have specialized settings that appear when selected. Config Options General configuration options including: SetToolHeightCompensationOnFeatureNormal setting EnableShortestRotary optimization Source Code Path See this page for git repository. WPF Application Source Code Path Numerical/Controller/ControllerWindow Numerical/Controller/IsoCoordinateTablePanel Numerical/Controller/DatumPresetTablePanel Numerical/Controller/DatumShiftTablePanel Numerical/Controller/ControllerExtendedRenderingCanvasToolBar Web Page Application Source Code Path wwwroot/controller/controller-panel.js wwwroot/controller/controller-extended-toolbar.js Controller/Controller/ControllerController.cs" + }, + "brief/dev-doc/build-hinc/general-rules.html": { + "href": "brief/dev-doc/build-hinc/general-rules.html", + "title": "General Rules | HiAPI-C# 2025", + "summary": "General Rules Tip You MUST read the cited hyperlink before you do the job. ASK if you think the hyperlink is not work. Handle Message and Exception If message is well-managed, apply MessageKit to show the message; if the message is Exception, apply ExceptionUtil.ShowException(Exception, object) to show the exception for detail treatment. The messages are shown in Message Section on Main Panel. For examples of message and exception handling patterns: Normal message handling: MessageKit.AddMessage(\"Operation completed successfully.\"); MessageKit.AddWarning(\"Please check your input.\"); Exception handling in synchronous code: try { // Your code here throw new NotImplementedException(\"Demo exception\"); } catch (Exception ex) { ExceptionUtil.ShowException(ex, null); } Exception handling in asynchronous code: await Task.Run(() => { // Your async operation here throw new NotImplementedException(\"Demo async exception\"); }).ShowIfCatched(null); The examples are in project Hi.Sample. See this page for git repository. Loose Manner Run Skippable Rapid Calling Synchronous Action in Loose Manner. 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 LooseRunner and apply LooseRunner.TryRun(Action) to run the action. Dispose the LooseRunner on owner disposing to ensure the tryrun action is well-managed. GUI File Path Assignment See GUI File Path Assignment. Translation Remarks See Translation Remarks." + }, + "brief/dev-doc/build-hinc/geom/box3d-control.html": { + "href": "brief/dev-doc/build-hinc/geom/box3d-control.html", + "title": "Box3dControl | HiAPI-C# 2025", + "summary": "Box3dControl The Box3dControl provides a user interface for editing a 3D box defined by its minimum and maximum coordinates. Features Edit the minimum and maximum coordinates of the box View the calculated dimensions and center of the box Read-Only Mode and Edit Mode There are three sub-edit modes that can be selected in Edit Mode: Min and Max Min and Dimension Center and Dimension UI Layout The Box3dControl includes the following UI elements: Min Vec3dControl Max Vec3dControl Dimension Vec3dControl Center Vec3dControl The sub-edit mode rules the controls to readonly or editable. Since the native of Box3d is that only Min and Max Properties are editable, the other mode requires little additional logic to take effect. Source Code Path See this page for git repository. WPF Application Source Code Path Geom/Box3dControl Web Page Application Source Code Path wwwroot/geom/box3d-control.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/cylindroid-control.html": { + "href": "brief/dev-doc/build-hinc/geom/cylindroid-control.html", + "title": "CylindroidControl | HiAPI-C# 2025", + "summary": "CylindroidControl The CylindroidControl provides a user interface for editing a cylindroid, which is a generalized cylinder defined by a series of radius values along the Z-axis. Features Edit the Z-radius pairs that define the cylindroid's profile Set the longitude number (resolution) for the cylindroid Add and remove Z-radius pairs UI Layout The CylindroidControl includes the following UI elements: Longitude Number - A numeric input for setting the resolution of the cylindroid Z-Radius Pairs - A DataGrid showing the Z-coordinate and radius pairs Add Button - Adds a new Z-radius pair Remove Button - Removes the selected Z-radius pair Source Code Path See this page for git repository. WPF Application Source Code Path Geom/CylindroidControl Web Page Application Source Code Path wwwroot/geom/cylindroid-control.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/extended-cylinder-panel.html": { + "href": "brief/dev-doc/build-hinc/geom/extended-cylinder-panel.html", + "title": "Extended Cylinder Panel | HiAPI-C# 2025", + "summary": "Extended Cylinder Panel The model is ExtendedCylinder. Layout Extended Cylinder Panel FullLength Input Field Source Code Path See this page for git repository. WPF Application Source Code Path Geom/ExtendedCylinderControl Web Page Application Source Code Path wwwroot/geom/extended-cylinder-panel.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/geom-combination-control.html": { + "href": "brief/dev-doc/build-hinc/geom/geom-combination-control.html", + "title": "GeomCombinationControl | HiAPI-C# 2025", + "summary": "GeomCombinationControl The GeomCombinationControl provides a user interface for combining multiple geometric objects into a single composite geometry. This is useful for creating complex shapes from simpler primitives. Features Add multiple geometric objects to the combination Remove selected objects from the combination Edit the properties of each included geometry Support for various geometry types UI Layout The GeomCombinationControl includes the following UI elements: Geometry List - A ListView showing all the geometries in the combination Add Geometry - A section for adding new geometries: Geometry Type - A combo box for selecting the type of geometry to add Add Button - Adds a new geometry of the selected type to the combination Remove Button - Removes the selected geometry from the combination Geometry Properties - A container that shows the appropriate control for editing the selected geometry Supported Geometry Types The control supports adding the following geometry types to the combination: Box3d Cylindroid StlFile TransformationGeom Source Code Path See this page for git repository. WPF Application Source Code Path Geom/GeomCombinationControl Web Page Application Source Code Path wwwroot/geom/geom-combination-control.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/geom-manage-control.html": { + "href": "brief/dev-doc/build-hinc/geom/geom-manage-control.html", + "title": "Geometry Management Panel | HiAPI-C# 2025", + "summary": "Geometry Management Panel Geometry Management Panel get and set a TargetGeometry IStlSource. null is acceptable for TargetGeometry. The TargetGeometry can be convert to TransformationGeom or get out of the TransformationGeom. The conversion button can be hide by the code-behind property. The TargetGeometry can be convert to GeomCombination or get out of the GeomCombination if there is only one geometry in StlSources. The conversion button can be hide by the code-behind property. The geometry type in the Layout Geometry Management Panel Geometry Selection and Conversion Bar Geometry Type Selection Bar TransformationGeom Conversion Button GeomCombination Conversion Button Content Panel (varied by the TargetGeometry) Geometry Type Selection Bar Setting See Geometry Panels for the various geometry type. The geometries are availible by default: Box3d Cylindroid StlFile TransformationGeom GeomCombination The geometries are default hiding but they can be code-behind optionally enabled: CubeTree ExtendedCylinder Source Code Path See this page for git repository. WPF Application Source Code Path Geom/GeometryManagementPanel Web Page Application Source Code Path wwwroot/geom/geom-manage-control.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/index.html": { + "href": "brief/dev-doc/build-hinc/geom/index.html", + "title": "Geometry Panels | HiAPI-C# 2025", + "summary": "Geometry Panels Geometry Panels are GUIs of Geometry Objects. Use Geometry Management Control to get, set and manage the geometry. Basic Geometry Control Box3dControl - A control for editing a 3D box defined by its minimum and maximum coordinates. CylindroidControl - A control for editing a cylindroid defined by a series of radius values along the Z-axis. StlFileControl - A control for loading and manipulating STL files. Management Geometry Control TransformationGeomControl - A control for applying transformations to geometric objects. GeomCombinationControl - A control for combining multiple geometric objects. Special Geometry Control Runtime Geometry Panel The model is not IStlSource. However, It should have the same design pattern with StlFileControl. Extended Cylinder Panel Source Code Path See this page for git repository. WPF Application Source Code Path Geom/ Web Page Application Source Code Path wwwroot/geom/ Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/runtime-geom-panel.html": { + "href": "brief/dev-doc/build-hinc/geom/runtime-geom-panel.html", + "title": "Runtime Geometry Panel | HiAPI-C# 2025", + "summary": "Runtime Geometry Panel Key model is CubeTreeFile. Note The term Runtime Geometry is CubeTree. Layout Runtime Geom Panel File Selector Source Code Path See this page for git repository. WPF Application Source Code Path Geom/RuntimeGeomPanel Web Page Application Source Code Path wwwroot/geom/runtime-geom-panel.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/stlfile-control.html": { + "href": "brief/dev-doc/build-hinc/geom/stlfile-control.html", + "title": "StlFileControl | HiAPI-C# 2025", + "summary": "StlFileControl The StlFileControl provides a user interface for loading and manipulating STL (STereoLithography) files, which are commonly used for representing 3D surface geometry. Features Load STL files from the file system Display the path of the loaded STL file View basic information about the loaded STL (when available) UI Layout The StlFileControl includes the following UI elements: File Path - A text box showing the path of the loaded STL file Browse Button - Opens a file dialog to select an STL file Information Panel - Displays information about the loaded STL file (when available) Source Code Path See this page for git repository. WPF Application Source Code Path Geom/StlFileControl Web Page Application Source Code Path wwwroot/geom/stlfile-control.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/geom/transformation-geom-control.html": { + "href": "brief/dev-doc/build-hinc/geom/transformation-geom-control.html", + "title": "TransformationGeomControl | HiAPI-C# 2025", + "summary": "TransformationGeomControl The TransformationGeomControl provides a user interface for applying transformations to geometric objects. It allows you to wrap any geometry with transformation parameters like scaling, rotation, and translation. Features Select and edit the base geometry object Apply transformations including scaling, rotation, and translation Preview the transformed geometry UI Layout The TransformationGeomControl includes the following UI elements: Base Geometry - A combo box for selecting the type of base geometry Geometry Properties - A container that shows the appropriate control for the selected geometry type Transformation Selection Bar Available options (The dynamic transformer is not avaible): Null Transform Option (Show if originally existed or code-behind optionally assinged) Identity Transform Option (Show if originally existed or code-behind optionally assinged) Static Translate Option General Transform Option Freeform Transform Option See Also Transformers Source Code Path See this page for git repository. WPF Source Code Path Geom/TransformationGeomControl Web Page Application Source Code Path wwwroot/geom/transformation-geom-control.js Controller/Geom/GeomController.cs" + }, + "brief/dev-doc/build-hinc/index.html": { + "href": "brief/dev-doc/build-hinc/index.html", + "title": "Sketch to Build HiNC GUI | HiAPI-C# 2025", + "summary": "Sketch to Build HiNC GUI Apply General Rules to build the HiNC GUI. WPF Application Source Code The source code of HiNC-2025-win-desktop project is at the git repository: https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-win-desktop.git Web Page Application Source Code The source code of HiNC-2025-webapi project is at the git repository: https://superhightech-gitea.webredirect.org/HiNC-Deploy/HiNC-2025-webapi.git Step by Step Program Construction Check List Tip If you are using AI agent to build the application: Ask AI to do only one job at one time to ensure the quality. Create and config a application project. Set the project platform to x64. Create a application project. Add HiNc packages to the project. See Getting Started to config the packages. Note Add Hi.Wpf packages to the project if the building WPF project. Create Main Window, set the layout according to Main Panel Layout. Build Message Section according to Message Section on Main Panel. Initialize HiAPI at application entry point according to Initialize HiAPI. Set behavior of Navigation Menu/Project according to Behavior of Navigation Menu/Project. Create RenderingCanvas Tool Bar for later usage. Create by Player Panel the Player Panel Step by Step Program Construction Check List. Build behavior of Graphic-Cache Dropdown. Build basic GUI widget component: Vec3dControl Build Transformers Build Geometry Panels. Build Fixture Page. Build Workpiece Page. Build Controller Page. Build ToolHouse Page. Add application icon, splash screen and etc.. (The content is consturcting..) Tip Complete the check list step by step. Compile to ensure the code work on each step completed. You MUST read the cited hyperlink before you do the job. ASK if you think the hyperlink is not work." + }, + "brief/dev-doc/build-hinc/initialize-hiapi.html": { + "href": "brief/dev-doc/build-hinc/initialize-hiapi.html", + "title": "Initialize HiAPI at Application Entry Point | HiAPI-C# 2025", + "summary": "Initialize HiAPI at Application Entry Point At the application entry point, you need to initialize HiAPI and set the exiting event. " + }, + "brief/dev-doc/build-hinc/main-panel.html": { + "href": "brief/dev-doc/build-hinc/main-panel.html", + "title": "Main Panel | HiAPI-C# 2025", + "summary": "Main Panel Key Model WPF Single-User Desktop Application: Self-hosted MachiningProject Web Page Application: Singleton Service inherits from IPathedMachiningProjectHost Other Model: UserEnv If the application is single-user application, the model binds to LocalApp.UserEnv. Main Panel Layout Top Navigation Menu Project Menu Dropdown Project Path Text Field New MenuItem Load MenuItem Save MenuItem Save As MenuItem Environment Menu Dropdown Machine Tool MenuItem Open Machine Tool Page Sole window in WPF app. The page manages MachiningEquipment.. Controller MenuItem Open Controller Page Tool House MenuItem Fixture MenuItem Open Fixture Page Workpiece MenuItem Open Workpiece Page Mission MenuItem Open Mission Page Player MenuItem Link to Player Panel (Not exist on WPF app.) Player Belonged Tool Bars. See Player Panel. Shows only if the Main Panel content is Player Panel. Preference Menu Dropdown Central Page Panel Message Section on Main Panel Behavior of Navigation Menu/Project Project Path Text Field Shows the Project Path if the project is assinged. Tip Project Path Text Field should not be button style. It should be a pure text field that can be selected and copied. The Project Menu Managing MachiningProject. To New (create), Save and Save As the MachiningProject, See DemoBuildGeomOnlyMachiningProject for the example. To Load MachiningProject, See DemoUseMachiningProject for the example. Show message for the actions result (successed or has exception) by MessageKit. Tip Recommmand using static function of MessageKit to do the job. Read document of MessageKit to ensure the proper usage. On project loaded (Navigation Menu/Project/Load MenuItem) , set the Player.Panel.RenderingCanvas.DispEngine to SetViewToIsometricView(). Tip Using async to comfort the process WPF Application Specification 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. 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. Web-Page Application Specification Apply Player Panel as the default panel. Application Specification and Source Code Path See this page for git repository. WPF Application Source Code Path MainWindow Web Page Application Source Code Path Controllers/PreferenceController.cs wwwroot/main.js wwwroot/index.html Web Page Application Specification The page and URL are bi-directional." + }, + "brief/dev-doc/build-hinc/mech/cutter/apt-profile-panel.html": { + "href": "brief/dev-doc/build-hinc/mech/cutter/apt-profile-panel.html", + "title": "APT Profile Panel | HiAPI-C# 2025", + "summary": "APT Profile Panel The main model is AptProfile and its property AptProfile.Apt. See APT Cutter Definition. GeneralApt is the generalization of other IAptBased types. Layout APT Profile Panel Diameter Input Field (mm) Round Radius Input Field (mm) Visibly if Apt is IAptRc Round Ring Radius Input Field(mm) Visibly if Apt is IAptRr Round Ring Height Input Field(mm) Visibly if Apt is IAptRz Bottom Cone Angle Input Field (deg) Visibly if Apt is IAptAlpha Top Cone Angle Input Field (deg) Visibly if Apt is IAptBeta Length of Cut Input Field (mm) Tip Keep field format “G4” Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/AptProfilePanel Web Page Application Source Code Path wwwroot/mech/cutter/apt-profile-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/cutter/freeform-remover-panel.html": { + "href": "brief/dev-doc/build-hinc/mech/cutter/freeform-remover-panel.html", + "title": "Freeform Remover Panel | HiAPI-C# 2025", + "summary": "Freeform Remover Panel The key model is FreeformRemover. Layout Freeform Remover Panel Tabs Strut Geometry Tab Geometry Management Panel Manages StrutGeom Shaper Geometry Tab Geometry Management Panel Manages ShaperGeom Anchor Tab Label: Geometry Anchor To Holder Buckle KeepHolderBuckleOnTop Checkbox Transformer Manage Panel Model is GeomToHolderTransformer Enabled if KeepHolderBuckleOnTop is true. Property Tab Is Spinning Cutter Checkbox Controls IsSpinningCutter Info Tab Name TextField (editable) AbstractNote TextField (readonly) Note TextField (editable) Geometry Definitions Strut Geometry - The non-cutting portion (holder/shank) Used for collision detection Shaper Geometry - The cutting portion Defines cutting surfaces Used for material removal simulation Implementation Note Remember to call ClearCache() after geometry changes. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/FreeformRemoverPanel Web Page Application Source Code Path wwwroot/mech/cutter/freeform-remover-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/cutter/index.html": { + "href": "brief/dev-doc/build-hinc/mech/cutter/index.html", + "title": "Cutter Panel | HiAPI-C# 2025", + "summary": "Cutter Panel Overview The key component is ICutter. The Cutter Panel is used to manage cutting tool definitions in HiNC. It supports two main types of cutting tools: MillingCutter and FreeformRemover. Layout Cutter Panel Head Line Object Management Menu Button File extension is .Cutter The pointed Editor Panel is Cutter Management Panel Title Label Cutter Type Selection Dropdown Options: Milling Cutter, Freeform Remover, Unset Cutter Management Panel Varies by the Cutter Type. It can be: Milling Cutter Panel Freeform Remover Panel Features Since ICutter implements IClearCache, remember to call the ClearCache method when the cutter geometry or properties change to ensure proper updates in simulation. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/CutterManagementPanel Web Page Application Source Code Path wwwroot/mech/cutter/cutter-management-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/cutter/milling-cutter-panel.html": { + "href": "brief/dev-doc/build-hinc/mech/cutter/milling-cutter-panel.html", + "title": "Milling Cutter Panel | HiAPI-C# 2025", + "summary": "Milling Cutter Panel The key model is MillingCutter. Layout Milling Cutter Panel Tabs Flute-Profile Tab Upper-Beam Tab Geometry Management Control ExtendedCylinder option is enabled. Property Tab Insert-Cutter Tab Material Tab Flute-Contours Tab Flute-Inner-Beam Tab Optimization Tab Info Tab Name TextField (editable) AbstractNote TextField (readonly) Note TextField (editable) Flute-Profile Tab Profile Type Selection Dropdown APT General (GeneralApt) APT Ball (BallApt) APT Column (ColumnApt) APT Cone (ConeApt) APT Taper (TaperApt) Custom Spinning Profile (CustomSpinningProfile) Profile Configuration Panel Dynamic component based on selected profile type See DemoBuildMachiningProject for creating the apt profile and setting to the cutter. See APT Panel for APT-based Profile Configuration Panel. The APT series option is all wrap by AptProfile but with different property AptProfile.Apt assigned. Custom Spinning Profile Panel Geometry Management Control Property Tab Visible if UserEnv.EnablePhysics is true. Integral Mode Selection Dropdown Solid End Insert End Cutter/Shank Mass Input Field (g) Show the label ‘Cutter Mass’ if the Cutter is Solid End Integral Mode; Show the label ‘Shank Mass’ if the Cutter is Insert End Integral Mode. Value format “G4” Auto Update CheckBox The model is ShankMassAssignmentMode. When enabled: field becomes readonly and shows calculated value. When disabled: field is editable Functionality Note: The value is calculate by the volume and density. The volume is the inner beam volume and the upper beam volume. Hone Radius (μm) Input Field Relief Angle (deg) Input Field Minimum Available Cutting Thickness (μm) Readonly field with format “G4” Shows calculated value from GetMinimumUncutChipThickness_um(ICuttingPara). The argument (cutting parameter) is obtained by the MachiningProject.Workpiece.CuttingPara. Series pass the models by the GUI if needed. Note Label Show Workpiece Cutting Parameter Name. Label Text \"Reference: Workpiece Cutting Parameter - {CuttingPara.Name}\". Since the thickness depdents on the Workpiece Cutting Parameter and hone radius. Insert-Cutter Tab Visible if UserEnv.EnablePhysics is true and Integral Mode is Insert End. Insert Number Input field Insert Mass Input field (g) Format “G4” Insert Thickness Input field (mm) Format “G4” The Insert Thickness is for computing heat transfer. Material Tab Visible if UserEnv.EnablePhysics is true. Shank Material (visible only for Integral Mode is Insert End mode) Material File Selector Apply IStructureMaterial Menu Dropdown Browse Button Browse Resource Button Readonly Name TextBox (Name) ToolTip by Note from the material Flute Material Material File Selector Apply CutterMaterial Menu Dropdown Browse Button Browse Resource Button Readonly Name TextBox (Name) ToolTip by Note from the material Coating Panel Show note that the sequence starts from surface, i.e. from outer to inner. Manages CoatingLayerList Exists sequence management. The first layer has the remark: Air-Exposing Coating. ThermalLayer1D Component Tip Keep the child components to one line. After Coating Material is manual loaded, set the PreferedThickness_um to the Length_um and update the corresponding field. Coating Material Material File Selector Apply CoatingMaterial Menu Dropdown Browse Button Browse Resource Button Readonly Name TextBox (Name) ToolTip by Note from the material Thickness Input Field (um) (editable) Length_um Use format “G4” If the cutter is Solid End, the Shank Material should keep the same with Flute Material. i.e. Set the Shank Material when Flute Material set. Default Resource The default resources of Material exist in Resource folder under application folder (Not project folder). Set the corresponding default folder of the File Selector to the Resource sub folder: “Resource/StructureMaterial” “Resource/CutterMaterial” “Resource/CoatingMaterial” Flute-Contours Tab Visible if UserEnv.EnablePhysics is true. This part manages FluteContourTray. Contour Tray Selection Dropdown Uniform Contour Tray (UniformContourTray) Free Contour Tray (FreeContourTray) Unset Contour Tray Configuration Panel Dynamic component based on selected contour tray type For Uniform Contour Tray: Track Number Input Field Baseline Contour Configuration //building For Free Contour Tray: Individual contour configuration for each flute //building Add/Remove contour controls Flute-Inner-Beam Tab Visible if UserEnv.EnablePhysics is true. This part manages InnerBeamProfile. Profile Type Selection Dropdown Flute Dependent Ratio Profile (FluteDependentRatioProfile) Const Ratio Profile (ConstRatioProfile) Custom Spinning Profile (CustomSpinningProfile) Unset Profile Configuration Panel Dynamic component based on selected profile type For Flute Dependent Ratio Profile: Radius Ratio Number Field (readonly) Label also shows the additional information: ‘Dependent on flute num xxx’, the ‘xxx’ is the flute number that pass by MillingCutter.FluteContourTray. Series pass the model by the GUI if needed. For Const Ratio Profile: Radius Ratio Number Field (editable) For Custom Spinning Profile: Geometry Management Control Optimization Tab Visible if UserEnv.EnablePhysics is true. This part manages MillingCutterOptLimit. Enable Optimization Checkbox Controls whether optimization limits are active When optimization is enabled: Limit by Theoretical Minimum Feed Per Tooth Checkbox Shows calculated minimum uncut chip thickness value. To get the value, MachiningProject.Workpiece.CuttingPara and MillingCutter are required. Series pass the model by the GUI if needed. When checked, enforces minimum feed constraint Min Feed Per Tooth (mm) Number Field Step (If UI supported): 0.01 Max Feed Per Tooth (mm) Number Field Step (If UI supported): 0.01 Safety Factor for Yielding Number Field Step (If UI supported): 0.1 Default value typically around 2.0 Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/MillingCutterPanel Mech/ToolHouse/AptProfilePanel Mech/ToolHouse/MaterialTabPanel Mech/ToolHouse/PropertyTabPanel Web Page Application Source Code Path wwwroot/mech/cutter/milling-cutter-panel.js wwwroot/mech/cutter/apt-profile-panel.js wwwroot/mech/cutter/material-tab-panel.js wwwroot/mech/cutter/property-tab-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/fixture-page.html": { + "href": "brief/dev-doc/build-hinc/mech/fixture-page.html", + "title": "Fixture Page | HiAPI-C# 2025", + "summary": "Fixture Page The page triggers by Main Panel. The key model is Fixture and FixtureEditorDisplayeeConfig. Fixture is assigned from the Main Panel's MachiningProject.MachiningEquipment.Fixture. FixtureEditorDisplayeeConfig is from UserEnv.UserConfig which assigned from the parent component. Layout Fixture Page Management Panel Head Line Object Management Menu Button file extension is Fixture The pointed Editor Panel is Management Tabs Panel Title Label Management Tabs Panel Geometry Tab (Apply Geometry Management Control to set the Fixture.Geom.) Anchor Tab (Apply Transformer Manage Panel to set the following tabs) Geom To Workpiece Tab Geom To Table Tab Viewer Panel Viewer ToolBar RenderingCanvas Tool Bar SetupDisplayee Options ToolBar Options of FixtureEditorDisplayee RenderingCanvas The DispEngine.Displayee is FixtureEditorDisplayee (Apply the model FixtureEditorDisplayeeConfig). Tip Add a resizable splition bar between Manage Panel and Viewer Panel. Behavior Call Fixture.ClearGeomCache() on geometry set or changed. Call RenderCanvas.DispEngine.SetViewToIsometricView() on geometry set. (Since the assumption of the shape set raise larger viewer changed than content changed, only adjust view of the setter event.) Source Code Path See this page for git repository. WPF Application Source Code Path Mech/Fixtures/FixturePage Mech/Fixtures/FixtureWindow Web Page Application Source Code Path wwwroot/mech/fixture-page.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/holder/cylindroid-holder-panel.html": { + "href": "brief/dev-doc/build-hinc/mech/holder/cylindroid-holder-panel.html", + "title": "Cylindroid Holder Panel | HiAPI-C# 2025", + "summary": "Cylindroid Holder Panel The key model is CylindroidHolder. Layout Cylindroid Holder Panel Head Line Title Label Tabs Geometry Tab Cylindroid Panel Resolution Tab Model: PolarResolution2d Polar Resolution 2d Info Tab Name TextField (editable) AbstractNote TextField (readonly) Note TextField (editable) Remember to call UpdateByCylindroid() after geometry reference or content changed. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/CylindroidHolderPanel Web Page Application Source Code Path wwwroot/mech/holder/cylindroid-holder-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/holder/freeform-holder-panel.html": { + "href": "brief/dev-doc/build-hinc/mech/holder/freeform-holder-panel.html", + "title": "Freeform Holder Panel | HiAPI-C# 2025", + "summary": "Freeform Holder Panel The key model is FreeformHolder. Layout Freeform Holder Panel Head Line Title Label Tabs Geometry Tab Geometry Management Panel Anchor Tab (Apply Transformer Manage Panel to set the following tabs) Geom To Spindle Tab Geom To Cutter Tab Resolution Tab Model: PolarResolution2d Polar Resolution 2d Info Tab Name TextField (editable) AbstractNote TextField (readonly) Note TextField (editable) Remember to call UpdateByGeom() after geometry reference or content changed. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/FreeformHolderPanel Web Page Application Source Code Path wwwroot/mech/holder/freeform-holder-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/holder/index.html": { + "href": "brief/dev-doc/build-hinc/mech/holder/index.html", + "title": "Holder Panel | HiAPI-C# 2025", + "summary": "Holder Panel This section describes the user interface and behavior for managing different types of tool holders in the application. Tool holders are crucial components in defining a complete tool assembly. Note 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. The primary models involved are subclasses of IHolder. Two common types are: Cylindroid Holder: Represents holders with a cylindrical geometry. See CylindroidHolder. Freeform Holder: Represents holders with more complex, freeform geometry, often defined by STL files. See FreeformHolder. Each holder type will have its own specific user interface elements for defining its geometry and properties. Layout Holder Panel Head Line Object Management Menu Button file extension is Holder The pointed Editor Panel is Holder Management Panel. Title Label Holder Management Panel Holder Type Selection Bar Holder Sub Management Panel The content varied by the Holder Type. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/HolderPanel Web Page Application Source Code Path wwwroot/mech/holder/holder-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/machining-chain-page.html": { + "href": "brief/dev-doc/build-hinc/mech/machining-chain-page.html", + "title": "Machine Tool Page | HiAPI-C# 2025", + "summary": "Machine Tool Page Key Model: IMachiningChain The model is managed by the getter function and setter function (see Object Management Menu Button for the design pattern). Assistant Model: NcEnv Layout Head Line Object Management Menu Button file extension is mt. The pointed Editor Panel is Management Panel Title Label “Machine Tool” Management Panel If the key model inherits INameNote: Name Setting Line Name Label Name TextField Note Setting Line Note Label Note TextField Source Code Path See this page for git repository. WPF Application Source Code Path Mech/MachiningChains/MachiningChainPage Mech/MachiningChains/MachiningChainWindow Web Page Application Source Code Path wwwroot/mech/machining-chain-page.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/stick-tool-panel/index.html": { + "href": "brief/dev-doc/build-hinc/mech/stick-tool-panel/index.html", + "title": "Stick Tool Panel | HiAPI-C# 2025", + "summary": "Stick Tool Panel The term stick is for not only milling, but other remover like electric discharge machining tool. The key model is MillingTool. Other model: UserEnv. Layout Head Line Object Management Menu Button file extension is MillingTool the pointed Editor Panel is Stick Tool Management Panel Title Label Stick Tool Management Panel Cutter Tab Cutter Panel Holder Tab Holder Panel Clamping Tab Exposed-Cutter-Height TextField Preserved-Distance-Between-Flute-and-Spindle-Nose TextField Intelligent Holder Tab Visible if UserEnv.EnablePhysics is true. Info Tab Abstract Note TextField (readonly) Note TextField (editable) Note The Exposed-Cutter-Height and Preserved-Distance-Between-Flute-and-Spindle-Nose are directly related. Each value changed if each other value is changed. Step by Step Build Guide Build the Stick Tool Panel Layout framework. Since the framework helps to check of the child componenet. Build accessory part of the framework. Object Management Menu Button Info Tab Clamping Tab Build Holder Panel and the related holder type panel. Build Cutter Panel and the related cutter type panel. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/StickToolPanel Web Page Application Source Code Path wwwroot/mech/stick-tool-panel.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/tool-house-page.html": { + "href": "brief/dev-doc/build-hinc/mech/tool-house-page.html", + "title": "Tool House Page | HiAPI-C# 2025", + "summary": "Tool House Page The page triggers by Main Panel. The key model is MachiningToolHouse. The model UserEnv is delivered by the host GUI. Layout Tool House Page Tool List Panel The panel has CRUD (and Duplicate) of the tools. Read and Update the selected tool by the Selected Tool Editor Panel. Head Line Object Management Menu Button file extension is MachiningToolHouse The pointed Editor Panel is Tool List Title Label Batch Action Menu Select All Button De-Select All Button (splition bar) Duplication Button Remove Button Create Tool Button Tool List Selection Checkbox (for batch action) Editable Tool ID TextField Editable Note/Abstract TextField Selected Tool Editor Panel Stick Tool Panel Viewer Panel Viewer ToolBar Title Label RenderingCanvas Tool Bar EditorDisplayee Options ToolBar EditorDisplayee Options Menu Dropdown Head Label: Cutter Show Cutter CheckBox (Options of MillingCutterEditorDisplayee) Shape Mode SubMenu Set ShapeMode to Solid Bounding Shape if UserEnv.EnablePhysics is false on GUI initialization. Solid Bounding Shape Ratio Button Detail Physics Shape Ratio Button Visible if UserEnv.EnablePhysics is true. (spliter) Head Label: Holder Show Holder CheckBox (Options of HolderEditorDisplayee) Show Geometry Anchor CheckBox Show Spindle Buckle CheckBox Show Cutter Buckle CheckBox Rendering Mode SubMenu Solid CheckBox Edge CheckBox Hide CheckBox RenderingCanvas The DispEngine.Displayee is MillingToolEditorDisplayee. Tip 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. Add a resizable splition bar between Tool List Panel, Selected Tool Editor Panel and Viewer Panel. The options of MillingCutterEditorDisplayee and HolderEditorDisplayee is enabled only if the upper level options are enabled, i.e. ShowCutter and ShowHolder. Use less layer of EditorDisplayee Options ToolBar for user convenient. Flatten the options of the children displayee except the ratio button group. The Tool ID can not be repeated. When create new tool, assign a new tool ID (maybe the largest ID plus 1). When a tool is entered, call the renderingCanvas.DispEngine.SetViewToHomeView(). Duplication Button Use Duplicate(params object[]) to duplicate the tool. Note/Abstract TextField The Note/Abstract TextField shows note if note existed and is not empty string; otherwise it shows the AbstractNote. The tooltip is the abstract note. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/ToolHouse/ToolHousePage Mech/ToolHouse/ToolHouseWindow Web Page Application Source Code Path wwwroot/mech/tool-house-page.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/mech/topo/transformers.html": { + "href": "brief/dev-doc/build-hinc/mech/topo/transformers.html", + "title": "Transformers GUI | HiAPI-C# 2025", + "summary": "Transformers GUI Each Transformers has GUI component. Transformer Manage Panel Use Transformer Manage Panel to setup the ITransformer. Layout Transformer Manage Panel Transformer Type Selection Bar Transformer Content Panel (vary by the selected Transformer) Transformer Type Selection Bar Transformer Type Selection Bar get or set ITransformer. The Transformer Type Selection Bar has code-behind option to choose what the transformer options to show. If the original model (i.e. source model) transformer conflicts with the restricted transformers, show the model. Tip Consider one line layout to save the space for the selection bar. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/Topo/TransformerSelectPanel Mech/Topo/StaticTranslationPanel Mech/Topo/StaticFreeformPanel Mech/Topo/DynamicTranslationPanel Mech/Topo/DynamicRotationPanel Mech/Topo/GeneralTransformPanel Mech/Topo/TransformerDemoWindow Web Page Application Source Code Path Mech/Topo/TransformerSelectDiv Mech/Topo/StaticTranslationDiv Mech/Topo/DynamicTranslationDiv Mech/Topo/DynamicRotationDiv Mech/Topo/GeneralTransformDiv" + }, + "brief/dev-doc/build-hinc/mech/workpiece-page.html": { + "href": "brief/dev-doc/build-hinc/mech/workpiece-page.html", + "title": "Workpiece Page | HiAPI-C# 2025", + "summary": "Workpiece Page The page triggers by Main Panel. The key model is Workpiece and WorkpieceEditorDisplayeeConfig. Which is assigned from the Main Panel's MachiningProject.Workpiece. FixtureEditorDisplayeeConfig is from UserEnv.UserConfig which assigned from the parent component. Layout Workpiece Page Management Panel Head Line Object Management Menu Button file extension is Workpiece The pointed Editor Panel is Management Tabs Panel Title Label Management Tabs Panel Raw Shape Tab Raw Geometry Source DropDown (Common Geometry and Runtime Geometry are EXCLUSIVE) Common Geometry Apply Geometry Management Control Runtime Geometry Apply Runtime Geometry Panel Target Shape Tab Geometry Management Control Anchor Tab Geom To Fixture Tab Transformer Manage Panel Geom To Program-Zero Tab Transformer Manage Panel Runtime Tab Initial Resolution Dropdown (powers of 2) 0.0009765625 0.001953125 0.00390625 0.0078125 0.015625 0.03125 0.0625 0.125 0.25 0.5 1 2 4 8 16 Material Tab Visible if UserEnv.EnablePhysics is true. Workpiece Material File Selector Browse Button The initial directory is the project directory. Browse Resource Button The directory is the Default Resource directory. Readonly File Path TextBox Readonly Name TextBox (Name) ToolTip: Note Cutting Parameter File Selector Browse Button The initial directory is the project directory. Browse Resource Button The directory is the Default Resource directory. Readonly File Path TextBox Readonly Name TextBox (Name) ToolTip: Note Viewer Panel Viewer ToolBar RenderingCanvas Tool Bar SetupDisplayee Options ToolBar Options of WorkpieceEditorDisplayee RenderingCanvas The DispEngine.Displayee is WorkpieceEditorDisplayee (Apply the model WorkpieceEditorDisplayeeConfig). Tip Add a resizable splition bar between Manage Panel and Viewer Panel. Default Resource The default resources of Workpiece Material and Cutting Parameter exist in Resource folder under application folder (Not project folder). Set the default folder of the File Selector to the Resource sub folder: “Resource/WorkpieceMaterial” “Resource/CuttingParameter” Behavior Call WorkpieceEditorDisplayee.ClearRawGeomCache() on Raw Shape set or changed. Call WorkpieceEditorDisplayee.ClearIdealGeomCache() on Target Shape set or changed. Call RenderCanvas.DispEngine.SetViewToIsometricView() 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.) Keep Portability of the Material properties. Source Code Path See this page for git repository. WPF Application Source Code Path Mech/Workpieces/WorkpiecePage Mech/Workpieces/WorkpieceWindow Web Page Application Source Code Path wwwroot/mech/workpiece-page.js Controller/Mech/MechController.cs" + }, + "brief/dev-doc/build-hinc/message-section-on-main-panel.html": { + "href": "brief/dev-doc/build-hinc/message-section-on-main-panel.html", + "title": "Message Section on Main Panel | HiAPI-C# 2025", + "summary": "Message Section on Main Panel Initialize MessageKit.Default with Message Section To show and save the message on Brief Message Text Field, add event to Default.OnAdding. The event contains: update the text content of Brief Message Text Field Append the message to log file (create if not existed) $\"logs/log-{DateTime.Now:yyyy-MM-dd}.txt\" Tip Handle the situation that logs over one day. Check if passing argument of OnAdding is Exception. If the it is Exception, update text content by Exception.Message but log to file with the full Exception information. Consider MessageFlag to set the behavior of Message Section. For example, apply alert style if passing argument is exception. The Info (and the other flags that the priority lower than it) should only record in the logs but not shows in the Message Section. WPF Application Layout Message Section Bottom Bar Brief Message Text Field Show Log Button Tip The text field should be selectable to let user easy to copy the message. Web Page Application Layout Message Section Stacking Toast Brief Message Text Field Enable toast Auto-Hide only if the message level is low. Note The convention of web page is not like WPF panel. Use Boostrap or Bootstrap-like toast. They are much appropriate than the fixed bottom bar on WPF. Log Page Layout Head Line Log Label Show Log Button Download Log Button Log TextArea Behavior of Show Log Button Call an editor (or reader, bootstrap modal like poping block) to show the current log. Tip Handle the situation that the current log file does not exist. It may occurs if no message has added." + }, + "brief/dev-doc/build-hinc/mission/ListCommand-panel.html": { + "href": "brief/dev-doc/build-hinc/mission/ListCommand-panel.html", + "title": "List Command Panel | HiAPI-C# 2025", + "summary": "List Command Panel The key model is ListCommand. Assistant Model MachiningProject UserEnv Layout Columns Layout (Two column with one splition bar) Command Entry List Panel Provide entrys for selection The model is CommandEntryList. Head Line Add Command Dropdown Button (Note that Dropdown is not combobox.) Buttons for adding: PreSettingCommand Content Panel: PreSetting Command Panel NcOptOptionCommand Content Panel: NcOptOption Panel NcFileCommand Content Panel: NcFile Command Panel NcCodeCommand ScriptCommand Content Panel: Script Command Panel PostExecutionCommand Content Panel: PostExecution Command Panel Remove Command Button Move Up Command Button Move Down Command Button Command Entrys Selection Panel (Each) Command Entry Box: The boxes are multi-selectable for re-order, remove and etc.. The boxes are draggable for re-order. Enable CheckBox The model is IsEnabled. Tip Show the label text. Title Label Apply if the command is inherited from ITitleCommand; otherwise, show the class name. Tip Apply style changed if the entry is selected. If there is only one PreSettingCommand in the list and at the begining, Keep it at begining when items adding, shows a “pin at begining” label with a pin icon. If there is only one PostExecutionCommand in the list and at the end, Keep it at end when items adding, shows a “pin at end” label a pin icon. Support file drag from the external application (such as file explorer), files drag into the Command Entrys List Panel is equivalent to create NcFileCommands (with the EnablingWrapper) and set the file into the NC File Command. Vertical Splition Bar The bar can be drag to tune the width. Selected Command Content Panel The model is Command. The panel is based on command type Tip The width of the entry block should expand to fulfill the content block. Tip Use Disabled Style for command panels if the Enable checkbox is not checked. Note Each command entry can be individually enabled or disabled without removing it from the list. Features Update the Title Label if the Command is updated by the Command Content Panel. WPF Application Source Code Path Mission/ListCommandPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/mission/NcFileCommand-panel.html": { + "href": "brief/dev-doc/build-hinc/mission/NcFileCommand-panel.html", + "title": "NcFileCommand Panel | HiAPI-C# 2025", + "summary": "NcFileCommand Panel The key model is NcFileCommand. Other Model: string BaseDirectory. Layout NcFileCommand Panel Head Line NC File Setting The model is . NC File Label NC File Text Field About 20 charactor width Load File Browser Button Apply universal file filter for the NC files. Since NC File has too many extensions, such as but not limits to: nc, h, mpf, ptp. Follow the Load Pattern. NC File Editor The editor only available for text file. If the file lines within 20000 line, enable the NC File Editor; Otherwise, just preview the first 20000 line of the file and show the message to the Head Message Place. Auto-Save the file if the content changed. Head Message Place Show the error or exception of the File. NC Code TextArea Tip Fix the height of NC Code TextArea to the panel bottom. Set NC Code TextArea height resizable. WPF Application Source Code Path Mission/NcFileCommandPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/mission/NcOptOption-panel.html": { + "href": "brief/dev-doc/build-hinc/mission/NcOptOption-panel.html", + "title": "NC Optimization Option Panel | HiAPI-C# 2025", + "summary": "NC Optimization Option Panel Key model is NcOptOption. Layout General Optimization Section Enable Optimization CheckBox The model is EnableOpt. Enable Feedrate Optimization CheckBox The model is EnableOptFeedrate. Enable Depth Splitting CheckBox The model is EnableDepthSplition. Enable Interpolation CheckBox The model is EnableInterpolation. Distance Settings Section Extended Pre-Distance Floating Number Field (with Unit) The model is ExtendedPreDistance_mm. Extended Post-Distance Floating Number Field (with Unit) The model is ExtendedPostDistance_mm. Feedrate Limits Section Minimum Feedrate Floating Number Field (with Unit) The model is MinFeedrate_mmdmin. Maximum Feedrate Floating Number Field (with Unit) The model is MaxFeedrate_mmdmin. Rapid Feed Floating Number Field (with Unit) The model is RapidFeed_mmdmin. Motion Dynamics Section Maximum Acceleration Floating Number Field (with Unit) The model is MaxAcceleration_mmds2. Maximum Jerk Floating Number Field (with Unit) The model is MaxJerk_mmds3. Force and Safety Section Preferred Force Floating Number Field (with Unit) The model is PreferedForce_N. Spindle Torque Safety Factor Floating Number Field The model is SpindleTorqueSafetyFactor. Spindle Power Safety Factor Floating Number Field The model is SpindlePowerSafetyFactor. Compensation Section Enable Forward Compensation CheckBox The model is EnableForwardCompensation. Enable Side Compensation CheckBox The model is EnableSideCompensation. Enable Depth Compensation CheckBox The model is EnableDepthCompensation. Tip Use XmlConvert.ToDouble and FromDouble to parse the double value for dealing with the inf value. WPF Application Source Code Path NcOpt/NcOptOptionPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/mission/PostExecutionCommand-panel.html": { + "href": "brief/dev-doc/build-hinc/mission/PostExecutionCommand-panel.html", + "title": "PostExecutionCommand Panel | HiAPI-C# 2025", + "summary": "PostExecutionCommand Panel Key Model PostExecutionCommand Assistant Model MachiningProject UserEnv Layout Output Step Files Section Enable Write Step Files CheckBox The model is . Step File Template Label Step File Template Text Field The model is . Default value: “Output/[NcName].step.csv” Apply one line layout to the label and the text field. Output Shot Files Section Visible if UserEnv.EnablePhysics is true. Enable Write Shot Files CheckBox The model is . Shot File Template Text Field The model is . Default value: Output/[NcName].shot.csv Shot File Time Resolution (ms) Number Field The model is . Default value: 1 Optimization Files Section Visible if UserEnv.EnablePhysics is true. Enable Optimize To Files CheckBox The model is . Optimization File Template Text Field The model is . Default value: “Output/Opt-[NcName]” Geometry Difference Section Enable Geom Diff CheckBox The model is . Geom Diff Detect Radius Number Field (with Unit) One Line layout The model is . Default value: 1 WPF Application Source Code Path Mission/PostExecutionCommandPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/mission/PreSettingCommand-panel.html": { + "href": "brief/dev-doc/build-hinc/mission/PreSettingCommand-panel.html", + "title": "PreSettingCommand Panel | HiAPI-C# 2025", + "summary": "PreSettingCommand Panel Key Model PreSettingCommand Assistant Model MachiningProject UserEnv Layout Machining Resolution Label (with Unit) Machining Resolution ComboBox The model is MachiningResolution_mm. Default value: 0.125 Options (powers of 2) 0.0009765625 0.001953125 0.00390625 0.0078125 0.015625 0.03125 0.0625 0.125 0.25 0.5 1 2 4 8 16 Note The Machining Resolution is initialized from workpiece's InitResolution if available. Machining Motion Resolution Setting The model is MachiningMotionResolution. Motion Resolution Label Type ComboBox (Feed Per Cycle, Feed Per Tooth, Fixed) FixedMachiningMotionResolution Section If MachiningMotionResolution is FixedMachiningMotionResolution, show the panel. Linear Resolution Label (with Unit) Linear Resolution Number Input Field Angle Resolution Label (with Unit) Angle Resolution Number Input Field Detection Settings Setting Enable Collision Detection CheckBox The model is EnableCollisionDetection. Default value: true Enable Pause On Failure CheckBox The model is EnablePauseOnFailure. Default value: false Enable Physics CheckBox The model is EnablePhysics. WPF Application Source Code Path Mission/PreSettingCommandPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/mission/SimpleSessionCommand-panel.html": { + "href": "brief/dev-doc/build-hinc/mission/SimpleSessionCommand-panel.html", + "title": "Classic Session Command Panel | HiAPI-C# 2025", + "summary": "Classic Session Command Panel The key model is SimpleSessionCommand. Layout Head Line Object Management Menu Button file extension is ShellCommand The pointed Editor Panel is Session Management Panel Title Label Session Management Panel NC/Command List Tab Shell Commands ListBox The model is NcCommandList. Support add, remove, reorder commands. The items are multi-selectable. Support file drag from the external application (such as file explorer), files drag into the Shell Commands List is equivalent to create NcFileCommands. Tip don't use file filter to the drag behavior On each Classic NC File Command: Only one line for each entry. Batch Selection CheckBox with ‘Select’ Text Label Classic NC File Command Panel. The horizontal auto scroll bar is required. Output Tab Output Shot Files Tab Enable Write Shot Files CheckBox The model is EnableWriteShotFiles. Shot File Template Text Field The model is ShotFileTemplate. Default value: Output/[NcName].shot.csv Shot File Time Resolution (ms) Number Field The model is ShotFileTimeResolution_ms. Default value: 1 Output Step Files Tab Enable Write Step Files CheckBox The model is EnableWriteStepFiles. Step File Template Label Step File Template Text Field The model is StepFileTemplate. Default value: “Output/[NcName].step.csv” Apply one line layout to the label and the text field. Optimization Files Tab Enable Optimize To Files CheckBox The model is EnableOptimizeToFiles. Optimization File Template Text Field The model is OptimizationFileTemplate. Default value: “Output/Opt-[NcName]” Geometry Difference Tab Enable Geom Diff CheckBox The model is EnableGeomDiff. Geom Diff Detect Radius (mm) Number Field One Line layout The model is GeomDiffDetectRadius_mm. Default value: 1 Tip Use Disabled Style if the section key checkbox is not checked. Tip The file templates support placeholder [NcName] which will be replaced with actual NC program name. WPF Application Source Code Path Mission/SimpleSessionCommandPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/mission/index.html": { + "href": "brief/dev-doc/build-hinc/mission/index.html", + "title": "Mission Page | HiAPI-C# 2025", + "summary": "Mission Page Key model: PlayerCommand. Assistant Model MachiningProject UserEnv Layout Mission Page Head Line Object Management Menu Button file extension is ShellCommand The pointed Editor Panel is Mission Edit Panel Mission Type Selection Section Mission Type Label Mission Type ComboBox Mission Edit Panel Content depends on the Mission Type Selection. Mission Type Selection ComboBox The options: Script Command Panel for ScriptCommand. List Command Panel for ListCommand. Step by Step Building Guide create the Mission Page window and Mission Page panel. build the options panel and set into the Mission Page panel. Build List Command Panel. Build Script Command Panel. WPF Application Source Code Path Mission/MissionWindow Mission/MissionPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/mission/script-command-panel.html": { + "href": "brief/dev-doc/build-hinc/mission/script-command-panel.html", + "title": "Script Command Panel | HiAPI-C# 2025", + "summary": "Script Command Panel The key model is ScriptCommand. Layout Head Line Script Title Label Script Title Text Field C# Rich Text Editor Area The model is ScriptText. WPF Application Source Code Path Mission/ScriptCommandPanel see this page for git repository." + }, + "brief/dev-doc/build-hinc/player/index.html": { + "href": "brief/dev-doc/build-hinc/player/index.html", + "title": "Player Panel | HiAPI-C# 2025", + "summary": "Player Panel The model of the player panel is MachiningProject and UserEnv. Step by Step Program Construction Check List Create the Player Panel Layout and set Player Panel/RenderingCanvas. Set behavior of RenderingCanvas. Create Player Tool Bar. Create layout of Player extended RenderingCanvas Tool Bar. Complete Behavior of Navigation Menu/Player on the Main Panel. Build behavior of Player extended RenderingCanvas Tool Bar Set behavior of Behavior of CL Strip Buttons and Fit View Button. Set behavior of Behavior of Project Rendering Items DropDown. Set notification to Player extended RenderingCanvas Tool Bar if project changed by Main Panel. Set Player Panel as default panel on Page Panel when open the main window. The related toolbar has to be set, too. Build Session Message Panel. Build Step Present Preference Page Build Selected-Step Info Panel Belonged Tool Bars Player Tool Bar RenderingCanvas Tool Bar Player extended RenderingCanvas Tool Bar Layout of Player Panel Central RenderingCanvas vertical splition bar (draggable to resize the width of the two div) Side Panel Upper Selected-Step Info Panel horizontal splition bar (draggable to resize the height of the two panel) Lower Session Message Panel Behavior of Player Panel/RenderingCanvas On initializing, create MachiningProjectDisplayee and set it to RenderingCanvas.DispEngine.Displayee. The MachiningProjectDisplayee constructor argument is from the model MachiningProject from Player Panel. Dispose RenderingCanvas on Player Panel disposing. Source Code Path and Specification See this page for git repository. WPF Application Source Code Path Play/PlayerPanel Webapi Application Source Code Path wwwroot/player/player-panel.js Controller/Player/PlayerController.cs" + }, + "brief/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html": { + "href": "brief/dev-doc/build-hinc/player/player-extended-renderingcanvas-tool-bar.html", + "title": "Player extended RenderingCanvas Tool Bar | HiAPI-C# 2025", + "summary": "Player extended RenderingCanvas Tool Bar The model of the tool bar is DispEngine which is assigned from the RenderingCanvas of Player Panel. The content of DispEngine.Displayee here is MachiningProjectDisplayee. the key content of the MachiningProjectDisplayee is MachiningProject. The sub-model is MachiningProjectDisplayee and MachiningProject. Layout Player extended RenderingCanvas Tool Bar Show CL Strip Button Show CL Strip Dots Button Only editable if the ClStrip in RenderingFlagBitArray is true. Fit View Button Rendering Items SubMenu 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. Create the submenu component class since the other GUI component also use it. See controller page Tip checkboxs in Project Rendering Items SubMenu can be classified by the category of RenderingFlag (see the hyperlink for the categories). Behavior of CL Strip Buttons and Fit View Button Apply RenderingFlagBitArray to set the Project Rendering Items. Tip Extract the MachiningProject From the MachiningProjectDisplayee and use it to set the behaviors. Behavior of Project Rendering Items DropDown See DemoRenderingMachiningProcessAndStripPosSelection for the sample code to complete the behavior of the buttons. Source Code Path See this page for git repository. WPF Application Source Code Path Play/PlayerExtendedRenderingCanvasToolBar Web Page Application Source Code Path wwwroot/player-extended-toolbar.js Controller/Player/PlayerController.cs" + }, + "brief/dev-doc/build-hinc/player/player-tool-bar.html": { + "href": "brief/dev-doc/build-hinc/player/player-tool-bar.html", + "title": "Player Tool Bar | HiAPI-C# 2025", + "summary": "Player Tool Bar Layout Player Tool Bar Status Text Field Start Button Pause Button Run-One-Line Button Run-One-Step Button Stop Button Reset Button Behavior of Player Tool Bar See the example code to: complete the behavior of the buttons and Status Text Field. The rapidly used buttons should has hotkey. At least the following buttons: Run One Line Button Run One Step Button Start/Continue Pause Add and remove the event to the PacePlayer on Player Tool Bar initialization and finalization. The events update the Status Text Field. Alter the background color of the Status Text Field if the status changed. Warning style color Running Secondary style color Paused No Project Success style color Finished Ready The action of Reset Button should be async for user experience. Tip Use icon instead of text to the tool bar button. Run One Line Button and Run One Step Button use the same icon, use the different color to resolve them. Run One Line Button > default color with green seasoned Run One Step Button > default color with blue seasoned The other button use the default color is enough. Source Code Path See this page for git repository. WPF Application Source Code Path Play/PlayerToolBar Web Page Application Source Code Path wwwroot/player/player-tool-bar.js Controller/Player/PlayerController.cs Razor Page Source Code @using Hi.Common.PathUtils; @using Hi.HiNcKits; @using Hi.MachiningProcs @using Hi.MillingProcs; @using Hi.Numerical.FilePlayers; @inject HiNcHost hiNcHost @{ MachiningProject machiningProject = hiNcHost.MachiningProject; bool disabledByMachiningProject = machiningProject == null; }
          @if (machiningProject == null) { } else if (!machiningProject.PacePlayer.IsLocked) { } else { }
          using Hi.Common; using Hi.MachiningProcs; using Hi.Parallels; using Microsoft.AspNetCore.Components; namespace HiNcRcl.Areas.Player { public partial class PlayerButtonGroup : IAsyncDisposable { [Parameter] public string Tid { set; get; } = System.Guid.NewGuid().ToString(); StringLocalizer Loc { get; } = new StringLocalizer(typeof(PlayerDiv)); SemaphoreSlim DisposeSemaphore { get; } = new SemaphoreSlim(1); MachiningProject MachiningProject => hiNcHost.MachiningProject; bool disposedValue = false; /// protected override async Task OnAfterRenderAsync(bool firstRender) { base.OnAfterRender(firstRender); if (firstRender) { using var _ = await DisposeSemaphore.EmbraceAsync(); if (disposedValue) return; var machiningProject = MachiningProject; if (machiningProject != null) { machiningProject.PacePlayer.IsLockedChangedEvent += EnumerablePlayer_IsLockedEventHandler; machiningProject.PacePlayer.IsRunningChangedEvent += EnumerablePlayer_IsLockedEventHandler; machiningProject.PacePlayer.IsFinishedChangedEvent += EnumerablePlayer_IsLockedEventHandler; } } } /// public async ValueTask DisposeAsync() { using var _ = await DisposeSemaphore.EmbraceAsync(); var machiningProject = MachiningProject; if (machiningProject != null) { machiningProject.PacePlayer.IsLockedChangedEvent -= EnumerablePlayer_IsLockedEventHandler; machiningProject.PacePlayer.IsRunningChangedEvent -= EnumerablePlayer_IsLockedEventHandler; machiningProject.PacePlayer.IsFinishedChangedEvent -= EnumerablePlayer_IsLockedEventHandler; } disposedValue = true; await ValueTask.CompletedTask; } private void EnumerablePlayer_IsLockedEventHandler(bool obj) { InvokeAsync(StateHasChanged).ConfigureAwait(false); } public void StartOrContinue() { if (!MachiningProject.PacePlayer.IsLocked) { MachiningProject.PacePlayer.Start(); } else if (!MachiningProject.PacePlayer.IsRunning && !MachiningProject.PacePlayer.IsFinished) { MachiningProject.PacePlayer.Resume(); } } public void Pause() { MachiningProject?.PacePlayer.Pause(); } public void RunToLineEnd() { MachiningProject?.NcRunner.RunToLineEnd(); } public void RunToNextPace() { MachiningProject?.PacePlayer.RunToNextPace(); } public void Break() { MachiningProject?.PacePlayer.Terminate(); } public async Task Reset() { await Task.Run(() => { MachiningProject?.PacePlayer.Reset(); }).ShowIfCatched(this); } } }" + }, + "brief/dev-doc/build-hinc/player/selected-step-info-panel.html": { + "href": "brief/dev-doc/build-hinc/player/selected-step-info-panel.html", + "title": "Selected-Step Info Panel | HiAPI-C# 2025", + "summary": "Selected-Step Info Panel The panel locates on the Player Panel. The model is MachiningStep and UserEnv. The MachiningStep is assigned by ClStrip.PosSelected. Show step infomation from UserEnv.DisplayedStepPresentAccessList. The resx of MachiningStep contains the translation of PresentAttribute.Name, apply the translation to the GUI. If the translation not existed, use the original value. See Also Step Present Preference Page. Sample Code Refer the code to show step infomation. internal static void ShowStepPresent( UserEnv userEnv, MachiningStep machiningStep) { foreach (var entry in userEnv.DisplayedStepPresentAccessList) { var present = entry.Value.Present; var valueText = string.Format(\"{0:\" + present.DataFormatString + \"}\", entry.Value.GetValueFunc.Invoke(machiningStep)); Console.WriteLine($\"{present.ShortName}: {valueText} {present.TailUnitString} ({present.Name} [{entry.Key}])\"); } } Source Code Path See this page for git repository. WPF Application Source Code Path Play/SelectedStepInfoPanel Web Page Application Source Code Path wwwroot/selected-step-info-panel.js (Vue component) wwwroot/selected-step-info-panel.css (Styles) Controllers/PlayerController.cs (REST API) Hubs/PlayerHub.cs (SignalR Hub for real-time updates)" + }, + "brief/dev-doc/build-hinc/preference/graphic-cache-dropdown.html": { + "href": "brief/dev-doc/build-hinc/preference/graphic-cache-dropdown.html", + "title": "Graphic-Cache SubMenu | HiAPI-C# 2025", + "summary": "Graphic-Cache SubMenu The submenu locates on the Preference Menu Dropdown. The model UserEnv is from its parent component. Layout Graphic-Cache SubMenu Graphic-Cache Lower Limit Input Text Field Graphic-Cache Upper Limit Input Text Field Graphic-Cache Input Text Field Graphic-Cache Slider Behavior Graphic-Cache Input Text Field and Graphic-Cache Slider bind the UserConfig.GraphicCacheMb. The limit text fields also bind to the properties of UserConfig. Source Code Path See this page for git repository. WPF Application Source Code Path MainWindow (be included in preference menu) Web Page Application Source Code Path wwwroot/preference/preference-menu.js Controller/Preference/PreferenceController.cs" + }, + "brief/dev-doc/build-hinc/preference/index.html": { + "href": "brief/dev-doc/build-hinc/preference/index.html", + "title": "Preference Menu Dropdown | HiAPI-C# 2025", + "summary": "Preference Menu Dropdown The model of the UI is UserEnv. UserEnv contains UserConfig, which is rapidly used in the GUI. The dropdown is on the Main Panel. Layout Preference Menu Dropdown Step Present Preference Button Graphic-Cache Dropdown Language Selection SubMenu Show Physics Options CheckBox The model is ShowPhysicsOptions. The checkbox is disabled and unchecked if IsPhysicsLicensed is false. Show Log Button See Message Section. The button does not exist on WPF application. Single User Application In single user application, access global UserEnv and UserConfig by the LocalApp. Apply LocalApp.SaveUserConfig() or LocalApp.LooseSaveUserConfig() (save config in Loose Manner) if config changed. Source Code Path See this page for git repository. WPF Application Source Code Path MainWindow (include preference menu) Web Page Application Source Code Path wwwroot/preference/preference-menu.js Controller/Preference/PreferenceController.cs" + }, + "brief/dev-doc/build-hinc/preference/language-selection-submenu.html": { + "href": "brief/dev-doc/build-hinc/preference/language-selection-submenu.html", + "title": "Language Selection SubMenu | HiAPI-C# 2025", + "summary": "Language Selection SubMenu The submenu locates on the Preference Menu Dropdown. The model UserEnv is from its parent component. Load the language preference on application start. Note Keep language resource on each UI componenets. Layout Language Selection SubMenu English Radio CheckBox Simlified Chinese Radio CheckBox Traditional Chinese Radio CheckBox Source Code Path See this page for git repository. WPF Application Source Code Path MainWindow (In the preference menu) Web Page Application Source Code Path wwwroot/preference/preference-menu.js Controller/Preference/PreferenceController.cs" + }, + "brief/dev-doc/build-hinc/preference/step-present-preference-page.html": { + "href": "brief/dev-doc/build-hinc/preference/step-present-preference-page.html", + "title": "Step Present Preference Page | HiAPI-C# 2025", + "summary": "Step Present Preference Page The model UserEnv is from its parent component. The UserEnv.UserConfig is rapidly used. The model of Candidate Keys Panel is CandidateStepPresentKeyList. The model of Displayed Keys Panel is DisplayedStepPresentKeyList. Layout Step Present Preference Page (or window) Candidate Keys Panel Category A Panel Key a ToggleButton Key b ToggleButton ... Category B Panel ... ... Category Other Panel Displayed Keys Panel Key 1 Key 2 ... The categories are not defined for programming logic but only for user experience. So decide and define the categories in the GUI here only. Since the Keys are not all come from the properties of MachiningStep, a category panel (Category Other Panel) for the uncategoried keys is required. The keys in the Displayed Keys Panel is in sequence of DisplayedStepPresentKeyList. User tune the sequence and remove key by the Displayed Keys Panel. User add and remove the key from the ToggleButtons in Candidate Keys Panel. Those UI control items are required. To both Candidate Keys Panel and Displayed Keys Panel: Apply PresentAttribute.Name as Key label by StepPresentAccessDictionary. Apply the key to the button tooltip. The resx of MachiningStep contains the translation of PresentAttribute.Name, apply the translation to the GUI. If the translation not existed, use the original value. Categories Refer the code to design Categories: @using Hi.Common @using Hi.Geom @using Hi.Mech.Topo @{ string pCalss = \"d-flex flex-wrap gap-2\"; string cardTextClass = $\"card-text {pCalss}\"; }
          @Loc[\"File\"] / @Loc[\"Command\"] / @Loc[\"Flag\"] / @Loc[\"Time\"] / @Loc[\"System\"]
          @Loc[\"F.L.No.\"] @MillingStep?.FileNo : @MillingStep?.LineNo
          @Loc[\"File\"] @MillingStep?.FilePath
          @Loc[\"Accumulated Time\"] @(MillingStep?.AccumulatedTime.ToString(\"G\"))
          @Loc[\"Line Text\"] @MillingStep?.LineText
          @Loc[\"Flags\"] @MillingStep?.FlagsText
          @Loc[\"Step Index\"] @MillingStep?.StepIndex
          @Loc[\"Tool\"] / @Loc[\"Feedrate\"] / @Loc[\"Spindle Speed\"]
          @Loc[\"T\"] @MillingStep?.ToolId
          @Loc[\"S\"] (rpm) @(MillingStep?.SpindleSpeed_rpm.ToString(\"G5\"))
          @Loc[\"F\"] (mm/min) @(MillingStep?.Feedrate_mmdmin.ToString(\"G5\"))
          @Loc[\"Feed per Tooth\"] (mm) @(MillingStep?.FeedPerTooth_mm.ToString(\"G5\"))
          @Loc[\"Feed per Cycle\"] (mm) @(MillingStep?.FeedPerCycle_mm.ToString(\"G5\"))
          @Loc[\"Tooth Arc Duration\"] (s) @(MillingStep?.ToothArcDuration_s.ToString(\"G4\"))
          @Loc[\"Spindle Cycle Period\"] (s) @(MillingStep?.SpindleCyclePeriod_s.ToString(\"G4\"))
          @Loc[\"Cutting Speed\"] (mm/s) @(MillingStep?.CuttingSpeed_mmds?.ToString(\"G4\"))
          @Loc[\"Coordinate\"] / @Loc[\"Move\"]

          @{ var mcCodes = HostMachiningProject?.MachiningEquipment?.GetMachiningChain()?.McCodes; if (mcCodes != null) { var mcTransformers = HostMachiningProject ?.MachiningEquipment?.GetMachiningChain()?.McTransformers; for (int i = 0; i < mcCodes.Length; i++) { if (mcTransformers[i] == null) continue; if (mcTransformers[i] is DynamicRotation) {

          MC.@mcCodes[i] (deg) @MillingStep?.GetMcValue(i)?.SelfInvoke(v => MathUtil.ToDeg(v)).ToString(\"F5\")
          } else {
          MC.@mcCodes[i] (mm) @MillingStep?.GetMcValue(i)?.ToString(\"F5\")
          } } } }

          CL.XYZ (mm) @(MillingStep?.Cl?.Point?.ToString(\"F5\"))
          CL.IJK @(MillingStep?.Cl?.Normal?.ToString(\"F5\"))
          @{ var moveDirection = MillingStep?.MoveOnProgramCoordinate.GetNormalized();
          @Loc[\"Move Direction\"] [W] @(moveDirection?.ToString(\"F4\"))
          }
          @Loc[\"Cutting Geometry\"] / @Loc[\"Chip\"] / @Loc[\"Bias\"] / @Loc[\"Roughness\"]
          @Loc[\"Is Touched\"] @Loc[(MillingStep?.IsTouched)?.ToString()]
          ae (mm) @(MillingStep?.CuttingWidth_mm.ToString(\"G3\"))
          ap (mm) @(MillingStep?.CuttingDepth_mm.ToString(\"G3\"))
          MRR (mm3/s) @(MillingStep?.Mrr_mm3ds.ToString(\"G3\"))
          @Loc[\"Chip Thickness\"] (um) @(MillingStep?.ChipThickness_um?.ToString(\"G3\"))
          @Loc[\"Chip Volume\"] (mm3) @(MillingStep?.ChipVolume_mm3?.ToString(\"G3\"))
          @Loc[\"Chip Mass\"] (mg) @(MillingStep?.ChipMass_mg?.ToString(\"G3\"))
          @Loc[\"Program Side Cusp\"] (um) @(MillingStep?.ProgramSideCusp_um.ToString(\"G4\"))
          @Loc[\"Re-Cut Depth\"] (um) @(MillingStep?.ReCutDepth_um.ToString(\"G4\"))
          @Loc[\"Delta Tip Deflection\"] [TR] (um) @(MillingStep?.DeltaTipDeflectionOnToolRunningCoordinate_um?.ToString(\"G3\"))
          @Loc[\"Max Tip Deflection\"] [TR] (um) @(MillingStep?.MaxTipDeflectionOnToolRunningCoordinate_um?.ToString(\"G3\"))
          @Loc[\"Mechanics\"] / @Loc[\"Power\"] / @Loc[\"Energy\"]
          @Loc[\"Max Force\"] (N) @MillingStep?.MaxAbsForce_N?.ToString(\"G4\")
          @Loc[\"Max Force\"] [TR] (N) @MillingStep?.MaxForceOnToolRunningCoordinate_N?.ToString(\"G4\")
          @Loc[\"Avg Moment about Sensor\"] [SR] (Nm) @MillingStep?.AvgMomentAboutSensor_Nm?.ToString(\"G4\")
          @Loc[\"Avg Abs Moment about Sensor\"] [SR] (Nm) @MillingStep?.AvgAbsMomentAboutSensorVec3d_Nm?.ToString(\"G4\")
          @Loc[\"Thermal Stress\"] (MPa) @MillingStep?.ThermalStress_MPa?.ToString(\"G4\")
          @Loc[\"Workpiece Plastic Depth\"] (um) @MillingStep?.WorkpiecePlasticDepth_um.ToString(\"G4\")
          @Loc[\"Spindle Input Power\"] (W) @MillingStep?.SpindleInputPower_W.ToString(\"G4\")
          @Loc[\"Spindle Output Power\"] (W) @MillingStep?.SpindleOutputPower_W.ToString(\"G4\")
          @Loc[\"Accumulated Spindle Energy Consumption\"] (kWh) @MillingStep?.AccumulatedSpindleEnergyConsumption_kWh.ToString(\"G6\")
          @Loc[\"Temperature\"] / @Loc[\"Wear\"]
          @Loc[\"Chip Temperature\"] (oC) @MillingStep?.ChipTemperature_C?.ToString(\"G4\")
          @Loc[\"Cutter Dermis Temperature\"] (oC) @MillingStep?.CutterDermisTemperature_C?.ToString(\"G4\")
          @Loc[\"Cutter Body Temperature\"] (oC) @MillingStep?.CutterBodyTemperature_C?.ToString(\"G4\")
          @Loc[\"Workpiece Dermis Temperature\"] (oC) @MillingStep?.WorkpieceDermisTemperature_C?.ToString(\"G4\")
          @Loc[\"Instant Crater Wear\"] (um) @MillingStep?.InstantCraterWear_um?.ToString(\"G3\")
          @Loc[\"Accumulated Crater Wear\"] (um) @MillingStep?.AccumulatedCraterWear_um.ToString(\"G4\")
          @Loc[\"Accumulated Flank Wear Depth\"] (um) @MillingStep?.AccumulatedFlankWearDepth_um.ToString(\"G4\")
          VB (um) @MillingStep?.AccumulatedFlankWearWidth_um.ToString(\"G4\")
          @Loc[\"Custom\"]
          @{ var flexDictionary=MillingStep?.FlexDictionary; if (flexDictionary != null) { foreach(var entry in flexDictionary) { if(HostMachiningProject?.StepPropertyAccessDictionary.TryGetValue( entry.Key, out var stepPropertyAccess)==true) {
          @(stepPropertyAccess.PresentAttribute?.ShortName) @(stepPropertyAccess.GetValueText(MillingStep))
          } else {
          @(entry.Key) @(entry.Value)
          } } } }
          Refer the code to apply PresentAttribute. internal static void ShowStepPresent( UserEnv userEnv, MachiningStep machiningStep) { foreach (var entry in userEnv.DisplayedStepPresentAccessList) { var present = entry.Value.Present; var valueText = string.Format(\"{0:\" + present.DataFormatString + \"}\", entry.Value.GetValueFunc.Invoke(machiningStep)); Console.WriteLine($\"{present.ShortName}: {valueText} {present.TailUnitString} ({present.Name} [{entry.Key}])\"); } } Source Code Path See this page for git repository. WPF Application Source Code Path Preference/StepPresentPreferenceWindow Web Page Application Source Code Path wwwroot/preference/step-present-preference.js Controller/Preference/PreferenceController.cs" + }, + "brief/dev-doc/build-hinc/renderingcanvas-tool-bar.html": { + "href": "brief/dev-doc/build-hinc/renderingcanvas-tool-bar.html", + "title": "RenderingCanvas Tool Bar | HiAPI-C# 2025", + "summary": "RenderingCanvas Tool Bar The model of the RenderingCanvas Tool Bar is DispEngine. Layout and Behavior View Buttons SubMenu Front View Button Call DispEngine.SetViewToFrontView(). Back View Button Call DispEngine.SetViewToFrontView() and turn back the view by the code: DispEngine.SetViewToFrontView(); DispEngine.TurnBackView(); Right View Button ...(refer the instruction above) Left View Button ... Top View Button ... Bottom View Button ... Isometric View Button ... (other RenderingCanvas tool bar item may be appended here) Source Code Path See this page for git repository. WPF Application Source Code Path Disp/RenderingCanvasToolBar Webapi Application Source Code Path wwwroot/disp/rendering-canvas-tool-bar.js wwwroot/disp/rendering-canvas-tool-bar.css To build it, you can refer Hi.Sample.Webapi/wwwroot/disp/rendering-canvas-view-dropdown.js." + }, + "brief/dev-doc/build-hinc/session-message-panel/index.html": { + "href": "brief/dev-doc/build-hinc/session-message-panel/index.html", + "title": "Session Message Panel | HiAPI-C# 2025", + "summary": "Session Message Panel The model is MachiningProject.SessionMessageHost. MachiningProject is assigned from the Player Panel. Layout Top Message Filter ToolBar Message Type Filter SubMenu NC CheckBox Progress CheckBox Error CheckBox Message Text Filter Input Message Text Filter Input Text Area Message Text Filter Reset Button Export Button Central Message Table Central Message Table The model of Central Message Table is SessionMessageHost.MessageCollection. Only take last 1000 filtered elements in the MessageCollection by GetFliteredList(FilterFlag, string) to show for user experience. Find the usage example in the code: internal static void DemoUseSessionMessageHost(MachiningProject project) { SessionMessageHost sessionMessageHost = project.SessionMessageHost; SessionMessageHost.FilterFlag filterFlags = SessionMessageHost.FilterFlag.NC | SessionMessageHost.FilterFlag.Progress | SessionMessageHost.FilterFlag.Error; string filterText = null; var filteredSessionMessageList = sessionMessageHost .GetFliteredList(filterFlags, filterText); foreach (var sessionMessage in filteredSessionMessageList) { //M.I.: Message Index. Console.Write($\"M.I.: {sessionMessage.Index}; Role: {sessionMessage.MessageRoleText}\"); // For SessionMessageHost.FilterFlag.NC var nc = sessionMessage.DirectInstantSourceCommand; if (nc != null) Console.Write($\"Message/NC: {nc.Line}; File: {nc.FilePath}; LineNo: {nc.GetLineNo()}; \"); // For SessionMessageHost.FilterFlag.Progress or Error. var multiTagMessage = sessionMessage.MultiTagMessage; if (multiTagMessage != null) Console.WriteLine($\"Message/NC: {multiTagMessage.Message}\"); var exception = sessionMessage.Exception; if (exception != null) Console.WriteLine($\"Message/NC: {exception.Message}\"); } File.WriteAllLines(\"output-session-messages.txt\", filteredSessionMessageList.Select(m => $\"Msg[{m.Index}][{m.MessageRoleText}]: {m}\")); } In the table, show the columns: Role, NC/Message. Add update table event to CollectionItemChanged. The updating process has to be called by Loose Manner for user experience. Tip On window desktop application (WPF), consider use textarea instead of datagrid to MessageTable for better performance. Use padding to show the different columns. And use the font in the textarea that with consistent width. Note The message display should be real-time. Behavior of Export Button Export ALL filtered elements in the MessageCollection by GetFliteredList(FilterFlag, string). Source Code Path See this page for git repository. WPF Application Source Code Path Play/SessionMessagePanel Web Page Application Source Code Path wwwroot/player-panel.js (include in Player Panel) Controller/Player/PlayerController.cs" + }, + "brief/dev-doc/build-hinc/translation-remarks.html": { + "href": "brief/dev-doc/build-hinc/translation-remarks.html", + "title": "Translation Remarks | HiAPI-C# 2025", + "summary": "Translation Remarks The translation terminology and convention has to keep consistency. Anchor 定位 Cutter 刀具 Insert Cutter 刀片式刀具 Insert 刀片 Holder 刀把 Cylindroid Holder 柱狀刀把 Freeform Holder 任意形刀把 Shank 刀柄 Fixture 夾具 Milling Cutter 銑刀 Freeform Remover 任意移除工具 Flute 刀刃 Flute-Profile 刃包絡型 Flute-Contours 刃型 Flute-Inner-Beam 刃中芯 Upper-Beam 夾持柱 Integral Mode 組裝形式 Solid End 一體式 Insert End 刀片式 Preset 前設置 Runtime Geometry 運行時幾何 Machining Resolution 加工解析度" + }, + "brief/dev-doc/build-hinc/unused/machine-tool-panel.html": { + "href": "brief/dev-doc/build-hinc/unused/machine-tool-panel.html", + "title": "Machine Tool Panel | HiAPI-C# 2025", + "summary": "Machine Tool Panel Layout of Machine Tool Panel Top Item: Load button and the Loaded Machine Tool File Name readonly textarea. Central Panel: RenderingCanvas Behavior of Machine Tool Panel RenderingCanvas.Displayee is the machine tool (MachiningProject.MachiningEquipment.MachiningChain) Load button load the machine tool to MachiningProject.MachiningEquipment.MachiningChain and MachiningProject.MachiningEquipment.MachiningChainFile by XFactory.Default.GenByFile." + }, + "brief/dev-doc/build-hinc/unused/mission-panel.html": { + "href": "brief/dev-doc/build-hinc/unused/mission-panel.html", + "title": "Mission Panel | HiAPI-C# 2025", + "summary": "Mission Panel The Mission Panel manages NC program loading, editing, and preparation for simulation in the geometry-only HiNC application. Panel Layout Left side: NC Program Management Panel Program Files Section Load NC File button New NC File button List view of loaded NC programs Remove button (to remove selected program) Program Properties Section File name and path display Program description input field Program size and line count display Program Association Section Tool mapping controls: Dropdown to select T-code Dropdown to select corresponding tool from Tool House Apply Mapping button Work offset mapping controls: Dropdown to select work offset code (G54, G55, etc.) X, Y, Z offset value inputs Apply Offset button Right side: NC Program Editor/Viewer Syntax-highlighted G-code editor Line numbers Save button Validate button Validation results display area Show Toolpath Preview toggle button Bottom: Toolpath Preview Panel (shown when preview is toggled on) 3D view of the toolpath Color-coded display based on operation type or feed rate Basic camera controls Behavior Loading NC Program Files When the user clicks the Load NC File button: Open a file selection dialog showing NC files (*.nc, *.cnc, *.ngc, etc.) After selection, validate the file format Add the file to the list of NC programs Display the file in the editor/viewer Update program properties display // Example code public void LoadNCFile(string filePath) { if (File.Exists(filePath)) { // Read and validate NC file string programContent = File.ReadAllText(filePath); // Create a new program object NCProgram program = new NCProgram { FilePath = filePath, FileName = Path.GetFileName(filePath), Content = programContent, LineCount = programContent.Split('\\n').Length, FileSize = new FileInfo(filePath).Length }; // Add to the project's mission machiningProject.MachiningMission.Programs.Add(program); // Update the NC program list view UpdateProgramListView(); // Select the newly added program SelectProgram(program); // Display the program in the editor LoadProgramIntoEditor(program); } } Creating a New NC Program When the user clicks the New NC File button: Create a new empty NC program object Add it to the list of programs Load it into the editor with minimal template content Allow the user to start editing public void CreateNewNCProgram() { // Create a basic template for a new NC program string templateContent = \"%\\nO0001\\n(NEW PROGRAM)\\n\\nG90 G40 G17\\nG21 (MM)\\n\\n(PROGRAM BODY)\\n\\nM30\\n%\"; // Create a new program object NCProgram program = new NCProgram { FileName = \"NewProgram.nc\", Content = templateContent, LineCount = templateContent.Split('\\n').Length, IsNew = true }; // Add to the project's mission machiningProject.MachiningMission.Programs.Add(program); // Update the NC program list view UpdateProgramListView(); // Select the newly added program SelectProgram(program); // Display the program in the editor LoadProgramIntoEditor(program); } Tool Mapping When the user sets up a tool mapping and clicks Apply Mapping: Extract the T-code from the selected dropdown Get the corresponding tool from the Tool House based on the selection Add or update the mapping in the mission's tool map Update the display to show the active mapping public void ApplyToolMapping(string tCodeStr, int toolHousePosition) { if (int.TryParse(tCodeStr.Substring(1), out int tCode)) { // Get the tool from the tool house var tool = machiningProject.MachiningToolHouse[toolHousePosition]; if (tool != null) { // Update or add the mapping machiningProject.MachiningMission.ToolMap[tCode] = toolHousePosition; // Update the display UpdateToolMappingDisplay(); } } } Work Offset Mapping When the user sets up a work offset and clicks Apply Offset: Extract the offset code (G54, G55, etc.) Create a vector from the X, Y, Z input values Add or update the offset in the mission's work offset map Update the display to show the active offset public void ApplyWorkOffset(string offsetCode, double x, double y, double z) { // Create the offset vector Vec3d offset = new Vec3d(x, y, z); // Update or add the mapping machiningProject.MachiningMission.WorkOffsetMap[offsetCode] = offset; // Update the display UpdateWorkOffsetDisplay(); } Validating NC Program When the user clicks the Validate button: Parse the current program content in the editor Check for syntax errors Verify tool references against the tool map Check for unsupported G/M codes Display validation results in the results area public void ValidateProgram() { // Get the current content from the editor string programContent = GetEditorContent(); // Create a validator NCProgramValidator validator = new NCProgramValidator(machiningProject); // Perform validation ValidationResult result = validator.Validate(programContent); // Display results ClearValidationResultsDisplay(); if (result.IsValid) { DisplayValidationSuccess(\"Program validation successful.\"); } else { foreach (var error in result.Errors) { DisplayValidationError(error); } } } Displaying Toolpath Preview When the user toggles the Show Toolpath Preview: If toggled on: a. Parse the NC program b. Generate a toolpath using the geometry-only simulation engine c. Render the toolpath in the preview panel d. Show the preview panel If toggled off: a. Hide the preview panel public void ToggleToolpathPreview(bool showPreview) { if (showPreview) { // Get the current program NCProgram program = GetSelectedProgram(); // Generate toolpath (simplified for geometry-only) Toolpath toolpath = ToolpathGenerator.GenerateFromNCProgram( program.Content, machiningProject.MachiningMission.ToolMap, machiningProject.MachiningMission.WorkOffsetMap, machiningProject.MachiningEquipment); // Render the toolpath RenderToolpathPreview(toolpath); // Show the preview panel toolpathPreviewPanel.Visibility = Visibility.Visible; } else { // Hide the preview panel toolpathPreviewPanel.Visibility = Visibility.Collapsed; } } Data Structure The panel operates primarily on the MachiningMission of the MachiningProject: public class MachiningMission { public List Programs { get; set; } = new List(); public Dictionary ToolMap { get; set; } = new Dictionary(); public Dictionary WorkOffsetMap { get; set; } = new Dictionary(); // Other mission-related properties } public class NCProgram { public string FilePath { get; set; } public string FileName { get; set; } public string Content { get; set; } public long FileSize { get; set; } public int LineCount { get; set; } public bool IsNew { get; set; } public string Description { get; set; } // Other program-related properties } Integration with Main Application The Mission Panel is activated when the user selects the Mission item in the Navigation Menu. It accesses and modifies the MachiningMission component of the current MachiningProject instance. When changes are made in this panel, the following notifications should be sent: ProgramListChanged - When programs are added or removed ProgramContentChanged - When program content is edited ToolMapChanged - When tool mappings are updated WorkOffsetMapChanged - When work offsets are updated These notifications allow other components (particularly the Player panel) to update their behavior accordingly when preparing for or executing the simulation." + }, + "brief/dev-doc/build-hinc/widget/gui-file-path-assignment.html": { + "href": "brief/dev-doc/build-hinc/widget/gui-file-path-assignment.html", + "title": "GUI File Path Assignment | HiAPI-C# 2025", + "summary": "GUI File Path Assignment See the remarks of MakeXmlSource(string, string, bool) to know the design pattern of file path treatment. if the assigned file path is descendent of the configuration directory, it is straight forward that set the baseDirectory to the configuration directory and apply relative path to relFile; if not, set baseDirectory to null and set relFile to absolute path. GUI that needs to assign file generally requires a code-behind BaseDirectory property as assistent model. The property is assigned by the parent model from the parent GUI. In most cases, the first BaseDirectory is the project directory if the project has assigned (created or loaded). Portability To maintain For the portability of project or the other folder-based unit, if the sub-item is loaded by absolute path outside the folder-based unit directory, redirect the saving path to the folder-based unit directory, i.e. the SubItemFile below. Note You have no need to do an additional action to create a duplicate in the folder-based unit directory. Since the file-writing pattern of MakeXmlSource(string, string, bool) create files when user call to save. In other perspective, if user does not call to save, the local duplicate should be created. The design pattern is usually saw in the HiAPI program, a object contains the properties: object SubItem; string SubItemFile; Then you should keep the Protability. File Path of Load Button and Save Button The genneral convention of the File Path of Load and Save is different by the single-user desktop application and web page application. Tip Always preserve an empty filter ( * . * ) for the browser. Single-User Desktop Application The default directory of the Save/Load button are generally: System Default Directory or Project Directory (default, if not explicitly indicated) The initial directory is the project directory. Resource Directory The path always point to /Resource/ directory. The button label has to explicitly show ‘Load Resource’. The kinds of buttons are not exclusive, they can be existed on the same tool bar. If the selected file path is under the project directory, apply the relative path from the project, i.e. baseDirectory is project directory and relFile is the relative path. Web Page Application The default directory of the Save/Load button are generally: Admin Directory Project Directory Resource Directory The Resource Directory and Project Directory are generally under the Admin Directory. And the admin directory is generally set in the appsettings.json file. Typical Action if exhibitionOnly false On IMakeXmlSource.MakeXmlSource(string, string, bool) with exhibitionOnly false, the argument (baseDirectory and relFile) should be the same from object's host (if exist) XML output function." + }, + "brief/dev-doc/build-hinc/widget/object-management-menu-button.html": { + "href": "brief/dev-doc/build-hinc/widget/object-management-menu-button.html", + "title": "Object Management Menu Button | HiAPI-C# 2025", + "summary": "Object Management Menu Button The menu button represent the target object with getter function and setter function. The target object generally is IMakeXmlSource. the target object with getter function and setter function is such like: object TargetObject{get=>TargetObjectGetter?.Invoke();set=>TargetObjectSetter?.Invoke(value);} Func TargetObjectGetter{get;set;} Action TargetObjectSetter{get;set;} The target object has the following functions: File Save/Load See GUI File Path Assignment Object Copy/Paste Editor Panel Mode Selection GUI (user-friendly) XML Get XML by IMakeXmlSource with exhibitionOnly true. Set XML by XFactory. If the target object is not IMakeXmlSource, then the XML Editor Panel Mode should not appear. The other functions are still buildable. Don't use GenMode.Default on XFactory functions. Use GenMode.Rebase. Since GenMode.Default pass the inner exception silently. Layout Object Management Menu Button Load Button Load Resource Button Save As Button (splitter) Copy Button (with hotkey support if the Object Management Menu Button is focused) Paste Button (with hotkey support if the Object Management Menu Button is focused) (splitter) GUI Ratio Button XML Ratio Button Tip Since the Object Management Menu Button has special meaning, use icon instead of text label. Do not use icon on the other child buttons. The icons gains nothing but hard to keep style to the full application. If the model is selected, show a different style (may be color) on the menu button. The model should contain a ResourceDirectory property. Do not show Load Resource Button if Resource directory not explicitly gave. Copy & Paste Object Copy/Paste (i.e. Select/Set or Duplicated-Set) Copy (i.e. Select) Set the model to UserEnv.SelectedItem. Paste Set UserEnv.SelectedItem to the model. Set by reference is default. Apply Duplicated-Set if explicitly required. While a object is copied (selected) here, it can also be paste (drag) to: Text editor Use IMakeXmlSource.MakeXmlSource(string, string, bool) with exhibitionOnly false and the argument (baseDirectory and relFile) from object's host to paste the text, it should be the same text content by the host XML output. File browser Use IMakeXmlSource.MakeXmlSource(string, string, bool) with exhibitionOnly true, baseDirectory destination folder, relFile destination file name (maybe xxx.class-name) to paste the file. Show message when paste action success or failed. See Handle Message and Exception. If the data type is not matched, show the un-matched message. Editor Panel Mode Ratio Button The Editor Panel switched by the Editor Panel Mode Ratio Button. The BaseDirectory and RelFile properties should exist. Use the RelFile property if the object's host has the corresponding property like XXXFile. The Apply action should be well-set. Include SetFileDelegate from XFactory.Gen(XElement, string, SetFileDelegate, GenMode, params object[]) function. The last argument should also be delivered by the host. So there must exist an property to pass the argument. XML Editor Panel Layout XML Editor Panel Cancel Button Apply Button XML TextArea Shows error message if the xml-parsing or object creation failed on XML Editor Panel Apply Button applied. WPF Application Source Code Path Common/ObjectManagementMenuButton see this page for git repository." + }, + "brief/dev-doc/build-hinc/widget/polar-resolution-2d-panel.html": { + "href": "brief/dev-doc/build-hinc/widget/polar-resolution-2d-panel.html", + "title": "Polar Resolution 2D Panel | HiAPI-C# 2025", + "summary": "Polar Resolution 2D Panel The model is PolarResolution2d. Layout Polar Resolution 2D Panel Enable Custom Resolution CheckBox enabled if host.model is not null. set host.model to null if not enabled. Linear Resolution (mm) Input Field enabled if model not null Angle Resolution (deg) Input Field enabled if model not null Feature There is a code-behind property to set visibility of Enable CheckBox. If the host.model is null, it may mean the resolution applied the default value. Source Code Path See this page for git repository. WPF Application Source Code Path Geom/PolarResolution2dPanel Web Page Application Source Code Path wwwroot/widget/polar-resolution-2d-panel.js Controller/Widget/WidgetController.cs" + }, + "brief/dev-doc/build-hinc/widget/vec3d/index.html": { + "href": "brief/dev-doc/build-hinc/widget/vec3d/index.html", + "title": "Vec3dControl Component | HiAPI-C# 2025", + "summary": "Vec3dControl Component Vec3dControl is a user control for Vec3d and display. Main Features Dual Input Modes Standard Mode: Input X, Y, Z components separately Text Mode: Input complete vector in text format Vector Normalization Normalization button (optional) Button visibility controlled by ShowNormalizeButton property Refer Sample Code