405 lines
18 KiB
HTML
405 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Player Tool Bar | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Player Tool Bar | HiAPI-C# 2025 ">
|
|
|
|
|
|
<link rel="icon" href="../../../img/HiAPI.favicon.ico">
|
|
<link rel="stylesheet" href="../../../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../../../public/main.css">
|
|
<meta name="docfx:navrel" content="../../../toc.html">
|
|
<meta name="docfx:tocrel" content="../../toc.html">
|
|
|
|
<meta name="docfx:rel" content="../../../">
|
|
|
|
|
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../../../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../../../index.html">
|
|
<img id="logo" class="svg" src="../../../img/HiAPI.logo.png" alt="">
|
|
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="">
|
|
<h1 id="player-tool-bar">Player Tool Bar</h1>
|
|
|
|
<h2 id="layout">Layout</h2>
|
|
<ul>
|
|
<li><code>Player Tool Bar</code>
|
|
<ul>
|
|
<li><code>Status Text Field</code></li>
|
|
<li><code>Start Button</code></li>
|
|
<li><code>Pause Button</code></li>
|
|
<li><code>Run-One-Line Button</code></li>
|
|
<li><code>Run-One-Step Button</code></li>
|
|
<li><code>Stop Button</code></li>
|
|
<li><code>Reset Button</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2 id="behavior-of-player-tool-bar">Behavior of <code>Player Tool Bar</code></h2>
|
|
<p>See the example code to:</p>
|
|
<ul>
|
|
<li>complete the behavior of the buttons and <code>Status Text Field</code>.</li>
|
|
<li>The rapidly used buttons should has hotkey. At least the following buttons:
|
|
<ul>
|
|
<li>Run One Line Button</li>
|
|
<li>Run One Step Button</li>
|
|
<li>Start/Continue</li>
|
|
<li>Pause</li>
|
|
</ul>
|
|
</li>
|
|
<li>Both webservice and win-desktop applications use <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> events for monitoring <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_PacePlayer">PacePlayer</a> status changes.</li>
|
|
<li>In webservice applications, the <code>PlayerStatusService</code> subscribes to these <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> events and broadcasts status changes via <code>PlayerStatusHub</code> using SignalR for real-time communication.</li>
|
|
<li>Win-desktop applications can directly subscribe to <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html">LocalProjectService</a> events for status updates.</li>
|
|
<li>Alter the background color of the <code>Status Text Field</code> if the status changed.
|
|
<ul>
|
|
<li>Warning style color
|
|
<ul>
|
|
<li>Running</li>
|
|
</ul>
|
|
</li>
|
|
<li>Secondary style color
|
|
<ul>
|
|
<li>Paused</li>
|
|
<li>No Project</li>
|
|
</ul>
|
|
</li>
|
|
<li>Success style color
|
|
<ul>
|
|
<li>Finished</li>
|
|
<li>Ready</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>The action of <code>Reset Button</code> should be async for user experience.</p>
|
|
<div class="TIP">
|
|
<h5>Tip</h5>
|
|
<p>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.</p>
|
|
<ul>
|
|
<li>Run One Line Button > default color with green seasoned</li>
|
|
<li>Run One Step Button > default color with blue seasoned</li>
|
|
</ul>
|
|
<p>The other button use the default color is enough.</p>
|
|
</div>
|
|
<h2 id="source-code-path">Source Code Path</h2>
|
|
<p>See <a href="../index.html">this page</a> for git repository.</p>
|
|
<h3 id="wpf-application-source-code-path">WPF Application Source Code Path</h3>
|
|
<ul>
|
|
<li>Play/PlayerToolBar</li>
|
|
</ul>
|
|
<h3 id="web-page-application-source-code-path">Web Page Application Source Code Path</h3>
|
|
<ul>
|
|
<li>wwwroot/player/player-tool-bar.js</li>
|
|
<li>Players/PlayerController.cs</li>
|
|
<li>Players/PlayerStatusHub.cs</li>
|
|
<li>Players/PlayerStatusService.cs</li>
|
|
</ul>
|
|
<h4 id="signalr-implementation-webapi-only">SignalR Implementation (Webapi Only)</h4>
|
|
<p><code>PlayerStatusHub</code> provides real-time player status updates, with methods <code>GetPlayerStatus()</code> and event <code>PlayerStatusUpdated</code>. <code>PlayerStatusService</code> monitors <a class="xref" href="../../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_PacePlayer">PacePlayer</a> events (<a class="xref" href="../../../api/Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_IsRunningChangedEvent">IsRunningChangedEvent</a>, <a class="xref" href="../../../api/Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_IsLockedChangedEvent">IsLockedChangedEvent</a>, <a class="xref" href="../../../api/Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_IsFinishedChangedEvent">IsFinishedChangedEvent</a>, <a class="xref" href="../../../api/Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_ResetedEvent">ResetedEvent</a>) and broadcasts changes via SignalR. The JavaScript component connects to <code>/playerStatusHub</code> and listens for status updates. API endpoints include <code>/api/player/start</code>, <code>/api/player/pause</code>, <code>/api/player/resume</code>, <code>/api/player/run-line</code>, <code>/api/player/run-step</code>, <code>/api/player/stop</code>, and <code>/api/player/reset</code>.</p>
|
|
<h3 id="razor-page-source-code">Razor Page Source Code</h3>
|
|
<pre><code class="lang-csharp" name="SampleCode-razor">@using Hi.Common.PathUtils;
|
|
@using Hi.HiNcKits;
|
|
@using Hi.MachiningProcs
|
|
@using Hi.MillingProcs;
|
|
@using Hi.Numerical.FilePlayers;
|
|
@inject HiNcHost hiNcHost
|
|
|
|
@{
|
|
MachiningProject machiningProject = hiNcHost.MachiningProject;
|
|
var localProjectService = hiNcHost.LocalProjectService;
|
|
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 (localProjectService.PacePlayer.IsRunning)
|
|
{
|
|
<span class="badge text-bg-warning">@Loc["Running"]</span>
|
|
}
|
|
else if (localProjectService.PacePlayer.IsLocked)
|
|
{
|
|
<span class="badge text-bg-secondary">@Loc["Pause"]</span>
|
|
}
|
|
else if (localProjectService.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 (!localProjectService.PacePlayer.IsLocked)
|
|
{
|
|
<button class="btn btn-primary text-nowrap" title="@Loc["Start"] (S)"
|
|
accesskey="s"
|
|
disabled="@(disabledByMachiningProject||localProjectService.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||localProjectService.PacePlayer.IsFinished||localProjectService.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||!localProjectService.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||localProjectService.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||localProjectService.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||!(localProjectService.PacePlayer.IsLocked||localProjectService.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>
|
|
|
|
</code></pre><pre><code class="lang-csharp" name="SampleCode-razor.cs">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;
|
|
LocalProjectService LocalProjectService => hiNcHost.LocalProjectService;
|
|
bool disposedValue = false;
|
|
/// <inheritdoc/>
|
|
protected override async Task OnAfterRenderAsync(bool firstRender)
|
|
{
|
|
base.OnAfterRender(firstRender);
|
|
if (firstRender)
|
|
{
|
|
using var _ = await DisposeSemaphore.EmbraceAsync();
|
|
if (disposedValue) return;
|
|
LocalProjectService.PacePlayer.IsLockedChangedEvent
|
|
+= EnumerablePlayer_IsLockedEventHandler;
|
|
LocalProjectService.PacePlayer.IsRunningChangedEvent
|
|
+= EnumerablePlayer_IsLockedEventHandler;
|
|
LocalProjectService.PacePlayer.IsFinishedChangedEvent
|
|
+= EnumerablePlayer_IsLockedEventHandler;
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public async ValueTask DisposeAsync()
|
|
{
|
|
using var _ = await DisposeSemaphore.EmbraceAsync();
|
|
LocalProjectService.PacePlayer.IsLockedChangedEvent
|
|
-= EnumerablePlayer_IsLockedEventHandler;
|
|
LocalProjectService.PacePlayer.IsRunningChangedEvent
|
|
-= EnumerablePlayer_IsLockedEventHandler;
|
|
LocalProjectService.PacePlayer.IsFinishedChangedEvent
|
|
-= EnumerablePlayer_IsLockedEventHandler;
|
|
disposedValue = true;
|
|
await ValueTask.CompletedTask;
|
|
}
|
|
|
|
private void EnumerablePlayer_IsLockedEventHandler(bool obj)
|
|
{
|
|
InvokeAsync(StateHasChanged).ConfigureAwait(false);
|
|
}
|
|
public async Task StartOrContinue()
|
|
{
|
|
await Task.Run(() =>
|
|
{
|
|
var pacePlayer = LocalProjectService.PacePlayer;
|
|
if (!pacePlayer.IsLocked)
|
|
{
|
|
pacePlayer.Start();
|
|
}
|
|
else if (!pacePlayer.IsRunning
|
|
&& !pacePlayer.IsFinished)
|
|
{
|
|
pacePlayer.Resume();
|
|
}
|
|
}).ShowIfCatched(this);
|
|
}
|
|
public async Task Pause()
|
|
{
|
|
await Task.Run(() =>
|
|
{
|
|
LocalProjectService.PacePlayer.Pause();
|
|
}).ShowIfCatched(this);
|
|
}
|
|
public async Task RunToLineEnd()
|
|
{
|
|
await Task.Run(() =>
|
|
{
|
|
LocalProjectService.NcRunner.RunToLineEnd();
|
|
}).ShowIfCatched(this);
|
|
}
|
|
public async Task RunToNextPace()
|
|
{
|
|
await Task.Run(() =>
|
|
{
|
|
LocalProjectService.PacePlayer.RunToNextPace();
|
|
}).ShowIfCatched(this);
|
|
}
|
|
public async Task Break()
|
|
{
|
|
await Task.Run(() =>
|
|
{
|
|
LocalProjectService.PacePlayer.Terminate();
|
|
}).ShowIfCatched(this);
|
|
}
|
|
public async Task Reset()
|
|
{
|
|
await Task.Run(() =>
|
|
{
|
|
LocalProjectService.PacePlayer.Reset();
|
|
}).ShowIfCatched(this);
|
|
}
|
|
}
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|