HiNC-Deploy/HiNC-2025-win-desktop-Deploy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Common.PacePlayer.html
iambossTC b5cad3c171 tune
2025-07-25 16:27:29 +08:00

756 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class PacePlayer | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PacePlayer | HiAPI-C# 2025 ">
<meta name="description" content="Controls the pace execution of a task.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.PacePlayer">
<h1 id="Hi_Common_PacePlayer" data-uid="Hi.Common.PacePlayer" class="text-break">
Class PacePlayer
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Controls the pace execution of a task.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PacePlayer : IDisposable</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">PacePlayer</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Common_PacePlayer_CancellationToken_" data-uid="Hi.Common.PacePlayer.CancellationToken*"></a>
<h3 id="Hi_Common_PacePlayer_CancellationToken" data-uid="Hi.Common.PacePlayer.CancellationToken">
CancellationToken
</h3>
<div class="markdown level1 summary"><p>Gets the cancellation token for the running task.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CancellationToken CancellationToken { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt>
<dd></dd>
</dl>
<a id="Hi_Common_PacePlayer_IsFinished_" data-uid="Hi.Common.PacePlayer.IsFinished*"></a>
<h3 id="Hi_Common_PacePlayer_IsFinished" data-uid="Hi.Common.PacePlayer.IsFinished">
IsFinished
</h3>
<div class="markdown level1 summary"><p>Is the process finished from <a class="xref" href="Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_Start">Start()</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsFinished { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_Common_PacePlayer_IsLocked_" data-uid="Hi.Common.PacePlayer.IsLocked*"></a>
<h3 id="Hi_Common_PacePlayer_IsLocked" data-uid="Hi.Common.PacePlayer.IsLocked">
IsLocked
</h3>
<div class="markdown level1 summary"><p>Is started but not finished.
<a class="xref" href="Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_IsLocked">IsLocked</a> keeps true even if <a class="xref" href="Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_Pause">Pause()</a> is called.
The property is true if a task started and the task has not yet finished.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsLocked { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_Common_PacePlayer_IsRunning_" data-uid="Hi.Common.PacePlayer.IsRunning*"></a>
<h3 id="Hi_Common_PacePlayer_IsRunning" data-uid="Hi.Common.PacePlayer.IsRunning">
IsRunning
</h3>
<div class="markdown level1 summary"><p>Is running. Not paused either finished.
The property is true if a task started and the task has not yet finished and <a class="xref" href="Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_Pause">Pause()</a> is not called.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsRunning { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Hi_Common_PacePlayer_MainAction_" data-uid="Hi.Common.PacePlayer.MainAction*"></a>
<h3 id="Hi_Common_PacePlayer_MainAction" data-uid="Hi.Common.PacePlayer.MainAction">
MainAction
</h3>
<div class="markdown level1 summary"><p>Gets or sets the main action to be executed by the player.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Action&lt;PacePlayee&gt; MainAction { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="Hi.Common.PacePlayee.html">PacePlayee</a>&gt;</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Common_PacePlayer_Dispose_" data-uid="Hi.Common.PacePlayer.Dispose*"></a>
<h3 id="Hi_Common_PacePlayer_Dispose" data-uid="Hi.Common.PacePlayer.Dispose">
Dispose()
</h3>
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<a id="Hi_Common_PacePlayer_Dispose_" data-uid="Hi.Common.PacePlayer.Dispose*"></a>
<h3 id="Hi_Common_PacePlayer_Dispose_System_Boolean_" data-uid="Hi.Common.PacePlayer.Dispose(System.Boolean)">
Dispose(bool)
</h3>
<div class="markdown level1 summary"><p>Releases the unmanaged resources and optionally releases the managed resources.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>disposing</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>true to release both managed and unmanaged resources; false to release only unmanaged resources.</p>
</dd>
</dl>
<a id="Hi_Common_PacePlayer_Pause_" data-uid="Hi.Common.PacePlayer.Pause*"></a>
<h3 id="Hi_Common_PacePlayer_Pause" data-uid="Hi.Common.PacePlayer.Pause">
Pause()
</h3>
<div class="markdown level1 summary"><p>Pauses the execution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Pause()</code></pre>
</div>
<a id="Hi_Common_PacePlayer_Reset_" data-uid="Hi.Common.PacePlayer.Reset*"></a>
<h3 id="Hi_Common_PacePlayer_Reset" data-uid="Hi.Common.PacePlayer.Reset">
Reset()
</h3>
<div class="markdown level1 summary"><p>Resets the player to its initial state.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Reset()</code></pre>
</div>
<a id="Hi_Common_PacePlayer_Resume_" data-uid="Hi.Common.PacePlayer.Resume*"></a>
<h3 id="Hi_Common_PacePlayer_Resume" data-uid="Hi.Common.PacePlayer.Resume">
Resume()
</h3>
<div class="markdown level1 summary"><p>Resumes the execution if paused.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Resume()</code></pre>
</div>
<a id="Hi_Common_PacePlayer_RunToNextPace_" data-uid="Hi.Common.PacePlayer.RunToNextPace*"></a>
<h3 id="Hi_Common_PacePlayer_RunToNextPace" data-uid="Hi.Common.PacePlayer.RunToNextPace">
RunToNextPace()
</h3>
<div class="markdown level1 summary"><p>Runs to the next pace point.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RunToNextPace()</code></pre>
</div>
<a id="Hi_Common_PacePlayer_Start_" data-uid="Hi.Common.PacePlayer.Start*"></a>
<h3 id="Hi_Common_PacePlayer_Start" data-uid="Hi.Common.PacePlayer.Start">
Start()
</h3>
<div class="markdown level1 summary"><p>Starts the main action execution.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Start()</code></pre>
</div>
<a id="Hi_Common_PacePlayer_Terminate_" data-uid="Hi.Common.PacePlayer.Terminate*"></a>
<h3 id="Hi_Common_PacePlayer_Terminate" data-uid="Hi.Common.PacePlayer.Terminate">
Terminate()
</h3>
<div class="markdown level1 summary"><p>Terminates the execution by cancelling the task.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Terminate()</code></pre>
</div>
<a id="Hi_Common_PacePlayer_Wait_" data-uid="Hi.Common.PacePlayer.Wait*"></a>
<h3 id="Hi_Common_PacePlayer_Wait" data-uid="Hi.Common.PacePlayer.Wait">
Wait()
</h3>
<div class="markdown level1 summary"><p>Waits for the task to complete.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Wait()</code></pre>
</div>
<h2 class="section" id="events">Events
</h2>
<h3 id="Hi_Common_PacePlayer_IsFinishedChangedEvent" data-uid="Hi.Common.PacePlayer.IsFinishedChangedEvent">
IsFinishedChangedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered when the <a class="xref" href="Hi.Common.PacePlayer.html#Hi_Common_PacePlayer_IsFinished">IsFinished</a> state changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; IsFinishedChangedEvent</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_Common_PacePlayer_IsLockedChangedEvent" data-uid="Hi.Common.PacePlayer.IsLockedChangedEvent">
IsLockedChangedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered when the lock state changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; IsLockedChangedEvent</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_Common_PacePlayer_IsRunningChangedEvent" data-uid="Hi.Common.PacePlayer.IsRunningChangedEvent">
IsRunningChangedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered when the running state changes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;bool&gt; IsRunningChangedEvent</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt>
<dd></dd>
</dl>
<h3 id="Hi_Common_PacePlayer_ResetedEvent" data-uid="Hi.Common.PacePlayer.ResetedEvent">
ResetedEvent
</h3>
<div class="markdown level1 summary"><p>Event triggered after the player has been reset.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action ResetedEvent</code></pre>
</div>
<h4 class="section">Event Type</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action">Action</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink