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

Virtual class which stores information about layers (map layers and overlays) of the map composition. More...

Inheritance diagram for gui_modules.render.Layer:

Public Member Functions

def __init__
def __del__
def Render
 Render layer to image.
def GetCmd
 Get GRASS command as list of string.
def GetType
 Get map layer type.
def GetElement
 Get map element type.
def GetOpacity
def GetName
 Get map layer name.
def IsActive
 Check if layer is activated for rendering.
def SetType
 Set layer type.
def SetName
 Set layer name.
def SetActive
 Active or deactive layer.
def SetHidden
 Hide or show map layer in Layer Manager.
def SetOpacity
 Set opacity value.
def SetCmd
 Set new command for layer.

Data Fields

 type
 name
 cmd
 active
 hidden
 opacity
 force_render
 gtemp
 maskfile
 mapfile

Detailed Description

Virtual class which stores information about layers (map layers and overlays) of the map composition.

For map layer use MapLayer class. For overlays use Overlay class.

Definition at line 56 of file render.py.


Constructor & Destructor Documentation

def gui_modules.render.Layer.__init__ (   self,
  type,
  cmd,
  name = None,
  active = True,
  hidden = False,
  opacity = 1.0 
)
Todo:
pass cmd as tuple instead of list
Parameters:
typelayer type ('raster', 'vector', 'overlay', 'command', etc.)
cmdGRASS command to render layer, given as list, e.g. ['d.rast', 'map=elevation']
namelayer name, e.g. 'elevation' (for layer tree)
activelayer is active, will be rendered only if True
hiddenlayer is hidden, won't be listed in Layer Manager if True
opacitylayer opacity <0;1>

Reimplemented in gui_modules.render.Overlay, and gui_modules.render.MapLayer.

Definition at line 64 of file render.py.


Member Function Documentation

def gui_modules.render.Layer.GetName (   self,
  fullyQualified = True 
)

Get map layer name.

Parameters:
fullyQualifiedTrue to return fully qualified name as a string 'name' otherwise directory { 'name', 'mapset' } is returned
Returns:
string / directory

Definition at line 257 of file render.py.

References gui_modules.render.Layer.name, gui_modules.gdialogs.DecorationDialog.name, gui_modules.gmodeler.PropertiesDialog.name, and gui_modules.gmodeler.VariablePanel.name.

Referenced by gui_modules.gmodeler.ItemCheckListCtrl.OnCheckItem().

def gui_modules.render.Layer.GetOpacity (   self,
  float = False 
)
Get layer opacity level

@param float get opacity level in <0,1> otherwise <0,100>

@return opacity level

Definition at line 244 of file render.py.

References gui_modules.render.Layer.opacity, and gui_modules.gdialogs.SetOpacityDialog.opacity.

def gui_modules.render.Layer.IsActive (   self)

Check if layer is activated for rendering.

Definition at line 276 of file render.py.

References gui_modules.render.Layer.active.

def gui_modules.render.Layer.Render (   self)
def gui_modules.render.Layer.SetActive (   self,
  enable = True 
)

Active or deactive layer.

Definition at line 295 of file render.py.

References gui_modules.render.Layer.active.

def gui_modules.render.Layer.SetHidden (   self,
  enable = False 
)

Hide or show map layer in Layer Manager.

Definition at line 299 of file render.py.

References gui_modules.render.Layer.hidden.

def gui_modules.render.Layer.SetOpacity (   self,
  value 
)

Set opacity value.

Definition at line 303 of file render.py.

References gui_modules.render.Layer.opacity, and gui_modules.gdialogs.SetOpacityDialog.opacity.


Field Documentation

gui_modules.render.Layer.active
gui_modules.render.Layer.force_render

Definition at line 90 of file render.py.

Referenced by gui_modules.render.Layer.Render(), and gui_modules.render.Layer.SetCmd().

gui_modules.render.Layer.gtemp

Definition at line 98 of file render.py.

Referenced by gui_modules.render.Layer.Render().

gui_modules.render.Layer.hidden

Definition at line 87 of file render.py.

Referenced by gui_modules.render.Layer.SetHidden().

gui_modules.render.Layer.mapfile
gui_modules.render.Layer.maskfile

Definition at line 99 of file render.py.

Referenced by gui_modules.render.Layer.Render().

gui_modules.render.Layer.opacity

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