GRASS Programmer's Manual  6.4.2(2012)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
gui_modules.layertree.LayerTree Class Reference

Creates layer tree structure. More...

Public Member Functions

def __init__
def GetMap
 Get map instace.
def GetMapDisplay
 Get associated MapFrame.
def OnIdle
 Only re-order and re-render a composite map image from GRASS during idle time instead of multiple times during layer changing.
def OnKeyUp
 Key pressed.
def OnLayerContextMenu
 Contextual menu for item/layer.
def OnTopology
 Rebuild topology of selected vector map.
def OnMetadata
 Print metadata of raster/vector map layer TODO: Dialog to modify metadata.
def OnSetCompRegFromRaster
 Set computational region from selected raster map (ignore NULLs)
def OnSetCompRegFromMap
 Set computational region from selected raster/vector map.
def OnProfile
 Plot profile of given raster map layer.
def OnColorTable
 Set color table for raster map.
def OnHistogram
def OnUnivariateStats
 Univariate raster statistics.
def OnStartEditing
 Start editing vector map layer requested by the user.
def OnStopEditing
 Stop editing the current vector map layer.
def OnSetBgMap
 Set background vector map for editing sesstion.
def OnPopupProperties
 Popup properties dialog.
def OnPopupOpacityLevel
 Popup opacity level indicator.
def OnNvizProperties
 Nviz-related properties (raster/vector/volume)
def OnRenameLayer
 Rename layer.
def OnRenamed
 Layer renamed.
def AddLayer
 Add new item to the layer tree, create corresponding MapLayer instance.
def PropertiesDialog
 Launch the properties dialog.
def OnActivateLayer
 Double click on the layer item.
def OnDeleteLayer
 Remove selected layer item from the layer tree.
def OnLayerChecked
 Enable/disable data layer.
def OnCmdChanged
 Change command string.
def OnChangeSel
 Selection changed.
def OnCollapseNode
 Collapse node.
def OnExpandNode
 Expand node.
def OnEndDrag
def OnDrop
def RecreateItem
 Recreate item (needed for OnEndDrag())
def GetOptData
 Process layer data (when changes in propertiesdialog are applied)
def ReorderLayers
 Add commands from data associated with any valid layers (checked or not) to layer list in order to match layers in layer tree.
def ChangeLayer
 Change layer.
def OnCloseWindow
def FindItemByData
 Find item based on key and value (see PyData[0])
def FindItemByIndex
 Find item by index (starting at 0)
def EnableItemType
 Enable/disable items in layer tree.

Data Fields

 disp_idx
 lmgr
 notebook
 auimgr
 treepg
 Map
 root
 groupnode
 optpage
 layer_selected
 saveitem
 first
 flag
 rerender
 reorder
 mapdisplay
 SetAutoLayout() causes that no vertical scrollbar is displayed when some layers are not visible in layer tree self.SetAutoLayout(True)
 folder_open
 folder
 rast_icon
 rast3d_icon
 rgb_icon
 his_icon
 shaded_icon
 rarrow_icon
 rnum_icon
 vect_icon
 theme_icon
 chart_icon
 grid_icon
 geodesic_icon
 rhumb_icon
 labels_icon
 cmd_icon
 popupID
 popupMenu
 profileFrame
 histogramFrame

Detailed Description

Creates layer tree structure.

Definition at line 58 of file layertree.py.

Constructor & Destructor Documentation

def gui_modules.layertree.LayerTree.__init__ (   self,
  parent,
  id = wx.ID_ANY,
  style = wx.SUNKEN_BORDER,
  ctstyle = CT.TR_HAS_BUTTONS | CT.TR_HAS_VARIABLE_ROW_HEIGHT |                  CT.TR_HIDE_ROOT | CT.TR_ROW_LINES | CT.TR_FULL_ROW_HIGHLIGHT |                  CT.TR_MULTIPLE,
  kwargs 
)

Definition at line 65 of file layertree.py.

Member Function Documentation

def gui_modules.layertree.LayerTree.AddLayer (   self,
  ltype,
  lname = None,
  lchecked = None,
  lopacity = 1.0,
  lcmd = None,
  lgroup = None,
  lvdigit = None,
  lnviz = None,
  multiple = True 
)

Add new item to the layer tree, create corresponding MapLayer instance.

Launch property dialog if needed (raster, vector, etc.)

Parameters
ltypelayer type (raster, vector, 3d-raster, ...)
lnamelayer name
lcheckedif True layer is checked
lopacitylayer opacity level
lcmdcommand (given as a list)
lgroupindex of group item (-1 for root) or None
lvdigitvector digitizer settings (eg. geometry attributes)
lnvizlayer Nviz properties
multipleTrue to allow multiple map layers in layer tree

Definition at line 661 of file layertree.py.

References gui_modules.layertree.LayerTree._getLayerName(), gui_modules.layertree.LayerTree.chart_icon, gui_modules.layertree.LayerTree.cmd_icon, gui_modules.layertree.LayerTree.FindItemByIndex(), gui_modules.layertree.LayerTree.first, gui_modules.layertree.LayerTree.folder, gui_modules.layertree.LayerTree.geodesic_icon, gui_modules.layertree.LayerTree.grid_icon, gui_modules.layertree.LayerTree.groupnode, gui_modules.layertree.LayerTree.his_icon, gui_modules.layertree.LayerTree.labels_icon, gui_modules.layertree.LayerTree.layer_selected, gui_modules.layertree.LayerTree.OnCmdChanged(), gui_modules.layertree.LayerTree.OnLayerContextMenu(), gui_modules.layertree.LayerTree.PropertiesDialog(), gui_modules.layertree.LayerTree.rarrow_icon, gui_modules.layertree.LayerTree.rast3d_icon, gui_modules.layertree.LayerTree.rast_icon, gui_modules.layertree.LayerTree.rgb_icon, gui_modules.layertree.LayerTree.rhumb_icon, gui_modules.layertree.LayerTree.rnum_icon, gui_modules.layertree.LayerTree.root, gui_modules.ghelp.ItemTree.root, gui_modules.ghelp.ExtensionTree.root, gui_modules.gmodeler.ProcessModelFile.root, gui_modules.layertree.LayerTree.shaded_icon, gui_modules.layertree.LayerTree.theme_icon, and gui_modules.layertree.LayerTree.vect_icon.

Referenced by gui_modules.layertree.LayerTree.OnRenamed().

def gui_modules.layertree.LayerTree.ChangeLayer (   self,
  item 
)
def gui_modules.layertree.LayerTree.EnableItemType (   self,
  type,
  enable = True 
)
def gui_modules.layertree.LayerTree.FindItemByData (   self,
  key,
  value 
)

Find item based on key and value (see PyData[0])

Returns
item instance
None not found

Definition at line 1504 of file layertree.py.

def gui_modules.layertree.LayerTree.FindItemByIndex (   self,
  index 
)

Find item by index (starting at 0)

Returns
item instance
None not found

Definition at line 1513 of file layertree.py.

References gui_modules.layertree.LayerTree.root, gui_modules.ghelp.ItemTree.root, gui_modules.ghelp.ExtensionTree.root, and gui_modules.gmodeler.ProcessModelFile.root.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

def gui_modules.layertree.LayerTree.GetMapDisplay (   self)

Get associated MapFrame.

Definition at line 222 of file layertree.py.

References gui_modules.layertree.LayerTree.mapdisplay, and gui_modules.dbm.AttributeManager.mapdisplay.

def gui_modules.layertree.LayerTree.GetOptData (   self,
  dcmd,
  layer,
  params,
  propwin 
)

Process layer data (when changes in propertiesdialog are applied)

Definition at line 1365 of file layertree.py.

References gui_modules.layertree.LayerTree._getLayerName(), and gui_modules.layertree.LayerTree.ChangeLayer().

Referenced by gui_modules.layertree.LayerTree.PropertiesDialog().

def gui_modules.layertree.LayerTree.OnActivateLayer (   self,
  event 
)

Double click on the layer item.

Launch property dialog, or expand/collapse group of items, etc.

Definition at line 987 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected, and gui_modules.layertree.LayerTree.PropertiesDialog().

def gui_modules.layertree.LayerTree.OnChangeSel (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnCloseWindow (   self,
  event 
)

Definition at line 1500 of file layertree.py.

def gui_modules.layertree.LayerTree.OnCmdChanged (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnCollapseNode (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnColorTable (   self,
  event 
)

Set color table for raster map.

Definition at line 506 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnDrop (   self,
  dropTarget,
  dragItem 
)
def gui_modules.layertree.LayerTree.OnEndDrag (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnExpandNode (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnHistogram (   self,
  event 
)
Plot histogram for given raster map layer

Definition at line 512 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnIdle (   self,
  event 
)

Only re-order and re-render a composite map image from GRASS during idle time instead of multiple times during layer changing.

Definition at line 226 of file layertree.py.

References gui_modules.layertree.LayerTree.rerender.

def gui_modules.layertree.LayerTree.OnKeyUp (   self,
  event 
)

Key pressed.

Definition at line 242 of file layertree.py.

References gui_modules.layertree.LayerTree.lmgr.

def gui_modules.layertree.LayerTree.OnLayerChecked (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnLayerContextMenu (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnMetadata (   self,
  event 
)

Print metadata of raster/vector map layer TODO: Dialog to modify metadata.

Definition at line 423 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnNvizProperties (   self,
  event 
)

Nviz-related properties (raster/vector/volume)

Todo:
vector/volume

Definition at line 633 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnPopupOpacityLevel (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnPopupProperties (   self,
  event 
)

Popup properties dialog.

Definition at line 600 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected, and gui_modules.layertree.LayerTree.PropertiesDialog().

def gui_modules.layertree.LayerTree.OnProfile (   self,
  event 
)

Plot profile of given raster map layer.

Definition at line 483 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnRenamed (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnRenameLayer (   self,
  event 
)

Rename layer.

Definition at line 647 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnSetBgMap (   self,
  event 
)

Set background vector map for editing sesstion.

Definition at line 583 of file layertree.py.

References gui_modules.layertree.LayerTree._setGradient(), and gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnSetCompRegFromMap (   self,
  event 
)

Set computational region from selected raster/vector map.

Definition at line 450 of file layertree.py.

def gui_modules.layertree.LayerTree.OnSetCompRegFromRaster (   self,
  event 
)

Set computational region from selected raster map (ignore NULLs)

Definition at line 439 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnStartEditing (   self,
  event 
)

Start editing vector map layer requested by the user.

Definition at line 551 of file layertree.py.

References gui_modules.layertree.LayerTree._setGradient(), and gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnStopEditing (   self,
  event 
)
def gui_modules.layertree.LayerTree.OnTopology (   self,
  event 
)

Rebuild topology of selected vector map.

Definition at line 416 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.OnUnivariateStats (   self,
  event 
)

Univariate raster statistics.

Definition at line 545 of file layertree.py.

References gui_modules.layertree.LayerTree.layer_selected.

def gui_modules.layertree.LayerTree.ReorderLayers (   self)

Add commands from data associated with any valid layers (checked or not) to layer list in order to match layers in layer tree.

Definition at line 1427 of file layertree.py.

References gui_modules.layertree.LayerTree.reorder.

Field Documentation

gui_modules.layertree.LayerTree.auimgr

Definition at line 76 of file layertree.py.

gui_modules.layertree.LayerTree.chart_icon

Definition at line 172 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.cmd_icon

Definition at line 187 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.disp_idx

Definition at line 70 of file layertree.py.

Referenced by wxgui.GMFrame.NewDisplay(), and wxgui.GMFrame.OnWorkspaceClose().

gui_modules.layertree.LayerTree.first
gui_modules.layertree.LayerTree.folder
gui_modules.layertree.LayerTree.folder_open

Definition at line 138 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.OnExpandNode().

gui_modules.layertree.LayerTree.geodesic_icon

Definition at line 178 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.grid_icon

Definition at line 175 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.groupnode

Definition at line 83 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.his_icon

Definition at line 154 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.histogramFrame

Definition at line 525 of file layertree.py.

gui_modules.layertree.LayerTree.labels_icon

Definition at line 184 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.mapdisplay

SetAutoLayout() causes that no vertical scrollbar is displayed when some layers are not visible in layer tree self.SetAutoLayout(True)

Definition at line 112 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.GetMapDisplay().

gui_modules.layertree.LayerTree.notebook
gui_modules.layertree.LayerTree.optpage

Definition at line 84 of file layertree.py.

gui_modules.layertree.LayerTree.popupID

Definition at line 265 of file layertree.py.

gui_modules.layertree.LayerTree.popupMenu

Definition at line 272 of file layertree.py.

gui_modules.layertree.LayerTree.profileFrame

Definition at line 494 of file layertree.py.

gui_modules.layertree.LayerTree.rarrow_icon

Definition at line 160 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.rast3d_icon

Definition at line 148 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.rast_icon

Definition at line 145 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.rgb_icon

Definition at line 151 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.rhumb_icon

Definition at line 181 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.rnum_icon

Definition at line 163 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.saveitem

Definition at line 86 of file layertree.py.

gui_modules.layertree.LayerTree.shaded_icon

Definition at line 157 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.theme_icon

Definition at line 169 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().

gui_modules.layertree.LayerTree.treepg

Definition at line 80 of file layertree.py.

gui_modules.layertree.LayerTree.vect_icon

Definition at line 166 of file layertree.py.

Referenced by gui_modules.layertree.LayerTree.AddLayer().


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