Package Pmv :: Module sdCommands :: Class ColorMolIndexedPolygons
[hide private]
[frames] | no frames]

Class ColorMolIndexedPolygons

source code

ViewerFramework.VFCommand.Command --+        
                                    |        
                  mvCommand.MVCommand --+    
                                        |    
               colorCommands.ColorCommand --+
                                            |
                                           ColorMolIndexedPolygons


Package : Pmv
Module  : sdCommands
Class   : ColorMolIndexedPolygons
Command : colorMolIndexedPolygons

Description:
The ColorMolIndexedPolygons class provides a mechanism for coloring
a MolIndexedPolygons instance according to its surface properties
(i.e. the properties listed in the vertex file used to generate
the MolIndexedPolygons). This command only colors a surface
according to _surface_ properties. To color according to
properties of the molecule to which the MolIndexedPolygons belongs
(such as atom type, chain ID etc.), use the general color commands.

Synopsis:
  None <- colorMolIndexedPolygin(nodes, geomsToColor,property,colorMap=None,**kw):
  nodes       : any set of MolKit nodes describing molecular components
  geomsToColor: list of MolIndexedPolygons instances to color
  property    : surface property by which to color
  colorMap    : colorMap which will translate the property values into colors
                (default is the rgb256 colorMap)

Keywords: color, surfdock, harmony



Instance Methods [hide private]
  onAddCmdToViewer(self)
method called when an instance of this command is added to the viewer.
  getPropsGUI(self, nodes, geomsToColor, showUndisplay=0)
  getAvailableGeoms(self, nodes, showUndisplay=0)
Method to build a dictionary containing all the molindexedpolygons geometries available in the scene.
  doit(self, nodes, geomsToColor, property, colorMap=None, **kw)
virtual method.
  cleanup(self)
The attribute deleted by this method of ColorCommand aren't created in this class, so skip this step.
  __call__(self, nodes, geomsToColor, property, colorMap=None, **kw)
None <- colorHarmony(self, molName, property, **kw) molName : property:
  guiCallback(self)
  colorMapEditor_cb(self, colorMap)

Inherited from colorCommands.ColorCommand: __init__, addNewEntries, buildFormDescr, color_cb, deselectall_cb, dismiss_cb, getChildrenGeomsName, getNodes, selectall_cb, setupUndoBefore, showForm, showUndisplayed_cb

Inherited from mvCommand.MVCommand: strArg

Inherited from mvCommand.MVCommand (private): _strArg

Inherited from ViewerFramework.VFCommand.Command: __repr__, addCallbackAfter, addCallbackBefore, addUndoCall, afterDoit, beforeDoit, buildLogArgList, checkDependencies, customizeGUI, doitWrapper, getArguments, getHelp, getLastUsedValues, getLogArgs, getValNamedArgs, log, logString, onAddNewCmd, onCmdRun, setLastUsedValues, setupUndoAfter, tkCb, updateGeom, warningMsg


Class Variables [hide private]

Inherited from ViewerFramework.VFCommand.Command: negateKw, objArgOnly


Method Details [hide private]

onAddCmdToViewer(self)

source code 
method called when an instance of this command is added to the viewer. This enable viewer-addition time initializations
Overrides: colorCommands.ColorCommand.onAddCmdToViewer

getPropsGUI(self, nodes, geomsToColor, showUndisplay=0)

source code 
None

getAvailableGeoms(self, nodes, showUndisplay=0)

source code 
Method to build a dictionary containing all the molindexedpolygons geometries available in the scene.
Overrides: colorCommands.ColorCommand.getAvailableGeoms

doit(self, nodes, geomsToColor, property, colorMap=None, **kw)

source code 
virtual method. Has to be implemented by the sub classes
Overrides: colorCommands.ColorCommand.doit

cleanup(self)

source code 
The attribute deleted by this method of ColorCommand aren't created in this class, so skip this step.
Overrides: colorCommands.ColorCommand.cleanup

__call__(self, nodes, geomsToColor, property, colorMap=None, **kw)
(Call operator)

source code 
None <- colorHarmony(self, molName, property, **kw) molName : property:
Overrides: colorCommands.ColorCommand.__call__

guiCallback(self)

source code 
None
Overrides: colorCommands.ColorCommand.guiCallback

colorMapEditor_cb(self, colorMap)

source code 
None