aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/system/CollisionSystem.h
diff options
context:
space:
mode:
authorheavydemon21 <nielsstunnebrink1@gmail.com>2024-12-06 20:09:09 +0100
committerheavydemon21 <nielsstunnebrink1@gmail.com>2024-12-06 20:09:09 +0100
commit81de5e68ba6cf5cd8bc64c3fc0eecef84c417b61 (patch)
tree144b0e9efecd4c10d6d79a17b4bf571336d45961 /src/crepe/system/CollisionSystem.h
parent5eedba3a070c3a7a4f27ae3ec7dd41812695f7e9 (diff)
parentfdb4c99e139a264d4e15e6913a3756fc6cccb2f2 (diff)
Merge branch 'master' into niels/decoupling_pixel_and_pos
Diffstat (limited to 'src/crepe/system/CollisionSystem.h')
-rw-r--r--src/crepe/system/CollisionSystem.h65
1 files changed, 32 insertions, 33 deletions
diff --git a/src/crepe/system/CollisionSystem.h b/src/crepe/system/CollisionSystem.h
index 7e893c8..5b136c6 100644
--- a/src/crepe/system/CollisionSystem.h
+++ b/src/crepe/system/CollisionSystem.h
@@ -37,7 +37,7 @@ private:
/**
* \brief A structure to store the collision data of a single collider.
- *
+ *
* This structure all components and id that are for needed within this system when calculating or handeling collisions.
* The transform and rigidbody are mostly needed for location and rotation.
* In rigidbody additional info is written about what the body of the object is,
@@ -65,7 +65,7 @@ private:
public:
/**
* \brief Structure representing detailed collision information between two colliders.
- *
+ *
* Includes information about the colliding objects and the resolution data for handling the collision.
*/
struct CollisionInfo {
@@ -90,9 +90,9 @@ public:
private:
/**
* \brief Determines the type of collider pair from two colliders.
- *
+ *
* Uses std::holds_alternative to identify the types of the provided colliders.
- *
+ *
* \param collider1 First collider variant (BoxCollider or CircleCollider).
* \param collider2 Second collider variant (BoxCollider or CircleCollider).
* \return The combined type of the two colliders.
@@ -102,9 +102,9 @@ private:
/**
* \brief Calculates the current position of a collider.
- *
+ *
* Combines the Collider offset, Transform position, and Rigidbody offset to compute the position of the collider.
- *
+ *
* \param collider_offset The offset of the collider.
* \param transform The Transform of the associated game object.
* \param rigidbody The Rigidbody of the associated game object.
@@ -116,9 +116,9 @@ private:
private:
/**
* \brief Handles collision resolution between two colliders.
- *
+ *
* Processes collision data and adjusts objects to resolve collisions and/or calls the user oncollision script function.
- *
+ *
* \param data1 Collision data for the first collider.
* \param data2 Collision data for the second collider.
*/
@@ -126,9 +126,9 @@ private:
/**
* \brief Resolves collision between two colliders and calculates the movement required.
- *
+ *
* Determines the displacement and direction needed to separate colliders based on their types.
- *
+ *
* \param data1 Collision data for the first collider.
* \param data2 Collision data for the second collider.
* \param type The type of collider pair.
@@ -140,9 +140,9 @@ private:
/**
* \brief Calculates the resolution vector for two BoxColliders.
- *
+ *
* Computes the displacement required to separate two overlapping BoxColliders.
- *
+ *
* \param box_collider1 The first BoxCollider.
* \param box_collider2 The second BoxCollider.
* \param position1 The position of the first BoxCollider.
@@ -155,13 +155,13 @@ private:
/**
* \brief Calculates the resolution vector for two CircleCollider.
- *
+ *
* Computes the displacement required to separate two overlapping CircleCollider.
- *
+ *
* \param circle_collider1 The first CircleCollider.
* \param circle_collider2 The second CircleCollider.
- * \param position1 The position of the first CircleCollider.
- * \param position2 The position of the second CircleCollider.
+ * \param final_position1 The position of the first CircleCollider.
+ * \param final_position2 The position of the second CircleCollider.
* \return The resolution vector for the collision.
*/
vec2 get_circle_circle_resolution(const CircleCollider & circle_collider1,
@@ -171,14 +171,13 @@ private:
/**
* \brief Calculates the resolution vector for two CircleCollider.
- *
+ *
* Computes the displacement required to separate two overlapping CircleCollider.
- *
+ *
* \param circle_collider The first CircleCollider.
* \param box_collider The second CircleCollider.
* \param circle_position The position of the CircleCollider.
* \param box_position The position of the BoxCollider.
- * \param inverse Inverted true if box circle collision, false if circle box collision (inverts the direction).
* \return The resolution vector for the collision.
*/
vec2 get_circle_box_resolution(const CircleCollider & circle_collider,
@@ -188,18 +187,18 @@ private:
/**
* \brief Determines the appropriate collision handler for a collision.
- *
+ *
* Decides the correct resolution process based on the dynamic or static nature of the colliders involved.
- *
+ *
* \param info Collision information containing data about both colliders.
*/
void determine_collision_handler(CollisionInfo & info);
/**
* \brief Handles collisions involving static objects.
- *
+ *
* Resolves collisions by adjusting positions and modifying velocities if bounce is enabled.
- *
+ *
* \param info Collision information containing data about both colliders.
*/
void static_collision_handler(CollisionInfo & info);
@@ -207,9 +206,9 @@ private:
private:
/**
* \brief Checks for collisions between colliders.
- *
+ *
* Identifies collisions and generates pairs of colliding objects for further processing.
- *
+ *
* \param colliders A collection of all active colliders.
* \return A list of collision pairs with their associated data.
*/
@@ -218,13 +217,13 @@ private:
/**
* \brief Checks if two collision layers have at least one common layer.
- *
+ *
* This function checks if there is any overlapping layer between the two inputs.
- * It compares each layer from the first input to see
- * if it exists in the second input. If at least one common layer is found,
- * the function returns true, indicating that the two colliders share a common
+ * It compares each layer from the first input to see
+ * if it exists in the second input. If at least one common layer is found,
+ * the function returns true, indicating that the two colliders share a common
* collision layer.
- *
+ *
* \param layers1 all collision layers for the first collider.
* \param layers2 all collision layers for the second collider.
* \return Returns true if there is at least one common layer, false otherwise.
@@ -234,9 +233,9 @@ private:
/**
* \brief Checks for collision between two colliders.
- *
+ *
* Calls the appropriate collision detection function based on the collider types.
- *
+ *
* \param first_info Collision data for the first collider.
* \param second_info Collision data for the second collider.
* \param type The type of collider pair.
@@ -248,7 +247,7 @@ private:
/**
* \brief Detects collisions between two BoxColliders.
- *
+ *
* \param box1 The first BoxCollider.
* \param box2 The second BoxCollider.
* \param transform1 Transform of the first object.