/usr/lib/python2.7/dist-packages/chaco/tools/better_selecting_zoom.py is in python-chaco 4.5.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | from __future__ import with_statement
import numpy
from chaco.abstract_overlay import AbstractOverlay
from enable.api import ColorTrait, KeySpec
from traits.api import Bool, Enum, Trait, Int, Float, Tuple, Instance, Property
from traits.util.deprecated import deprecated
from better_zoom import BetterZoom
from tool_states import SelectedZoomState
class BetterSelectingZoom(AbstractOverlay, BetterZoom):
""" Zooming tool which allows the user to draw a box which defines the
desired region to zoom in to
"""
# The selection mode:
#
# range:
# Select a range across a single index or value axis.
# box:
# Perform a "box" selection on two axes.
tool_mode = Enum("box", "range")
# Is the tool always "on"? If True, left-clicking always initiates
# a zoom operation; if False, the user must press a key to enter zoom mode.
always_on = Bool(False)
# Defines a meta-key, that works with always_on to set the zoom mode. This
# is useful when the zoom tool is used in conjunction with the pan tool.
always_on_modifier = Enum('control', 'shift', 'control', 'alt')
# The mouse button that initiates the drag. If "None", then the tool
# will not respond to drag. (It can still respond to mousewheel events.)
drag_button = Enum("left", "right", None)
# The minimum amount of screen space the user must select in order for
# the tool to actually take effect.
minimum_screen_delta = Int(10)
#-------------------------------------------------------------------------
# deprecated interaction controls, used for API compatability with
# SimpleZoom
#-------------------------------------------------------------------------
# Conversion ratio from wheel steps to zoom factors.
wheel_zoom_step = Property(Float, depends_on='zoom_factor')
# The key press to enter zoom mode, if **always_on** is False. Has no effect
# if **always_on** is True.
enter_zoom_key = Instance(KeySpec, args=("z",))
# The key press to leave zoom mode, if **always_on** is False. Has no effect
# if **always_on** is True.
exit_zoom_key = Instance(KeySpec, args=("z",))
# Disable the tool after the zoom is completed?
disable_on_complete = Property()
#-------------------------------------------------------------------------
# Appearance properties (for Box mode)
#-------------------------------------------------------------------------
# The pointer to use when drawing a zoom box.
pointer = "magnifier"
# The color of the selection box.
color = ColorTrait("lightskyblue")
# The alpha value to apply to **color** when filling in the selection
# region. Because it is almost certainly useless to have an opaque zoom
# rectangle, but it's also extremely useful to be able to use the normal
# named colors from Enable, this attribute allows the specification of a
# separate alpha value that replaces the alpha value of **color** at draw
# time.
alpha = Trait(0.4, None, Float)
# The color of the outside selection rectangle.
border_color = ColorTrait("dodgerblue")
# The thickness of selection rectangle border.
border_size = Int(1)
# The possible event states of this zoom tool.
event_state = Enum("normal", "selecting", "pre_selecting")
# The (x,y) screen point where the mouse went down.
_screen_start = Trait(None, None, Tuple)
# The (x,,y) screen point of the last seen mouse move event.
_screen_end = Trait(None, None, Tuple)
# If **always_on** is False, this attribute indicates whether the tool
# is currently enabled.
_enabled = Bool(False)
#-------------------------------------------------------------------------
# Private traits
#-------------------------------------------------------------------------
# the original numerical screen ranges
_orig_low_setting = Tuple
_orig_high_setting = Tuple
def __init__(self, component=None, *args, **kw):
# Since this class uses multiple inheritance (eek!), lets be
# explicit about the order of the parent class constructors
AbstractOverlay.__init__(self, component, *args, **kw)
BetterZoom.__init__(self, component, *args, **kw)
# Store the original range settings
x_range = self._get_x_mapper().range
y_range = self._get_y_mapper().range
self._orig_low_setting = (x_range.low_setting, y_range.low_setting)
self._orig_high_setting = (x_range.high_setting, y_range.high_setting)
def reset(self, event=None):
""" Resets the tool to normal state, with no start or end position.
"""
self.event_state = "normal"
self._screen_start = None
self._screen_end = None
#--------------------------------------------------------------------------
# BetterZoom interface
#--------------------------------------------------------------------------
def normal_key_pressed(self, event):
""" Handles a key being pressed when the tool is in the 'normal'
state.
"""
if not self.always_on:
if self.enter_zoom_key.match(event) and not self._enabled:
self.event_state = 'pre_selecting'
event.window.set_pointer(self.pointer)
event.window.set_mouse_owner(self, event.net_transform())
self._enabled = True
event.handled = True
elif self.exit_zoom_key.match(event) and self._enabled:
self.state = 'normal'
self._end_select(event)
event.handled = True
if not event.handled:
super(BetterSelectingZoom, self).normal_key_pressed(event)
def normal_left_down(self, event):
""" Handles the left mouse button being pressed while the tool is
in the 'normal' state.
If the tool is enabled or always on, it starts selecting.
"""
if self._is_enabling_event(event):
self._start_select(event)
event.handled = True
return
def normal_right_down(self, event):
""" Handles the right mouse button being pressed while the tool is
in the 'normal' state.
If the tool is enabled or always on, it starts selecting.
"""
if self._is_enabling_event(event):
self._start_select(event)
event.handled = True
return
def pre_selecting_left_down(self, event):
""" The user pressed the key to turn on the zoom mode,
now handle the click to start the select mode
"""
self._start_select(event)
event.handled = True
def pre_selecting_key_pressed(self, event):
""" Handle key presses, specifically the exit zoom key
"""
if self.exit_zoom_key.match(event) and self._enabled:
self._end_selecting(event)
def selecting_key_pressed(self, event):
""" Handle key presses, specifically the exit zoom key
"""
if self.exit_zoom_key.match(event) and self._enabled:
self._end_selecting(event)
def selecting_mouse_move(self, event):
""" Handles the mouse moving when the tool is in the 'selecting' state.
The selection is extended to the current mouse position.
"""
# Take into account when we update the current endpoint, but only
# if we are in box select mode. The way we handle aspect ratio
# is to find the largest rectangle of the specified aspect which
# will fit within the rectangle defined by the start coords and
# the current mouse position.
if self.tool_mode == "box" and self.aspect_ratio is not None:
x1, y1 = self._screen_start
x2, y2 = event.x, event.y
if (y2 - y1) == 0:
x2 = x1
y2 = y1
else:
width = abs(x2 - x1)
height = abs(y2 - y1)
drawn_aspect = width / height
if drawn_aspect > self.aspect_ratio:
# Drawn box is wider, so use its height to compute the
# restricted width
x2 = x1 + height * self.aspect_ratio * (1 if x2 > x1 else -1)
else:
# Drawn box is taller, so use its width to compute the
# restricted height
y2 = y1 + width / self.aspect_ratio * (1 if y2 > y1 else -1)
self._screen_end = (x2, y2)
else:
self._screen_end = (event.x, event.y)
self.component.request_redraw()
event.handled = True
return
def selecting_left_up(self, event):
""" Handles the left mouse button being released when the tool is in
the 'selecting' state.
Finishes selecting and does the zoom.
"""
if self.drag_button in ("left", None):
self._end_select(event)
return
def selecting_right_up(self, event):
""" Handles the right mouse button being released when the tool is in
the 'selecting' state.
Finishes selecting and does the zoom.
"""
if self.drag_button == "right":
self._end_select(event)
return
def selecting_mouse_leave(self, event):
""" Handles the mouse leaving the plot when the tool is in the
'selecting' state.
Ends the selection operation without zooming.
"""
self._end_selecting(event)
return
#--------------------------------------------------------------------------
# AbstractOverlay interface
#--------------------------------------------------------------------------
def overlay(self, component, gc, view_bounds=None, mode="normal"):
""" Draws this component overlaid on another component.
Overrides AbstractOverlay.
"""
if self.event_state == "selecting":
if self.tool_mode == "range":
self._overlay_range(component, gc)
else:
self._overlay_box(component, gc)
return
#--------------------------------------------------------------------------
# private interface
#--------------------------------------------------------------------------
@deprecated
def _get_disable_on_complete(self):
return True
@deprecated
def _set_disable_on_complete(self, value):
return
@deprecated
def _get_wheel_zoom_step(self):
return self.zoom_factor - 1.0
@deprecated
def _set_wheel_zoom_step(self, value):
self.zoom_factor = value + 1.0
def _is_enabling_event(self, event):
if self.always_on:
enabled = True
else:
if self.always_on_modifier == 'shift':
enabled = event.shift_down
elif self.always_on_modifier == 'control':
enabled = event.control_down
elif self.always_on_modifier == 'alt':
enabled = event.alt_down
if enabled:
if event.right_down and self.drag_button == 'right':
return True
if event.left_down and self.drag_button == 'left':
return True
return False
def _start_select(self, event):
""" Starts selecting the zoom region
"""
if self.component.active_tool in (None, self):
self.component.active_tool = self
else:
self._enabled = False
self._screen_start = (event.x, event.y)
self._screen_end = None
self.event_state = "selecting"
event.window.set_pointer(self.pointer)
event.window.set_mouse_owner(self, event.net_transform())
self.selecting_mouse_move(event)
return
def _end_select(self, event):
""" Ends selection of the zoom region, adds the new zoom range to
the zoom stack, and does the zoom.
"""
self._screen_end = (event.x, event.y)
start = numpy.array(self._screen_start)
end = numpy.array(self._screen_end)
if sum(abs(end - start)) < self.minimum_screen_delta:
self._end_selecting(event)
event.handled = True
return
low, high = self._map_coordinate_box(self._screen_start, self._screen_end)
x_range = self._get_x_mapper().range
y_range = self._get_y_mapper().range
prev = (x_range.low, x_range.high, y_range.low, y_range.high)
if self.tool_mode == 'range':
axis = self._determine_axis()
if axis == 1:
# vertical
next = (x_range.low, x_range.high, low[1], high[1])
else:
# horizontal
next = (low[0], high[0], y_range.low, y_range.high)
else:
next = (low[0], high[0], low[1], high[1])
zoom_state = SelectedZoomState(prev, next)
zoom_state.apply(self)
self._append_state(zoom_state)
self._end_selecting(event)
event.handled = True
return
def _end_selecting(self, event=None):
""" Ends selection of zoom region, without zooming.
"""
self.reset()
self._enabled = False
if self.component.active_tool == self:
self.component.active_tool = None
if event and event.window:
event.window.set_pointer("arrow")
self.component.request_redraw()
if event and event.window.mouse_owner == self:
event.window.set_mouse_owner(None)
return
def _overlay_box(self, component, gc):
""" Draws the overlay as a box.
"""
if self._screen_start and self._screen_end:
with gc:
gc.set_antialias(0)
gc.set_line_width(self.border_size)
gc.set_stroke_color(self.border_color_)
gc.clip_to_rect(component.x, component.y, component.width, component.height)
x, y = self._screen_start
x2, y2 = self._screen_end
rect = (x, y, x2-x+1, y2-y+1)
if self.color != "transparent":
if self.alpha:
color = list(self.color_)
if len(color) == 4:
color[3] = self.alpha
else:
color += [self.alpha]
else:
color = self.color_
gc.set_fill_color(color)
gc.draw_rect(rect)
else:
gc.rect(*rect)
gc.stroke_path()
return
def _overlay_range(self, component, gc):
""" Draws the overlay as a range.
"""
axis_ndx = self._determine_axis()
lower_left = [0,0]
upper_right = [0,0]
lower_left[axis_ndx] = self._screen_start[axis_ndx]
lower_left[1-axis_ndx] = self.component.position[1-axis_ndx]
upper_right[axis_ndx] = self._screen_end[axis_ndx] - self._screen_start[axis_ndx]
upper_right[1-axis_ndx] = self.component.bounds[1-axis_ndx]
with gc:
gc.set_antialias(0)
gc.set_alpha(self.alpha)
gc.set_fill_color(self.color_)
gc.set_stroke_color(self.border_color_)
gc.clip_to_rect(component.x, component.y, component.width, component.height)
gc.draw_rect((lower_left[0], lower_left[1], upper_right[0], upper_right[1]))
return
def _determine_axis(self):
""" Determines whether the index of the coordinate along the axis of
interest is the first or second element of an (x,y) coordinate tuple.
"""
if self.axis == "index":
if self.component.orientation == "h":
return 0
else:
return 1
else:
if self.component.orientation == "h":
return 1
else:
return 0
def _map_coordinate_box(self, start, end):
""" Given start and end points in screen space, returns corresponding
low and high points in data space.
"""
low = [0,0]
high = [0,0]
for axis_index, mapper in [(0, self.component.x_mapper), \
(1, self.component.y_mapper)]:
# Ignore missing axis mappers (ColorBar instances only have one).
if not mapper:
continue
low_val = mapper.map_data(start[axis_index])
high_val = mapper.map_data(end[axis_index])
if low_val > high_val:
low_val, high_val = high_val, low_val
low[axis_index] = low_val
high[axis_index] = high_val
return low, high
def _reset_range_settings(self):
""" Reset the range settings to their original values """
x_range = self._get_x_mapper().range
y_range = self._get_y_mapper().range
x_range.low_setting, y_range.low_setting = self._orig_low_setting
x_range.high_setting, y_range.high_setting = self._orig_high_setting
#--------------------------------------------------------------------------
# overloaded
#--------------------------------------------------------------------------
def _prev_state_pressed(self):
super(BetterSelectingZoom, self)._prev_state_pressed()
# Reset the range settings
if self._history_index == 0:
self._reset_range_settings()
def _reset_state_pressed(self):
super(BetterSelectingZoom, self)._reset_state_pressed()
# Reset the range settings
self._reset_range_settings()
|