Package Pmv :: Module msmsCommands :: Class DisplayBuriedTriangles
[hide private]
[frames] | no frames]

Class DisplayBuriedTriangles

source code

 ViewerFramework.VFCommand.Command --+        
                                     |        
                   mvCommand.MVCommand --+    
                                         |    
ViewerFramework.VFCommand.ICOM --+       |    
                                 |       |    
                  mvCommand.MVICOM --+   |    
                                     |   |    
                  mvCommand.MVAtomICOM --+    
                                         |    
            displayCommands.DisplayCommand --+
                                             |
                                            DisplayBuriedTriangles

This Command display/Undisplay buried SES as computed with BuriedSurface command.

    Package : Pmv

    Module  : msmsCommands

    Class   : DisplayBuriedTriangles

    Command name : displayBuriedTriangles
    
    
Synopsis :

    None <--- displayBuriedTriangles(nodes, surfaceName, negate=0)

    
Required Arguments:

    nodes --- set of nodes for which the buried vertices of the surface 'surfaceName' are to be 
    displayed. (string, TreeNode or TreeNodeSet)

    surfaceName --- name of an MSMS surface computed using msms. (string)

    
Optional Arguments:

    cut---specifies how many vertices has to be buried (or not) for a triangle to be displayed.(1, 2 or 3)

    negate---specifies whether we want to display buried or exposed triangles

    



Instance Methods [hide private]
  __init__(self, func=None)
  checkDependencies(self)
make sure the mslib package is available
  setupUndoBefore(self, nodes, surfaceName, cut=1, negate=False, only=False, redraw=1)
This method builds the self.undoCmds string.
  doit(self, nodes, surfaceName, cut=1, negate=False, only=False, **kw)
nodes--- nodes for which the buried surface is to be displayed.
  selectMolecule_cb(self, event=None)
  OK_cb(self, event=None)
call back for OK button
  buildFormDescr(self, formName)
descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command.
  guiCallback(self, event=None)
Default callback function called by the gui
  __call__(self, nodes, surfaceName, cut=1, negate=False, only=False, **kw)
None <- displayBuriedTriangles(nodes, surfaceName, negate=0, only=False, redraw=0) Required Arguments: nodes--- nodes for which the buried surface is to be displayed.

Inherited from displayCommands.DisplayCommand: getFormValues, getLastUsedValues, getNodes, handleDisplayValue, handleNegateOnly, onAddCmdToViewer, setLastUsedValues, updateGeom

Inherited from mvCommand.MVCommand: strArg

Inherited from mvCommand.MVCommand (private): _strArg

Inherited from ViewerFramework.VFCommand.Command: __repr__, addCallbackAfter, addCallbackBefore, addUndoCall, afterDoit, beforeDoit, buildLogArgList, cleanup, customizeGUI, doitWrapper, getArguments, getHelp, getLogArgs, getValNamedArgs, log, logString, onAddNewCmd, onCmdRun, setupUndoAfter, showForm, tkCb, 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: displayCommands.DisplayCommand.__init__

checkDependencies(self)

source code 
make sure the mslib package is available
Overrides: ViewerFramework.VFCommand.Command.checkDependencies

setupUndoBefore(self, nodes, surfaceName, cut=1, negate=False, only=False, redraw=1)

source code 
This method builds the self.undoCmds string. This method should have the same signature than the __call__. When this string is executed it should undo the actions of this command. This string will be appended to the undoCmdStack list if the command is successfuly carried out. This method handles only commands with the negateKw. Other commands have to overwrite it.
Overrides: ViewerFramework.VFCommand.Command.setupUndoBefore
(inherited documentation)

doit(self, nodes, surfaceName, cut=1, negate=False, only=False, **kw)

source code 
nodes--- nodes for which the buried surface is to be displayed. surfaceName--- name of an MSMS surface computed using MSMS. cut-- triangles with this number of buried vertices will be displayed
Overrides: ViewerFramework.VFCommand.Command.doit

selectMolecule_cb(self, event=None)

source code 
None

OK_cb(self, event=None)

source code 
call back for OK button

buildFormDescr(self, formName)

source code 
descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command. This is where the inputFormDescr is created and the description of the widgets appended. If a command has several inputForm buildFormDescr should build all the inputFormDescr and you do a if / elif check to know which one to create. formName : string name of the form corresponding to this descr.
Overrides: displayCommands.DisplayCommand.buildFormDescr

guiCallback(self, event=None)

source code 
Default callback function called by the gui
Overrides: displayCommands.DisplayCommand.guiCallback

__call__(self, nodes, surfaceName, cut=1, negate=False, only=False, **kw)
(Call operator)

source code 
None <- displayBuriedTriangles(nodes, surfaceName, negate=0, only=False, redraw=0)

        
Required Arguments:

         nodes--- nodes for which the buried surface is to be displayed.
         surfaceName-- name of an MSMS surface computed using msms.(string)

         
Optional Arguments:

         cut--- specifies how many vertices has to be buried (or not) for a triangle to be displayed.(1, 2 or 3)

         negate-- specifies whether we want to display buried or exposed triangles

         only-- specifies whether we want to display only triangles for these nodes

Overrides: ViewerFramework.VFCommand.Command.__call__