Skip to content

Commit

Permalink
deploy: f4bbe25
Browse files Browse the repository at this point in the history
  • Loading branch information
RiscadoA committed Feb 1, 2024
1 parent 57de4a0 commit 54ce5ca
Show file tree
Hide file tree
Showing 47 changed files with 1,104 additions and 857 deletions.
10 changes: 5 additions & 5 deletions docs/access_8hpp.html
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
31 changes: 15 additions & 16 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,7 @@ <h1>Classes</h1>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacecubos_1_1core_1_1ecs.html" class="m-doc">ecs</a> <span class="m-doc"><a href="group__core-ecs.html" class="m-doc">ECS</a> module.</span>
<ul class="m-doc">
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">namespace</a> <a href="namespacecubos_1_1core_1_1ecs_1_1impl.html" class="m-doc">impl</a> <span class="m-doc">Contains functions used internally by the implementation of the ECS.</span>
<ul class="m-doc">
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1impl_1_1Index.html" class="m-doc">Index</a> <span class="m-doc">Used to get the index of a type in a tuple.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1impl_1_1SystemFetcher.html" class="m-doc">SystemFetcher</a> <span class="m-doc">Fetches the requested data from a world.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1impl_1_1SystemTraits.html" class="m-doc">SystemTraits</a> <span class="m-doc">Template magic used to inspect the arguments of a system.</span></li>
</ul>
</li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1AnySystemWrapper.html" class="m-doc">AnySystemWrapper</a> <span class="m-doc">Base class for system wrappers.</span></li>
<li>namespace <a href="namespacecubos_1_1core_1_1ecs_1_1impl.html" class="m-doc">impl</a> <span class="m-doc">Contains functions used internally by the implementation of the ECS.</span></li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">class</a> <a href="classcubos_1_1core_1_1ecs_1_1ArchetypeGraph.html" class="m-doc">ArchetypeGraph</a> <span class="m-doc">Stores which column types each archetype holds and the edges which connect them.</span>
<ul class="m-doc">
Expand All @@ -121,7 +113,7 @@ <h1>Classes</h1>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Blueprint.html" class="m-doc">Blueprint</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Collection of entities and their respective components and relations.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1ColumnId.html" class="m-doc">ColumnId</a> <span class="m-doc">Identifies a data column type.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1CommandBuffer.html" class="m-doc">CommandBuffer</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Stores commands to execute them later.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Commands.html" class="m-doc">Commands</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">System argument used to write ECS commands and execute them at a later time.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Commands.html" class="m-doc">Commands</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc"><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.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1ComponentManager.html" class="m-doc">ComponentManager</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Holds and manages components.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Cubos.html" class="m-doc">Cubos</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Represents the engine itself, and exposes the interface with which the game developer interacts with. Ties up all the different parts of the engine together.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1DataTypeId.html" class="m-doc">DataTypeId</a> <span class="m-doc">Identifies a data type registered in the world.</span></li>
Expand Down Expand Up @@ -160,15 +152,14 @@ <h1>Classes</h1>
</ul>
</li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">class</a> <a href="classcubos_1_1core_1_1ecs_1_1EventReader.html" class="m-doc">EventReader</a> <span class="m-doc">System arguments used to read events of type <code>T</code>.</span>
<a href="#" onclick="return toggle(this)">class</a> <a href="classcubos_1_1core_1_1ecs_1_1EventReader.html" class="m-doc">EventReader</a> <span class="m-doc"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> arguments used to read events of type <code>T</code>.</span>
<ul class="m-doc">
<li>class <a href="classcubos_1_1core_1_1ecs_1_1EventReader_1_1Iterator.html" class="m-doc">Iterator</a> <span class="m-doc">Used to iterate over events received by a reader.</span></li>
</ul>
</li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1EventWriter.html" class="m-doc">EventWriter</a> <span class="m-doc">System argument which allows the system to send events of type <code>T</code> to other systems.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1EventWriter.html" class="m-doc">EventWriter</a> <span class="m-doc"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> argument which allows the system to send events of type <code>T</code> to other systems.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Opt.html" class="m-doc">Opt</a> <span class="m-doc">Wrapper for reference types to indicate that the given argument type is optional in a query.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Query.html" class="m-doc">Query</a> <span class="m-doc">System argument which holds the result of a query over all entities in world which match the given arguments.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1QueryAccess.html" class="m-doc">QueryAccess</a> <span class="m-doc">Describes the types of data a query accesses.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Query.html" class="m-doc">Query</a> <span class="m-doc"><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> argument which holds the result of a query over all entities in world which match the given arguments.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1QueryData.html" class="m-doc">QueryData</a> <span class="m-doc">Holds the data necessary to execute a query.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1QueryFetcher.html" class="m-doc">QueryFetcher</a> <span class="m-doc">Type meant to be specialized which implements for each argument type the necessary logic to extract it from the tables.</span></li>
<li class="m-doc-collapsible collapsed">
Expand Down Expand Up @@ -212,8 +203,16 @@ <h1>Classes</h1>
</li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Storage.html" class="m-doc">Storage</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Stores the components of a given type.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1SymmetricTrait.html" class="m-doc">SymmetricTrait</a> <span class="m-doc">Trait used to identify symmetric relations.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1SystemInfo.html" class="m-doc">SystemInfo</a> <span class="m-doc">Describes a system.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1SystemWrapper.html" class="m-doc">SystemWrapper</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Wrapper for a system of type <code>F</code>.</span></li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">class</a> <a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> <span class="m-doc">Holds a system with a return type <code>T</code>.</span>
<ul class="m-doc">
<li>class <a href="classcubos_1_1core_1_1ecs_1_1System_1_1SystemFunction.html" class="m-doc">SystemFunction</a> <span class="m-doc">Specific class for the stored system function type with specific arguments.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1System_1_1SystemTraits.html" class="m-doc">SystemTraits</a> <span class="m-doc">Used to get a <a href="classcubos_1_1core_1_1ecs_1_1System_1_1SystemFunction.html" class="m-doc">SystemFunction</a> from any functional type.</span></li>
</ul>
</li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1SystemAccess.html" class="m-doc">SystemAccess</a> <span class="m-doc">Describes the types of data a system accesses.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1SystemFetcher.html" class="m-doc">SystemFetcher</a> <span class="m-doc">Type meant to be specialized which implements for each argument type the necessary logic to extract it from the world.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1SystemOptions.html" class="m-doc">SystemOptions</a> <span class="m-doc">Contains extra options for a specific system argument.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1Tables.html" class="m-doc">Tables</a> <span class="m-label m-flat m-warning">final</span> <span class="m-doc">Stores the tables of a given world.</span></li>
<li>class <a href="classcubos_1_1core_1_1ecs_1_1TagBuilder.html" class="m-doc">TagBuilder</a> <span class="m-doc">Used to chain configurations related to tags.</span></li>
<li>struct <a href="structcubos_1_1core_1_1ecs_1_1TreeTrait.html" class="m-doc">TreeTrait</a> <span class="m-doc">Trait used to identify tree relations.</span></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/classcubos_1_1core_1_1ecs_1_1Commands.html
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
4 changes: 2 additions & 2 deletions docs/classcubos_1_1core_1_1ecs_1_1Cubos.html
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ <h3>
<tbody>
<tr>
<td style="width: 1%">name</td>
<td>System debug name.</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> debug name.</td>
</tr>
</tbody>
<tfoot>
Expand All @@ -361,7 +361,7 @@ <h3>
<tbody>
<tr>
<td style="width: 1%">name</td>
<td>System debug name.</td>
<td><a href="classcubos_1_1core_1_1ecs_1_1System.html" class="m-doc">System</a> debug name.</td>
</tr>
</tbody>
<tfoot>
Expand Down
Loading

0 comments on commit 54ce5ca

Please sign in to comment.