aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/ParticleEmitter.h
blob: b83fd61ac5937c47581a7d20f2aefa3119a5e156 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
#pragma once

#include <vector>

#include "Component.h"
#include "Particle.h"
#include "types.h"

namespace crepe {

class Sprite;

/**
 * \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:
	/**
	 * \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
		vec2 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
		vec2 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)
		vec2 force_over_time;
		//! particle boundary
		Boundary boundary;
		//! collection of particles
		std::vector<Particle> particles;
		//! sprite reference
		const Sprite & sprite;
	};

public:
	/**
	 * \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