Home       Trees       Index       Help   

Aldrin API

Package aldrin :: Module router :: Class RouteView
[show private | hide private]
[frames | no frames]

Type RouteView

object --+                
         |                
    Object --+            
             |            
    EvtHandler --+        
                 |        
            Window --+    
                     |    
                Canvas --+
                         |
                        RouteView

Allows to monitor and control plugins and their connections.
Method Summary
  __init__(self, rootwindow, *args, **kwds)
Initializer.
  draw_leds(self)
Draws only the leds into the offscreen buffer.
  DrawBuffer(self, leds_only)
Draws machines, connections and arrows to an offscreen buffer.
(int,int) float_to_pixel(self, (x, y))
Converts a router coordinate to an on-screen pixel coordinate.
libzzub.Connection or None get_connection_at(self, (mx, my))
Finds the connection arrow at a specific position.
(libzzub.Metaplugin,(int,int)) or None get_plugin_at(self, (x, y))
Finds a plugin at a specific position.
wx.Menu get_plugin_menu(self)
Generates and returns a new plugin menu.
  on_context_menu(self, event)
Event handler for requests to show the context menu.
  on_draw_led_timer(self, event)
Timer event that only updates the machine leds.
  on_focus(self, event)
  on_left_dclick(self, event)
Event handler for left doubleclicks.
  on_left_down(self, event)
Event handler for left mouse button presses.
  on_left_up(self, event)
Event handler for left mouse button releases.
  on_motion(self, event)
Event handler for mouse movements.
  on_player_callback(self, player, plugin, data)
callback for ui events sent by libzzub.
  on_popup_command(self, event)
Event handler for requests to show the context menu.
  on_popup_delete(self, event)
Event handler for the "Delete" context menu option.
  on_popup_disconnect(self, event)
Event handler for the "Disconnect" context menu option.
  on_popup_mute(self, event)
Event handler for the "Mute" context menu option.
  on_popup_new_plugin(self, event, pl)
Event handler for "new plugin" context menu options.
  on_popup_rename(self, event)
  on_popup_show_attribs(self, event)
Event handler for the "Attributes..." context menu option.
  on_popup_show_params(self, event)
Event handler for the "Parameters..." context menu option.
  on_popup_solo(self, event)
Event handler for the "Mute" context menu option.
(float, float) pixel_to_float(self, (x, y))
Converts an on-screen pixel coordinate to a router coordinate.
  reset(self)
Destroys all parameter dialogs.
  show_parameter_dialog(self, plugin)
Shows a parameter dialog for a plugin.
  solo(self, machine)
  toggle_mute(self, machine)
  update_all(self)
  update_colors(self)
Updates the routers color scheme.
  update_info(self)
  yield_newplugin_indices(self)
    Inherited from Canvas
  Blit(self, dc)
Performs the blit of the buffer contents on-screen.
  GetBoundingRect(self)
Returns a tuple that contains the co-ordinates of the top-left and bottom-right corners of the canvas.
  MakeNewBuffer(self)
  onEraseBackground(self, event)
  onPaint(self, event)
Renders the off-screen buffer on-screen.
  onPostPaint(self, dc)
  onSize(self, event)
Perform actual redraw to off-screen buffer only when the size of the canvas has changed.
  ReDraw(self, *args, **kargs)
Explicitly tells the canvas to redraw it's contents.
  Refresh(self)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
int ABOUT = 370                                                                   
int ATTRIBS = 367                                                                   
int CENTERPAN = 365                                                                   
int CMDBASEID = 375                                                                   
bool connecting = False
NoneType context_conn = None                                                                  
NoneType context_plugin = None                                                                  
tuple contextmenupos = (0, 0)
NoneType current_plugin = None                                                                  
int DELETE = 369                                                                   
int DISCONNECT = 374                                                                   
bool dragging = False
tuple dragoffset = (0, 0)
int i = 8191                                                                  
int IMPORTSONG = 372                                                                   
int MAX_PLUGINS = 8192                                                                  
int MUTE = 363                                                                   
int NEWPLUGIN = 631                                                                   
int PARAMS = 366                                                                   
int RENAME = 368                                                                   
int SIGNALANALYSIS = 371                                                                   
int SOLO = 364                                                                   
int UNMUTEALL = 373                                                                   
    Inherited from Canvas
bool doublebuffered = True

Instance Method Details

__init__(self, rootwindow, *args, **kwds)
(Constructor)

Initializer.
Parameters:
rootwindow - Main window.
           (type=wx.Frame)
Overrides:
aldrin.canvas.Canvas.__init__

draw_leds(self)

Draws only the leds into the offscreen buffer.

DrawBuffer(self, leds_only=False)

Draws machines, connections and arrows to an offscreen buffer.
Overrides:
aldrin.canvas.Canvas.DrawBuffer

float_to_pixel(self, (x, y))

Converts a router coordinate to an on-screen pixel coordinate.
Parameters:
x - X coordinate.
           (type=float)
y - Y coordinate.
           (type=float)
Returns:
A tuple returning the pixel coordinate.
           (type=(int,int))

get_connection_at(self, (mx, my))

Finds the connection arrow at a specific position.
Parameters:
mx - X coordinate in pixels.
           (type=int)
my - Y coordinate in pixels.
           (type=int)
Returns:
A connection item or None.
           (type=libzzub.Connection or None)

get_plugin_at(self, (x, y))

Finds a plugin at a specific position.
Parameters:
x - X coordinate in pixels.
           (type=int)
y - Y coordinate in pixels.
           (type=int)
Returns:
A connection item and exact pixel position or None.
           (type=(libzzub.Metaplugin,(int,int)) or None)

get_plugin_menu(self)

Generates and returns a new plugin menu.
Returns:
A menu containing commands to instantiate new plugins.
           (type=wx.Menu)

on_context_menu(self, event)

Event handler for requests to show the context menu.
Parameters:
event - event.
           (type=wx.Event)

on_draw_led_timer(self, event)

Timer event that only updates the machine leds.
Parameters:
event - Paint event.
           (type=wx.PaintEvent)

on_left_dclick(self, event)

Event handler for left doubleclicks. If the doubleclick hits a plugin, the parameter window is being shown.
Parameters:
event - Mouse event.
           (type=wx.MouseEvent)

on_left_down(self, event)

Event handler for left mouse button presses. Initiates plugin dragging or connection volume adjustments.
Parameters:
event - Mouse event.
           (type=wx.MouseEvent)

on_left_up(self, event)

Event handler for left mouse button releases.
Parameters:
event - Mouse event.
           (type=wx.MouseEvent)

on_motion(self, event)

Event handler for mouse movements.
Parameters:
event - Mouse event.
           (type=wx.MouseEvent)

on_player_callback(self, player, plugin, data)

callback for ui events sent by libzzub.
Parameters:
player - player instance.
           (type=zzub.Player)
plugin - metaplugin instance
           (type=zzub.Metaplugin)
data - event data.
           (type=zzub_event_data_t)

on_popup_command(self, event)

Event handler for requests to show the context menu.
Parameters:
event - event.
           (type=wx.Event)

on_popup_delete(self, event)

Event handler for the "Delete" context menu option.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_popup_disconnect(self, event)

Event handler for the "Disconnect" context menu option.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_popup_mute(self, event)

Event handler for the "Mute" context menu option.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_popup_new_plugin(self, event=None, pl=None)

Event handler for "new plugin" context menu options. if pl is omitted, the pluginloader is deduced from event.GetId().
Parameters:
event - Menu event.
           (type=zzub.Pluginloader)
pl - Pluginloader

on_popup_show_attribs(self, event)

Event handler for the "Attributes..." context menu option.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_popup_show_params(self, event)

Event handler for the "Parameters..." context menu option.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

on_popup_solo(self, event)

Event handler for the "Mute" context menu option.
Parameters:
event - Menu event.
           (type=wx.MenuEvent)

pixel_to_float(self, (x, y))

Converts an on-screen pixel coordinate to a router coordinate.
Parameters:
x - X coordinate.
           (type=int)
y - Y coordinate.
           (type=int)
Returns:
A tuple returning the router coordinate.
           (type=(float, float))

reset(self)

Destroys all parameter dialogs. Used when a new song is being loaded.

show_parameter_dialog(self, plugin)

Shows a parameter dialog for a plugin.
Parameters:
plugin - Metaplugin instance.
           (type=Metaplugin)

update_colors(self)

Updates the routers color scheme.

Class Variable Details

ABOUT

Type:
int
Value:
370                                                                   

ATTRIBS

Type:
int
Value:
367                                                                   

CENTERPAN

Type:
int
Value:
365                                                                   

CMDBASEID

Type:
int
Value:
375                                                                   

connecting

Type:
bool
Value:
False

context_conn

Type:
NoneType
Value:
None                                                                  

context_plugin

Type:
NoneType
Value:
None                                                                  

contextmenupos

Type:
tuple
Value:
(0, 0)

current_plugin

Type:
NoneType
Value:
None                                                                  

DELETE

Type:
int
Value:
369                                                                   

DISCONNECT

Type:
int
Value:
374                                                                   

dragging

Type:
bool
Value:
False

dragoffset

Type:
tuple
Value:
(0, 0)

i

Type:
int
Value:
8191                                                                  

IMPORTSONG

Type:
int
Value:
372                                                                   

MAX_PLUGINS

Type:
int
Value:
8192                                                                  

MUTE

Type:
int
Value:
363                                                                   

NEWPLUGIN

Type:
int
Value:
631                                                                   

PARAMS

Type:
int
Value:
366                                                                   

RENAME

Type:
int
Value:
368                                                                   

SIGNALANALYSIS

Type:
int
Value:
371                                                                   

SOLO

Type:
int
Value:
364                                                                   

UNMUTEALL

Type:
int
Value:
373                                                                   

   Home       Trees       Index       Help   

Aldrin API

Generated by Epydoc 2.1 on Fri Nov 24 13:58:33 2006 http://epydoc.sf.net