deploy: dc686ce

GameDevTecnico · Feb 11, 2024 · e1faa9f · e1faa9f
1 parent 0b4e65f
commit e1faa9f
Show file tree

Hide file tree

Showing 21 changed files with 97 additions and 84 deletions.
diff --git a/docs/controller_8hpp.html b/docs/controller_8hpp.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>engine/utils/free_camera_controller/controller.hpp file | CUBOS. Docs</title>
+  <title>engine/utils/free_camera/controller.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" />
@@ -46,7 +46,7 @@
     <div class="m-row">
       <div class="m-col-l-10 m-push-l-1">
         <h1>
-          <span class="m-breadcrumb"><a href="dir_bafb7af0e03e95b24a45ff63060ab57b.html">engine</a>/</span><span class="m-breadcrumb"><a href="dir_20045a2d36300afa8be5b259d598f1fc.html">utils</a>/</span><span class="m-breadcrumb"><a href="dir_4157c777a146e020408c4ca4ac982bb6.html">free_camera_controller</a>/</span>controller.hpp <span class="m-thin">file</span>
+          <span class="m-breadcrumb"><a href="dir_bafb7af0e03e95b24a45ff63060ab57b.html">engine</a>/</span><span class="m-breadcrumb"><a href="dir_20045a2d36300afa8be5b259d598f1fc.html">utils</a>/</span><span class="m-breadcrumb"><a href="dir_6e7fefd5d33489e77ed24a475a1b2d04.html">free_camera</a>/</span>controller.hpp <span class="m-thin">file</span>
         </h1>
         <p>Component <a href="structcubos_1_1engine_1_1FreeCameraController.html" class="m-doc">cubos::<wbr />engine::<wbr />FreeCameraController</a>.</p>
         <nav class="m-block m-default">

diff --git a/...dir_4157c777a146e020408c4ca4ac982bb6.html → ...dir_6e7fefd5d33489e77ed24a475a1b2d04.html b/...dir_4157c777a146e020408c4ca4ac982bb6.html → ...dir_6e7fefd5d33489e77ed24a475a1b2d04.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>engine/utils/free_camera_controller/ directory | CUBOS. Docs</title>
+  <title>engine/utils/free_camera/ directory | 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" />
@@ -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_bafb7af0e03e95b24a45ff63060ab57b.html">engine</a>/</span><span class="m-breadcrumb"><a href="dir_20045a2d36300afa8be5b259d598f1fc.html">utils</a>/</span>free_camera_controller<span class="m-breadcrumb">/</span> <span class="m-thin">directory</span>
+          <span class="m-breadcrumb"><a href="dir_bafb7af0e03e95b24a45ff63060ab57b.html">engine</a>/</span><span class="m-breadcrumb"><a href="dir_20045a2d36300afa8be5b259d598f1fc.html">utils</a>/</span>free_camera<span class="m-breadcrumb">/</span> <span class="m-thin">directory</span>
         </h1>
-        <p><a href="group__free-camera-controller-plugin.html" class="m-doc">FreeCameraController</a> plugin directory.</p>
+        <p><a href="group__free-camera-plugin.html" class="m-doc">Free Camera</a> plugin directory.</p>
         <nav class="m-block m-default">
           <h3>Contents</h3>
           <ul>
@@ -65,7 +65,7 @@ <h2><a href="#files">Files</a></h2>
           <dl class="m-doc">
             <dt>file <a href="controller_8hpp.html" class="m-doc">controller.hpp</a></dt>
             <dd>Component <a href="structcubos_1_1engine_1_1FreeCameraController.html" class="m-doc">cubos::<wbr />engine::<wbr />FreeCameraController</a>.</dd>
-            <dt>file <a href="engine_2include_2cubos_2engine_2utils_2free__camera__controller_2plugin_8hpp.html" class="m-doc">plugin.hpp</a></dt>
+            <dt>file <a href="engine_2include_2cubos_2engine_2utils_2free__camera_2plugin_8hpp.html" class="m-doc">plugin.hpp</a></dt>
             <dd>Plugin entry point.</dd>
           </dl>
         </section>

diff --git a/...ree__camera__controller_2plugin_8hpp.html → ...ne_2utils_2free__camera_2plugin_8hpp.html b/...ree__camera__controller_2plugin_8hpp.html → ...ne_2utils_2free__camera_2plugin_8hpp.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>engine/utils/free_camera_controller/plugin.hpp file | CUBOS. Docs</title>
+  <title>engine/utils/free_camera/plugin.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" />
@@ -46,7 +46,7 @@
     <div class="m-row">
       <div class="m-col-l-10 m-push-l-1">
         <h1>
-          <span class="m-breadcrumb"><a href="dir_bafb7af0e03e95b24a45ff63060ab57b.html">engine</a>/</span><span class="m-breadcrumb"><a href="dir_20045a2d36300afa8be5b259d598f1fc.html">utils</a>/</span><span class="m-breadcrumb"><a href="dir_4157c777a146e020408c4ca4ac982bb6.html">free_camera_controller</a>/</span>plugin.hpp <span class="m-thin">file</span>
+          <span class="m-breadcrumb"><a href="dir_bafb7af0e03e95b24a45ff63060ab57b.html">engine</a>/</span><span class="m-breadcrumb"><a href="dir_20045a2d36300afa8be5b259d598f1fc.html">utils</a>/</span><span class="m-breadcrumb"><a href="dir_6e7fefd5d33489e77ed24a475a1b2d04.html">free_camera</a>/</span>plugin.hpp <span class="m-thin">file</span>
         </h1>
         <p>Plugin entry point.</p>
         <nav class="m-block m-default">
@@ -74,7 +74,7 @@ <h2><a href="#namespaces">Namespaces</a></h2>
           <h2><a href="#func-members">Functions</a></h2>
           <dl class="m-doc">
             <dt>
-              <span class="m-doc-wrap-bumper">void <a href="namespacecubos_1_1engine.html#a1f34045821152dc97988b63c424faaa3" class="m-doc">freeCameraControllerPlugin</a>(</span><span class="m-doc-wrap">Cubos&amp; cubos)</span>
+              <span class="m-doc-wrap-bumper">void <a href="group__free-camera-plugin.html#ga56048beedb26811cb07dfca88b5cd0e3" class="m-doc">freeCameraPlugin</a>(</span><span class="m-doc-wrap">Cubos&amp; cubos)</span>
             </dt>
             <dd>Plugin entry function.</dd>
           </dl>

diff --git a/docs/group__engine.html b/docs/group__engine.html
@@ -89,8 +89,8 @@ <h2><a href="#groups">Modules</a></h2>
             <dd>Adds viewport to all active cameras to achieve a splitscreen layout.</dd>
             <dt>module <a href="group__transform-plugin.html" class="m-doc">Transform</a></dt>
             <dd>Adds transform components which assign positions, rotations and scaling to entities.</dd>
-            <dt>module <a href="group__free-camera-controller-plugin.html" class="m-doc">FreeCameraController</a></dt>
-            <dd>Adds a free camera controller to the scene that accepts input and moves a camera accordingly.</dd>
+            <dt>module <a href="group__free-camera-plugin.html" class="m-doc">Free Camera</a></dt>
+            <dd>Adds the free camera controller component, which locks the mouse and moves an entity.</dd>
             <dt>module <a href="group__voxels-plugin.html" class="m-doc">Voxels</a></dt>
             <dd>Adds grid and palette assets to <strong>CUBOS</strong>.</dd>
             <dt>module <a href="group__window-plugin.html" class="m-doc">Window</a></dt>

diff --git a/...group__free-camera-controller-plugin.html → docs/group__free-camera-plugin.html b/...group__free-camera-controller-plugin.html → docs/group__free-camera-plugin.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8" />
-  <title>Engine &raquo; FreeCameraController module | CUBOS. Docs</title>
+  <title>Engine &raquo; Free Camera module | 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" />
@@ -47,41 +47,59 @@
       <div class="m-col-l-10 m-push-l-1">
         <h1>
           <span class="m-breadcrumb"><a href="group__engine.html">Engine</a> &raquo;</span>
-          FreeCameraController <span class="m-thin">module</span></h1>
-        <p>Adds a free camera controller to the scene that accepts input and moves a camera accordingly.</p>
+          Free Camera <span class="m-thin">module</span></h1>
+        <p>Adds the free camera controller component, which locks the mouse and moves an entity.</p>
         <nav class="m-block m-default">
           <h3>Contents</h3>
           <ul>
             <li><a href="#autotoc_md100">Components</a></li>
-            <li><a href="#autotoc_md101">Tags</a></li>
             <li>
               Reference
               <ul>
                 <li><a href="#files">Files</a></li>
-                <li><a href="#nested-classes">Classes</a></li>
+                <li><a href="#func-members">Functions</a></li>
               </ul>
             </li>
           </ul>
         </nav>
-<p>This plugin operates on entities with a <a href="structcubos_1_1engine_1_1Camera.html" class="m-doc">Camera</a> component.</p><aside class="m-note m-info"><h4>Note</h4><p>Any camera gets automatically a SimpleController component.</p></aside><section id="autotoc_md100"><h3><a href="#autotoc_md100">Components</a></h3><ul><li><a href="structcubos_1_1engine_1_1FreeCameraController.html" class="m-doc">FreeCameraController</a> - handles logic to move a camera.</li></ul></section><section id="autotoc_md101"><h3><a href="#autotoc_md101">Tags</a></h3><ul><li>???</li></ul></section>
+<section id="autotoc_md100"><h3><a href="#autotoc_md100">Components</a></h3><ul><li><a href="structcubos_1_1engine_1_1FreeCameraController.html" class="m-doc">FreeCameraController</a> - handles logic to move a camera.</li></ul></section>
         <section id="files">
           <h2><a href="#files">Files</a></h2>
           <dl class="m-doc">
-            <dt>file <a href="controller_8hpp.html" class="m-doc">controller.hpp</a></dt>
-            <dd>Component <a href="structcubos_1_1engine_1_1FreeCameraController.html" class="m-doc">cubos::<wbr />engine::<wbr />FreeCameraController</a>.</dd>
-            <dt>file <a href="engine_2include_2cubos_2engine_2utils_2free__camera__controller_2plugin_8hpp.html" class="m-doc">plugin.hpp</a></dt>
+            <dt>file <a href="engine_2include_2cubos_2engine_2utils_2free__camera_2plugin_8hpp.html" class="m-doc">plugin.hpp</a></dt>
             <dd>Plugin entry point.</dd>
           </dl>
         </section>
-        <section id="nested-classes">
-          <h2><a href="#nested-classes">Classes</a></h2>
+        <section id="func-members">
+          <h2><a href="#func-members">Functions</a></h2>
           <dl class="m-doc">
             <dt>
-              struct <a href="structcubos_1_1engine_1_1FreeCameraController.html" class="m-doc">cubos::engine::FreeCameraController</a>
+              <span class="m-doc-wrap-bumper">void <a href="#ga56048beedb26811cb07dfca88b5cd0e3" class="m-doc">freeCameraPlugin</a>(</span><span class="m-doc-wrap">Cubos&amp; cubos)</span>
             </dt>
-            <dd>Component which moves the camera.</dd>
+            <dd>Plugin entry function.</dd>
           </dl>
         </section>
+        <section>
+          <h2>Function documentation</h2>
+          <section class="m-doc-details" id="ga56048beedb26811cb07dfca88b5cd0e3"><div>
+            <h3>
+              <span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga56048beedb26811cb07dfca88b5cd0e3" class="m-doc-self">freeCameraPlugin</a>(</span><span class="m-doc-wrap">Cubos&amp; cubos)</span></span>
+              <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="engine_2include_2cubos_2engine_2utils_2free__camera_2plugin_8hpp.html">&lt;engine/utils/free_camera/plugin.hpp&gt;</a></div>
+            </h3>
+            <p>Plugin entry function.</p>
+            <table class="m-table m-fullwidth m-flat">
+              <thead>
+                <tr><th colspan="2">Parameters</th></tr>
+              </thead>
+              <tbody>
+                <tr>
+                  <td style="width: 1%">cubos</td>
+                  <td><strong>CUBOS</strong>. main class</td>
+                </tr>
+              </tbody>
+            </table>
+          </div></section>
+        </section>
       </div>
     </div>
   </div>

diff --git a/docs/group__tesseratos-asset-explorer-plugin.html b/docs/group__tesseratos-asset-explorer-plugin.html
@@ -52,8 +52,8 @@ <h1>
         <nav class="m-block m-default">
           <h3>Contents</h3>
           <ul>
-            <li><a href="#autotoc_md110">Events</a></li>
-            <li><a href="#autotoc_md111">Dependencies</a></li>
+            <li><a href="#autotoc_md109">Events</a></li>
+            <li><a href="#autotoc_md110">Dependencies</a></li>
             <li>
               Reference
               <ul>
@@ -63,7 +63,7 @@ <h3>Contents</h3>
             </li>
           </ul>
         </nav>
-<section id="autotoc_md110"><h3><a href="#autotoc_md110">Events</a></h3><ul><li><a href="structtesseratos_1_1AssetSelectedEvent.html" class="m-doc">AssetSelectedEvent</a> - sent when an asset is selected in the explorer.</li></ul></section><section id="autotoc_md111"><h3><a href="#autotoc_md111">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__assets-plugin.html" class="m-doc">Assets</a></li><li><a href="group__tesseratos-toolbox-plugin.html" class="m-doc">Toolbox</a></li></ul></section>
+<section id="autotoc_md109"><h3><a href="#autotoc_md109">Events</a></h3><ul><li><a href="structtesseratos_1_1AssetSelectedEvent.html" class="m-doc">AssetSelectedEvent</a> - sent when an asset is selected in the explorer.</li></ul></section><section id="autotoc_md110"><h3><a href="#autotoc_md110">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__assets-plugin.html" class="m-doc">Assets</a></li><li><a href="group__tesseratos-toolbox-plugin.html" class="m-doc">Toolbox</a></li></ul></section>
         <section id="files">
           <h2><a href="#files">Files</a></h2>
           <dl class="m-doc">

diff --git a/docs/group__tesseratos-debug-camera-plugin.html b/docs/group__tesseratos-debug-camera-plugin.html
@@ -52,7 +52,7 @@ <h1>
         <nav class="m-block m-default">
           <h3>Contents</h3>
           <ul>
-            <li><a href="#autotoc_md112">Dependencies</a></li>
+            <li><a href="#autotoc_md111">Dependencies</a></li>
             <li>
               Reference
               <ul>
@@ -62,7 +62,7 @@ <h3>Contents</h3>
             </li>
           </ul>
         </nav>
-<section id="autotoc_md112"><h3><a href="#autotoc_md112">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__renderer-plugin.html" class="m-doc">Renderer</a></li><li><a href="group__tesseratos-toolbox-plugin.html" class="m-doc">Toolbox</a></li></ul></section>
+<section id="autotoc_md111"><h3><a href="#autotoc_md111">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__renderer-plugin.html" class="m-doc">Renderer</a></li><li><a href="group__tesseratos-toolbox-plugin.html" class="m-doc">Toolbox</a></li></ul></section>
         <section id="files">
           <h2><a href="#files">Files</a></h2>
           <dl class="m-doc">

diff --git a/docs/group__tesseratos-entity-inspector-plugin.html b/docs/group__tesseratos-entity-inspector-plugin.html
@@ -52,7 +52,7 @@ <h1>
         <nav class="m-block m-default">
           <h3>Contents</h3>
           <ul>
-            <li><a href="#autotoc_md113">Dependencies</a></li>
+            <li><a href="#autotoc_md112">Dependencies</a></li>
             <li>
               Reference
               <ul>
@@ -62,7 +62,7 @@ <h3>Contents</h3>
             </li>
           </ul>
         </nav>
-<aside class="m-note m-info"><h4>Note</h4><p>The selected entity is identified by the <a href="structtesseratos_1_1EntitySelector.html" class="m-doc">EntitySelector</a> resource.</p></aside><section id="autotoc_md113"><h3><a href="#autotoc_md113">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__tesseratos-entity-selector-plugin.html" class="m-doc">Entity selector</a></li><li><a href="group__tesseratos-toolbox-plugin.html" class="m-doc">Toolbox</a></li></ul></section>
+<aside class="m-note m-info"><h4>Note</h4><p>The selected entity is identified by the <a href="structtesseratos_1_1EntitySelector.html" class="m-doc">EntitySelector</a> resource.</p></aside><section id="autotoc_md112"><h3><a href="#autotoc_md112">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__tesseratos-entity-selector-plugin.html" class="m-doc">Entity selector</a></li><li><a href="group__tesseratos-toolbox-plugin.html" class="m-doc">Toolbox</a></li></ul></section>
         <section id="files">
           <h2><a href="#files">Files</a></h2>
           <dl class="m-doc">

diff --git a/docs/group__tesseratos-entity-selector-plugin.html b/docs/group__tesseratos-entity-selector-plugin.html
@@ -52,10 +52,10 @@ <h1>
         <nav class="m-block m-default">
           <h3>Contents</h3>
           <ul>
-            <li><a href="#autotoc_md114">Resources</a></li>
-            <li><a href="#autotoc_md115">Startup tags</a></li>
-            <li><a href="#autotoc_md116">Tags</a></li>
-            <li><a href="#autotoc_md117">Dependencies</a></li>
+            <li><a href="#autotoc_md113">Resources</a></li>
+            <li><a href="#autotoc_md114">Startup tags</a></li>
+            <li><a href="#autotoc_md115">Tags</a></li>
+            <li><a href="#autotoc_md116">Dependencies</a></li>
             <li>
               Reference
               <ul>
@@ -65,7 +65,7 @@ <h3>Contents</h3>
             </li>
           </ul>
         </nav>
-<p>This plugins exists to reduce coupling between plugins. For example, a plugin which allows selecting entities through a ImGui window only needs to depend on this plugin, instead of having to know about all the plugins which care about it. The same applies in the other direction.</p><section id="autotoc_md114"><h3><a href="#autotoc_md114">Resources</a></h3><ul><li><a href="structtesseratos_1_1EntitySelector.html" class="m-doc">EntitySelector</a> - identifies the currently selected entity.</li></ul></section><section id="autotoc_md115"><h3><a href="#autotoc_md115">Startup tags</a></h3><ul><li><code>cubos.entitySelector.init</code> - the <a href="structtesseratos_1_1EntitySelector.html" class="m-doc">EntitySelector</a> resource is initialized</li></ul></section><section id="autotoc_md116"><h3><a href="#autotoc_md116">Tags</a></h3><ul><li><code>cubos.entitySelector.input</code> - entity selection is handled, after <code>cubos.window.poll</code> and <code>cubos.renderer.draw</code></li></ul></section><section id="autotoc_md117"><h3><a href="#autotoc_md117">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__screen-picker-plugin.html" class="m-doc">ScreenPicker</a></li><li><a href="group__window-plugin.html" class="m-doc">Window</a></li></ul></section>
+<p>This plugins exists to reduce coupling between plugins. For example, a plugin which allows selecting entities through a ImGui window only needs to depend on this plugin, instead of having to know about all the plugins which care about it. The same applies in the other direction.</p><section id="autotoc_md113"><h3><a href="#autotoc_md113">Resources</a></h3><ul><li><a href="structtesseratos_1_1EntitySelector.html" class="m-doc">EntitySelector</a> - identifies the currently selected entity.</li></ul></section><section id="autotoc_md114"><h3><a href="#autotoc_md114">Startup tags</a></h3><ul><li><code>cubos.entitySelector.init</code> - the <a href="structtesseratos_1_1EntitySelector.html" class="m-doc">EntitySelector</a> resource is initialized</li></ul></section><section id="autotoc_md115"><h3><a href="#autotoc_md115">Tags</a></h3><ul><li><code>cubos.entitySelector.input</code> - entity selection is handled, after <code>cubos.window.poll</code> and <code>cubos.renderer.draw</code></li></ul></section><section id="autotoc_md116"><h3><a href="#autotoc_md116">Dependencies</a></h3><ul><li><a href="group__imgui-plugin.html" class="m-doc">ImGui integration</a></li><li><a href="group__screen-picker-plugin.html" class="m-doc">ScreenPicker</a></li><li><a href="group__window-plugin.html" class="m-doc">Window</a></li></ul></section>
         <section id="files">
           <h2><a href="#files">Files</a></h2>
           <dl class="m-doc">