Gamedev Framework (gf)  0.17.0
A C++14 framework for 2D games
Sprite.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2019 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  * Part of this file comes from SFML, with the same license:
22  * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
23  */
24 #ifndef GF_SPRITE_H
25 #define GF_SPRITE_H
26 
27 #include "BasicSprite.h"
28 #include "Transformable.h"
29 #include "Portability.h"
30 #include "Vertex.h"
31 #include "VertexBuffer.h"
32 
33 namespace gf {
34 #ifndef DOXYGEN_SHOULD_SKIP_THIS
35 inline namespace v1 {
36 #endif
37  class Texture;
38 
75  class GF_API Sprite : public Transformable {
76  public:
82  Sprite();
83 
91  Sprite(const Texture& texture);
92 
101  Sprite(const Texture& texture, const RectF& textureRect);
102 
121  void setTexture(const Texture& texture, bool resetRect = false);
122 
133  const Texture& getTexture() const {
134  return m_basic.getTexture();
135  }
136 
144  bool hasTexture() const {
145  return m_basic.hasTexture();
146  }
147 
155  void unsetTexture();
156 
172  void setTextureRect(const RectF& rect);
173 
181  const RectF& getTextureRect() const {
182  return m_basic.getTextureRect();
183  }
184 
198  void setColor(const Color4f& color);
199 
207  const Color4f& getColor() const;
208 
209 
221  RectF getLocalBounds() const;
222 
233  void setAnchor(Anchor anchor);
234 
243  VertexBuffer commitGeometry() const;
244 
245  virtual void draw(RenderTarget& target, const RenderStates& states) override;
246 
247  private:
248  BasicSprite m_basic;
249  Vertex m_vertices[4];
250  };
251 
252 #ifndef DOXYGEN_SHOULD_SKIP_THIS
253 }
254 #endif
255 }
256 
257 #endif // GF_SPRITE_H
Decomposed transform defined by a position, a rotation and a scale.
Definition: Transformable.h:95
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.h:90
Define the states used for drawing to a RenderTarget.
Definition: RenderStates.h:82
A point associated with a color and a texture coordinate.
Definition: Vertex.h:75
A drawable representation of a texture, with its own transformations, color, etc. ...
Definition: Sprite.h:75
Data in the graphics memory.
Definition: VertexBuffer.h:77
A texture for colored images.
Definition: Texture.h:309
The namespace for gf classes.
Definition: Action.h:35
A 4D vector.
Definition: Vector.h:852
Anchor
An anchor of a box.
Definition: Anchor.h:38
bool hasTexture() const
Check if a texture is set.
Definition: Sprite.h:144
A basic sprite.
Definition: BasicSprite.h:46
const RectF & getTextureRect() const
Get the sub-rectangle of the texture displayed by the sprite.
Definition: Sprite.h:181
const Texture & getTexture() const
Get the source texture of the sprite.
Definition: Sprite.h:133