- engine /utils // directory
+ engine /utils // directory
-
FreeCameraController plugin directory.
+
Free Camera plugin directory.
Contents
@@ -65,7 +65,7 @@
file controller.hpp
Component cubos:: .
- file plugin.hpp
+ file plugin.hpp
Plugin entry point.
diff --git a/docs-preview/pr-954/dir_85f1b5bc6fb8e602e74068211760bfae.html b/docs-preview/pr-954/dir_85f1b5bc6fb8e602e74068211760bfae.html
index 5786aea25..e1a4f8c93 100644
--- a/docs-preview/pr-954/dir_85f1b5bc6fb8e602e74068211760bfae.html
+++ b/docs-preview/pr-954/dir_85f1b5bc6fb8e602e74068211760bfae.html
@@ -71,8 +71,12 @@
Utilities for cubos:: .
file dictionary.hpp
Class cubos:: .
+ file enum.hpp
+ Class cubos:: .
file fields.hpp
Class cubos:: .
+ file mask.hpp
+ Class cubos:: .
file nullable.hpp
Class cubos:: .
file string_conversion.hpp
diff --git a/docs-preview/pr-954/engine_2include_2cubos_2engine_2utils_2free__camera__controller_2plugin_8hpp.html b/docs-preview/pr-954/engine_2include_2cubos_2engine_2utils_2free__camera_2plugin_8hpp.html
similarity index 92%
rename from docs-preview/pr-954/engine_2include_2cubos_2engine_2utils_2free__camera__controller_2plugin_8hpp.html
rename to docs-preview/pr-954/engine_2include_2cubos_2engine_2utils_2free__camera_2plugin_8hpp.html
index 75d507f3f..9a6c7260a 100644
--- a/docs-preview/pr-954/engine_2include_2cubos_2engine_2utils_2free__camera__controller_2plugin_8hpp.html
+++ b/docs-preview/pr-954/engine_2include_2cubos_2engine_2utils_2free__camera_2plugin_8hpp.html
@@ -2,7 +2,7 @@
engine/utils/free_camera_controller/plugin.hpp file | CUBOS. Docs
+ engine/utils/free_camera/plugin.hpp file | CUBOS. Docs
Plugin entry point.
@@ -74,7 +74,7 @@
- void freeCameraControllerPlugin ( Cubos& cubos)
+ void freeCameraPlugin ( Cubos& cubos)
Plugin entry function.
diff --git a/docs-preview/pr-954/group__free-camera-controller-plugin.html b/docs-preview/pr-954/enum_8hpp.html
similarity index 75%
rename from docs-preview/pr-954/group__free-camera-controller-plugin.html
rename to docs-preview/pr-954/enum_8hpp.html
index ccd5d15ea..b2c22db87 100644
--- a/docs-preview/pr-954/group__free-camera-controller-plugin.html
+++ b/docs-preview/pr-954/enum_8hpp.html
@@ -2,7 +2,7 @@
Engine » FreeCameraController module | CUBOS. Docs
+ core/reflection/traits/enum.hpp file | CUBOS. Docs
diff --git a/docs-preview/pr-954/examples-core-reflection-traits-mask.html b/docs-preview/pr-954/examples-core-reflection-traits-mask.html
new file mode 100644
index 000000000..b43d7451b
--- /dev/null
+++ b/docs-preview/pr-954/examples-core-reflection-traits-mask.html
@@ -0,0 +1,174 @@
+
+
+
+
+
Mask Trait | CUBOS. Docs
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Mask Trait
+
+
Exposing a bit mask type.
+
See also Full source code here .
In this example, we'll explore how to expose a bit mask along with its bits using cubos:: .
#include <cubos/core/reflection/reflect.hpp>
+
+enum class Permissions
+{
+ None = 0 ,
+
+ Read = 1 ,
+ Write = 2 ,
+ Execute = 4
+};
+
+inline Permissions operator ~ ( Permissions p )
+{
+ return static_cast < Permissions > ( ~ static_cast < int > ( p ));
+}
+
+inline Permissions operator | ( Permissions a , Permissions b )
+{
+ return static_cast < Permissions > ( static_cast < int > ( a ) | static_cast < int > ( b ));
+}
+
+inline Permissions operator & ( Permissions a , Permissions b )
+{
+ return static_cast < Permissions > ( static_cast < int > ( a ) & static_cast < int > ( b ));
+} #include <cubos/core/reflection/traits/mask.hpp>
+#include <cubos/core/reflection/type.hpp>
+
+using cubos :: core :: reflection :: MaskTrait ;
+using cubos :: core :: reflection :: Type ;
+
+template <>
+CUBOS_REFLECT_EXTERNAL_IMPL ( Permissions )
+{
+ return Type :: create ( "Permissions" )
+ . with ( MaskTrait {}
+ . withBit < Permissions :: Read > ( "Read" )
+ . withBit < Permissions :: Write > ( "Write" )
+ . withBit < Permissions :: Execute > ( "Execute" ));
+} Notice that we don't include the None type in the trait, as it doesn't correspond to a bit.
int main ()
+{
+ using cubos :: core :: reflection :: reflect ;
+
+ const auto & permissionsType = reflect < Permissions > ();
+ CUBOS_ASSERT ( permissionsType . has < MaskTrait > ());
+
+ const auto & mask = permissionsType . get < MaskTrait > ();
+ CUBOS_ASSERT ( mask . contains ( "Read" ));
+ CUBOS_ASSERT ( mask . contains ( "Write" ));
+ CUBOS_ASSERT ( mask . contains ( "Execute" ));
+ CUBOS_ASSERT ( ! mask . contains ( "None" ));
+
+ auto p = Permissions :: Read | Permissions :: Write ;
+ CUBOS_ASSERT ( mask . view ( & p ). test ( "Read" ));
+ CUBOS_ASSERT ( mask . view ( & p ). test ( "Write" ));
+ CUBOS_ASSERT ( ! mask . view ( & p ). test ( "Execute" ));
+
+ for ( const auto & b : mask )
+ {
+ CUBOS_INFO ( "Type has bit {}" , b . name ());
+ }
+
+ for ( const auto & b : mask . view ( & p ))
+ {
+ CUBOS_INFO ( "Value has bit {} set" , b . name ());
+ }
+
+ return 0 ;
+} // Type has bit "Read"
+// Type has bit "Write"
+// Type has bit "Execute"
+// Value has bit "Read" set
+// Value has bit "Write" set
+
+
+
+
+
+
+
+
+
+
+
+
Unlike everything else in the docs, the search functionality requires JavaScript.
+
+
Search for symbols, directories, files, pages or
+ modules. You can omit any prefix from the symbol or file path; adding a
+ : or / suffix lists all members of given symbol or
+ directory.
+
Use ↓
+ / ↑ to navigate through the list,
+ Enter to go.
+ Tab autocompletes common prefix, you can
+ copy a link to the result using ⌘
+ L while ⌘
+ M produces a Markdown link.
+
+
Sorry, nothing was found.
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs-preview/pr-954/examples-engine-imgui.html b/docs-preview/pr-954/examples-engine-imgui.html
index cfd192c28..c94384920 100644
--- a/docs-preview/pr-954/examples-engine-imgui.html
+++ b/docs-preview/pr-954/examples-engine-imgui.html
@@ -103,12 +103,26 @@
struct DummyResource
{
+ CUBOS_REFLECT ;
+
int integer ;
Person person ;
std :: vector < Person > persons ;
std :: vector < int32_t > vec ;
std :: map < int32_t , int32_t > map ;
-}; cubos . addResource < DummyResource > (
+};
+
+CUBOS_REFLECT_IMPL ( DummyResource )
+{
+ return Type :: create ( "DummyResource" )
+ . with ( FieldsTrait ()
+ . withField ( "integer" , & DummyResource :: integer )
+ . withField ( "person" , & DummyResource :: person )
+ . withField ( "persons" , & DummyResource :: persons )
+ . withField ( "vec" , & DummyResource :: vec )
+ . withField ( "v" , & DummyResource :: map ))
+ . with ( ConstructibleTrait :: typed < Person > (). withDefaultConstructor (). build ());
+} cubos . addResource < DummyResource > (
DummyResource {. integer = 1337 ,
. person = Person { "roby" , 1337 , 666.5F , false },
. persons { Person { "roby" , 1337 , 666.5F , false }, Person { "riscado" , 123 , 321.0F , false }},
@@ -122,15 +136,7 @@
. tagged ( "cubos.imgui" )
. call ([]( DataInspector & inspector , DummyResource & data ) {
ImGui :: Begin ( "Data Inspector" );
- ImGui :: BeginTable ( "id1" , 2 );
-
- inspector . show ( "data.integer" , data . integer );
- inspector . edit ( "data.person" , data . person );
- inspector . edit ( "data.persons" , data . persons );
- inspector . edit ( "data.vec" , data . vec );
- inspector . edit ( "data.map" , data . map );
-
- ImGui :: EndTable ();
+ inspector . edit ( data );
ImGui :: End ();
}); You can find more about how to use Dear ImGui stuff here .
diff --git a/docs-preview/pr-954/examples-engine-input.html b/docs-preview/pr-954/examples-engine-input.html
index 34ccb642b..364b4b814 100644
--- a/docs-preview/pr-954/examples-engine-input.html
+++ b/docs-preview/pr-954/examples-engine-input.html
@@ -57,58 +57,43 @@
"keys": [
"Return"
],
- "gamepad": [
+ "gamepadButtons": [
"RBumper"
- ],
- "mouse": []
+ ]
},
"x-or-z": {
"keys": [
- "x",
- "z"
- ],
- "gamepad": [],
- "mouse": []
+ "X",
+ "Z"
+ ]
},
"shift-space": {
"keys": [
- "S-Space"
- ],
- "gamepad": [],
- "mouse": []
+ "Shift-Space"
+ ]
},
"ctrl-shift-space": {
"keys": [
- "C-S-Space"
- ],
- "gamepad": [],
- "mouse": []
+ "Control-Shift-Space"
+ ]
},
"left-mb": {
- "keys": [],
- "gamepad": [],
- "mouse": [
+ "mouseButtons": [
"Left"
]
},
"right-mb": {
- "keys": [],
- "gamepad": [],
- "mouse": [
+ "mouseButtons": [
"Right"
]
},
"middle-mb": {
- "keys": [],
- "gamepad": [],
- "mouse": [
+ "mouseButtons": [
"Middle"
]
},
"extra-mb": {
- "keys": [],
- "gamepad": [],
- "mouse": [
+ "mouseButtons": [
"Extra1",
"Extra2"
]
@@ -116,44 +101,44 @@
},
"axes": {
"vertical": {
- "pos": [
- "w",
+ "positive": [
+ "W",
"Up"
],
- "neg": [
- "s",
+ "negative": [
+ "S",
"Down"
],
- "gamepad": [
+ "gamepadAxes": [
"LY"
]
},
"horizontal": {
- "pos": [
- "d",
+ "positive": [
+ "D",
"Right"
],
- "neg": [
- "a",
+ "negative": [
+ "A",
"Left"
],
- "gamepad": [
+ "gamepadAxes": [
"LX"
]
},
"shift-vertical": {
- "pos": [
- "S-w",
- "S-Up"
+ "positive": [
+ "Shift-W",
+ "Shift-Up"
],
- "neg": [
- "S-s",
- "S-Down"
+ "negative": [
+ "Shift-S",
+ "Shift-Down"
],
- "gamepad": []
+ "gamepadAxes": []
}
}
-} There are two types of bindings: actions and axes. An action is an input that only has two states: pressed or not pressed. This would be most keys on a keyboard. An axe is an input that has a numeric value. For example, the joysticks on a controller can go from -1 to 1, depending on how much they are tilt in which direction. Using axes can also be useful for keys with symetric behaviour. For example, in this sample, w sets the vertical axe to 1, while s sets it to -1.
To define an action or an axe, you simply have to add it to the respective list, giving it a name. The very first action in the file is called next-showcase. Then, if it's an action, you simply have to define which keys trigger it. You can also define key combinations by using a -. To check which strings map to which keys, you check the keyToString function implementation on this file .
Now that we have our bindings file, let's get our application to do something with it. The first thing we're going to need is a reference to the bindings asset. For the purposes of this sample we can simply use an hardcoded reference to the asset.
static const Asset < InputBindings > BindingsAsset = AnyAsset ( "bf49ba61-5103-41bc-92e0-8a442d7842c3" ); To utilize the bindings, loading them is essential. This can be accomplished by establishing a startup systems which reads from the asset and sets the required bindings.
cubos . startupSystem ( "load and set the Input Bindings" )
+}There are two types of bindings: actions and axes. An action is an input that only has two states: pressed or not pressed. This would be most keys on a keyboard. An axe is an input that has a numeric value. For example, the joysticks on a controller can go from -1 to 1, depending on how much they are tilt in which direction. Using axes can also be useful for keys with symmetric behaviour. For example, in this sample, W sets the vertical axe to 1, while S sets it to -1.
To define an action or an axe, you simply have to add it to the respective list, giving it a name. The very first action in the file is called next-showcase. Then, if it's an action, you simply have to define which keys trigger it. You can also define key combinations by using a -. To check which strings map to which keys, you check the names of the variants of the enums Key and Modifier on this file .
Now that we have our bindings file, let's get our application to do something with it. The first thing we're going to need is a reference to the bindings asset. For the purposes of this sample we can simply use an hardcoded reference to the asset.
static const Asset < InputBindings > BindingsAsset = AnyAsset ( "bf49ba61-5103-41bc-92e0-8a442d7842c3" ); To utilize the bindings, loading them is essential. This can be accomplished by establishing a startup systems which reads from the asset and sets the required bindings.
cubos . startupSystem ( "load and set the Input Bindings" )
. tagged ( "cubos.assets" )
. call ([]( const Assets & assets , Input & input ) {
auto bindings = assets . read < InputBindings > ( BindingsAsset );
@@ -198,7 +183,7 @@
{
CUBOS_INFO ( "Shift" );
}
-} Getting modified input (such as with a CTRL or a SHIFT hold) is no different from getting non-modified input, just make sure the binding for it is defined in the Bindings asset.
static void showcaseMultipleModifiers ( const Input & input , bool & explained )
+} Getting modified input (such as with a Control or a Shift hold) is no different from getting non-modified input, just make sure the binding for it is defined in the Bindings asset.
static void showcaseMultipleModifiers ( const Input & input , bool & explained )
{
if ( ! explained )
{
@@ -277,7 +262,7 @@
{
CUBOS_INFO ( "Extra1 or Extra2" );
}
-} Reading mouse buttons is also supported, just bind them to an action, and then call Input:: as usual. To check which strings map to which buttons, you check the mouseButtonToString function implementation on this file .
+} Reading mouse buttons is also supported, just bind them to an action, and then call Input:: as usual. To check which strings map to which buttons, you check the names of the variants of the enum MouseButton on this file .
diff --git a/docs-preview/pr-954/examples-engine-scene.html b/docs-preview/pr-954/examples-engine-scene.html
index 7c521f5be..298b0132e 100644
--- a/docs-preview/pr-954/examples-engine-scene.html
+++ b/docs-preview/pr-954/examples-engine-scene.html
@@ -83,12 +83,12 @@
"sub1": "cd007ba2-ee0d-44fd-bf36-85c829dbe66f",
"sub2": "cd007ba2-ee0d-44fd-bf36-85c829dbe66f"
}
-} This file imports the asset with id cd007ba2-ee0d-44fd-bf36-85c829dbe66f, which is the scene we looked at in the previous file, under the name sub1. It then imports the very same scene again, but this time with the name sub2 instead. This effectively instantiates the entities of the previous scene twice in this new scene, each with their names prefixed with either sub1. or sub2.
Also take a look at the DistanceTo relation: it is a symmetric relation, so it doesn't make a different whether wwe put it in sub.root or sub2.root. Since DistanceTo is a relation which holds data, instead of only specifying the target, as we do with OwnedBy, we write a JSON object with a key, "value".
Under entities, we can override the entities in the sub-scenes to edit components or add new ones. For example, by referencing sub1.root we are making local changes to the root entity of that instance of the subscene. The result of the changes we make to both sub1.root and sub2.root is that the owner of these entities will be set to be the main entity.
Now that we have our scene file, let's get our application to load it. The first thing we're going to need is a reference to the scene asset. For the purposes of this sample we can simply use an hardcoded reference to the asset.
static const Asset < Scene > SceneAsset = AnyAsset ( "f0d86ba8-5f34-440f-a180-d9d12c8e8b91" ); Then we'll need a system that spawns that scene. To do this we simply get the Scene object from the asset, and then spawn its entities. Commands:: will create in the world a copy of every entity defined in the scene's blueprint. It won't remove the entities already there, so if you want to close a scene, you'll have to do it yourself.
cubos . startupSystem ( "spawn the scene" )
+}This file imports the asset with id cd007ba2-ee0d-44fd-bf36-85c829dbe66f, which is the scene we looked at in the previous file, under the name sub1. It then imports the very same scene again, but this time with the name sub2 instead. This effectively instantiates the entities of the previous scene twice in this new scene, each with their names prefixed with either sub1. or sub2.
Also take a look at the DistanceTo relation: it is a symmetric relation, so it doesn't make a different whether wwe put it in sub.root or sub2.root. Since DistanceTo is a relation which holds data, instead of only specifying the target, as we do with OwnedBy, we write a JSON object with a key, "value".
Under entities, we can override the entities in the sub-scenes to edit components or add new ones. For example, by referencing sub1.root we are making local changes to the root entity of that instance of the subscene. The result of the changes we make to both sub1.root and sub2.root is that the owner of these entities will be set to be the main entity.
Now that we have our scene file, let's get our application to load it. The first thing we're going to need is a reference to the scene asset. For the purposes of this sample we can simply use an hardcoded reference to the asset.
static const Asset < Scene > SceneAsset = AnyAsset ( "f0d86ba8-5f34-440f-a180-d9d12c8e8b91" ); Then we'll need a system that spawns that scene. To do this we simply get the Scene object from the asset, and then spawn its entities. Commands:: will create in the world a copy of every entity defined in the scene's blueprint. It won't remove the entities already there, so if you want to close a scene, you'll have to do it yourself.
cubos . startupSystem ( "spawn the scene" )
. tagged ( "spawn" )
. tagged ( "cubos.assets" )
. call ([]( Commands commands , const Assets & assets ) {
auto sceneRead = assets . read ( SceneAsset );
- commands . spawn ( sceneRead -> blueprint , true );
+ commands . spawn ( sceneRead -> blueprint );
}); In this case, we'll run this system at startup, since we want to spawn it a single time. Since it's a startup system, we'll have to tag it with cubos.assets to make sure it runs only after the scene bridge has been registered. On a real game, you could have, for example, a scene for an enemy which you spawn multiple times, instead of just once at startup.
cubos . startupSystem ( "print the scene" )
. after ( "spawn" )
. call ([]( Query < Entity , const Num &> numQuery , Query < const OwnedBy & , Entity > ownedByQuery ,
diff --git a/docs-preview/pr-954/files.html b/docs-preview/pr-954/files.html
index 648ca7cb4..d3b91178d 100644
--- a/docs-preview/pr-954/files.html
+++ b/docs-preview/pr-954/files.html
@@ -231,7 +231,9 @@ Files
file constructible.hpp Class cubos:: .
file constructible_utils.hpp Utilities for cubos:: .
file dictionary.hpp Class cubos:: .
+
file enum.hpp Class cubos:: .
file fields.hpp Class cubos:: .
+
file mask.hpp Class cubos:: .
file nullable.hpp Class cubos:: .
file string_conversion.hpp Class cubos:: .
diff --git a/docs-preview/pr-954/group__core-io.html b/docs-preview/pr-954/group__core-io.html
index d6bf26b20..fa825f549 100644
--- a/docs-preview/pr-954/group__core-io.html
+++ b/docs-preview/pr-954/group__core-io.html
@@ -88,6 +88,10 @@
struct
cubos::core::io::GamepadState
Holds the state of a gamepad.
+
+ struct cubos::core::io::KeyWithModifiers
+
+
Keyboard key code and modifier flags.
struct cubos::core::io::KeyEvent
@@ -326,22 +330,6 @@
auto stringToGamepadAxis ( const std::string& str) -> GamepadAxis
Convert a string to a GamepadAxis .
-
- auto modifiersToString ( Modifiers modifiers) -> std::string
-
-
Converts a Modifiers enum to a string.
-
- auto stringToModifiers ( const std::string& str) -> Modifiers
-
-
Converts a string to a Modifiers enum.
-
- auto keyToString ( Key key) -> std::string
-
-
Converts a Key enum to a string.
-
- auto stringToKey ( const std::string& str) -> Key
-
-
Convert a string to a Key enum.
auto openWindow ( const std::string& title = "CUBOS.",
const glm::ivec2& size = {800, 600}) -> Window
@@ -584,102 +572,6 @@