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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
# -*- indent-tabs-mode: t -*-
# Soya 3D
# Copyright (C) 2001-2006 Jean-Baptiste LAMY -- jiba@tuxfamily.org
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import weakref
MAIN_LOOP = None
IDLER = None # Backward compatibility
BEFORE_RENDER = []
MAIN_LOOP_ITEMS = weakref.WeakKeyDictionary()
cdef class MainLoop:
"""MainLoop
A main loop, with FPS regulation.
Interesting attributes:
- fps (read only): the frame rate (number of frame per second, a usefull speed indicator).
- running (read only): true if the MainLoop is idling (=running).
- next_round_tasks: a list of callable (taking no arg) that will be called once, just
after the beginning of the next round.
- scenes: the scenes associated to this main_loop.
- round_duration: The duration of a round. Round is the main_loop's time unit. The main_loop calls
successively begin_round(), advance_time() (possibly several times) and end_round(); it
is granted that ALL rounds correspond to a period of duration ROUND_DURATION (though
the different period may not be regularly spread over time).
Default is 0.030.
- min_frame_duration: minimum duration for a frame. This attribute can be used to limit
the maximum FPS to save CPU time; e.g. FPS higher than 30-40 is usually useless.
Default is 0.020, which limits FPS to 40 in theory and to about 33 in practice
(I don't know why there is a difference between theory and practice !).
"""
# for time computation, double precision is needed
#cdef _next_round_tasks, _return_value
#cdef _scenes
#cdef public double round_duration, min_frame_duration
#cdef readonly double fps
#cdef public int running
#cdef public int will_render
#cdef double _time, _time_since_last_round
#cdef double _last_fps_computation_time
#cdef int _nb_frame
property scenes:
def __get__(self):
return self._scenes
property next_round_tasks:
def __get__(self):
return self._next_round_tasks
property return_value:
def __get__(self):
return self._return_value
def __init__(self, *scenes):
"""MainLoop(scene1, scene2,...) -> MainLoop
Creates a new main_loop for scenes SCENE1, SCENE2,...."""
self._next_round_tasks = []
self.fps = 0.0
self.running = 0
self._scenes = list(scenes)
self.round_duration = 0.030
self.min_frame_duration = 0.020
self.will_render = 0
import soya
soya.MAIN_LOOP = self
soya.IDLER = self
def stop(self, value = None):
"""MainLoop.stop(VALUE = None)
Stops the main loop. The stopping may not occur immediately, but at the end of the next iteration.
MainLoop.stop() causes MainLoop.main_loop() to returns ; VALUE is the (optionnal) value that MainLoop.main_loop() will return."""
self.running = 0
self._return_value = value
def reset(self):
import time
self._time = time.time()
def idle(self): return self.main_loop() # Backward compatibility
def main_loop(self):
"""MainLoop.main_loop()
Starts idling with the current thread. This method never finishes, until you call MainLoop.stop()."""
import time
# for time computation, double precision is needed
cdef double last_fps_computation_time, current, delta, spent_time
cdef int nb_frame
self.running = 1
self._time = last_fps_computation_time = time.time()
self._time_since_last_round = 0.0
self.begin_round()
while self.running == 1:
nb_frame = 0
while (self.running == 1) and (nb_frame < 80):
nb_frame = nb_frame + 1
while 1: # Sleep until at least MIN_FRAME_DURATION second has passed since the last frame
current = time.time()
delta = current - self._time
if delta > self.min_frame_duration: break
time.sleep(self.min_frame_duration - delta)
self._time = current
while self._time_since_last_round + delta > self.round_duration: # Start a new frame
spent_time = self.round_duration - self._time_since_last_round
self.advance_time(spent_time / self.round_duration) # Complete the previous round
self.end_round() # Ends the previous round
self.begin_round() # Prepare the following round
if self._next_round_tasks:
for task in self._next_round_tasks: task()
self._next_round_tasks = []
delta = delta - spent_time
self._time_since_last_round = 0
self.will_render = 1
self.advance_time(delta / self.round_duration) # start the current round
self.will_render = 0
self._time_since_last_round = self._time_since_last_round + delta
self.render()
current = time.time()
self.fps = nb_frame / (current - last_fps_computation_time)
last_fps_computation_time = current
return self._return_value
def update(self):
"""MainLoop.update()
"""
import time
cdef double current, delta, spent_time
current = time.time()
if self._last_fps_computation_time == 0.0: # First call
self._time = current
self._time_since_last_round = 0.0
self._last_fps_computation_time = current
self.begin_round()
delta = current - self._time
self._time = current
while self._time_since_last_round + delta > self.round_duration: # Start a new frame
spent_time = self.round_duration - self._time_since_last_round
self.advance_time(spent_time / self.round_duration) # Complete the previous round
self.end_round() # Ends the previous round
self.begin_round() # Prepare the following round
if self._next_round_tasks:
for task in self._next_round_tasks: task()
self._next_round_tasks = []
delta = delta - spent_time
self._time_since_last_round = 0
self.will_render = 1
self.advance_time(delta / self.round_duration) # start the current round
self.will_render = 0
self._time_since_last_round = self._time_since_last_round + delta
self.render()
self._nb_frame = self._nb_frame + 1
if self._nb_frame == 80:
self.fps = 80 / (current - self._last_fps_computation_time)
self._last_fps_computation_time = current
self._nb_frame = 0
def begin_round(self):
"""MainLoop.begin_round()
Called by MainLoop.main_loop when a new round begins; default implementation delegates to MainLoop.scene.begin_round."""
cdef _World scene
for item in MAIN_LOOP_ITEMS: item.begin_round()
for scene in self._scenes: scene.begin_round()
if root_widget: root_widget.widget_begin_round()
def end_round(self):
"""MainLoop.end_round()
Called by MainLoop.main_loop when a round is finished; default implementation delegates to MainLoop.scene.end_round."""
cdef _World scene
for item in MAIN_LOOP_ITEMS: item.end_round()
for scene in self._scenes: scene.end_round()
if root_widget: root_widget.widget_end_round()
PyErr_CheckSignals()
def advance_time(self, float proportion):
"""MainLoop.advance_time(proportion)
Called by MainLoop.main_loop when a piece of a round has occured; default implementation delegates to MainLoop.scene.advance_time.
PROPORTION is the proportion of the current round's time that has passed (1.0 for an entire round)."""
cdef _World scene
for item in MAIN_LOOP_ITEMS: item.advance_time(proportion)
for scene in self._scenes: scene.advance_time(proportion)
if root_widget: root_widget.widget_advance_time(proportion)
def render(self):
"""MainLoop.render()
Called by MainLoop.main_loop when rendering is needed; default implementation calls soya.render."""
for i in BEFORE_RENDER: i()
render()
|
