+
+
+ ;
+// [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/Entity.h b/include/Entity.h
index 196a105..aa067a4 100644
--- a/include/Entity.h
+++ b/include/Entity.h
@@ -22,28 +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 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()) {
@@ -51,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)...));
@@ -77,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/Manager.h b/include/Manager.h
index bb2ad65..8b9ceb3 100644
--- a/include/Manager.h
+++ b/include/Manager.h
@@ -10,20 +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 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/TransformComponent.h b/include/TransformComponent.h
index bfe3160..7a15aa4 100644
--- a/include/TransformComponent.h
+++ b/include/TransformComponent.h
@@ -24,6 +24,7 @@ public:
TransformComponent(float x, float y, int w, int h, int scale);
void init() override;
+ /*! TODO: document usage of collision handler */
void update() override;
void setPositionAfterCollision(Vector2D& positionChange);
void modifySpeed(int8_t modifier);
diff --git a/src/CollisionHandler.cpp b/src/CollisionHandler.cpp
index 3e0eaec..5477c6c 100644
--- a/src/CollisionHandler.cpp
+++ b/src/CollisionHandler.cpp
@@ -109,6 +109,17 @@ std::vector CollisionHandler::getColliders(
return colliders;
}
+/*!
+ *
+ * \details Refer to getAnyIntersection() for more details
+ * \return A bitset of intersections, describing the directions of intersection. Position `Direction` in bitset true if edge in that direction collides
+ * \see Direction
+ * \see IntersectionBitSet
+ * \snippet CollisionHandler.h IntersectionBitSet
+ * \details Example usage for IntersectionBitSet (TransformComponent::update()):
+ * \snippet{trimleft} TransformComponent.cpp getAnyIntersection example code
+ *
+ */
template<>
IntersectionBitSet CollisionHandler::getAnyIntersection(
Entity* entity,
@@ -116,6 +127,7 @@ IntersectionBitSet CollisionHandler::getAnyIntersection(
std::initializer_list const& groupLabels,
std::initializer_list const& excludedEntities)
{
+ if (!entity->hasComponent()) return std::bitset();
IntersectionBitSet intersections;
for (auto& collider : getColliders(groupLabels, excludedEntities)) {
intersections |= getIntersection(entity, collider->entity, posMod);
@@ -123,6 +135,13 @@ IntersectionBitSet CollisionHandler::getAnyIntersection(
return intersections;
};
+/*!
+ *
+ * \details Refer to getAnyIntersection() for more details
+ * \return The first entity with collision found
+ * \see Entity
+ *
+ */
template<>
Entity* CollisionHandler::getAnyIntersection(
Entity* entity,
@@ -130,6 +149,7 @@ Entity* CollisionHandler::getAnyIntersection(
std::initializer_list const& groupLabels,
std::initializer_list const& excludedEntities)
{
+ if (!entity->hasComponent()) return nullptr;
for (auto& collider : getColliders(groupLabels, excludedEntities)) {
SDL_Rect rect = entity->getComponent().collider + posMod;
if (SDL_HasIntersection(&rect, &collider->collider)) {
@@ -137,4 +157,27 @@ Entity* CollisionHandler::getAnyIntersection(
}
}
return nullptr;
+};
+
+/*!
+ *
+ * \details Refer to getAnyIntersection() for more details
+ * \return True if any collision was found, otherwise false
+ *
+ */
+template<>
+bool CollisionHandler::getAnyIntersection(
+ Entity* entity,
+ Vector2D posMod,
+ std::initializer_list const& groupLabels,
+ std::initializer_list const& excludedEntities)
+{
+ if (!entity->hasComponent()) return false;
+ for (auto& collider : getColliders(groupLabels, excludedEntities)) {
+ SDL_Rect rect = entity->getComponent().collider + posMod;
+ if (SDL_HasIntersection(&rect, &collider->collider)) {
+ return true;
+ }
+ }
+ return false;
};
\ No newline at end of file
diff --git a/src/TransformComponent.cpp b/src/TransformComponent.cpp
index 3854176..e8e299b 100644
--- a/src/TransformComponent.cpp
+++ b/src/TransformComponent.cpp
@@ -73,6 +73,7 @@ void TransformComponent::modifySpeed(int8_t modifier)
void TransformComponent::setPositionAfterCollision(Vector2D& positionChange)
{
std::initializer_list colliders = { Entity::GroupLabel::MAPTILES, Entity::GroupLabel::COLLIDERS };
+ // [getAnyIntersection example code]
IntersectionBitSet intersections =
(CollisionHandler::getIntersectionWithBounds(entity, Vector2D(positionChange.x, 0)) |
(this->entity->getManager()
@@ -88,4 +89,5 @@ void TransformComponent::setPositionAfterCollision(Vector2D& positionChange)
if (intersections.test((size_t)Direction::UP) || intersections.test((size_t)Direction::DOWN))
positionChange.y = 0;
+ // [getAnyIntersection example code]
}
\ No newline at end of file
+
+
+
+
+
+
\ 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/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|
+ $projectname
+ $projectnumber
+
+
+
+ $projectbrief
+
+ |
+
+
+
+
+ $projectbrief
+ |
+
+
+
+
+
+ $searchbox | + + + +|
| $searchbox | +|||