2222
2323
2424class EventDrivenFeedback (Feedback ):
25- """
26- Example Feedback:
25+ """Event Driven Feedback Base Class.
2726
28- #!/usr/bin/env python
2927
30- import pygame
28+ Example Feedback::
3129
32- from FeedbackBase.EventDrivenFeedback import EventDrivenFeedback
30+ #!/usr/bin/env python
3331
34- class TestEventDrivenFeedback(EventDrivenFeedback):
32+ import pygame
3533
34+ from FeedbackBase.EventDrivenFeedback import EventDrivenFeedback
3635
37- def run(self):
38- pygame.init()
39- pygame.display.set_mode([800, 600], pygame.HWSURFACE)
40- # Glue pygame events to ours
41- self.bind_event_to_method(pygame.VIDEOEXPOSE, self.paint)
42- self.bind_event_to_method(pygame.KEYDOWN, self.keyboard)
43- self.bind_event_to_method(pygame.MOUSEBUTTONDOWN, self.mouse)
44- # Let's start the show
45- print "executing paint"
46- self.execute([self.paint], 10.0)
47- print "executing mouse, keyboard, paint"
48- self.execute([self.mouse, self.keyboard, self.paint], 10.0)
49- pygame.quit()
36+ class TestEventDrivenFeedback(EventDrivenFeedback):
5037
5138
52- def tick(self):
53- # Poll pygames event queue and dispatch our events
54- for event in pygame.event.get():
55- self.dispatch_event(event.type)
39+ def run(self):
40+ pygame.init()
41+ pygame.display.set_mode([800, 600], pygame.HWSURFACE)
42+ # Glue pygame events to ours
43+ self.bind_event_to_method(pygame.VIDEOEXPOSE, self.paint)
44+ self.bind_event_to_method(pygame.KEYDOWN, self.keyboard)
45+ self.bind_event_to_method(pygame.MOUSEBUTTONDOWN, self.mouse)
46+ # Let's start the show
47+ print "executing paint"
48+ self.execute([self.paint], 10.0)
49+ print "executing mouse, keyboard, paint"
50+ self.execute([self.mouse, self.keyboard, self.paint], 10.0)
51+ pygame.quit()
52+
5653
54+ def tick(self):
55+ # Poll pygames event queue and dispatch our events
56+ for event in pygame.event.get():
57+ self.dispatch_event(event.type)
5758
58- #########################################################################
59- # Our event handlers
60- #########################################################################
61- def paint(self):
62- print "print"
6359
64- def mouse(self):
65- print "mouse"
60+ #########################################################################
61+ # Our event handlers
62+ #########################################################################
63+ def paint(self):
64+ print "print"
6665
67- def keyboard(self):
68- print "keyboard"
69- """
66+ def mouse(self):
67+ print "mouse"
68+
69+ def keyboard(self):
70+ print "keyboard"
71+ """
7072
7173 def on_init (self ):
7274 self .event_method_mapping = dict ()
@@ -78,20 +80,32 @@ def on_play(self):
7880
7981
8082 def run (self ):
81- # Your script goes here.
82- # You should populate this method with execute calls.
83+ """Start the Feedback activity.
84+
85+ Overwrite this method and put your script here. You should populate
86+ this method with :func:`execute` calls.
87+ """
8388 pass
8489
8590
8691 def tick (self ):
87- # Your code to get events and dispatch events goes here.
88- # You should poll the event queue of your toolkit/library/etc and
89- # translate their events to yours.
92+ """
93+ Your code to get events and dispatch events goes here. You should poll
94+ the event queue of your toolkit/library/etc and translate their events
95+ to yours.
96+ """
9097 pass
9198
9299
93100 def execute (self , methodlist , runtime ):
94- """Enable given methods for a certain time."""
101+ """Enable given methods for a certain time.
102+
103+ :param methodlist: Callables
104+ :type methodlist: list
105+ :param runtime: Fractions of Secons
106+ :type runtime: float
107+
108+ """
95109 self .enabled_methods = methodlist
96110 elapsed_time = 0.0
97111 t_start = time .time ()
@@ -101,14 +115,24 @@ def execute(self, methodlist, runtime):
101115
102116
103117 def dispatch_event (self , event ):
104- """Dispatch the event and run the associated method if enabled."""
118+ """Dispatch the event and run the associated method if enabled.
119+
120+ :param event: Event
121+
122+ """
105123 method = self .event_method_mapping .get (event )
106124 if method and method in self .enabled_methods :
107125 # Call the event method
108126 method ()
109127
110128
111129 def bind_event_to_method (self , event , method ):
112- """Bind event to methodcall."""
130+ """Bind event to methodcall.
131+
132+ :param event: An event
133+ :param method: The method which should be called when ``event`` was received.
134+ :type method: callable
135+
136+ """
113137 self .event_method_mapping [event ] = method
114138
0 commit comments