annotate src/parpg/grease/mode.py @ 27:09b581087d68

Added base files for grease
author KarstenBock@gmx.net
date Tue, 12 Jul 2011 10:16:48 +0200
parents
children e00919fc0510
rev   line source
27
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
1 #############################################################################
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
2 #
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
3 # Copyright (c) 2010 by Casey Duncan and contributors
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
4 # All Rights Reserved.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
5 #
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
6 # This software is subject to the provisions of the MIT License
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
7 # A copy of the license should accompany this distribution.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
8 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
9 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
10 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
11 #
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
12 #############################################################################
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
13 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
14 Modes manage the state and transition between different application modes.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
15 Typically such modes are presented as different screens that the user can
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
16 navigate between, similar to the way a browser navigates web pages. Individual
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
17 modes may be things like:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
18
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
19 - Title screen
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
20 - Options dialog
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
21 - About screen
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
22 - In-progress game
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
23 - Inventory interface
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
24
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
25 The modal framework provides a simple mechanism to ensure that modes are
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
26 activated and deactivated properly. An activated mode is running and receives
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
27 events. A deactivated mode is paused and does not receive events.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
28
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
29 Modes may be managed as a *last-in-first-out* stack, or as a list, or ring
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
30 of modes in sequence, or some combination of all.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
31
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
32 For example usage see: :ref:`the mode section of the tutorial <tut-mode-section>`.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
33 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
34
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
35 __version__ = '$Id$'
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
36
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
37 import abc
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
38
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
39
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
40 class BaseManager(object):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
41 """Mode manager abstract base class.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
42
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
43 The mode manager keeps a stack of modes where a single mode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
44 is active at one time. As modes are pushed on and popped from
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
45 the stack, the mode at the top is always active. The current
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
46 active mode receives events from the manager's event dispatcher.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
47 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
48
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
49 modes = ()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
50 """The mode stack sequence. The last mode in the stack is
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
51 the current active mode. Read-only.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
52 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
53
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
54 @property
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
55 def current_mode(self):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
56 """The current active mode or ``None``. Read-only"""
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
57 try:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
58 return self.modes[-1]
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
59 except IndexError:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
60 return None
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
61
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
62 def on_last_mode_pop(self, mode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
63 """Hook executed when the last mode is popped from the manager.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
64 Implementing this method is optional for subclasses.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
65
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
66 :param mode: The :class:`Mode` object just popped from the manager
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
67 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
68
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
69 def activate_mode(self, mode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
70 """Perform actions to activate a node
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
71
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
72 :param mode: The :class: 'Mode' object to activate
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
73 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
74 mode.activate(self)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
75
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
76 def deactivate_mode(self, mode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
77 """Perform actions to deactivate a node
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
78
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
79 :param mode: The :class: 'Mode' object to deactivate
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
80 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
81 mode.deactivate(self)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
82
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
83
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
84 def push_mode(self, mode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
85 """Push a mode to the top of the mode stack and make it active
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
86
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
87 :param mode: The :class:`Mode` object to make active
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
88 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
89 current = self.current_mode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
90 if current is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
91 self.deactivate_mode(current)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
92 self.modes.append(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
93 self.activate_mode(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
94
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
95 def pop_mode(self):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
96 """Pop the current mode off the top of the stack and deactivate it.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
97 The mode now at the top of the stack, if any is then activated.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
98
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
99 :param mode: The :class:`Mode` object popped from the stack
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
100 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
101 mode = self.modes.pop()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
102 mode.deactivate(self)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
103 self.event_dispatcher.remove_handlers(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
104 current = self.current_mode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
105 if current is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
106 self.activate_mode(current)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
107 else:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
108 self.on_last_mode_pop(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
109 return mode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
110
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
111 def swap_modes(self, mode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
112 """Exchange the specified mode with the mode at the top of the stack.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
113 This is similar to popping the current mode and pushing the specified
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
114 one, but without activating the previous mode on the stack or
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
115 executing :meth:`on_last_mode_pop()` if there is no previous mode.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
116
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
117 :param mode: The :class:`Mode` object that was deactivated and replaced.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
118 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
119 old_mode = self.modes.pop()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
120 self.deactivate_mode(old_mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
121 self.modes.append(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
122 self.activate_mode(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
123 return old_mode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
124
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
125 def remove_mode(self, mode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
126 """Remove the specified mode. If the mode is at the top of the stack,
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
127 this is equivilent to :meth:`pop_mode()`. If not, no other modes
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
128 are affected. If the mode is not in the manager, do nothing.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
129
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
130 :param mode: The :class:`Mode` object to remove from the manager.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
131 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
132 if self.current_mode is mode:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
133 self.pop_mode()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
134 else:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
135 try:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
136 self.modes.remove(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
137 except ValueError:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
138 pass
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
139
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
140 class BaseMode(object):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
141 """Application mode very abstract base class
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
142 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
143 __metaclass__ = abc.ABCMeta
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
144
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
145 manager = None
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
146 """The :class:`BaseManager` that manages this mode"""
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
147
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
148 def __init__(self):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
149 self.active = False
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
150
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
151 def on_activate(self):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
152 """Being called when the Mode is activated"""
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
153 pass
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
154
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
155 def activate(self, mode_manager):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
156 """Activate the mode for the given mode manager, if the mode is already active,
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
157 do nothing
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
158
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
159 The default implementation schedules time steps at :attr:`step_rate` per
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
160 second, sets the :attr:`manager` and sets the :attr:`active` flag to True.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
161 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
162 if not self.active:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
163 self.on_activate()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
164 self.manager = mode_manager
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
165 self.active = True
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
166
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
167 def on_deactivate(self):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
168 """Being called when the Mode is deactivated"""
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
169 pass
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
170
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
171 def deactivate(self, mode_manager):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
172 """Deactivate the mode, if the mode is not active, do nothing
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
173
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
174 The default implementation unschedules time steps for the mode and
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
175 sets the :attr:`active` flag to False.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
176 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
177 self.on_deactivate()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
178 self.active = False
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
179
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
180
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
181 class BaseMulti(BaseMode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
182 """A mode with multiple submodes. One submode is active at one time.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
183 Submodes can be switched to directly or switched in sequence. If
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
184 the Multi is active, then one submode is always active.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
185
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
186 Multis are useful when modes can switch in an order other than
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
187 a LIFO stack, such as in "hotseat" multiplayer games, a
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
188 "wizard" style ui, or a sequence of slides.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
189
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
190 Note unlike a normal :class:`Mode`, a :class:`Multi` doesn't have it's own
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
191 :attr:`clock` and :attr:`step_rate`. The active submode's are used
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
192 instead.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
193 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
194 active_submode = None
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
195 """The currently active submode"""
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
196
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
197 def __init__(self, *submodes):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
198 # We do not invoke the superclass __init__ intentionally
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
199 self.active = False
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
200 self.submodes = list(submodes)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
201
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
202 def add_submode(self, mode, before=None, index=None):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
203 """Add the submode, but do not make it active.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
204
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
205 :param mode: The :class:`Mode` object to add.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
206
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
207 :param before: The existing mode to insert the mode before.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
208 If the mode specified is not a submode, raise
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
209 ValueError.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
210
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
211 :param index: The place to insert the mode in the mode list.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
212 Only one of ``before`` or ``index`` may be specified.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
213
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
214 If neither ``before`` or ``index`` are specified, the
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
215 mode is appended to the end of the list.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
216 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
217 assert before is None or index is None, (
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
218 "Cannot specify both 'before' and 'index' arguments")
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
219 if before is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
220 index = self.submodes.index(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
221 if index is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
222 self.submodes.insert(index, mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
223 else:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
224 self.submodes.append(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
225
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
226 def remove_submode(self, mode=None):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
227 """Remove the submode.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
228
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
229 :param mode: The submode to remove, if omitted the active submode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
230 is removed. If the mode is not present, do nothing. If the
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
231 mode is active, it is deactivated, and the next mode, if any
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
232 is activated. If the last mode is removed, the :class:`Multi`
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
233 is removed from its manager.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
234 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
235 # TODO handle multiple instances of the same subnode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
236 if mode is None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
237 mode = self.active_submode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
238 elif mode not in self.submodes:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
239 return
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
240 next_mode = self.activate_next()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
241 self.submodes.remove(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
242 if next_mode is mode:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
243 if self.manager is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
244 self.manager.remove_mode(self)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
245 self._deactivate_submode()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
246
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
247 def activate_subnode(self, mode, before=None, index=None):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
248 """Activate the specified mode, adding it as a subnode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
249 if it is not already. If the mode is already the active
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
250 submode, do nothing.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
251
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
252 :param mode: The mode to activate, and add as necesary.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
253
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
254 :param before: The existing mode to insert the mode before
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
255 if it is not already a submode. If the mode specified is not
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
256 a submode, raise ValueError.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
257
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
258 :param index: The place to insert the mode in the mode list
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
259 if it is not already a submode. Only one of ``before`` or
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
260 ``index`` may be specified.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
261
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
262 If the mode is already a submode, the ``before`` and ``index``
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
263 arguments are ignored.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
264 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
265 if mode not in self.submodes:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
266 self.add_submode(mode, before, index)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
267 if self.active_submode is not mode:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
268 self._activate_submode(mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
269
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
270 def activate_next(self, loop=True):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
271 """Activate the submode after the current submode in order. If there
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
272 is no current submode, the first submode is activated.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
273
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
274 Note if there is only one submode, it's active, and `loop` is True
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
275 (the default), then this method does nothing and the subnode remains
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
276 active.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
277
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
278 :param loop: When :meth:`activate_next` is called
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
279 when the last submode is active, a True value for ``loop`` will
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
280 cause the first submode to be activated. Otherwise the
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
281 :class:`Multi` is removed from its manager.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
282 :type loop: bool
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
283
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
284 :return:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
285 The submode that was activated or None if there is no
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
286 other submode to activate.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
287 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
288 assert self.submodes, "No submode to activate"
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
289 next_mode = None
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
290 if self.active_submode is None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
291 next_mode = self.submodes[0]
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
292 else:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
293 last_mode = self.active_submode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
294 index = self.submodes.index(last_mode) + 1
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
295 if index < len(self.submodes):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
296 next_mode = self.submodes[index]
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
297 elif loop:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
298 next_mode = self.submodes[0]
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
299 self._activate_submode(next_mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
300 return next_mode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
301
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
302 def activate_previous(self, loop=True):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
303 """Activate the submode before the current submode in order. If there
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
304 is no current submode, the last submode is activated.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
305
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
306 Note if there is only one submode, it's active, and `loop` is True
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
307 (the default), then this method does nothing and the subnode remains
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
308 active.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
309
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
310 :param loop: When :meth:`activate_previous` is called
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
311 when the first submode is active, a True value for ``loop`` will
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
312 cause the last submode to be activated. Otherwise the
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
313 :class:`Multi` is removed from its manager.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
314 :type loop: bool
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
315
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
316 :return:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
317 The submode that was activated or None if there is no
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
318 other submode to activate.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
319 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
320 assert self.submodes, "No submode to activate"
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
321 prev_mode = None
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
322 if self.active_submode is None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
323 prev_mode = self.submodes[-1]
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
324 else:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
325 last_mode = self.active_submode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
326 index = self.submodes.index(last_mode) - 1
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
327 if loop or index >= 0:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
328 prev_mode = self.submodes[index]
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
329 self._activate_submode(prev_mode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
330 return prev_mode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
331
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
332 def _set_active_submode(self, submode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
333 self.active_submode = submode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
334 self.step_rate = submode.step_rate
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
335
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
336 def _activate_submode(self, submode):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
337 """Activate a submode deactivating any current submode. If the Multi
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
338 itself is active, this happens immediately, otherwise the actual
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
339 activation is deferred until the Multi is activated. If the submode
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
340 is None, the Mulitmode is removed from its manager.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
341
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
342 If submode is already the active submode, do nothing.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
343 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
344 if self.active_submode is submode:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
345 return
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
346 assert submode in self.submodes, "Unknown submode"
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
347 self._deactivate_submode()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
348 self._set_active_submode(submode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
349 if submode is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
350 if self.active:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
351 self.manager.activate_mode(submode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
352 else:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
353 if self.manager is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
354 self.manager.remove_mode(self)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
355
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
356 def clear_subnode(self):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
357 """Clear any subnmode data"""
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
358 self.active_submode = None
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
359 self.step_rate = None
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
360
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
361 def _deactivate_submode(self, clear_subnode=True):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
362 """Deactivate the current submode, if any. if `clear_subnode` is
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
363 True, `active_submode` is always None when this method returns
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
364 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
365 if self.active_submode is not None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
366 if self.active:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
367 self.manager.deactivate_mode(self.active_submode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
368 if clear_subnode:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
369 self.clear_subnode()
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
370
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
371 def activate(self, mode_manager):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
372 """Activate the :class:`Multi` for the specified manager. The
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
373 previously active submode of the :class:`Multi` is activated. If there
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
374 is no previously active submode, then the first submode is made active.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
375 A :class:`Multi` with no submodes cannot be activated
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
376 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
377 assert self.submodes, "No submode to activate"
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
378 self.manager = mode_manager
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
379 if self.active_submode is None:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
380 self._set_active_submode(self.submodes[0])
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
381 else:
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
382 self._set_active_submode(self.active_submode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
383 self.manager.activate_mode(self.active_submode)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
384 super(BaseMulti, self).activate(mode_manager)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
385
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
386 def deactivate(self, mode_manager):
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
387 """Deactivate the :class:`Multi` for the specified manager.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
388 The `active_submode`, if any, is deactivated.
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
389 """
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
390 self._deactivate_submode(clear_subnode=False)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
391 super(BaseMulti, self).deactivate(mode_manager)
09b581087d68 Added base files for grease
KarstenBock@gmx.net
parents:
diff changeset
392