Gamedev Framework (gf)  0.1.0
A C++11 framework for 2D games
Drawable.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016 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_DRAWABLE_H
25 #define GF_DRAWABLE_H
26 
27 #include "Portability.h"
28 #include "RenderStates.h"
29 
30 namespace gf {
31 #ifndef DOXYGEN_SHOULD_SKIP_THIS
32 inline namespace v1 {
33 #endif
34 
35  class RenderTarget;
36 
37  /**
38  * @ingroup graphics
39  * @brief Abstract base class for objects that can be drawn to a render window
40  *
41  * gf::Drawable is a very simple base class that allows objects
42  * of derived classes to be drawn to a sf::RenderTarget.
43  *
44  * All you have to do in your derived class is to override the
45  * `draw()` virtual function.
46  *
47  * Note that inheriting from `gf::Drawable` is not mandatory,
48  * but it allows this nice syntax `target.draw(object)` rather
49  * than `object.draw(target)`, which is more consistent with other
50  * classes.
51  *
52  * Example:
53  *
54  * ~~~{.cc}
55  * class MyDrawable : public gf::Drawable {
56  * public:
57  *
58  * ...
59  *
60  * virtual void draw(gf::RenderTarget& target, gf::RenderStates states) override {
61  * // You can draw other high-level objects
62  * target.draw(m_sprite, states);
63  *
64  * // ... or use the low-level API
65  * states.texture = &m_texture;
66  * target.draw(m_vertices, states);
67  *
68  * }
69  *
70  *
71  * private:
72  * gf::Sprite m_sprite;
73  * gf::Texture m_texture;
74  * gf::VertexArray m_vertices;
75  * };
76  * ~~~
77  *
78  */
79  class GF_API Drawable {
80  public:
81  /**
82  * @brief Virtual desctructor
83  */
84  virtual ~Drawable();
85 
86  /**
87  * @brief Draw the object to a render target
88  *
89  * This is a pure virtual function that has to be implemented
90  * by the derived class to define how the drawable should be
91  * drawn.
92  *
93  * @param target Render target to draw to
94  * @param states Current render states
95  */
96  virtual void draw(RenderTarget& target, RenderStates states) = 0;
97 
98  };
99 
100 #ifndef DOXYGEN_SHOULD_SKIP_THIS
101 }
102 #endif
103 }
104 
105 #endif // GF_DRAWABLE_H
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.h:65
Define the states used for drawing to a RenderTarget.
Definition: RenderStates.h:81
virtual void draw(RenderTarget &target, RenderStates states)=0
Draw the object to a render target.
Abstract base class for objects that can be drawn to a render window.
Definition: Drawable.h:79
Definition: Action.h:34
virtual ~Drawable()
Virtual desctructor.
#define GF_API
Definition: Portability.h:35