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
|
/***********************************************************************
filename: Minesweeper_Timer.h
created: 08/08/2006
author: Olivier Delannoy
purpose: Interface to timer window
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _Minesweeper_Timer_h_
#define _Minesweeper_Timer_h_
#include "CEGUIWindow.h"
#include "CEGUIWindowFactory.h"
#include "CEGUIProperty.h"
namespace TimerProperties
{
/*!
\brief
Property to access the delay between two alarm
\par Usage:
- Name: Delay
- Format: "[float]".
\par Where:
- [float] represents the current delay of the timer
*/
class Delay : public CEGUI::Property
{
public:
Delay() : Property("Delay", "Property to get/set the current delay used by the timer. Value is a float.", "0.000000") {}
CEGUI::String get(const CEGUI::PropertyReceiver* receiver) const;
void set(CEGUI::PropertyReceiver* receiver, const CEGUI::String& value);
};
}
/*!
\brief
Window class intended to be used as a timer.
An application can contains several timer to generate events each count milliseconds.
The accuracy of the timer is not accurate enough to do any time counting and is
not guaranty either.
This class does no rendering and so appears totally transparent. This window defaults
to position 0.0f, 0.0f with a size of 1.0f x 1.0f.
*/
class Timer : public CEGUI::Window
{
public:
/*************************************************************************
Constants
*************************************************************************/
// type name for this widget
static const CEGUI::String WidgetTypeName; //!< The unique typename of this widget
static const CEGUI::String EventNamespace; //!< Store the event namespace related to the timer
static const CEGUI::String EventTimerAlarm; //!< The name of the event generated by this widget
/*************************************************************************
Construction and Destruction
*************************************************************************/
/*!
\brief
Constructor for Timer windows.
*/
Timer(const CEGUI::String& type, const CEGUI::String& name);
/*!
\brief
Destructor for Timer windows.
*/
virtual ~Timer(void) {}
/*!
\brief start the timer in order to generate alarm event
*/
void start();
/*!
\brief stop generating alarm event
*/
void stop();
/*!
\brief Check wether the timer is started or not
*/
bool isStarted() const;
/*!
\brief
Set the delay between to event generation in seconds
*/
void setDelay(float delay);
float getDelay() const;
protected:
virtual void updateSelf(float elapsed);
/*!
\brief
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
\param class_name
The class name that is to be checked.
\return
true if this window was inherited from \a class_name. false if not.
*/
virtual bool testClassName_impl(const CEGUI::String& class_name) const
{
if (class_name=="Timer")
return true;
return CEGUI::Window::testClassName_impl(class_name);
}
private:
static TimerProperties::Delay d_delayProperty;
float d_delay; //!< Store the current delay between two alarm
float d_currentValue; //!< Set the current value
bool d_started; //!< Store wether the timer should produce event or not
void addTimerProperties(void);
};
class TimerFactory : public CEGUI::WindowFactory
{
public:
TimerFactory() : CEGUI::WindowFactory(Timer::WidgetTypeName) {}
CEGUI::Window* createWindow(const CEGUI::String& name)
{ return new Timer(d_type, name); }
void destroyWindow(CEGUI::Window* window)
{ delete window;}
};
TimerFactory& getTimerFactory();
#endif // end of guard _CEGUIGUISheet_h_
|
