GRASS Programmer's Manual  6.5.svn(2012)-r51648
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Member Functions | Data Fields
mapdisplay.MapFrame Class Reference

Main frame for map display window. More...

Inheritance diagram for mapdisplay.MapFrame:
Inheritance graph
[legend]
Collaboration diagram for mapdisplay.MapFrame:
Collaboration graph
[legend]

Public Member Functions

def __init__
 Main map display window with toolbars, statusbar and DrawWindow.
def AddToolbar
 Add defined toolbar to the window.
def OnUpdateProgress
def OnFocus
def OnDraw
 Re-display current map composition.
def OnRender
 Re-render map composition (each map layer)
def OnPointer
 Pointer button clicked.
def OnZoomIn
def OnZoomOut
def OnPan
def OnErase
def OnZoomRegion
def OnAlignRegion
def SaveToFile
 Save map to image.
def PrintMenu
def FormatDist
 Format length numbers and units in a nice way, as a function of length.
def OnZoomToRaster
 Set display extents to match selected raster map (ignore NULLs)
def OnZoomToSaved
 Set display geometry to match extents in saved region file.
def OnDisplayToWind
 Set computational region (WIND file) to match display extents.
def SaveDisplayRegion
 Save display extents to named region file.
def OnZoomMenu
 Popup Zoom menu.
def IsStandalone
 Check if Map display is standalone.
def GetLayerManager
 Get reference to Layer Manager.
def GetSrcWindow
def GetTgtWindow
def GetShowTarget
def GetMapToolbar
 Returns toolbar with zooming tools.

Data Fields

 tree
 page
 layerbook
 activemap
 SrcMap
 TgtMap
 statusbarItems
 statusbarManager
 SrcMapWindow
 TgtMapWindow
 MapWindow
 Map
 list
 printopt
 digit
 dialogs
 decorationDialog
 show_target

Detailed Description

Main frame for map display window.

Drawing takes place in child double buffered drawing window.

Definition at line 41 of file mapdisplay.py.

Constructor & Destructor Documentation

def mapdisplay.MapFrame.__init__ (   self,
  parent = None,
  title = _("GRASS GIS Manage Ground Control Points"),
  toolbars = ["gcpdisp"],
  tree = None,
  notebook = None,
  lmgr = None,
  page = None,
  Map = None,
  auimgr = None,
  name = 'GCPMapWindow',
  kwargs 
)

Main map display window with toolbars, statusbar and DrawWindow.

Parameters:
toolbarsarray of activated toolbars, e.g. ['map', 'digit']
treereference to layer tree
notebookcontrol book ID in Layer Manager
lmgrLayer Manager
pagenotebook page with layer tree
Mapinstance of render.Map
auimgsAUI manager
kwargswx.Frame attribures

Definition at line 47 of file mapdisplay.py.

References mapdisplay.MapFrame._layerManager.

Member Function Documentation

def mapdisplay.MapFrame.AddToolbar (   self,
  name 
)

Add defined toolbar to the window.

Currently known toolbars are:

  • 'map' - basic map toolbar
  • 'vdigit' - vector digitizer
  • 'gcpdisp' - GCP Manager, Display
  • 'gcpman' - GCP Manager, points management
  • 'nviz' - 3D view mode

Definition at line 206 of file mapdisplay.py.

References mapdisplay.MapFrame.Map, manager.GCPWizard.Map, manager.GCP.Map, mapdisp.MapFrameBase.toolbars, and frame.GMFrame.toolbars.

def mapdisplay.MapFrame.FormatDist (   self,
  dist 
)

Format length numbers and units in a nice way, as a function of length.

From code by Hamish Bowman Grass Development Team 2006

Definition at line 501 of file mapdisplay.py.

References round.

Referenced by frame.MapFrame.MeasureDist().

def mapdisplay.MapFrame.GetLayerManager (   self)

Get reference to Layer Manager.

Returns:
window reference
None (if standalone)

Definition at line 610 of file mapdisplay.py.

References mapdisplay.MapFrame._layerManager.

def mapdisplay.MapFrame.GetMapToolbar (   self)

Returns toolbar with zooming tools.

Definition at line 627 of file mapdisplay.py.

References mapdisp.MapFrameBase.toolbars, and frame.GMFrame.toolbars.

Referenced by manager.GCP.OnDispResize(), mapdisp.MapFrameBase.OnPan(), frame.MapFrame.OnPointer(), frame.MapFrame.OnQuery(), frame.MapFrame.OnRotate(), mapdisp.MapFrameBase.OnZoomIn(), mapdisp.MapFrameBase.OnZoomOut(), and manager.GCP.UpdateActive().

def mapdisplay.MapFrame.GetShowTarget (   self)

Definition at line 624 of file mapdisplay.py.

References mapdisplay.MapFrame.show_target, and manager.GCP.show_target.

def mapdisplay.MapFrame.GetSrcWindow (   self)

Definition at line 618 of file mapdisplay.py.

References mapdisplay.MapFrame.SrcMapWindow.

def mapdisplay.MapFrame.GetTgtWindow (   self)

Definition at line 621 of file mapdisplay.py.

References mapdisplay.MapFrame.TgtMapWindow.

def mapdisplay.MapFrame.IsStandalone (   self)

Check if Map display is standalone.

Definition at line 603 of file mapdisplay.py.

References mapdisplay.MapFrame._layerManager.

Referenced by frame.MapFrame.OnQuery(), and frame.MapFrame.QueryMap().

def mapdisplay.MapFrame.OnAlignRegion (   self,
  event 
) 
Align region

Definition at line 424 of file mapdisplay.py.

def mapdisplay.MapFrame.OnDisplayToWind (   self,
  event 
)

Set computational region (WIND file) to match display extents.

Definition at line 559 of file mapdisplay.py.

Referenced by mapdisplay.MapFrame.OnZoomMenu(), and frame.MapFrame.OnZoomMenu().

def mapdisplay.MapFrame.OnDraw (   self,
  event 
)

Re-display current map composition.

Definition at line 284 of file mapdisplay.py.

def mapdisplay.MapFrame.OnErase (   self,
  event 
) 
Erase the canvas

Definition at line 402 of file mapdisplay.py.

References mapdisplay.MapFrame.MapWindow, manager.GCP.MapWindow, mapdisplay.MapFrame.SrcMapWindow, and mapdisplay.MapFrame.TgtMapWindow.

def mapdisplay.MapFrame.OnFocus (   self,
  event 
) 
Change choicebook page to match display.
Or set display for georectifying

Definition at line 264 of file mapdisplay.py.

References mapdisplay.MapFrame._layerManager, mapdisplay.MapFrame.OnPointer(), and mapdisplay.MapFrame.page.

def mapdisplay.MapFrame.OnPan (   self,
  event 
) 
Panning, set mouse to drag

Definition at line 375 of file mapdisplay.py.

References mapdisp.MapFrameBase.cursors, frame.ModelFrame.cursors, frame.PsMapFrame.cursors, mapwindow.GLWindow.cursors, frame.PsMapBufferedWindow.cursors, mapdisp.MapFrameBase.GetToolbar(), mapdisplay.MapFrame.MapWindow, manager.GCP.MapWindow, mapdisplay.MapFrame.SrcMapWindow, mapdisplay.MapFrame.TgtMapWindow, mapdisp.MapFrameBase.toolbars, and frame.GMFrame.toolbars.

def mapdisplay.MapFrame.OnPointer (   self,
  event 
)

Pointer button clicked.

Definition at line 304 of file mapdisplay.py.

References mapdisp.MapFrameBase.cursors, frame.ModelFrame.cursors, frame.PsMapFrame.cursors, mapwindow.GLWindow.cursors, and frame.PsMapBufferedWindow.cursors.

Referenced by mapdisplay.MapFrame.OnFocus().

def mapdisplay.MapFrame.OnRender (   self,
  event 
)

Re-render map composition (each map layer)

Definition at line 289 of file mapdisplay.py.

References mapdisplay.MapFrame.show_target, manager.GCP.show_target, and mapdisp.MapFrameBase.StatusbarUpdate().

def mapdisplay.MapFrame.OnUpdateProgress (   self,
  event 
) 
Update progress bar info

Definition at line 256 of file mapdisplay.py.

References mapdisp.MapFrameBase.GetProgressBar(), statusbar.SbManager.GetProgressBar(), goutput.GMConsole.GetProgressBar(), and widgets.SetValue().

def mapdisplay.MapFrame.OnZoomIn (   self,
  event 
) 
Zoom in the map.
Set mouse cursor, zoombox attributes, and zoom direction

Definition at line 315 of file mapdisplay.py.

References mapdisp.MapFrameBase.cursors, frame.ModelFrame.cursors, frame.PsMapFrame.cursors, mapwindow.GLWindow.cursors, frame.PsMapBufferedWindow.cursors, mapdisp.MapFrameBase.GetToolbar(), mapdisplay.MapFrame.MapWindow, manager.GCP.MapWindow, mapdisplay.MapFrame.SrcMapWindow, mapdisplay.MapFrame.TgtMapWindow, mapdisp.MapFrameBase.toolbars, and frame.GMFrame.toolbars.

def mapdisplay.MapFrame.OnZoomMenu (   self,
  event 
)

Popup Zoom menu.

Definition at line 570 of file mapdisplay.py.

References mapdisplay.MapFrame.OnDisplayToWind(), mapdisp.MapFrameBase.OnZoomToDefault(), mapdisplay.MapFrame.OnZoomToSaved(), mapdisp.MapFrameBase.OnZoomToWind(), and mapdisplay.MapFrame.SaveDisplayRegion().

def mapdisplay.MapFrame.OnZoomOut (   self,
  event 
) 
Zoom out the map.
Set mouse cursor, zoombox attributes, and zoom direction

Definition at line 345 of file mapdisplay.py.

References mapdisp.MapFrameBase.cursors, frame.ModelFrame.cursors, frame.PsMapFrame.cursors, mapwindow.GLWindow.cursors, frame.PsMapBufferedWindow.cursors, mapdisp.MapFrameBase.GetToolbar(), mapdisplay.MapFrame.MapWindow, manager.GCP.MapWindow, mapdisplay.MapFrame.SrcMapWindow, mapdisplay.MapFrame.TgtMapWindow, mapdisp.MapFrameBase.toolbars, and frame.GMFrame.toolbars.

def mapdisplay.MapFrame.OnZoomRegion (   self,
  event 
) 
Zoom to region

Definition at line 415 of file mapdisplay.py.

References mapwindow.BufferedWindow.UpdateMap(), and mapwindow.GLWindow.UpdateMap().

def mapdisplay.MapFrame.OnZoomToRaster (   self,
  event 
)

Set display extents to match selected raster map (ignore NULLs)

Definition at line 547 of file mapdisplay.py.

def mapdisplay.MapFrame.OnZoomToSaved (   self,
  event 
)

Set display geometry to match extents in saved region file.

Definition at line 553 of file mapdisplay.py.

Referenced by mapdisplay.MapFrame.OnZoomMenu(), and frame.MapFrame.OnZoomMenu().

def mapdisplay.MapFrame.PrintMenu (   self,
  event 
) 
Print options and output menu for map display

Definition at line 477 of file mapdisplay.py.

def mapdisplay.MapFrame.SaveDisplayRegion (   self,
  event 
)

Save display extents to named region file.

Definition at line 565 of file mapdisplay.py.

Referenced by mapdisplay.MapFrame.OnZoomMenu(), and frame.MapFrame.OnZoomMenu().

def mapdisplay.MapFrame.SaveToFile (   self,
  event 
)

Save map to image.

Definition at line 434 of file mapdisplay.py.

References dialogs.GetImageHandlers().

Field Documentation

mapdisplay.MapFrame.activemap

Definition at line 74 of file mapdisplay.py.

mapdisplay.MapFrame.decorationDialog

Definition at line 204 of file mapdisplay.py.

mapdisplay.MapFrame.dialogs

Definition at line 198 of file mapdisplay.py.

Referenced by frame.MapFrame.OnAddBarscale(), frame.MapFrame.OnAddLegend(), frame.MapFrame.OnAddText(), frame.GMFrame.OnPreferences(), frame.GMFrame.OnShowAttributeTable(), and frame.MapFrame.QueryVector().

mapdisplay.MapFrame.digit

Definition at line 187 of file mapdisplay.py.

Referenced by mapwindow.VDigitWindow.GetDisplay(), dialogs.VDigitCategoryDialog.OnCancel(), toolbars.VDigitToolbar.OnSettings(), toolbars.VDigitToolbar.OnTool(), toolbars.VDigitToolbar.StartEditing(), and toolbars.VDigitToolbar.StopEditing().

mapdisplay.MapFrame.layerbook

Definition at line 67 of file mapdisplay.py.

mapdisplay.MapFrame.list

Definition at line 145 of file mapdisplay.py.

Referenced by dialogs.ImportDialog.doLayout(), dialogs.VDigitCategoryDialog.GetListCtrl(), and manager.GCP.GetListCtrl().

mapdisplay.MapFrame.Map

Definition at line 123 of file mapdisplay.py.

Referenced by frame.MapFrame.AddNviz(), mapdisplay.MapFrame.AddToolbar(), frame.MapFrame.AddToolbar(), mapdisp.MapFrameBase.GetMap(), layertree.LayerTree.GetMap(), mapdisp.MapFrameBase.GetMapScale(), frame.MapFrame.GetMapWindow(), mapwindow.BufferedWindow.OnMouseEnter(), and mapdisp.MapFrameBase.SetMapScale().

mapdisplay.MapFrame.MapWindow

Definition at line 122 of file mapdisplay.py.

Referenced by frame.MapFrame.AddNviz(), frame.MapFrame.GetMapWindow(), mapdisp.MapFrameBase.GetWindow(), mapdisplay.MapFrame.OnErase(), mapdisplay.MapFrame.OnPan(), mapdisplay.MapFrame.OnZoomIn(), mapdisplay.MapFrame.OnZoomOut(), frame.MapFrame.QueryVector(), frame.MapFrame.RemoveNviz(), and frame.MapFrame.RemoveToolbar().

mapdisplay.MapFrame.page

Definition at line 66 of file mapdisplay.py.

Referenced by frame.MapFrame.OnCloseWindow(), mapdisplay.MapFrame.OnFocus(), frame.MapFrame.OnFocus(), and tools.NvizToolWindow.UpdateScrolling().

mapdisplay.MapFrame.printopt

Definition at line 182 of file mapdisplay.py.

mapdisplay.MapFrame.show_target

Definition at line 241 of file mapdisplay.py.

Referenced by mapdisplay.MapFrame.GetShowTarget(), and mapdisplay.MapFrame.OnRender().

mapdisplay.MapFrame.SrcMap

Definition at line 77 of file mapdisplay.py.

Referenced by manager.GCP.OnUpdateActive(), and manager.GCP.OnZoomToTarget().

mapdisplay.MapFrame.SrcMapWindow

Definition at line 116 of file mapdisplay.py.

Referenced by manager.GCP.DrawGCP(), mapdisplay.MapFrame.GetSrcWindow(), mapdisplay.MapFrame.OnErase(), mapdisplay.MapFrame.OnPan(), manager.GCP.OnUpdateActive(), mapdisplay.MapFrame.OnZoomIn(), mapdisplay.MapFrame.OnZoomOut(), manager.GCP.OnZoomToTarget(), manager.GCP.ReadGCPs(), manager.GCP.ReloadGCPs(), manager.GCP.SetGCPData(), and manager.GCP.UpdateColours().

mapdisplay.MapFrame.statusbarItems

Definition at line 86 of file mapdisplay.py.

Referenced by statusbar.SbManager.AddStatusbarItem(), statusbar.SbManager.GetProperty(), statusbar.SbManager.HasProperty(), statusbar.SbManager.SetProperty(), and statusbar.SbManager.ShowItem().

mapdisplay.MapFrame.statusbarManager

Definition at line 101 of file mapdisplay.py.

mapdisplay.MapFrame.TgtMap

Definition at line 78 of file mapdisplay.py.

Referenced by manager.GCP.OnUpdateActive(), and manager.GCP.OnZoomToSource().

mapdisplay.MapFrame.TgtMapWindow

Definition at line 120 of file mapdisplay.py.

Referenced by manager.GCP.DrawGCP(), mapdisplay.MapFrame.GetTgtWindow(), mapdisplay.MapFrame.OnErase(), mapdisplay.MapFrame.OnPan(), manager.GCP.OnUpdateActive(), mapdisplay.MapFrame.OnZoomIn(), mapdisplay.MapFrame.OnZoomOut(), manager.GCP.OnZoomToSource(), manager.GCP.ReadGCPs(), manager.GCP.ReloadGCPs(), manager.GCP.UpdateActive(), and manager.GCP.UpdateColours().

mapdisplay.MapFrame.tree

Definition at line 65 of file mapdisplay.py.

Referenced by frame.MapFrame.AddNviz(), mapwindow.MapWindow.GetLayerByName(), frame.MapFrame.GetMapWindow(), mapwindow.MapWindow.GetSelectedLayer(), mapwindow.GLWindow.LoadDataLayers(), mapwindow.GLWindow.UnloadDataLayers(), and mapwindow.BufferedWindow.UpdateMap().

The documentation for this class was generated from the following file: