GRASS Programmer's Manual  6.4.4(2014)-r
frame.MapFrame Class Reference

Main frame for map display window. More...

Inheritance diagram for frame.MapFrame:
Collaboration diagram for frame.MapFrame:

Public Member Functions

def __init__ (self, parent=None, title=_("GRASS GIS - Map display"), toolbars=["map"], tree=None, notebook=None, lmgr=None, page=None, Map=None, auimgr=None, name='MapWindow', kwargs)
 Main map display window with toolbars, statusbar and BufferedWindow (map canvas) More...
 
def GetMapWindow (self)
 
def AddNviz (self)
 Add 3D view mode window. More...
 
def RemoveNviz (self)
 Restore 2D view. More...
 
def AddToolbar (self, name)
 Add defined toolbar to the window. More...
 
def RemoveToolbar (self, name)
 Removes defined toolbar from the window. More...
 
def IsPaneShown (self, name)
 Check if pane (toolbar, mapWindow ...) of given name is currently shown. More...
 
def OnUpdateProgress (self, event)
 Update progress bar info. More...
 
def OnFocus (self, event)
 Change choicebook page to match display. More...
 
def RemoveQueryLayer (self)
 Removes temporary map layers (queries) More...
 
def OnRender (self, event)
 Re-render map composition (each map layer) More...
 
def OnPointer (self, event)
 Pointer button clicked. More...
 
def OnRotate (self, event)
 Rotate 3D view. More...
 
def OnFlyThrough (self, event)
 Fly-through mode. More...
 
def OnZoomRegion (self, event)
 
def OnAlignRegion (self, event)
 
def SaveToFile (self, event)
 Save map to image. More...
 
def PrintMenu (self, event)
 
def OnCloseWindow (self, event)
 Window closed. More...
 
def Query (self, x, y, layers)
 Query selected layers. More...
 
def QueryMap (self, east, north, qdist, layers)
 Query raster or vector map layers by r/v.what. More...
 
def QueryVector (self, east, north, qdist, posWindow, layer)
 Query vector map layer features. More...
 
def OnQuery (self, event)
 Query tools menu. More...
 
def AddTmpVectorMapLayer
 Add temporal vector map layer to map composition. More...
 
def OnMeasure (self, event)
 Init measurement routine that calculates map distance along transect drawn on map display. More...
 
def MeasureDist (self, beginpt, endpt)
 Calculate map distance from screen distance and print to output window. More...
 
def OnProfile (self, event)
 Launch profile tool. More...
 
def FormatDist (self, dist)
 Format length numbers and units in a nice way, as a function of length. More...
 
def OnHistogram (self, event)
 Init histogram display canvas and tools. More...
 
def AddBarscale
 Handler for scale/arrow map decoration menu selection. More...
 
def AddLegend
 Handler for legend map decoration menu selection. More...
 
def OnAddText (self, event)
 Handler for text decoration menu selection. More...
 
def OnAddArrow (self, event)
 Handler for north arrow menu selection. More...
 
def GetOptData (self, dcmd, type, params, propwin)
 Callback method for decoration overlay command generated by dialog created in menuform.py. More...
 
def OnZoomToMap (self, event)
 Set display extents to match selected raster (including NULLs) or vector map. More...
 
def OnZoomToRaster (self, event)
 Set display extents to match selected raster map (ignore NULLs) More...
 
def OnZoomToSaved (self, event)
 Set display geometry to match extents in saved region file. More...
 
def OnDisplayToWind (self, event)
 Set computational region (WIND file) to match display extents. More...
 
def SaveDisplayRegion (self, event)
 Save display extents to named region file. More...
 
def OnZoomMenu (self, event)
 Popup Zoom menu. More...
 
def SetProperties
 Set properies of map display window. More...
 
def IsStandalone (self)
 Check if Map display is standalone. More...
 
def GetLayerManager (self)
 Get reference to Layer Manager. More...
 
def GetMapToolbar (self)
 Returns toolbar with zooming tools. More...
 

Data Fields

 tree
 
 page
 
 layerbook
 
 statusbarItems
 
 statusbarItemsHiddenInNviz
 
 statusbarManager
 
 decorations
 
 legend
 
 barscale
 
 MapWindow2D
 
 MapWindow
 
 MapWindowVDigit
 
 MapWindow3D
 
 printopt
 
 dialogs
 
 decorationDialog
 
 tmpreg
 
 totaldist
 

Detailed Description

Main frame for map display window.

Drawing takes place in child double buffered drawing window.

Definition at line 60 of file mapdisp/frame.py.

Constructor & Destructor Documentation

def frame.MapFrame.__init__ (   self,
  parent = None,
  title = _("GRASS GIS - Map display"),
  toolbars = ["map"],
  tree = None,
  notebook = None,
  lmgr = None,
  page = None,
  Map = None,
  auimgr = None,
  name = 'MapWindow',
  kwargs 
)

Main map display window with toolbars, statusbar and BufferedWindow (map canvas)

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
nameframe name
kwargswx.Frame attributes

Definition at line 66 of file mapdisp/frame.py.

References mapdisplay.MapFrame._layerManager, and frame.MapFrame._layerManager.

Member Function Documentation

def frame.MapFrame.AddBarscale (   self,
  cmd = None,
  showDialog = True 
)

Handler for scale/arrow map decoration menu selection.

Definition at line 1094 of file mapdisp/frame.py.

References frame.MapFrame.barscale, frame.GMFrame.dialogs, frame.MapFrame.dialogs, and mapdisplay.MapFrame.dialogs.

def frame.MapFrame.AddLegend (   self,
  cmd = None,
  showDialog = True 
)

Handler for legend map decoration menu selection.

Definition at line 1133 of file mapdisp/frame.py.

References frame.GMFrame.dialogs, frame.MapFrame.dialogs, mapdisplay.MapFrame.dialogs, and frame.MapFrame.legend.

def frame.MapFrame.AddTmpVectorMapLayer (   self,
  name,
  cats,
  useId = False,
  addLayer = True 
)

Add temporal vector map layer to map composition.

Parameters
namename of map layer
useIduse feature id instead of category

Definition at line 881 of file mapdisp/frame.py.

References utils.ListOfCatsToRange().

Referenced by frame.MapFrame.QueryVector().

def frame.MapFrame.AddToolbar (   self,
  name 
)
def frame.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 1034 of file mapdisp/frame.py.

References round.

Referenced by frame.MapFrame.MeasureDist().

def frame.MapFrame.GetLayerManager (   self)

Get reference to Layer Manager.

Returns
window reference
None (if standalone)

Definition at line 1317 of file mapdisp/frame.py.

References mapdisplay.MapFrame._layerManager, and frame.MapFrame._layerManager.

def frame.MapFrame.GetMapToolbar (   self)
def frame.MapFrame.GetOptData (   self,
  dcmd,
  type,
  params,
  propwin 
)

Callback method for decoration overlay command generated by dialog created in menuform.py.

Definition at line 1228 of file mapdisp/frame.py.

References python.task.grassTask.params, histogram.HistogramFrame.params, model.ModelParamDialog.params, overlays.OverlayController.propwin, and histogram.HistogramFrame.propwin.

Referenced by histogram.HistogramFrame.OnOptions().

def frame.MapFrame.IsPaneShown (   self,
  name 
)

Check if pane (toolbar, mapWindow ...) of given name is currently shown.

Definition at line 421 of file mapdisp/frame.py.

Referenced by frame.MapFrame.OnAddText(), frame.MapFrame.OnCloseWindow(), frame.MapFrame.Query(), frame.MapFrame.QueryVector(), and frame.MapFrame.SaveToFile().

def frame.MapFrame.IsStandalone (   self)

Check if Map display is standalone.

Definition at line 1310 of file mapdisp/frame.py.

References mapdisplay.MapFrame._layerManager, and frame.MapFrame._layerManager.

Referenced by frame.MapFrame.OnQuery().

def frame.MapFrame.MeasureDist (   self,
  beginpt,
  endpt 
)

Calculate map distance from screen distance and print to output window.

Definition at line 978 of file mapdisp/frame.py.

References mapdisplay.MapFrame.FormatDist(), frame.MapFrame.FormatDist(), round, and frame.MapFrame.totaldist.

def frame.MapFrame.OnAddArrow (   self,
  event 
)

Handler for north arrow menu selection.

Opens Appearance page of nviz notebook.

Definition at line 1220 of file mapdisp/frame.py.

def frame.MapFrame.OnAddText (   self,
  event 
)

Handler for text decoration menu selection.

Definition at line 1169 of file mapdisp/frame.py.

References frame.GMFrame.dialogs, frame.MapFrame.dialogs, mapdisplay.MapFrame.dialogs, frame.GMFrame.IsPaneShown(), frame.MapFrame.IsPaneShown(), and max.

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

Definition at line 540 of file mapdisp/frame.py.

def frame.MapFrame.OnDisplayToWind (   self,
  event 
)

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

Definition at line 1256 of file mapdisp/frame.py.

Referenced by frame.MapFrame.OnZoomMenu().

def frame.MapFrame.OnFocus (   self,
  event 
)

Change choicebook page to match display.

Definition at line 434 of file mapdisp/frame.py.

References mapdisplay.MapFrame.page, wizard.TitledPage.page, and frame.MapFrame.page.

def frame.MapFrame.OnHistogram (   self,
  event 
)

Init histogram display canvas and tools.

Definition at line 1084 of file mapdisp/frame.py.

def frame.MapFrame.OnMeasure (   self,
  event 
)

Init measurement routine that calculates map distance along transect drawn on map display.

Definition at line 935 of file mapdisp/frame.py.

def frame.MapFrame.OnProfile (   self,
  event 
)

Launch profile tool.

Definition at line 1018 of file mapdisp/frame.py.

def frame.MapFrame.OnRender (   self,
  event 
)

Re-render map composition (each map layer)

Definition at line 452 of file mapdisp/frame.py.

References mapdisp.MapFrameBase.GetToolbar(), frame.MapFrame.RemoveQueryLayer(), and mapdisp.MapFrameBase.StatusbarUpdate().

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

Definition at line 531 of file mapdisp/frame.py.

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

def frame.MapFrame.OnZoomToMap (   self,
  event 
)

Set display extents to match selected raster (including NULLs) or vector map.

Definition at line 1239 of file mapdisp/frame.py.

def frame.MapFrame.OnZoomToRaster (   self,
  event 
)

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

Definition at line 1245 of file mapdisp/frame.py.

def frame.MapFrame.OnZoomToSaved (   self,
  event 
)

Set display geometry to match extents in saved region file.

Definition at line 1250 of file mapdisp/frame.py.

Referenced by frame.MapFrame.OnZoomMenu().

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

Definition at line 598 of file mapdisp/frame.py.

def frame.MapFrame.Query (   self,
  x,
  y,
  layers 
)

Query selected layers.

Calls QueryMap in case of raster or more vectors, or QueryVector in case of one vector with db connection.

Parameters
x,ycoordinates
layersselected tree item layers

Definition at line 644 of file mapdisp/frame.py.

References utils.GetAllVectorLayers(), frame.GMFrame.IsPaneShown(), frame.MapFrame.IsPaneShown(), frame.MapFrame.QueryMap(), and frame.MapFrame.QueryVector().

def frame.MapFrame.QueryMap (   self,
  east,
  north,
  qdist,
  layers 
)

Query raster or vector map layers by r/v.what.

Parameters
east,northcoordinates
qdistquery distance
layersselected tree items

Definition at line 709 of file mapdisp/frame.py.

References utils.GetLayerNameFromCmd().

Referenced by frame.MapFrame.Query().

def frame.MapFrame.QueryVector (   self,
  east,
  north,
  qdist,
  posWindow,
  layer 
)
def frame.MapFrame.RemoveQueryLayer (   self)

Removes temporary map layers (queries)

Definition at line 446 of file mapdisp/frame.py.

References mapdisp.MapFrameBase.GetMap(), and layertree.LayerTree.GetMap().

Referenced by frame.MapFrame.OnRender().

def frame.MapFrame.RemoveToolbar (   self,
  name 
)

Removes defined toolbar from the window.

Todo:
Only hide, activate by calling AddToolbar()

Definition at line 398 of file mapdisp/frame.py.

References mapdisplay.MapFrame.MapWindow, frame.MapFrame.MapWindow, manager.GCP.MapWindow, frame.MapFrame.MapWindow2D, mapdisp.MapFrameBase.toolbars, and frame.GMFrame.toolbars.

def frame.MapFrame.SaveDisplayRegion (   self,
  event 
)

Save display extents to named region file.

Definition at line 1262 of file mapdisp/frame.py.

Referenced by frame.MapFrame.OnZoomMenu().

def frame.MapFrame.SaveToFile (   self,
  event 
)

Save map to image.

Definition at line 550 of file mapdisp/frame.py.

References dialogs.GetImageHandlers(), frame.GMFrame.IsPaneShown(), and frame.MapFrame.IsPaneShown().

def frame.MapFrame.SetProperties (   self,
  render = False,
  mode = 0,
  showCompExtent = False,
  constrainRes = False,
  projection = False,
  alignExtent = True 
)

Set properies of map display window.

Definition at line 1300 of file mapdisp/frame.py.

References statusbar.SbManager.SetProperty(), mapdisp.MapFrameBase.SetProperty(), and mapdisp.MapFrameBase.StatusbarUpdate().

Referenced by frame.MapFrame.OnZoomMenu().

Field Documentation

frame.MapFrame.barscale

Definition at line 130 of file mapdisp/frame.py.

Referenced by frame.MapFrame.AddBarscale().

frame.MapFrame.decorationDialog

Definition at line 190 of file mapdisp/frame.py.

frame.MapFrame.decorations

Definition at line 128 of file mapdisp/frame.py.

frame.MapFrame.layerbook

Definition at line 86 of file mapdisp/frame.py.

frame.MapFrame.legend

Definition at line 129 of file mapdisp/frame.py.

Referenced by frame.MapFrame.AddLegend().

frame.MapFrame.MapWindow2D

Definition at line 137 of file mapdisp/frame.py.

Referenced by frame.MapFrame.RemoveNviz(), and frame.MapFrame.RemoveToolbar().

frame.MapFrame.MapWindow3D

Definition at line 145 of file mapdisp/frame.py.

Referenced by frame.MapFrame.AddNviz().

frame.MapFrame.MapWindowVDigit

Definition at line 143 of file mapdisp/frame.py.

Referenced by frame.MapFrame.GetMapWindow().

frame.MapFrame.page
frame.MapFrame.printopt

Definition at line 171 of file mapdisp/frame.py.

frame.MapFrame.statusbarItemsHiddenInNviz

Definition at line 109 of file mapdisp/frame.py.

Referenced by frame.MapFrame.AddNviz(), and frame.MapFrame.RemoveNviz().

frame.MapFrame.statusbarManager

Definition at line 118 of file mapdisp/frame.py.

frame.MapFrame.tmpreg

Definition at line 737 of file mapdisp/frame.py.

frame.MapFrame.totaldist

Definition at line 939 of file mapdisp/frame.py.

Referenced by frame.MapFrame.MeasureDist().

frame.MapFrame.tree

Definition at line 84 of file mapdisp/frame.py.

Referenced by frame.MapFrame.AddNviz(), and frame.MapFrame.GetMapWindow().


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