Package Pmv :: Module secondaryStructureCommands :: Class ColorBySSElementType
[hide private]
[frames] | no frames]

Class ColorBySSElementType

source code

ViewerFramework.VFCommand.Command --+            
                                    |            
                  mvCommand.MVCommand --+        
                                        |        
               colorCommands.ColorCommand --+    
                                            |    
   ViewerFramework.VFCommand.ICOM --+       |    
                                    |       |    
                     mvCommand.MVICOM --+   |    
                                        |   |    
                     mvCommand.MVAtomICOM --+    
                                            |    
               colorCommands.ColorFromPalette --+
                                                |
                                               ColorBySSElementType

Command to color the given geometry by secondary structure
    element. (Rasmol color code)
    
Package : Pmv
    
Module  : secondaryStructureCommands
    
Class   : ColorBySSElementType
     



Instance Methods [hide private]
  __init__(self, func=None)
  getNodes(self, nodes, returnNodes=False)
expand nodes argument into a list of atoms and a list of molecules.
  getColors(self, nodes)
  doit(self, nodes, geomsToColor)
virtual method.
  cleanup(self)
This method is called by the afterDoit method and will be called eventhough the doit failed.

Inherited from colorCommands.ColorFromPalette: __call__, guiCallback, onAddCmdToViewer, setupUndoBefore

Inherited from colorCommands.ColorCommand: addNewEntries, buildFormDescr, color_cb, deselectall_cb, dismiss_cb, getAvailableGeoms, getChildrenGeomsName, selectall_cb, 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

Inherited from mvCommand.MVAtomICOM: getObjects

Inherited from ViewerFramework.VFCommand.ICOM: initICOM, startICOM, stopICOM


Class Variables [hide private]

Inherited from ViewerFramework.VFCommand.Command: negateKw, objArgOnly


Method Details [hide private]

__init__(self, func=None)
(Constructor)

source code 
None
Overrides: colorCommands.ColorFromPalette.__init__

getNodes(self, nodes, returnNodes=False)

source code 
expand nodes argument into a list of atoms and a list of molecules. this function is used to prevent the expansion operation to be done in both doit and setupUndoBefore The nodes.findType( Atom ) is the operation that is potentially expensive
Overrides: colorCommands.ColorCommand.getNodes

getColors(self, nodes)

source code 
None
Overrides: colorCommands.ColorFromPalette.getColors

doit(self, nodes, geomsToColor)

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

cleanup(self)

source code 
This method is called by the afterDoit method and will be called eventhough the doit failed.
Overrides: colorCommands.ColorCommand.cleanup
(inherited documentation)