merge `jaro/particle-system-master` into `loek/cleanup` early

4 files changed, 86 insertions, 68 deletions

diff --git a/src/crepe/api/ParticleEmitter.cpp b/src/crepe/api/ParticleEmitter.cpp
index 0bc2197..7032f9e 100644
--- a/src/crepe/api/ParticleEmitter.cpp
+++ b/src/crepe/api/ParticleEmitter.cpp
@@ -1,41 +1,11 @@
-#include <ctime>
-#include <iostream>
-
-#include "Particle.h"
 #include "ParticleEmitter.h"
+#include "Particle.h"
 
 using namespace crepe;
 
-ParticleEmitter::ParticleEmitter(game_object_id_t id, uint32_t max_particles,
-								 uint32_t emission_rate, uint32_t speed,
-								 uint32_t speed_offset, uint32_t angle,
-								 uint32_t angleOffset, float begin_lifespan,
-								 float end_lifespan)
-	: Component(id),
-	  max_particles(max_particles),
-	  emission_rate(emission_rate),
-	  speed(speed),
-	  speed_offset(speed_offset),
-	  position{0, 0},
-	  begin_lifespan(begin_lifespan),
-	  end_lifespan(end_lifespan) {
-	std::srand(
-		static_cast<uint32_t>(std::time(nullptr))); // initialize random seed
-	std::cout << "Create emitter" << std::endl;
-	// FIXME: Why do these expressions start with `360 +`, only to be `% 360`'d
-	// right after? This does not make any sense to me.
-	min_angle = (360 + angle - (angleOffset % 360)) % 360;
-	max_angle = (360 + angle + (angleOffset % 360)) % 360;
-	position.x = 400; // FIXME: what are these magic values?
-	position.y = 400;
-	for (size_t i = 0; i < max_particles; i++) {
-		this->particles.emplace_back();
-	}
-}
-
-ParticleEmitter::~ParticleEmitter() {
-	std::vector<Particle>::iterator it = this->particles.begin();
-	while (it != this->particles.end()) {
-		it = this->particles.erase(it);
+ParticleEmitter::ParticleEmitter(game_object_id_t game_object_id, const Data & data)
+	: Component(game_object_id), data(data) {
+	for (size_t i = 0; i < this->data.max_particles; i++) {
+		this->data.particles.emplace_back();
 	}
 }
diff --git a/src/crepe/api/ParticleEmitter.h b/src/crepe/api/ParticleEmitter.h
index 5939723..6e29e60 100644
--- a/src/crepe/api/ParticleEmitter.h
+++ b/src/crepe/api/ParticleEmitter.h
@@ -5,38 +5,86 @@
 
 #include "Component.h"
 #include "Particle.h"
+#include "Sprite.h"
+#include "Vector2.h"
+
+// class Sprite;
 
 namespace crepe {
 
+/**
+ * \brief Data holder for particle emission parameters.
+ *
+ * The ParticleEmitter class stores configuration data for particle properties,
+ * defining the characteristics and boundaries of particle emissions.
+ */
+
 class ParticleEmitter : public Component {
 public:
-	ParticleEmitter(game_object_id_t id, uint32_t max_particles,
-					uint32_t emission_rate, uint32_t speed,
-					uint32_t speed_offset, uint32_t angle, uint32_t angleOffset,
-					float begin_lifespan, float end_lifespan);
-	~ParticleEmitter();
-
-	//! position of the emitter
-	Position position;
-	//! maximum number of particles
-	uint32_t max_particles;
-	//! rate of particle emission
-	uint32_t emission_rate;
-	//! base speed of the particles
-	uint32_t speed;
-	//! offset for random speed variation
-	uint32_t speed_offset;
-	//! min angle of particle emission
-	uint32_t min_angle;
-	//! max angle of particle emission
-	uint32_t max_angle;
-	//! begin Lifespan of particle (only visual)
-	float begin_lifespan;
-	//! begin Lifespan of particle
-	float end_lifespan;
-
-	//! collection of particles
-	std::vector<Particle> particles;
+	/**
+	 * \brief Defines the boundary within which particles are constrained.
+	 *
+	 * This structure specifies the boundary's size and offset, as well as the
+	 * behavior of particles upon reaching the boundary limits.
+	 */
+	struct Boundary {
+		//! boundary width (midpoint is emitter location)
+		double width = 0.0;
+		//! boundary height (midpoint is emitter location)
+		double height = 0.0;
+		//! boundary offset from particle emitter location
+		Vector2 offset;
+		//! reset on exit or stop velocity and set max postion
+		bool reset_on_exit = false;
+	};
+
+	/**
+	 * \brief Holds parameters that control particle emission.
+	 *
+	 * Contains settings for the emitter’s position, particle speed, angle, lifespan,
+	 * boundary, and the sprite used for rendering particles.
+	 */
+	struct Data {
+		//! position of the emitter
+		Vector2 position;
+		//! maximum number of particles
+		const unsigned int max_particles = 0;
+		//! rate of particle emission per update (Lowest value = 0.001 any lower is ignored)
+		double emission_rate = 0;
+		//! min speed of the particles
+		double min_speed = 0;
+		//! min speed of the particles
+		double max_speed = 0;
+		//! min angle of particle emission
+		double min_angle = 0;
+		//! max angle of particle emission
+		double max_angle = 0;
+		//! begin Lifespan of particle (only visual)
+		double begin_lifespan = 0.0;
+		//! end Lifespan of particle
+		double end_lifespan = 0.0;
+		//! force over time (physics)
+		Vector2 force_over_time;
+		//! particle boundary
+		Boundary boundary;
+		//! collection of particles
+		std::vector<Particle> particles;
+		//! sprite reference
+		const Sprite & sprite;
+	};
+
+public:
+	/**
+	 * \brief Constructs a ParticleEmitter data holder with specified settings.
+	 *
+	 * \param game_object_id  Identifier for the game object using this emitter.
+	 * \param data            Configuration data defining particle properties.
+	 */
+	ParticleEmitter(game_object_id_t game_object_id, const Data & data);
+
+public:
+	//! Configuration data for particle emission settings.
+	Data data;
 };
 
 } // namespace crepe
diff --git a/src/crepe/api/Vector2.cpp b/src/crepe/api/Vector2.cpp
index 7da202a..97b74ac 100644
--- a/src/crepe/api/Vector2.cpp
+++ b/src/crepe/api/Vector2.cpp
@@ -10,7 +10,7 @@ Vector2 Vector2::operator+(const Vector2 & other) const {
 	return {x + other.x, y + other.y};
 }
 
-Vector2 Vector2::operator*(float scalar) const {
+Vector2 Vector2::operator*(double scalar) const {
 	return {x * scalar, y * scalar};
 }
 
@@ -26,7 +26,7 @@ Vector2 & Vector2::operator+=(const Vector2 & other) {
 	return *this;
 }
 
-Vector2 & Vector2::operator+=(float other) {
+Vector2 & Vector2::operator+=(double other) {
 	x += other;
 	y += other;
 	return *this;
diff --git a/src/crepe/api/Vector2.h b/src/crepe/api/Vector2.h
index a069a57..2fb6136 100644
--- a/src/crepe/api/Vector2.h
+++ b/src/crepe/api/Vector2.h
@@ -5,9 +5,9 @@ namespace crepe {
 //! 2D vector
 struct Vector2 {
 	//! X component of the vector
-	float x = 0;
+	double x = 0;
 	//! Y component of the vector
-	float y = 0;
+	double y = 0;
 
 	//! Subtracts another vector from this vector and returns the result.
 	Vector2 operator-(const Vector2 & other) const;
@@ -16,7 +16,7 @@ struct Vector2 {
 	Vector2 operator+(const Vector2 & other) const;
 
 	//! Multiplies this vector by a scalar and returns the result.
-	Vector2 operator*(float scalar) const;
+	Vector2 operator*(double scalar) const;
 
 	//! Multiplies this vector by another vector element-wise and updates this vector.
 	Vector2 & operator*=(const Vector2 & other);
@@ -25,7 +25,7 @@ struct Vector2 {
 	Vector2 & operator+=(const Vector2 & other);
 
 	//! Adds a scalar value to both components of this vector and updates this vector.
-	Vector2 & operator+=(float other);
+	Vector2 & operator+=(double other);
 
 	//! Returns the negation of this vector.
 	Vector2 operator-() const;