GRASS Programmer's Manual  6.5.svn(2012)-r51648
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
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 OnRasterColorTable
 Set color table for raster map.
def OnVectorColorTable
 Set color table for vector map.
def OnHistogram
 Plot histogram for given raster map layer.
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

Detailed Description

Creates layer tree structure.

Definition at line 94 of file layertree.py.


Constructor & Destructor Documentation

def 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 101 of file layertree.py.


Member Function Documentation

def 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 693 of file layertree.py.

References layertree.LayerTree._getLayerName(), layertree.LayerTree.chart_icon, layertree.LayerTree.cmd_icon, layertree.LayerTree.FindItemByIndex(), layertree.LayerTree.first, layertree.LayerTree.folder, layertree.LayerTree.geodesic_icon, utils.GetLayerNameFromCmd(), layertree.LayerTree.grid_icon, layertree.LayerTree.groupnode, layertree.LayerTree.his_icon, layertree.LayerTree.labels_icon, layertree.LayerTree.layer_selected, layertree.LayerTree.OnCmdChanged(), layertree.LayerTree.OnLayerContextMenu(), layertree.LayerTree.PropertiesDialog(), layertree.LayerTree.rarrow_icon, layertree.LayerTree.rast3d_icon, layertree.LayerTree.rast_icon, layertree.LayerTree.rgb_icon, layertree.LayerTree.rhumb_icon, layertree.LayerTree.rnum_icon, workspace.ProcessWorkspaceFile.root, layertree.LayerTree.root, widgets.ItemTree.root, model.ProcessModelFile.root, widgets.SetRange(), layertree.LayerTree.shaded_icon, layertree.LayerTree.theme_icon, and layertree.LayerTree.vect_icon.

Referenced by layertree.LayerTree.OnRenamed().

def layertree.LayerTree.EnableItemType (   self,
  type,
  enable = True 
)
def 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 1534 of file layertree.py.

def layertree.LayerTree.FindItemByIndex (   self,
  index 
)

Find item by index (starting at 0)

Returns:
item instance
None not found

Definition at line 1543 of file layertree.py.

References workspace.ProcessWorkspaceFile.root, layertree.LayerTree.root, widgets.ItemTree.root, and model.ProcessModelFile.root.

Referenced by layertree.LayerTree.AddLayer().

Get associated MapFrame.

Definition at line 257 of file layertree.py.

References layertree.LayerTree.mapdisplay, and manager.AttributeManager.mapdisplay.

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

Process layer data (when changes in propertiesdialog are applied)

Definition at line 1395 of file layertree.py.

References layertree.LayerTree._getLayerName(), render.Map.ChangeLayer(), layertree.LayerTree.ChangeLayer(), and utils.GetLayerNameFromCmd().

Referenced by histogram.HistogramFrame.OnOptions(), and layertree.LayerTree.PropertiesDialog().

def layertree.LayerTree.OnActivateLayer (   self,
  event 
)

Double click on the layer item.

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

Definition at line 1003 of file layertree.py.

References goutput.PyStc.Expand(), layertree.LayerTree.layer_selected, and layertree.LayerTree.PropertiesDialog().

def layertree.LayerTree.OnChangeSel (   self,
  event 
)

Selection changed.

Definition at line 1157 of file layertree.py.

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

def layertree.LayerTree.OnCloseWindow (   self,
  event 
)

Definition at line 1530 of file layertree.py.

def layertree.LayerTree.OnCmdChanged (   self,
  event 
)

Change command string.

Definition at line 1139 of file layertree.py.

References render.Map.ChangeLayer(), and layertree.LayerTree.ChangeLayer().

Referenced by layertree.LayerTree.AddLayer(), and layertree.LayerTree.RecreateItem().

def layertree.LayerTree.OnCollapseNode (   self,
  event 
)

Collapse node.

Definition at line 1233 of file layertree.py.

References layertree.LayerTree.folder, and layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnDrop (   self,
  dropTarget,
  dragItem 
)
def layertree.LayerTree.OnExpandNode (   self,
  event 
)

Expand node.

Definition at line 1239 of file layertree.py.

References layertree.LayerTree.folder_open, and layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnHistogram (   self,
  event 
)

Plot histogram for given raster map layer.

Definition at line 559 of file layertree.py.

References layertree.LayerTree.layer_selected.

def 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 261 of file layertree.py.

References layertree.LayerTree.rerender.

def layertree.LayerTree.OnKeyUp (   self,
  event 
)

Key pressed.

Definition at line 279 of file layertree.py.

References mapwindow.MapWindow.lmgr, layertree.LayerTree.lmgr, and workspace.WriteWorkspaceFile.lmgr.

def layertree.LayerTree.OnLayerChecked (   self,
  event 
)

Enable/disable data layer.

Definition at line 1073 of file layertree.py.

References layertree.LayerTree.first, layertree.LayerTree.reorder, layertree.LayerTree.rerender, and widgets.SetRange().

def layertree.LayerTree.OnLayerContextMenu (   self,
  event 
)

Contextual menu for item/layer.

Definition at line 289 of file layertree.py.

References layertree.LayerTree.layer_selected.

Referenced by layertree.LayerTree.AddLayer(), and layertree.LayerTree.RecreateItem().

def layertree.LayerTree.OnMetadata (   self,
  event 
)

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

Definition at line 464 of file layertree.py.

References layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnNvizProperties (   self,
  event 
)

Nviz-related properties (raster/vector/volume)

Todo:
vector/volume

Definition at line 665 of file layertree.py.

References layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnPopupProperties (   self,
  event 
)

Popup properties dialog.

Definition at line 632 of file layertree.py.

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

def layertree.LayerTree.OnProfile (   self,
  event 
)

Plot profile of given raster map layer.

Definition at line 524 of file layertree.py.

References layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnRasterColorTable (   self,
  event 
)

Set color table for raster map.

Definition at line 547 of file layertree.py.

References layertree.LayerTree.layer_selected.

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

Rename layer.

Definition at line 679 of file layertree.py.

References layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnSetBgMap (   self,
  event 
)

Set background vector map for editing sesstion.

Definition at line 615 of file layertree.py.

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

def layertree.LayerTree.OnSetCompRegFromMap (   self,
  event 
)

Set computational region from selected raster/vector map.

Definition at line 491 of file layertree.py.

def layertree.LayerTree.OnSetCompRegFromRaster (   self,
  event 
)

Set computational region from selected raster map (ignore NULLs)

Definition at line 480 of file layertree.py.

References layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnStartEditing (   self,
  event 
)

Start editing vector map layer requested by the user.

Definition at line 583 of file layertree.py.

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

def layertree.LayerTree.OnTopology (   self,
  event 
)

Rebuild topology of selected vector map.

Definition at line 457 of file layertree.py.

References layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnUnivariateStats (   self,
  event 
)

Univariate raster statistics.

Definition at line 578 of file layertree.py.

References layertree.LayerTree.layer_selected.

def layertree.LayerTree.OnVectorColorTable (   self,
  event 
)

Set color table for vector map.

Definition at line 553 of file layertree.py.

References layertree.LayerTree.layer_selected.

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 1457 of file layertree.py.

References tools.range, and layertree.LayerTree.reorder.


Field Documentation

Definition at line 112 of file layertree.py.

Definition at line 106 of file layertree.py.

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

Definition at line 148 of file layertree.py.

Referenced by layertree.LayerTree.GetMapDisplay().

Definition at line 110 of file layertree.py.

Definition at line 120 of file layertree.py.

Definition at line 302 of file layertree.py.

Definition at line 309 of file layertree.py.

Definition at line 535 of file layertree.py.

Definition at line 122 of file layertree.py.

Definition at line 116 of file layertree.py.


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