Skip to content

Commit

Permalink
Deploy preview for PR 880 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
@fallenatlas
fallenatlas committed Feb 1, 2024
1 parent 72129e4 commit ee3af83
Show file tree
Hide file tree
Showing 151 changed files with 2,890 additions and 3,333 deletions.
10 changes: 5 additions & 5 deletions docs-preview/pr-880/access_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>core/ecs/query/access.hpp file | CUBOS. Docs</title>
<title>core/ecs/system/access.hpp file | CUBOS. Docs</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
<link rel="icon" href="favicon-dark.png" type="image/png" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<span class="m-breadcrumb"><a href="dir_6c897dd97bedf3914ee8a4d9f7f6549c.html">core</a>/</span><span class="m-breadcrumb"><a href="dir_b6daa990b896c2c0c53126427e4d978d.html">ecs</a>/</span><span class="m-breadcrumb"><a href="dir_26a5878ebb5e9988b6ffa6f152301254.html">query</a>/</span>access.hpp <span class="m-thin">file</span>
<span class="m-breadcrumb"><a href="dir_6c897dd97bedf3914ee8a4d9f7f6549c.html">core</a>/</span><span class="m-breadcrumb"><a href="dir_b6daa990b896c2c0c53126427e4d978d.html">ecs</a>/</span><span class="m-breadcrumb"><a href="dir_1849b6590c20a7c40f18c0337f505edf.html">system</a>/</span>access.hpp <span class="m-thin">file</span>
</h1>
<p>Struct <a href="structcubos_1_1core_1_1ecs_1_1QueryAccess.html" class="m-doc">cubos::<wbr />core::<wbr />ecs::<wbr />QueryAccess</a>.</p>
<p>Struct <a href="structcubos_1_1core_1_1ecs_1_1SystemAccess.html" class="m-doc">cubos::<wbr />core::<wbr />ecs::<wbr />SystemAccess</a>.</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
Expand Down Expand Up @@ -76,9 +76,9 @@ <h2><a href="#namespaces">Namespaces</a></h2>
<h2><a href="#nested-classes">Classes</a></h2>
<dl class="m-doc">
<dt>
struct <a href="structcubos_1_1core_1_1ecs_1_1QueryAccess.html" class="m-doc">cubos::core::ecs::QueryAccess</a>
struct <a href="structcubos_1_1core_1_1ecs_1_1SystemAccess.html" class="m-doc">cubos::core::ecs::SystemAccess</a>
</dt>
<dd>Describes the types of data a query accesses.</dd>
<dd>Describes the types of data a system accesses.</dd>
</dl>
</section>
</div>
Expand Down
70 changes: 29 additions & 41 deletions docs-preview/pr-880/annotated.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs-preview/pr-880/blueprint_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h2><a href="#nested-classes">Classes</a></h2>
<dt>
class <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">cubos::core::ecs::Blueprint</a>
</dt>
<dd>Collection of entities and their respective components.</dd>
<dd>Collection of entities and their respective components and relations.</dd>
</dl>
</section>
</div>
Expand Down
131 changes: 115 additions & 16 deletions docs-preview/pr-880/classcubos_1_1core_1_1ecs_1_1Blueprint.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs-preview/pr-880/classcubos_1_1core_1_1ecs_1_1Commands.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@
<div class="m-col-l-10 m-push-l-1">
<h1>
<span class="m-breadcrumb"><a href="namespacecubos.html">cubos</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1core.html">core</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecubos_1_1core_1_1ecs.html">ecs</a>::<wbr/></span>Commands <span class="m-thin">class</span> <span class="m-label m-flat m-warning">final</span>
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="commands_8hpp.html">&lt;core/ecs/system/commands.hpp&gt;</a></div>
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="commands_8hpp.html">&lt;core/ecs/system/arguments/commands.hpp&gt;</a></div>
</h1>
<p>System argument used to write ECS commands and execute them at a later time.</p>
<p><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> argument used to write ECS commands and execute them at a later time.</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
Expand Down
382 changes: 0 additions & 382 deletions docs-preview/pr-880/classcubos_1_1core_1_1ecs_1_1ComponentManager.html
View file

This file was deleted.

160 changes: 78 additions & 82 deletions ...pr-880/classcubos_1_1engine_1_1Cubos.html → ...0/classcubos_1_1core_1_1ecs_1_1Cubos.html
View file

Large diffs are not rendered by default.

81 changes: 18 additions & 63 deletions docs-preview/pr-880/classcubos_1_1core_1_1ecs_1_1Dispatcher.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,11 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</dt>
<dd>Makes the current tag run before the given tag.</dd>
<dt>
<div class="m-doc-template">template&lt;typename F&gt;</div>
<span class="m-doc-wrap-bumper">void <a href="#a5698906e8294827bf572b07692ae1eb7" class="m-doc">tagAddCondition</a>(</span><span class="m-doc-wrap">F func)</span>
<span class="m-doc-wrap-bumper">void <a href="#a73674240a0312f477923d18cac0e0edb" class="m-doc">tagAddCondition</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">ecs::<wbr />System</a>&lt;bool&gt; condition)</span>
</dt>
<dd>Adds a condition to the current tag.</dd>
<dt>
<div class="m-doc-template">template&lt;typename F&gt;</div>
<span class="m-doc-wrap-bumper">void <a href="#a8dd6a3c5853b7f8f526be0eef779692a" class="m-doc">addSystem</a>(</span><span class="m-doc-wrap">F func)</span>
<span class="m-doc-wrap-bumper">void <a href="#a4c899e81d143a9b6758eda41d450fa84" class="m-doc">addSystem</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">ecs::<wbr />System</a>&lt;void&gt; system)</span>
</dt>
<dd>Adds a system, and sets it as the current system for further configuration.</dd>
<dt>
Expand All @@ -103,17 +101,15 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</dt>
<dd>Sets the current system to run before the tag.</dd>
<dt>
<div class="m-doc-template">template&lt;typename F&gt;</div>
<span class="m-doc-wrap-bumper">void <a href="#a7f4fd5101153c4a5f7fffa4668a1facd" class="m-doc">systemAddCondition</a>(</span><span class="m-doc-wrap">F func)</span>
<span class="m-doc-wrap-bumper">void <a href="#ad4d05d090cb063cadd36a78de6f5bfa5" class="m-doc">systemAddCondition</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">ecs::<wbr />System</a>&lt;bool&gt; condition)</span>
</dt>
<dd>Adds a condition to the current system.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#a0a892298f420498324f6af0ded49e2b2" class="m-doc">compileChain</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Compiles the call chain. Required before <a href="classcubos_1_1core_1_1ecs_1_1Dispatcher.html#af609121dc12f26ae53cf4e7fc853cd1f" class="m-doc">callSystems()</a> can be called.</dd>
<dd>Compiles the call chain. Required before <a href="classcubos_1_1core_1_1ecs_1_1Dispatcher.html#a735d7d39e6411f49022da5fbef99cf34" class="m-doc">callSystems()</a> can be called.</dd>
<dt>
<span class="m-doc-wrap-bumper">void <a href="#af609121dc12f26ae53cf4e7fc853cd1f" class="m-doc">callSystems</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a>&amp; world,
<a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">CommandBuffer</a>&amp; cmds)</span>
<span class="m-doc-wrap-bumper">void <a href="#a735d7d39e6411f49022da5fbef99cf34" class="m-doc">callSystems</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">CommandBuffer</a>&amp; cmds)</span>
</dt>
<dd>Calls all systems in the compiled call chain. <a href="classcubos_1_1core_1_1ecs_1_1Dispatcher.html#a0a892298f420498324f6af0ded49e2b2" class="m-doc">compileChain()</a> must be called prior to this.</dd>
</dl>
Expand Down Expand Up @@ -188,59 +184,35 @@ <h3>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a5698906e8294827bf572b07692ae1eb7"><div>
<section class="m-doc-details" id="a73674240a0312f477923d18cac0e0edb"><div>
<h3>
<div class="m-doc-template">
template&lt;typename F&gt;
</div>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a5698906e8294827bf572b07692ae1eb7" class="m-doc-self">tagAddCondition</a>(</span><span class="m-doc-wrap">F func)</span></span>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a73674240a0312f477923d18cac0e0edb" class="m-doc-self">tagAddCondition</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">ecs::<wbr />System</a>&lt;bool&gt; condition)</span></span>
</h3>
<p>Adds a condition to the current tag.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">F</td>
<td>Condition type.</td>
</tr>
</tbody>
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td>func</td>
<td style="width: 1%">condition</td>
<td>Condition to add.</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a8dd6a3c5853b7f8f526be0eef779692a"><div>
<section class="m-doc-details" id="a4c899e81d143a9b6758eda41d450fa84"><div>
<h3>
<div class="m-doc-template">
template&lt;typename F&gt;
</div>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8dd6a3c5853b7f8f526be0eef779692a" class="m-doc-self">addSystem</a>(</span><span class="m-doc-wrap">F func)</span></span>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4c899e81d143a9b6758eda41d450fa84" class="m-doc-self">addSystem</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">ecs::<wbr />System</a>&lt;void&gt; system)</span></span>
</h3>
<p>Adds a system, and sets it as the current system for further configuration.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">F</td>
<td><a href="structcubos_1_1core_1_1ecs_1_1Dispatcher_1_1System.html" class="m-doc">System</a> type.</td>
</tr>
</tbody>
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td>func</td>
<td style="width: 1%">system</td>
<td><a href="structcubos_1_1core_1_1ecs_1_1Dispatcher_1_1System.html" class="m-doc">System</a> to add.</td>
</tr>
</tbody>
Expand Down Expand Up @@ -297,30 +269,18 @@ <h3>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a7f4fd5101153c4a5f7fffa4668a1facd"><div>
<section class="m-doc-details" id="ad4d05d090cb063cadd36a78de6f5bfa5"><div>
<h3>
<div class="m-doc-template">
template&lt;typename F&gt;
</div>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a7f4fd5101153c4a5f7fffa4668a1facd" class="m-doc-self">systemAddCondition</a>(</span><span class="m-doc-wrap">F func)</span></span>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad4d05d090cb063cadd36a78de6f5bfa5" class="m-doc-self">systemAddCondition</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">ecs::<wbr />System</a>&lt;bool&gt; condition)</span></span>
</h3>
<p>Adds a condition to the current system.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">F</td>
<td>Condition type.</td>
</tr>
</tbody>
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td>func</td>
<td style="width: 1%">condition</td>
<td>Condition.</td>
</tr>
</tbody>
Expand All @@ -330,13 +290,12 @@ <h3>
<h3>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0a892298f420498324f6af0ded49e2b2" class="m-doc-self">compileChain</a>(</span><span class="m-doc-wrap">)</span></span>
</h3>
<p>Compiles the call chain. Required before <a href="classcubos_1_1core_1_1ecs_1_1Dispatcher.html#af609121dc12f26ae53cf4e7fc853cd1f" class="m-doc">callSystems()</a> can be called.</p>
<p>Compiles the call chain. Required before <a href="classcubos_1_1core_1_1ecs_1_1Dispatcher.html#a735d7d39e6411f49022da5fbef99cf34" class="m-doc">callSystems()</a> can be called.</p>
<p>Takes all pending systems and determines their execution order.</p>
</div></section>
<section class="m-doc-details" id="af609121dc12f26ae53cf4e7fc853cd1f"><div>
<section class="m-doc-details" id="a735d7d39e6411f49022da5fbef99cf34"><div>
<h3>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af609121dc12f26ae53cf4e7fc853cd1f" class="m-doc-self">callSystems</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a>&amp; world,
<a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">CommandBuffer</a>&amp; cmds)</span></span>
<span class="m-doc-wrap-bumper">void cubos::<wbr />core::<wbr />ecs::<wbr />Dispatcher::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a735d7d39e6411f49022da5fbef99cf34" class="m-doc-self">callSystems</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">CommandBuffer</a>&amp; cmds)</span></span>
</h3>
<p>Calls all systems in the compiled call chain. <a href="classcubos_1_1core_1_1ecs_1_1Dispatcher.html#a0a892298f420498324f6af0ded49e2b2" class="m-doc">compileChain()</a> must be called prior to this.</p>
<table class="m-table m-fullwidth m-flat">
Expand All @@ -345,11 +304,7 @@ <h3>
</thead>
<tbody>
<tr>
<td style="width: 1%">world</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1World.html" class="m-doc">World</a> to call the systems in.</td>
</tr>
<tr>
<td>cmds</td>
<td style="width: 1%">cmds</td>
<td>Command buffer.</td>
</tr>
</tbody>
Expand Down
Loading

0 comments on commit ee3af83

Please sign in to comment.