1. Bart van Strien
  2. love-experiments

Source

love-experiments / src / modules / graphics / opengl / ParticleSystem.h

The branch 'particles2' does not exist.
  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
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
/**
 * Copyright (c) 2006-2012 LOVE Development Team
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 **/

#ifndef LOVE_GRAPHICS_OPENGL_PARTICLE_SYSTEM_H
#define LOVE_GRAPHICS_OPENGL_PARTICLE_SYSTEM_H

// STL
#include <vector>

// LOVE
#include "common/math.h"
#include "common/Vector.h"
#include "graphics/Drawable.h"
#include "graphics/Color.h"
#include "VertexBuffer.h"
#include "Image.h"

namespace love
{
namespace graphics
{
namespace opengl
{

/**
 * A class for creating, moving and drawing particles.
 * A big thanks to bobthebloke.org
 **/
class ParticleSystem : public Drawable
{
public:
	/**
	 * Type of distribution new particles are drawn from: None, uniform, normal.
	 */
	enum AreaSpreadDistribution
	{
		DISTRIBUTION_NONE,
		DISTRIBUTION_UNIFORM,
		DISTRIBUTION_NORMAL,
		DISTRIBUTION_MAX_ENUM,
	};

	/**
	 * Points that the tangential and radial acceleration can be relative to: particleorigin, emitter.
	 */
	enum AccelerationCenterPoint
	{
		ACCELERATION_CENTER_PARTICLE_ORIGIN,
		ACCELERATION_CENTER_EMITTER,
		ACCELERATION_CENTER_MAX_ENUM,
	};

	/**
	 * Insertion modes of new particles in the list: top, bottom, random.
	 */
	enum InsertMode
	{
		INSERT_MODE_TOP,
		INSERT_MODE_BOTTOM,
		INSERT_MODE_RANDOM,
		INSERT_MODE_MAX_ENUM,
	};

	/**
	 * Creates a particle system with the specified image and number of particles.
	 */
	ParticleSystem(Image *image, unsigned int size);

	/**
	 * Deletes any allocated memory.
	 */
	virtual ~ParticleSystem();

	/**
	 * Sets the image used for the particles.
	 * @param image The new particle image.
	 */
	void setImage(Image *image);

	/**
	 * Clears the current buffer and allocates the appropriate amount of space for the buffer.
	 * @param size The new buffer size.
	 */
	void setBufferSize(unsigned int size);

	/**
	 * Sets the insert mode for new particles.
	 * @param mode The new insert mode.
	 */
	void setInsertMode(InsertMode mode);

	/**
	 * Sets the emission rate.
	 * @param rate The amount of particles per second.
	 */
	void setEmissionRate(float rate);

	/**
	 * Sets the lifetime of the particle emitter (-1 means eternal)
	 * @param life The lifetime (in seconds).
	 */
	void setLifetime(float life);

	/**
	 * Sets the life range of the particles.
	 * @param lifeMin The minimum life.
	 * @param lifeMax The maximum life (if 0, then becomes the same as minimum life).
	 */
	void setParticleLife(float min, float max = 0);

	/**
	 * Sets the position of the center of the emitter and the direction (if set to relative).
	 * Used to move the emitter without changing the position of already existing particles.
	 * @param x The x-coordinate.
	 * @param y The y-coordinate.
	 */
	void setPosition(float x, float y);

	/**
	 * Sets the emission area spread parameters and distribution type. The interpretation of
	 * the parameters depends on the distribution type:
	 *
	 * * None:    Parameters are ignored. No area spread.
	 * * Uniform: Parameters denote maximal (symmetric) displacement from emitter position.
	 * * Normal:  Parameters denote the standard deviation in x and y direction. x and y are assumed to be uncorrelated.
	 * @param x First parameter. Interpretation depends on distribution type.
	 * @param y Second parameter. Interpretation depends on distribution type.
	 * @param distribution Distribution type
	 */
	void setAreaSpread(AreaSpreadDistribution distribution, float x, float y);

	/**
	 * Sets the direction and the spread of the particle emitter.
	 * @param direction The direction (in degrees).
	 */
	void setDirection(float direction);

	/**
	 * Sets the spread of the particle emitter.
	 * @param spread The spread (in degrees).
	 */
	void setSpread(float spread);

	/**
	 * Sets the center for the radial and tangential acceleration of all particles.
	 * @param point The new acceleration center.
	 */
	void setAccelerationCenter(AccelerationCenterPoint point);

	/**
	 * Sets the speed of the particles.
	 * @param speed The speed.
	 */
	void setSpeed(float speed);

	/**
	 * Sets the speed of the particles.
	 * @param min The minimum speed.
	 * @param max The maximum speed.
	 */
	void setSpeed(float min, float max);

	/**
	 * Sets the gravity of the particles (the acceleration along the y-axis).
	 * @param gravity The amount of gravity.
	 */
	void setGravity(float gravity);

	/**
	 * Sets the gravity of the particles (the acceleration along the y-axis).
	 * @param min The minimum gravity.
	 * @param max The maximum gravity.
	 */
	void setGravity(float min, float max);

	/**
	 * Sets the radial acceleration (the acceleration towards the particle emitter).
	 * @param acceleration The amount of acceleration.
	 */
	void setRadialAcceleration(float acceleration);

	/**
	 * Sets the radial acceleration (the acceleration towards the particle emitter).
	 * @param min The minimum acceleration.
	 * @param max The maximum acceleration.
	 */
	void setRadialAcceleration(float min, float max);

	/**
	 * Sets the tangential acceleration (the acceleration perpendicular to the particle's direction).
	 * @param acceleration The amount of acceleration.
	 */
	void setTangentialAcceleration(float acceleration);

	/**
	 * Sets the tangential acceleration (the acceleration perpendicular to the particle's direction).
	 * @param min The minimum acceleration.
	 * @param max The maximum acceleration.
	 */
	void setTangentialAcceleration(float min, float max);

	/**
	 * Sets the size of the sprite (1.0 being the default size).
	 * @param size The size of the sprite.
	 */
	void setSize(float size);

	/**
	 * Sets the size of the sprite upon creation and upon death (1.0 being the default size) and any variation.
	 * @param newSizes Array of sizes
	 * @param variation The amount of variation on the starting size (0 being no variation and 1.0 a random size between start and end).
	 */
	void setSize(const std::vector<float> &newSizes, float variation = 0.0f);

	/**
	 * Sets the amount of variation to the sprite's beginning size (0 being no variation and 1.0 a random size between start and end).
	 * @param variation The amount of variation.
	 */
	void setSizeVariation(float variation);

	/**
	 * Sets the amount of rotation a sprite starts out with.
	 * @param rotation The amount of rotation.
	 */
	void setRotation(float rotation);

	/**
	 * Sets the amount of rotation a sprite starts out with (a random value between min and max).
	 * @param min The minimum amount of rotation.
	 * @param max The maximum amount of rotation.
	 */
	void setRotation(float min, float max);

	/**
	 * Sets the spin of the sprite.
	 * @param spin The spin of the sprite (in degrees).
	 */
	void setSpin(float spin);

	/**
	 * Sets the spin of the sprite upon particle creation and death.
	 * @param start The spin of the sprite upon creation (in degrees).
	 * @param end The spin of the sprite upon death (in degrees).
	 */
	void setSpin(float start, float end);

	/**
	 * Sets the spin of the sprite upon particle creation and death and the variation.
	 * @param start The spin of the sprite upon creation (in degrees).
	 * @param end The spin of the sprite upon death (in degrees).
	 * @param variation The variation of the start spin (0 being no variation and 1 beign a random spin between start and end).
	 */
	void setSpin(float start, float end, float variation);

	/**
	 * Sets the variation of the start spin (0 being no variation and 1 beign a random spin between start and end).
	 * @param variation The variation in degrees.
	 */
	void setSpinVariation(float variation);

	/**
	 * Sets the color of the particles.
	 * @param color The color.
	 */
	void setColor(const Color &color);

	/**
	 * Sets the particles' offsets for rotation.
	 * @param x The x offset.
	 * @param y The y offset.
	 */
	void setOffset(float x, float y);

	/**
	 * Sets the color of the particles.
	 * @param newColors Array of colors
	 */
	void setColor(const std::vector<Color> &newColors);

	/**
	 * Returns the x-coordinate of the emitter's position.
	 */
	float getX() const;

	/**
	 * Returns the y-coordinate of the emitter's position.
	 */
	float getY() const;

	/**
	 * Returns the position of the emitter.
	 */
	const love::Vector &getPosition() const;

	/**
	 * Returns area spread distribution type.
	 */
	AreaSpreadDistribution getAreaSpreadDistribution() const;

	/**
	 * Returns area spread parameters.
	 */
	const love::Vector &getAreaSpreadParameters() const;

	/**
	 * Returns the direction of the emitter (in degrees).
	 */
	float getDirection() const;

	/**
	 * Returns the directional spread of the emitter (in degrees).
	 */
	float getSpread() const;

	/**
	 * Returns the X offset of the particles.
	 */
	float getOffsetX() const;

	/**
	 * Returns the Y offset of the particles.
	 */
	float getOffsetY() const;

	/**
	 * Returns the amount of particles that are currently active in the system.
	 */
	unsigned int getCount() const;

	/**
	 * Starts/resumes the particle emitter.
	 */
	void start();

	/**
	 * Stops the particle emitter and resets.
	 */
	void stop();

	/**
	 * Pauses the particle emitter.
	 */
	void pause();

	/**
	 * Resets the particle emitter.
	 */
	void reset();

	/**
	 * Returns whether the particle emitter is active.
	 */
	bool isActive() const;

	/**
	 * Returns whether the particle system is empty of particles or not.
	 */
	bool isEmpty() const;

	/**
	 * Returns whether the amount of particles has reached the buffer limit or not.
	 */
	bool isFull() const;

	/**
	 * Draws the particle emitter at the specified position.
	 * @param x The x-coordinate.
	 * @param y The y-coordinate.
	 */
	virtual void draw(float x, float y, float angle, float sx, float sy, float ox, float oy, float kx, float ky) const;

	/**
	 * Updates the particle system.
	 * @param dt Time since last update.
	 */
	void update(float dt);

	static bool getConstant(const char *in, AreaSpreadDistribution &out);
	static bool getConstant(AreaSpreadDistribution in, const char *&out);

	static bool getConstant(const char *in, AccelerationCenterPoint &out);
	static bool getConstant(AccelerationCenterPoint in, const char *&out);

	static bool getConstant(const char *in, InsertMode &out);
	static bool getConstant(InsertMode in, const char *&out);

private:
	// Represents a single particle.
	struct particle
	{
		float lifetime;
		float lifetimeLeft;

		// Particle origin set upon creation.
		love::Vector origin;
		love::Vector position;
		love::Vector velocity;

		float gravity;
		float radialAcceleration;
		float tangentialAcceleration;

		float sizeOffset;
		float sizeIntervalSize;

		float rotation;
		float spinStart;
		float spinEnd;

		particle *prev;
		particle *next;
	};

	// Particle buffers for the drawing operation.
	love::vertex *vertexBuffer;
	VertexIndex *elementBuffer;

	// Pointer to the beginning of the allocated memory.
	particle *pMem;

	// Pointer to a free particle.
	particle *pFree;

	// Pointer to the start of the linked list.
	particle *pHead;

	// Pointer to the end of the linked list.
	particle *pTail;

	// The image used for the particles.
	Image *image;

	// Whether the particle emitter is active.
	bool active;

	// Insert mode of new particles.
	InsertMode insertMode;

	// The maximum number of particles.
	unsigned int maxParticles;

	// The number of active particles.
	unsigned int numParticles;

	// The emission rate (particles/sec).
	float emissionRate;

	// Used to determine when a particle should be emitted.
	float emitCounter;

	// The relative position of the particle emitter.
	love::Vector position;

	// Emission area spread.
	AreaSpreadDistribution areaSpreadDistribution;
	love::Vector areaSpread;

	// The lifetime of the particle emitter (-1 means infinite) and the life it has left.
	float lifetime;
	float life;

	// The particle life.
	float particleLifeMin;
	float particleLifeMax;

	// The direction (and spread) the particles will be emitted in. Measured in radians.
	float direction;
	float spread;

	// The speed.
	float speedMin;
	float speedMax;

	// Acceleration towards the bottom of the screen
	float gravityMin;
	float gravityMax;

	// The point the radial and tangential acceleration are relative to.
	AccelerationCenterPoint accelerationCenter;

	// Acceleration towards the emitter's center
	float radialAccelerationMin;
	float radialAccelerationMax;

	// Acceleration perpendicular to the particle's direction.
	float tangentialAccelerationMin;
	float tangentialAccelerationMax;

	// Size.
	std::vector<float> sizes;
	float sizeVariation;

	// Rotation
	float rotationMin;
	float rotationMax;

	// Spin.
	float spinStart;
	float spinEnd;
	float spinVariation;

	// Offsets
	float offsetX;
	float offsetY;

	// Color.
	std::vector<Colorf> colors;

	void createBuffers(unsigned int size);
	void deleteBuffers();

	void createParticle(particle *p);
	void addParticle();
	particle *removeParticle(particle *p);

	void insertTop(particle *p);
	void insertBottom(particle *p);
	void insertRandom(particle *p);

	static StringMap<AreaSpreadDistribution, DISTRIBUTION_MAX_ENUM>::Entry distributionsEntries[];
	static StringMap<AreaSpreadDistribution, DISTRIBUTION_MAX_ENUM> distributions;

	static StringMap<AccelerationCenterPoint, ACCELERATION_CENTER_MAX_ENUM>::Entry accelerationCentersEntries[];
	static StringMap<AccelerationCenterPoint, ACCELERATION_CENTER_MAX_ENUM> accelerationCenters;

	static StringMap<InsertMode, INSERT_MODE_MAX_ENUM>::Entry insertModesEntries[];
	static StringMap<InsertMode, INSERT_MODE_MAX_ENUM> insertModes;
};

} // opengl
} // graphics
} // love

#endif // LOVE_GRAPHICS_OPENGL_PARTICLE_SYSTEM_H