Abstract map display window class. More...

Inheritance diagram for mapwindow.MapWindow:

Public Member Functions
def	__init__
def	RegisterMouseEventHandler
	Binds event handler.
def	UnregisterMouseEventHandler
	Unbinds event handler a restores previous state.
def	Pixel2Cell
def	Cell2Pixel
def	OnMotion
	Tracks mouse motion and update statusbar.
def	GetLastEN
	Returns last coordinates of mouse cursor.
def	GetLayerByName
	Get layer from layer tree by nam.
def	GetSelectedLayer
	Get selected layer from layer tree.
Data Fields
	parent
	Map
	tree
	lmgr
	mouse
	lastEN

Detailed Description

Abstract map display window class.

Superclass for BufferedWindow class (2D display mode), and GLWindow (3D display mode).

Subclasses have to define

_bindMouseEvents method which binds MouseEvent handlers
Pixel2Cell
Cell2Pixel (if it is possible)

Definition at line 23 of file gui_core/mapwindow.py.

Constructor & Destructor Documentation

def mapwindow.MapWindow.__init__	(	self,
		parent,
		id = `wx.ID_ANY`,
		Map = `None`,
		tree = `None`,
		lmgr = `None`,
		kwargs
	)

Definition at line 36 of file gui_core/mapwindow.py.

Member Function Documentation

def mapwindow.MapWindow.Cell2Pixel	(	self,
		east,
		north
	)

Reimplemented in mapwindow.BufferedWindow.

Definition at line 137 of file gui_core/mapwindow.py.

Referenced by mapwindow.BufferedWindow.DrawLines(), mapwindow.VDigitWindow.OnLeftUpConnectLine(), and mapwindow.VDigitWindow.OnLeftUpModifyLine().

def mapwindow.MapWindow.GetLastEN ( self )

Returns last coordinates of mouse cursor.

See also:: OnMotion

Definition at line 162 of file gui_core/mapwindow.py.

References mapwindow.MapWindow.lastEN.

def mapwindow.MapWindow.GetLayerByName	(	self,
		name,
		mapType,
		dataType = `'layer'`
	)

Get layer from layer tree by nam.

Parameters:

name	layer name
type	'item' / 'layer' / 'nviz'

Returns:: layer / map layer properties / nviz properties; None

Definition at line 169 of file gui_core/mapwindow.py.

References workspace.ProcessWorkspaceFile.tree, mapwindow.MapWindow.tree, menudata.MenuData.tree, mapdisplay.MapFrame.tree, ghelp.MenuTreeWindow.tree, and model.ProcessModelFile.tree.

def mapwindow.MapWindow.GetSelectedLayer	(	self,
		type = `'layer'`,
		multi = `False`
	)

Get selected layer from layer tree.

Parameters:

type	'item' / 'layer' / 'nviz'
multi	return first selected layer or all

Returns:: layer / map layer properties / nviz properties; None / [] on failure

Definition at line 196 of file gui_core/mapwindow.py.

References workspace.ProcessWorkspaceFile.tree, mapwindow.MapWindow.tree, menudata.MenuData.tree, mapdisplay.MapFrame.tree, ghelp.MenuTreeWindow.tree, and model.ProcessModelFile.tree.

Referenced by mapwindow.GLWindow.DoPaint(), mapwindow.GLWindow.LoadRaster3d(), mapwindow.GLWindow.LoadVector(), mapwindow.GLWindow.OnLeftUp(), mapwindow.BufferedWindow.OnLeftUp(), and mapwindow.BufferedWindow.ZoomToMap().

def mapwindow.MapWindow.OnMotion	(	self,
		event
	)

Tracks mouse motion and update statusbar.

See also:: GetLastEN

Definition at line 140 of file gui_core/mapwindow.py.

References mapwindow.VDigitWindow._onMotion(), mapwindow.MapWindow.lastEN, and mapwindow.MapWindow.Pixel2Cell().

Referenced by mapwindow.GLWindow.StopTimer().

def mapwindow.MapWindow.Pixel2Cell	(	self,
		x,
		y
	)

Reimplemented in mapwindow.BufferedWindow, and mapwindow.GLWindow.

Definition at line 134 of file gui_core/mapwindow.py.

Referenced by mapwindow.BufferedWindow.Distance(), mapwindow.BufferedWindow.OnLeftDown(), mapwindow.VDigitWindow.OnLeftDownAddLine(), mapwindow.VDigitWindow.OnLeftDownDisplayCA(), mapwindow.VDigitWindow.OnLeftDownEditLine(), mapwindow.BufferedWindow.OnLeftUp(), mapwindow.VDigitWindow.OnLeftUpConnectLine(), mapwindow.VDigitWindow.OnLeftUpCopyLine(), mapwindow.VDigitWindow.OnLeftUpModifyLine(), mapwindow.VDigitWindow.OnLeftUpVarious(), mapwindow.MapWindow.OnMotion(), and mapwindow.BufferedWindow.Zoom().

def mapwindow.MapWindow.RegisterMouseEventHandler	(	self,
		event,
		handler,
		cursor = `None`
	)

Binds event handler.

Call event.Skip() in handler to allow default processing in MapWindow.

# your class methods
def OnButton(self, event):
    # current map display's map window
    # expects LayerManager to be the parent
    self.mapwin = self.parent.GetLayerTree().GetMapDisplay().GetWindow()
    if self.mapwin.RegisterMouseEventHandler(wx.EVT_LEFT_DOWN, self.OnMouseAction,
                                     wx.StockCursor(wx.CURSOR_CROSS)):
self.parent.GetLayerTree().GetMapDisplay().Raise()
    else:
# handle that you cannot get coordinates

def OnMouseAction(self, event):
    # get real world coordinates of mouse click
    coor = self.mapwin.Pixel2Cell(event.GetPositionTuple()[:])
    self.text.SetLabel('Coor: ' + str(coor))
    self.mapwin.UnregisterMouseEventHandler(wx.EVT_LEFT_DOWN)
    event.Skip()

Parameters: