Skip to content

Commit

Permalink
deploy: 82ac899
Browse files Browse the repository at this point in the history
  • Loading branch information
DiogoMendonc-a committed Sep 18, 2023
1 parent 3b861e0 commit 4256c93
Show file tree
Hide file tree
Showing 2,070 changed files with 68 additions and 431,568 deletions.
21 changes: 21 additions & 0 deletions classcubos_1_1core_1_1data_1_1SerializationMap.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ <h2><a href="#pub-methods">Public functions</a></h2>
<span class="m-doc-wrap-bumper">auto <a href="#a541041119a92973c40d7fc18cb5337af" class="m-doc">size</a>(</span><span class="m-doc-wrap">) const -&gt; std::size_t</span>
</dt>
<dd></dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a4769f7e04b41ea5f94c9d58def0bd020" class="m-doc">getMap</a>(</span><span class="m-doc-wrap">) const -&gt; std::unordered_map&lt;R, I&gt;</span>
</dt>
<dd>Returns the internal map that maps references to IDs.</dd>
</dl>
</section>
<section>
Expand Down Expand Up @@ -292,6 +296,23 @@ <h3>
</table>
<p>Gets the number of mapped references.</p>
</div></section>
<section class="m-doc-details" id="a4769f7e04b41ea5f94c9d58def0bd020"><div>
<h3>
<div class="m-doc-template">
template&lt;typename R, typename I&gt;
</div>
<span class="m-doc-wrap-bumper">std::unordered_map&lt;R, I&gt; cubos::<wbr />core::<wbr />data::<wbr />SerializationMap&lt;R, I&gt;::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4769f7e04b41ea5f94c9d58def0bd020" class="m-doc-self">getMap</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Returns the internal map that maps references to IDs.</p>
<table class="m-table m-fullwidth m-flat">
<tfoot>
<tr>
<th style="width: 1%">Returns</th>
<td>Map of references and Ids.</td>
</tr>
</tfoot>
</table>
</div></section>
</section>
</div>
</div>
Expand Down
18 changes: 18 additions & 0 deletions classcubos_1_1core_1_1ecs_1_1Blueprint.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ <h2><a href="#pub-methods">Public functions</a></h2>
<span class="m-doc-wrap-bumper">void <a href="#a98b440b50553018db544d6ce8c7bea6a" class="m-doc-self">clear</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>Clears the blueprint, removing any added entities and components.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#af8e0cd0dff35e70b78a3fd6603358010" class="m-doc">getMap</a>(</span><span class="m-doc-wrap">) const -&gt; std::unordered_map&lt;<a href="classcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a>, std::string&gt;</span>
</dt>
<dd>Returns the internal map that maps entities to their names.</dd>
</dl>
</section>
<section>
Expand Down Expand Up @@ -258,6 +262,20 @@ <h3>
</table>
<aside class="m-note m-info"><h4>Note</h4><p>All of the entity names of the other blueprint will be prefixed with the specified string.</p></aside>
</div></section>
<section class="m-doc-details" id="af8e0cd0dff35e70b78a3fd6603358010"><div>
<h3>
<span class="m-doc-wrap-bumper">std::unordered_map&lt;<a href="classcubos_1_1core_1_1ecs_1_1Entity.html" class="m-doc">Entity</a>, std::string&gt; cubos::<wbr />core::<wbr />ecs::<wbr />Blueprint::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af8e0cd0dff35e70b78a3fd6603358010" class="m-doc-self">getMap</a>(</span><span class="m-doc-wrap">) const</span></span>
</h3>
<p>Returns the internal map that maps entities to their names.</p>
<table class="m-table m-fullwidth m-flat">
<tfoot>
<tr>
<th style="width: 1%">Returns</th>
<td>Map of entities and names.</td>
</tr>
</tfoot>
</table>
</div></section>
</section>
</div>
</div>
Expand Down
File renamed without changes.
2 changes: 2 additions & 0 deletions dir_c185369e92e3603c6d00fa8343148da7.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ <h2><a href="#subdirs">Directories</a></h2>
<dd><a href="group__entity-inspector-tool-plugin.html" class="m-doc">Entity inspector</a> plugin directory.</dd>
<dt>directory <a href="dir_3733897ca737f1fa8773f329655abd67.html" class="m-doc">entity_selector</a>/</dt>
<dd><a href="group__entity-selector-tool-plugin.html" class="m-doc">Entity selector</a> plugin directory.</dd>
<dt>directory <a href="dir_8b12085945cef5a7cea7b856ed1ac7f6.html" class="m-doc">scene_editor</a>/</dt>
<dd><a href="group__scene-editor-tool-plugin.html" class="m-doc">Scene editor</a> plugin directory.</dd>
<dt>directory <a href="dir_e42c9d7813efab99826f1cb60398c3fa.html" class="m-doc">settings_inspector</a>/</dt>
<dd><a href="group__settings-inspector-tool-plugin.html" class="m-doc">Settings inspector</a> plugin directory.</dd>
<dt>directory <a href="dir_764b6913e5a035b506325f3918f13ed7.html" class="m-doc">world_inspector</a>/</dt>
Expand Down
6 changes: 6 additions & 0 deletions files.html
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,12 @@ <h1>Files</h1>
<li>file <a href="tools_2entity__selector_2plugin_8hpp.html" class="m-doc">plugin.hpp</a> <span class="m-doc">Plugin entry point.</span></li>
</ul>
</li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">dir</a> <a href="dir_8b12085945cef5a7cea7b856ed1ac7f6.html" class="m-doc">scene_editor</a> <span class="m-doc"><a href="group__scene-editor-tool-plugin.html" class="m-doc">Scene editor</a> plugin directory.</span>
<ul class="m-doc">
<li>file <a href="tools_2scene__editor_2plugin_8hpp.html" class="m-doc">plugin.hpp</a> <span class="m-doc">Plugin entry point.</span></li>
</ul>
</li>
<li class="m-doc-collapsible collapsed">
<a href="#" onclick="return toggle(this)">dir</a> <a href="dir_e42c9d7813efab99826f1cb60398c3fa.html" class="m-doc">settings_inspector</a> <span class="m-doc"><a href="group__settings-inspector-tool-plugin.html" class="m-doc">Settings inspector</a> plugin directory.</span>
<ul class="m-doc">
Expand Down
2 changes: 1 addition & 1 deletion group__assets-plugin.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h3>Contents</h3>
</li>
</ul>
</nav>
<section id="autotoc_md56"><h3><a href="#autotoc_md56">Settings</a></h3><ul><li><code>assets.io.enabled</code> - whether asset I/O should be done (default: <code>true</code>).</li><li><code>assets.io.path</code> - path to the assets directory - will be mounted to <code>/assets/</code> (default: <code>assets/</code>).</li><li><code>assets.io.readOnly</code> - if true, the assets directory will be mounted as read-only (default: <code>true</code>).</li></ul></section><section id="autotoc_md57"><h3><a href="#autotoc_md57">Events</a></h3><ul><li>AssetEvent - (TODO) emitted when an asset is either loaded, modified or unloaded.</li></ul></section><section id="autotoc_md58"><h3><a href="#autotoc_md58">Resources</a></h3><ul><li><a href="classcubos_1_1engine_1_1Assets.html" class="m-doc">Assets</a> - the asset manager, used to access asset data.</li></ul></section><section id="autotoc_md59"><h3><a href="#autotoc_md59">Startup tags</a></h3><ul><li><code>cubos.assets.init</code> - initializes the assets manager and loads the meta files (after <code>cubos.settings</code>).</li><li><code>cubos.assets.bridge</code> - systes which add bridges to the asset manager should be tagged with this.</li><li><code>cubos.assets</code> - systems which load assets should be tagged with this.</li></ul></section><section id="autotoc_md60"><h3><a href="#autotoc_md60">Tags</a></h3><ul><li><code>cubos.assets.cleanup</code> - frees any assets no longer in use.</li></ul></section>
<section id="autotoc_md56"><h3><a href="#autotoc_md56">Settings</a></h3><ul><li><code>assets.io.enabled</code> - whether asset I/O should be done (default: <code>true</code>).</li><li><code>assets.io.path</code> - path to the assets directory - will be mounted to <code>/assets/</code> (default: <code>assets/</code>).</li><li><code>assets.io.readOnly</code> - if true, the assets directory will be mounted as read-only (default: <code>true</code>).</li></ul></section><section id="autotoc_md57"><h3><a href="#autotoc_md57">Events</a></h3><ul><li>AssetEvent - (TODO) emitted when an asset is either loaded, modified or unloaded.</li></ul></section><section id="autotoc_md58"><h3><a href="#autotoc_md58">Resources</a></h3><ul><li><a href="classcubos_1_1engine_1_1Assets.html" class="m-doc">Assets</a> - the asset manager, used to access asset data.</li></ul></section><section id="autotoc_md59"><h3><a href="#autotoc_md59">Startup tags</a></h3><ul><li><code>cubos.assets.init</code> - initializes the assets manager and loads the meta files (after <code>cubos.settings</code>).</li><li><code>cubos.assets.bridge</code> - systes which add bridges to the asset manager should be tagged with this.</li><li><code>cubos.assets</code> - startup systems which load assets should be tagged with this.</li></ul></section><section id="autotoc_md60"><h3><a href="#autotoc_md60">Tags</a></h3><ul><li><code>cubos.assets.cleanup</code> - frees any assets no longer in use.</li></ul></section>
<section id="files">
<h2><a href="#files">Files</a></h2>
<dl class="m-doc">
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions group__settings-inspector-tool-plugin.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h1>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li><a href="#autotoc_md89">Dependencies</a></li>
<li><a href="#autotoc_md90">Dependencies</a></li>
<li>
Reference
<ul>
Expand All @@ -61,7 +61,7 @@ <h3>Contents</h3>
</li>
</ul>
</nav>
<section id="autotoc_md89"><h3><a href="#autotoc_md89">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li></ul></section>
<section id="autotoc_md90"><h3><a href="#autotoc_md90">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li></ul></section>
<section id="files">
<h2><a href="#files">Files</a></h2>
<dl class="m-doc">
Expand Down
2 changes: 2 additions & 0 deletions group__tool-plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ <h2><a href="#groups">Modules</a></h2>
<dd>Allows inspecting and modifying the components of the selected entity through a ImGui window.</dd>
<dt>module <a href="group__entity-selector-tool-plugin.html" class="m-doc">Entity selector</a></dt>
<dd>Adds a resource used to select an entity.</dd>
<dt>module <a href="group__scene-editor-tool-plugin.html" class="m-doc">Scene editor</a></dt>
<dd>Adds a window to edit scenes and select entities in them.</dd>
<dt>module <a href="group__settings-inspector-tool-plugin.html" class="m-doc">Settings inspector</a></dt>
<dd>Allows inspecting the current setting values through a ImGui window.</dd>
<dt>module <a href="group__world-inspector-tool-plugin.html" class="m-doc">World inspector</a></dt>
Expand Down
6 changes: 3 additions & 3 deletions group__transform-plugin.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ <h1>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li><a href="#autotoc_md91">Components</a></li>
<li><a href="#autotoc_md92">Tags</a></li>
<li><a href="#autotoc_md92">Components</a></li>
<li><a href="#autotoc_md93">Tags</a></li>
<li>
Reference
<ul>
Expand All @@ -62,7 +62,7 @@ <h3>Contents</h3>
</li>
</ul>
</nav>
<p>This plugin operates on entities with a <a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> component and any combination of the <a href="structPosition.html" class="m-doc">Position</a>, <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> and <a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> components. For example, if you have an entity which doesn&#x27;t need rotation, but has a position and a scale, you do not need to add the <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> component, and its transform will still be updated.</p><aside class="m-note m-info"><h4>Note</h4><p>Any entity with either a <a href="structPosition.html" class="m-doc">Position</a>, <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> or <a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> component automatically gets a <a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> component.</p></aside><section id="autotoc_md91"><h3><a href="#autotoc_md91">Components</a></h3><ul><li><a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> - holds the local to world transform matrix.</li><li><a href="structPosition.html" class="m-doc">Position</a> - holds the position of an entity.</li><li><a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> - holds the rotation of an entity.</li><li><a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> - holds the scaling of an entity.</li></ul></section><section id="autotoc_md92"><h3><a href="#autotoc_md92">Tags</a></h3><ul><li><code>cubos.transform.update</code> - the <a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> components are updated with the information from the <a href="structPosition.html" class="m-doc">Position</a>, <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> and <a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> components.</li></ul></section>
<p>This plugin operates on entities with a <a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> component and any combination of the <a href="structPosition.html" class="m-doc">Position</a>, <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> and <a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> components. For example, if you have an entity which doesn&#x27;t need rotation, but has a position and a scale, you do not need to add the <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> component, and its transform will still be updated.</p><aside class="m-note m-info"><h4>Note</h4><p>Any entity with either a <a href="structPosition.html" class="m-doc">Position</a>, <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> or <a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> component automatically gets a <a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> component.</p></aside><section id="autotoc_md92"><h3><a href="#autotoc_md92">Components</a></h3><ul><li><a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> - holds the local to world transform matrix.</li><li><a href="structPosition.html" class="m-doc">Position</a> - holds the position of an entity.</li><li><a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> - holds the rotation of an entity.</li><li><a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> - holds the scaling of an entity.</li></ul></section><section id="autotoc_md93"><h3><a href="#autotoc_md93">Tags</a></h3><ul><li><code>cubos.transform.update</code> - the <a href="structcubos_1_1engine_1_1LocalToWorld.html" class="m-doc">LocalToWorld</a> components are updated with the information from the <a href="structPosition.html" class="m-doc">Position</a>, <a href="structcubos_1_1engine_1_1Rotation.html" class="m-doc">Rotation</a> and <a href="structcubos_1_1engine_1_1Scale.html" class="m-doc">Scale</a> components.</li></ul></section>
<section id="files">
<h2><a href="#files">Files</a></h2>
<dl class="m-doc">
Expand Down
6 changes: 3 additions & 3 deletions group__voxels-plugin.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ <h1>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li><a href="#autotoc_md93">Bridges</a></li>
<li><a href="#autotoc_md94">Dependencies</a></li>
<li><a href="#autotoc_md94">Bridges</a></li>
<li><a href="#autotoc_md95">Dependencies</a></li>
<li>
Reference
<ul>
Expand All @@ -61,7 +61,7 @@ <h3>Contents</h3>
</li>
</ul>
</nav>
<section id="autotoc_md93"><h3><a href="#autotoc_md93">Bridges</a></h3><ul><li><a href="classcubos_1_1engine_1_1BinaryBridge.html" class="m-doc">BinaryBridge</a> - registered with the <code>.grd</code> extension, loads <a href="classcubos_1_1core_1_1gl_1_1Grid.html" class="m-doc">cubos::<wbr />core::<wbr />gl::<wbr />Grid</a> assets.</li><li><a href="classcubos_1_1engine_1_1BinaryBridge.html" class="m-doc">BinaryBridge</a> - registered with the <code>.pal</code> extension, loads <a href="classcubos_1_1core_1_1gl_1_1Palette.html" class="m-doc">cubos::<wbr />core::<wbr />gl::<wbr />Palette</a> assets.</li></ul></section><section id="autotoc_md94"><h3><a href="#autotoc_md94">Dependencies</a></h3><ul><li><a href="group__assets-plugin.html" class="m-doc">Assets</a></li></ul></section>
<section id="autotoc_md94"><h3><a href="#autotoc_md94">Bridges</a></h3><ul><li><a href="classcubos_1_1engine_1_1BinaryBridge.html" class="m-doc">BinaryBridge</a> - registered with the <code>.grd</code> extension, loads <a href="classcubos_1_1core_1_1gl_1_1Grid.html" class="m-doc">cubos::<wbr />core::<wbr />gl::<wbr />Grid</a> assets.</li><li><a href="classcubos_1_1engine_1_1BinaryBridge.html" class="m-doc">BinaryBridge</a> - registered with the <code>.pal</code> extension, loads <a href="classcubos_1_1core_1_1gl_1_1Palette.html" class="m-doc">cubos::<wbr />core::<wbr />gl::<wbr />Palette</a> assets.</li></ul></section><section id="autotoc_md95"><h3><a href="#autotoc_md95">Dependencies</a></h3><ul><li><a href="group__assets-plugin.html" class="m-doc">Assets</a></li></ul></section>
<section id="files">
<h2><a href="#files">Files</a></h2>
<dl class="m-doc">
Expand Down
Loading

0 comments on commit 4256c93

Please sign in to comment.