Gamedev Framework (gf)  0.3.0
A C++11 framework for 2D games
Control.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 #ifndef GF_CONTROL_H
22 #define GF_CONTROL_H
23 
24 #include "Portability.h"
25 
26 namespace gf {
27 #ifndef DOXYGEN_SHOULD_SKIP_THIS
28 inline namespace v1 {
29 #endif
30 
31  struct Event;
32 
33  /**
34  * @ingroup window
35  * @brief A physical control.
36  *
37  */
38  class GF_API Control {
39  public:
40  /**
41  * @brief Construct a control
42  *
43  */
45  : m_active(false)
46  {
47  }
48 
49  /**
50  * @brief Destroy the control.
51  */
52  virtual ~Control();
53 
54  /**
55  * @brief Check if the control is active.
56  *
57  * @return true if the control is active.
58  *
59  * @sa Action::isActive()
60  */
61  bool isActive() {
62  return m_active;
63  }
64 
65  /**
66  * @brief Change the active state of the control.
67  *
68  * @param active The new state of the control.
69  */
70  void setActive(bool active = true) {
71  m_active = active;
72  }
73 
74  /**
75  * @brief Desactivate the control.
76  *
77  * This call is equivalent to:
78  *
79  * ~~~{.cc}
80  * this.setActive(false);
81  * ~~~
82  *
83  * @sa Action::reset()
84  */
85  void reset() {
86  m_active = false;
87  }
88 
89  /**
90  * @brief Update the state of the control thanks to an event.
91  *
92  * @param event The event to update the control.
93  *
94  * @sa Action::processEvent()
95  */
96  virtual void processEvent(const Event& event) = 0;
97 
98  private:
99  bool m_active;
100  };
101 
102 #ifndef DOXYGEN_SHOULD_SKIP_THIS
103 }
104 #endif
105 }
106 
107 #endif // GF_CONTROL_H
void setActive(bool active=true)
Change the active state of the control.
Definition: Control.h:70
virtual void processEvent(const Event &event)=0
Update the state of the control thanks to an event.
A physical control.
Definition: Control.h:38
bool isActive()
Check if the control is active.
Definition: Control.h:61
virtual ~Control()
Destroy the control.
Definition: Action.h:34
Control()
Construct a control.
Definition: Control.h:44
Defines a system event and its parameters.
Definition: Event.h:115
#define GF_API
Definition: Portability.h:35
void reset()
Desactivate the control.
Definition: Control.h:85