Gamedev Framework (gf)  0.6.0
A C++11 framework for 2D games
Particles.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2017 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_PARTICLES_H
22 #define GF_PARTICLES_H
23 
24 #include "Circ.h"
25 #include "Portability.h"
26 #include "Rect.h"
27 #include "Transformable.h"
28 #include "VertexArray.h"
29 #include "Vector.h"
30 
31 namespace gf {
32 #ifndef DOXYGEN_SHOULD_SKIP_THIS
33 inline namespace v1 {
34 #endif
35  class Texture;
36 
37  /**
38  * @ingroup graphics
39  * @brief A class to display a high number of points
40  */
42  public:
43  /**
44  * @brief Default constructor
45  */
47 
48  /**
49  * @brief Add a point to the particles
50  *
51  * @param position The position of the point
52  * @param color The color of the point
53  */
54  void addPoint(Vector2f position, Color4f color);
55 
56  virtual void draw(RenderTarget& target, RenderStates states) override;
57 
58  private:
59  VertexArray m_vertices;
60  };
61 
62 
63  /**
64  * @ingroup graphics
65  * @brief A class to display a high number of small simple shapes
66  */
68  public:
69  /**
70  * @brief Default constructor
71  */
73 
74  /**
75  * @brief Add a circle shape to the particles
76  *
77  * @param center The center of the circle
78  * @param radius The radius of the circle
79  * @param color The color of the circle
80  * @param pointCount The number of points composing the circle
81  */
82  void addCircle(Vector2f center, float radius, Color4f color, std::size_t pointCount = 15);
83 
84  /**
85  * @brief Add a circle shape to the particles
86  *
87  * @param circ The circle
88  * @param color The color of the circle
89  * @param pointCount The number of points composing the circle
90  */
91  void addCircle(const CircF& circ, Color4f color, std::size_t pointCount = 15);
92 
93  /**
94  * @brief Add a rectangle shape to the particles
95  *
96  * @param position The position of the top-left of the rectangle
97  * @param size The size of the rectangle
98  * @param color The color of the rectangle
99  */
100  void addRectangle(Vector2f position, Vector2f size, Color4f color);
101 
102  /**
103  * @brief Add a rectangle shape to the particles
104  *
105  * @param rect The rectangle
106  * @param color The color of the rectangle
107  */
108  void addRectangle(const RectF& rect, Color4f color);
109 
110  virtual void draw(RenderTarget& target, RenderStates states) override;
111 
112  private:
113  VertexArray m_vertices;
114  };
115 
116  /**
117  * @ingroup graphics
118  * @brief A class to display a high number of sprites
119  *
120  * @sa gf::SpriteBatch
121  */
123  public:
124  /**
125  * @brief Default constructor
126  */
127  SpriteParticles();
128 
129  /**
130  * @brief Constructor with a texture
131  *
132  * @param texture The source texture
133  */
134  SpriteParticles(const Texture& texture);
135 
136  /**
137  * @brief Change the source texture
138  *
139  * @param texture The new texture
140  */
141  void setTexture(const Texture& texture);
142 
143  /**
144  * @brief Add a sprite to the particles
145  *
146  * @param position The position of the center of the sprite
147  * @param textureRect The sub-rectangle of the texture to assign to the sprite
148  * @param color The color of the sprite
149  */
150  void addSprite(Vector2f position, const RectF& textureRect, Color4f color = Color::White);
151 
152  virtual void draw(RenderTarget& target, RenderStates states) override;
153 
154  private:
155  const Texture *m_texture;
156  VertexArray m_vertices;
157  };
158 
159 #ifndef DOXYGEN_SHOULD_SKIP_THIS
160 }
161 #endif
162 }
163 
164 #endif // GF_PARTICLES_H
Decomposed transform defined by a position, a rotation and a scale.
Definition: Transformable.h:95
SpriteParticles(const Texture &texture)
Constructor with a texture.
void addCircle(Vector2f center, float radius, Color4f color, std::size_t pointCount=15)
Add a circle shape to the particles.
virtual void draw(RenderTarget &target, RenderStates states) override
Draw the object to a render target.
A set of primitives.
Definition: VertexArray.h:65
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.h:66
Define the states used for drawing to a RenderTarget.
Definition: RenderStates.h:82
PointParticles()
Default constructor.
void addSprite(Vector2f position, const RectF &textureRect, Color4f color=Color::White)
Add a sprite to the particles.
virtual void draw(RenderTarget &target, RenderStates states) override
Draw the object to a render target.
A class to display a high number of points.
Definition: Particles.h:41
virtual void draw(RenderTarget &target, RenderStates states) override
Draw the object to a render target.
void addPoint(Vector2f position, Color4f color)
Add a point to the particles.
A texture for colored images.
Definition: Texture.h:339
void addRectangle(Vector2f position, Vector2f size, Color4f color)
Add a rectangle shape to the particles.
The namespace for gf classes.
Definition: Action.h:34
void setTexture(const Texture &texture)
Change the source texture.
void addCircle(const CircF &circ, Color4f color, std::size_t pointCount=15)
Add a circle shape to the particles.
A class to display a high number of sprites.
Definition: Particles.h:122
A class to display a high number of small simple shapes.
Definition: Particles.h:67
void addRectangle(const RectF &rect, Color4f color)
Add a rectangle shape to the particles.
#define GF_API
Definition: Portability.h:35
ShapeParticles()
Default constructor.
SpriteParticles()
Default constructor.