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

Class DisplayIntermolecularBuriedTriangles

source code

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

This Command display/Undisplay buried SES between two molecules.

    Package : Pmv

    Module  : msmsCommands

    Class   : DisplayIntermolecularBuriedTriangles

    Command name : displayIntermolecularBuriedTriangles
    
    
Synopsis :

    None <--- displayIntermolecularBuriedTriangles(nodes1, surfaceName1,nodes2, surfaceName2, negate=0)

    
Required Arguments:

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

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

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

    surfaceName2 --- 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, nodes1, surfaceName1, nodes2, surfaceName2, cut, negate, only, **kw)
This method builds the self.undoCmds string.
  doit(self, nodes1, surfaceName1, nodes2, surfaceName2, cut=1, negate=False, only=False)
nodes1--- nodes for which the buried surface is to be displayed.
  selectFirstMolecule_cb(self, event=None)
  selectSecondMolecule_cb(self, event=None)
  OK_cb(self, event=None)
call back for OK button
  guiCallback(self, event=None)
  __call__(self, nodes1, surfaceName1, nodes2, surfaceName2, cut=1, negate=False, only=False, **kw)
None <- displayIntermolecularBuriedTriangles(nodes1, surfaceName1, nodes2, surfaceName2, negate=0, only=False, **kw)

Inherited from displayCommands.DisplayCommand: buildFormDescr, 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, nodes1, surfaceName1, nodes2, surfaceName2, cut, negate, only, **kw)

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, nodes1, surfaceName1, nodes2, surfaceName2, cut=1, negate=False, only=False)

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

selectFirstMolecule_cb(self, event=None)

source code 
None

selectSecondMolecule_cb(self, event=None)

source code 
None

OK_cb(self, event=None)

source code 
call back for OK button

guiCallback(self, event=None)

source code 
None
Overrides: displayCommands.DisplayCommand.guiCallback

__call__(self, nodes1, surfaceName1, nodes2, surfaceName2, cut=1, negate=False, only=False, **kw)
(Call operator)

source code 

None <- displayIntermolecularBuriedTriangles(nodes1, surfaceName1, nodes2, surfaceName2, negate=0, only=False, **kw)

nodes1--- nodes for which the buried surface is to be displayed. surfaceName1--- name of an MSMS surface computed using MSMS. nodes2--- nodes for which the buried surface is to be displayed. surfaceName2--- name of an MSMS surface computed using MSMS. cut-- triangles with this number of buried vertices will be displayed 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__