+
+
+
+
+
+
+
+  |
+
+
+
+ $projectname
+ $projectnumber
+
+
+
+ $projectbrief
+
+ |
+
+
+
+
+ $projectbrief
+ |
+
+
+
+
+
+ $searchbox |
+
+
+
+
+
+
+
+ | $searchbox |
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/engine.sublime-project b/engine.sublime-project
new file mode 100644
index 0000000..1466f8e
--- /dev/null
+++ b/engine.sublime-project
@@ -0,0 +1,49 @@
+{
+ "folders":
+ [
+ {
+ "path": "."
+ }
+ ],
+ "settings":
+ {
+ "tab_size": 4
+ },
+ "build_systems": [
+ {
+ "name": "Build engine",
+ "shell_cmd": "cmake --build build",
+ "working_dir": "$project_path",
+ "variants": [
+ {
+ "name": "Debug",
+ "shell_cmd": "cmake -DCMAKE_BUILD_TYPE=Debug build && cmake --build build",
+ },
+ {
+ "name": "Release",
+ "shell_cmd": "cmake -DCMAKE_BUILD_TYPE=Release build && cmake --build build",
+ },
+ ]
+ },
+ {
+ "name": "Generate CMake",
+ "shell_cmd": "cmake -S . -B build",
+ "working_dir": "$project_path",
+ },
+ {
+ "name": "Doxygen",
+ "shell_cmd": "xdg-open $project_path/docs/html/index.html",
+ "working_dir": "$project_path",
+ "variants": [
+ {
+ "name": "Build image",
+ "shell_cmd": "docker build -t vego_engine-docker $project_path/docs/docker",
+ },
+ {
+ "name": "Generate documentation",
+ "shell_cmd": "docker run --rm -v \"$project_path:/source\" -v \"$project_path/docs:/output\" -v \"$project_path/docs/Doxyfile:/Doxyfile\" vego_engine-docker",
+ },
+ ]
+ }
+ ]
+}
diff --git a/extern/tmxlite b/extern/tmxlite
new file mode 160000
index 0000000..fcef1a2
--- /dev/null
+++ b/extern/tmxlite
@@ -0,0 +1 @@
+Subproject commit fcef1a28ade8406e290d5fd168a8950e6996844f
diff --git a/include/CollisionHandler.h b/include/CollisionHandler.h
index 41993fb..9802f7d 100644
--- a/include/CollisionHandler.h
+++ b/include/CollisionHandler.h
@@ -1,5 +1,9 @@
#pragma once
+//! \file CollisionHandler.h
+//! \file CollisionHandler.cpp
+//! \file TransformComponent.cpp
+
#include "ColliderComponent.h"
#include "Constants.h"
#include "Entity.h"
@@ -17,9 +21,11 @@
class ColliderComponent;
class Entity;
+// [IntersectionBitSet]
constexpr uint8_t DIRECTION_C = 4;
using IntersectionBitSet = std::bitset
;
+// [IntersectionBitSet]
class CollisionHandler
{
@@ -46,6 +52,20 @@ public:
std::initializer_list const& groupLabels,
std::initializer_list const& excludedEntities = {});
+ /*!
+ *
+ * \brief Tests entity against all entities with the specified labels for a collision
+ * \details Tests the given entity against every other entity with the specified labels for intersections between their collison boxes.
+ * If the primary entity has no ColliderComponent, the equivalent of no collision is returned immediately, other entities are skipped
+ * if they don't have a ColliderComponent
+ * \param entity The primary entity to check against. Return values will be relative to this entity
+ * \param posMod Modifier to apply toposition before checking collisions.
+ * \param groupLabels Entities need to have at least one listed GroupLabels to get checked against
+ * \param teamLabels Entities need to have one of the specified TeamLabels to get checked against
+ * \param negateTeam If set to true, entities will only be checked against if they **don't** have one of the specified TeamLabels
+ * \see ColliderComponent
+ *
+ */
template
T getAnyIntersection(
Entity* entity,
diff --git a/include/Component.h b/include/Component.h
index 095b370..566fee9 100644
--- a/include/Component.h
+++ b/include/Component.h
@@ -9,7 +9,6 @@ public:
virtual void init() {}
virtual void update() {}
- virtual void draw() {}
virtual ~Component() = default;
};
\ No newline at end of file
diff --git a/include/Entity.h b/include/Entity.h
index 073b65d..aa067a4 100644
--- a/include/Entity.h
+++ b/include/Entity.h
@@ -22,29 +22,48 @@ using ComponentBitSet = std::bitset;
using GroupBitSet = std::bitset;
using ComponentArray = std::array;
+/*!
+ *
+ * \brief Main class for any object in game, stores associations, labeling and components
+ * \details The entity class is the primary class each object in the game needs to use. Add components to assign functionality.
+ *
+ * \todo More detailed description
+ * \todo Some functions in entity class are only supposed to be called in specific context, which might be valid uses for `friend` keyword. Example: Entity() should only be called from Manager::addEntity(). Verify each functions intended use/scope.
+ *
+ */
class Entity
{
public:
-/*! TODO */
+ /*!
+ * \brief Used for rendering order (last is highest) or retrieving entities of group
+ * \todo Label used in singular entity shouldn't use plural
+ * \todo HEARTS are rendered above POWERUPS, missleading order
+ * \todo PROJECTILE are rendered above POWERUPS, missleading order
+ * \todo Generalize HEARTS as UI or similar
+ */
enum class GroupLabel
{
- MAPTILES,
- PLAYERS,
- ENEMIES,
- COLLIDERS,
- PROJECTILE,
- HEARTS,
- POWERUPS
+ MAPTILES, //!< Entity using TileComponent
+ PLAYERS, //!< Primary entity in player controll
+ ENEMIES, //!< \deprecated All players now grouped as Entity::PLAYERS
+ COLLIDERS, //!< Fixed collider entity, e.g. a wall
+ PROJECTILE, //!< \todo Document
+ HEARTS, //!< \todo Document
+ POWERUPS //!< \todo Document
};
+ /*!
+ * \todo Document
+ */
explicit Entity(Manager& mManager) :
manager(mManager) { };
- void update() const;
- void draw() const;
+ void update() const; //!< Call each frame to update all components
- bool isActive() const { return this->active; }
+ bool isActive() const { return this->active; } //!< \sa destroy()
+ //! Mark for destruction for Manager::refresh() and disables collision
+ //! \sa ColliderComponent
void destroy() {
this->active = false;
if (this->hasComponent()) {
@@ -52,18 +71,23 @@ public:
}
}
- bool hasGroup(Group mGroup);
- void addGroup(Group mGroup);
- void delGroup(Group mGroup);
+ bool hasGroup(Group mGroup); //!< \sa GroupLabel
+ void addGroup(Group mGroup); //!< \sa GroupLabel
+ void delGroup(Group mGroup); //!< \sa GroupLabel
+ //! \returns bitset with true on position GroupLabel if the entity belongs to group
+ //! \sa GroupLabel
std::bitset getGroupBitSet();
+ //! \sa Manager
Manager& getManager() { return manager; };
- template bool hasComponent() const
+ template bool hasComponent() const //! \sa Component
{
return componentBitSet[getComponentTypeID()];
}
+ //! \brief Adds specified type as component and calls Component::init()
+ //! \param mArgs Constructor arguments of component
template T& addComponent(TArgs&&...mArgs)
{
T* c(new T(std::forward(mArgs)...));
@@ -78,7 +102,7 @@ public:
return *c;
};
- template T& getComponent() const
+ template T& getComponent() const //! \returns Component of type T
{
auto ptr(componentArray[getComponentTypeID()]);
return *static_cast(ptr);
diff --git a/include/GameInternal.h b/include/GameInternal.h
index e300f2f..44cec2d 100644
--- a/include/GameInternal.h
+++ b/include/GameInternal.h
@@ -9,6 +9,7 @@
#include "Manager.h"
#include "Vector2D.h"
#include "Entity.h"
+#include "RenderManager.h"
typedef std::function gamefunction;
@@ -42,8 +43,8 @@ public:
/* static */ TextureManager* textureManager;
/* static */ SoundManager* soundManager;
- // moved globals
Manager manager;
+ RenderManager renderManager;
Map* map; // game specific, might not be needed for all types of games
std::vector& tiles;
diff --git a/include/GameObject.h b/include/GameObject.h
deleted file mode 100644
index 1c209ae..0000000
--- a/include/GameObject.h
+++ /dev/null
@@ -1,21 +0,0 @@
-#pragma once
-#include
-
-class GameObject
-{
-public:
- GameObject(const char* texturesheet, int x, int y);
- ~GameObject() = default;
-
- void update();
- void render();
-
-private:
- int xPos;
- int yPos;
-
- SDL_Texture* objTexture;
- SDL_Rect srcRect;
- SDL_Rect destRect;
-};
-
diff --git a/include/Manager.h b/include/Manager.h
index 3282d9d..8b9ceb3 100644
--- a/include/Manager.h
+++ b/include/Manager.h
@@ -10,21 +10,31 @@
#include "Entity.h"
class GameInternal;
+/*!
+ *
+ * \brief Is responsible for managing all entities
+ * \details The manager class handles update and draw calls collectively for all entities, and provides functionality to get all or a subset of all entities
+ * \sa Entity
+ * \sa Entity::GroupLabel
+ * \sa Entity::TeamLabel
+ *
+ */
class Manager
{
public:
Manager(GameInternal* game) : game(game) {};
- void update();
- void draw();
+ void update(); //!< \sa Entity::update()
+ //! Disables all functionality of entities marked for destruction
+ //! \sa Entity::destroy()
void refresh();
- void addToGroup(Entity* mEntity, Group mGroup);
- std::vector& getGroup(Group mGroup);
+ void addToGroup(Entity* mEntity, Group mGroup); //!< \todo `friend` to Entity
+ std::vector& getGroup(Group mGroup); //!< \returns std::vector containing all entities in group Entity::GroupLabel
- std::vector getAll();
+ std::vector getAll(); //!< \returns std::vector containing all entities
- Entity& addEntity();
+ Entity& addEntity(); //!< Creates and returns a new, empty entity
GameInternal* getGame() { return this->game; };
diff --git a/include/Map.h b/include/Map.h
index 32184be..5e96186 100644
--- a/include/Map.h
+++ b/include/Map.h
@@ -1,27 +1,52 @@
#pragma once
-#include