663 lines
37 KiB
HTML
663 lines
37 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::process< Derived, Delta > Class Template Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">EnTT<span id="projectnumber"> 3.15.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1process.html">process</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classentt_1_1process-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">entt::process< Derived, Delta > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for processes.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="process_8hpp_source.html">process.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a625b574ea6d83e3a4933acc3d0279295" id="r_a625b574ea6d83e3a4933acc3d0279295"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a625b574ea6d83e3a4933acc3d0279295">delta_type</a> = Delta</td></tr>
|
|
<tr class="memdesc:a625b574ea6d83e3a4933acc3d0279295"><td class="mdescLeft"> </td><td class="mdescRight">Type used to provide elapsed time. <br /></td></tr>
|
|
<tr class="separator:a625b574ea6d83e3a4933acc3d0279295"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a4a5cf6bbe22a8b5b60b8b6c7221bc3b9" id="r_a4a5cf6bbe22a8b5b60b8b6c7221bc3b9"><td class="memItemLeft" align="right" valign="top"><a id="a4a5cf6bbe22a8b5b60b8b6c7221bc3b9" name="a4a5cf6bbe22a8b5b60b8b6c7221bc3b9"></a>
|
|
constexpr </td><td class="memItemRight" valign="bottom"><b>process</b> ()=default</td></tr>
|
|
<tr class="memdesc:a4a5cf6bbe22a8b5b60b8b6c7221bc3b9"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a4a5cf6bbe22a8b5b60b8b6c7221bc3b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23a46de31f2f5e8eeefcc07739b28038" id="r_a23a46de31f2f5e8eeefcc07739b28038"><td class="memItemLeft" align="right" valign="top"><a id="a23a46de31f2f5e8eeefcc07739b28038" name="a23a46de31f2f5e8eeefcc07739b28038"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>process</b> (const <a class="el" href="classentt_1_1process.html">process</a> &)=default</td></tr>
|
|
<tr class="memdesc:a23a46de31f2f5e8eeefcc07739b28038"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor. <br /></td></tr>
|
|
<tr class="separator:a23a46de31f2f5e8eeefcc07739b28038"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bd3a2e2889ad05c3314367652bf3223" id="r_a5bd3a2e2889ad05c3314367652bf3223"><td class="memItemLeft" align="right" valign="top"><a id="a5bd3a2e2889ad05c3314367652bf3223" name="a5bd3a2e2889ad05c3314367652bf3223"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>process</b> (<a class="el" href="classentt_1_1process.html">process</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:a5bd3a2e2889ad05c3314367652bf3223"><td class="mdescLeft"> </td><td class="mdescRight">Default move constructor. <br /></td></tr>
|
|
<tr class="separator:a5bd3a2e2889ad05c3314367652bf3223"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72788a7962cf5001746c4714659f4630" id="r_a72788a7962cf5001746c4714659f4630"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1process.html">process</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a72788a7962cf5001746c4714659f4630">operator=</a> (const <a class="el" href="classentt_1_1process.html">process</a> &)=default</td></tr>
|
|
<tr class="memdesc:a72788a7962cf5001746c4714659f4630"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator. <br /></td></tr>
|
|
<tr class="separator:a72788a7962cf5001746c4714659f4630"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0bf8ba1041e6fccd9062dc113ede77e" id="r_aa0bf8ba1041e6fccd9062dc113ede77e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1process.html">process</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa0bf8ba1041e6fccd9062dc113ede77e">operator=</a> (<a class="el" href="classentt_1_1process.html">process</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:aa0bf8ba1041e6fccd9062dc113ede77e"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <br /></td></tr>
|
|
<tr class="separator:aa0bf8ba1041e6fccd9062dc113ede77e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2baf1b6aef37c1420a77cd3f8eadcf79" id="r_a2baf1b6aef37c1420a77cd3f8eadcf79"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2baf1b6aef37c1420a77cd3f8eadcf79">~process</a> ()</td></tr>
|
|
<tr class="memdesc:a2baf1b6aef37c1420a77cd3f8eadcf79"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a2baf1b6aef37c1420a77cd3f8eadcf79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdcca68a2cd65bbece91ca7b504dfe60" id="r_abdcca68a2cd65bbece91ca7b504dfe60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdcca68a2cd65bbece91ca7b504dfe60">abort</a> (const bool immediate=false)</td></tr>
|
|
<tr class="memdesc:abdcca68a2cd65bbece91ca7b504dfe60"><td class="mdescLeft"> </td><td class="mdescRight">Aborts a process if it's still alive. <br /></td></tr>
|
|
<tr class="separator:abdcca68a2cd65bbece91ca7b504dfe60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacb0108ddb7ee68eac145c092b4e4163" id="r_aacb0108ddb7ee68eac145c092b4e4163"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#aacb0108ddb7ee68eac145c092b4e4163">alive</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:aacb0108ddb7ee68eac145c092b4e4163"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is either running or paused. <br /></td></tr>
|
|
<tr class="separator:aacb0108ddb7ee68eac145c092b4e4163"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0385aa714f8fe603a7d89c960b22751e" id="r_a0385aa714f8fe603a7d89c960b22751e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0385aa714f8fe603a7d89c960b22751e">finished</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a0385aa714f8fe603a7d89c960b22751e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is already terminated. <br /></td></tr>
|
|
<tr class="separator:a0385aa714f8fe603a7d89c960b22751e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7738f4e908293a072a89981a004669a" id="r_ac7738f4e908293a072a89981a004669a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7738f4e908293a072a89981a004669a">paused</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ac7738f4e908293a072a89981a004669a"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process is currently paused. <br /></td></tr>
|
|
<tr class="separator:ac7738f4e908293a072a89981a004669a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c716b08baea91192512aeb14f26328b" id="r_a6c716b08baea91192512aeb14f26328b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6c716b08baea91192512aeb14f26328b">rejected</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a6c716b08baea91192512aeb14f26328b"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a process terminated with errors. <br /></td></tr>
|
|
<tr class="separator:a6c716b08baea91192512aeb14f26328b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacc7fe0ef3265113079c70ff8cd9478d" id="r_aacc7fe0ef3265113079c70ff8cd9478d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aacc7fe0ef3265113079c70ff8cd9478d">tick</a> (const Delta delta, void *data=nullptr)</td></tr>
|
|
<tr class="memdesc:aacc7fe0ef3265113079c70ff8cd9478d"><td class="mdescLeft"> </td><td class="mdescRight">Updates a process and its internal state if required. <br /></td></tr>
|
|
<tr class="separator:aacc7fe0ef3265113079c70ff8cd9478d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a4380dab12dc4c7559ada2182468aa1db" id="r_a4380dab12dc4c7559ada2182468aa1db"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4380dab12dc4c7559ada2182468aa1db">succeed</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a4380dab12dc4c7559ada2182468aa1db"><td class="mdescLeft"> </td><td class="mdescRight">Terminates a process with success if it's still alive. <br /></td></tr>
|
|
<tr class="separator:a4380dab12dc4c7559ada2182468aa1db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac7438533f769e1d24836ca04f86ec7c" id="r_aac7438533f769e1d24836ca04f86ec7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aac7438533f769e1d24836ca04f86ec7c">fail</a> () noexcept</td></tr>
|
|
<tr class="memdesc:aac7438533f769e1d24836ca04f86ec7c"><td class="mdescLeft"> </td><td class="mdescRight">Terminates a process with errors if it's still alive. <br /></td></tr>
|
|
<tr class="separator:aac7438533f769e1d24836ca04f86ec7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bcdfd9f2ec24b591ba1fbf38f563023" id="r_a2bcdfd9f2ec24b591ba1fbf38f563023"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bcdfd9f2ec24b591ba1fbf38f563023">pause</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a2bcdfd9f2ec24b591ba1fbf38f563023"><td class="mdescLeft"> </td><td class="mdescRight">Stops a process if it's in a running state. <br /></td></tr>
|
|
<tr class="separator:a2bcdfd9f2ec24b591ba1fbf38f563023"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b024d8b110a8ab631132acc6abfb9e1" id="r_a5b024d8b110a8ab631132acc6abfb9e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5b024d8b110a8ab631132acc6abfb9e1">unpause</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a5b024d8b110a8ab631132acc6abfb9e1"><td class="mdescLeft"> </td><td class="mdescRight">Restarts a process if it's paused. <br /></td></tr>
|
|
<tr class="separator:a5b024d8b110a8ab631132acc6abfb9e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename Derived, typename Delta><br />
|
|
class entt::process< Derived, Delta ></div><p>Base class for processes. </p>
|
|
<p>This class stays true to the CRTP idiom. Derived classes must specify what's the intended type for elapsed times.<br />
|
|
A process should expose publicly the following member functions whether required:</p>
|
|
<ul>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> update(Delta, <span class="keywordtype">void</span> *);</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked once per tick until a process is explicitly aborted or it terminates either with or without errors. Even though it's not mandatory to declare this member function, as a rule of thumb each process should at least define it to work properly. The <code>void *</code> parameter is an opaque pointer to user data (if any) forwarded directly to the process during an update.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> init();</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked when the process joins the running queue of a scheduler. This happens as soon as it's attached to the scheduler if the process is a top level one, otherwise when it replaces its parent if the process is a continuation.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> succeeded();</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked in case of success, immediately after an update and during the same tick.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> failed();</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked in case of errors, immediately after an update and during the same tick.</p>
|
|
</li>
|
|
<li><div class="fragment"><div class="line"><span class="keywordtype">void</span> aborted();</div>
|
|
</div><!-- fragment --><p class="startli">It's invoked only if a process is explicitly aborted. There is no guarantee that it executes in the same tick, this depends solely on whether the process is aborted immediately or not.</p>
|
|
</li>
|
|
</ul>
|
|
<p>Derived classes can change the internal state of a process by invoking the <code>succeed</code> and <code>fail</code> protected member functions and even pause or unpause the process itself.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceentt.html#afb4634a5b738455e0b6d35bb5444dbf4" title="Alias declaration for the most common use case.">scheduler</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Derived</td><td>Actual type of process that extends the class template. </td></tr>
|
|
<tr><td class="paramname">Delta</td><td>Type to use to provide elapsed time. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00071">71</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a625b574ea6d83e3a4933acc3d0279295" name="a625b574ea6d83e3a4933acc3d0279295"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a625b574ea6d83e3a4933acc3d0279295">◆ </a></span>delta_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::delta_type = Delta</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type used to provide elapsed time. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00167">167</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2baf1b6aef37c1420a77cd3f8eadcf79" name="a2baf1b6aef37c1420a77cd3f8eadcf79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2baf1b6aef37c1420a77cd3f8eadcf79">◆ </a></span>~process()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::~<a class="el" href="classentt_1_1process.html">process</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default destructor. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00191">191</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="abdcca68a2cd65bbece91ca7b504dfe60" name="abdcca68a2cd65bbece91ca7b504dfe60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abdcca68a2cd65bbece91ca7b504dfe60">◆ </a></span>abort()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::abort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool</td> <td class="paramname"><span class="paramname"><em>immediate</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Aborts a process if it's still alive. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't alive.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">immediate</td><td>Requests an immediate operation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00203">203</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacb0108ddb7ee68eac145c092b4e4163" name="aacb0108ddb7ee68eac145c092b4e4163"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacb0108ddb7ee68eac145c092b4e4163">◆ </a></span>alive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::alive </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process is either running or paused. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process is still alive, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00217">217</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac7438533f769e1d24836ca04f86ec7c" name="aac7438533f769e1d24836ca04f86ec7c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac7438533f769e1d24836ca04f86ec7c">◆ </a></span>fail()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::fail </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel protected">protected</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminates a process with errors if it's still alive. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't alive. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00135">135</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0385aa714f8fe603a7d89c960b22751e" name="a0385aa714f8fe603a7d89c960b22751e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0385aa714f8fe603a7d89c960b22751e">◆ </a></span>finished()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::finished </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process is already terminated. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process is terminated, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00225">225</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a72788a7962cf5001746c4714659f4630" name="a72788a7962cf5001746c4714659f4630"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72788a7962cf5001746c4714659f4630">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1process.html">process</a> & <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1process.html">process</a>< Derived, Delta > &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel default">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default copy assignment operator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This process. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa0bf8ba1041e6fccd9062dc113ede77e" name="aa0bf8ba1041e6fccd9062dc113ede77e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa0bf8ba1041e6fccd9062dc113ede77e">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1process.html">process</a> & <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1process.html">process</a>< Derived, Delta > &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel default">default</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default move assignment operator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This process. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bcdfd9f2ec24b591ba1fbf38f563023" name="a2bcdfd9f2ec24b591ba1fbf38f563023"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bcdfd9f2ec24b591ba1fbf38f563023">◆ </a></span>pause()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::pause </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel protected">protected</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stops a process if it's in a running state. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't running. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00147">147</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7738f4e908293a072a89981a004669a" name="ac7738f4e908293a072a89981a004669a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7738f4e908293a072a89981a004669a">◆ </a></span>paused()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::paused </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process is currently paused. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process is paused, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00233">233</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c716b08baea91192512aeb14f26328b" name="a6c716b08baea91192512aeb14f26328b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c716b08baea91192512aeb14f26328b">◆ </a></span>rejected()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::rejected </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if a process terminated with errors. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the process terminated with errors, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00241">241</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4380dab12dc4c7559ada2182468aa1db" name="a4380dab12dc4c7559ada2182468aa1db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4380dab12dc4c7559ada2182468aa1db">◆ </a></span>succeed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::succeed </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel protected">protected</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Terminates a process with success if it's still alive. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't alive. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00123">123</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacc7fe0ef3265113079c70ff8cd9478d" name="aacc7fe0ef3265113079c70ff8cd9478d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacc7fe0ef3265113079c70ff8cd9478d">◆ </a></span>tick()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::tick </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const Delta</td> <td class="paramname"><span class="paramname"><em>delta</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates a process and its internal state if required. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">delta</td><td>Elapsed time. </td></tr>
|
|
<tr><td class="paramname">data</td><td>Optional data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00250">250</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b024d8b110a8ab631132acc6abfb9e1" name="a5b024d8b110a8ab631132acc6abfb9e1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b024d8b110a8ab631132acc6abfb9e1">◆ </a></span>unpause()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Derived, typename Delta> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1process.html">entt::process</a>< Derived, Delta >::unpause </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel protected">protected</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Restarts a process if it's paused. </p>
|
|
<p>The function is idempotent and it does nothing if the process isn't paused. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="process_8hpp_source.html#l00159">159</a> of file <a class="el" href="process_8hpp_source.html">process.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/entt/process/<a class="el" href="process_2fwd_8hpp_source.html">fwd.hpp</a></li>
|
|
<li>src/entt/process/<a class="el" href="process_8hpp_source.html">process.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|