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

Class DisplayMSMS

source code

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

The displayMSMS command allows the user to display/undisplay or display only the given MSMS surface corresponding to the current selection.

    Package : Pmv

    Module  : msmsCommands

    Class   : DisplayMSMS

    Command name : displayMSMS

    
Required Arguments:

    nodes  --- TreeNodeSet holding the current selection

    
Optional Arguments:

    only     --- flag when set to 1 only the current selection will be
              displayed

    negate   --- flag when set to 1 undisplay the current selection

    surfName --- name of the selection, default = 'all'

    nbVert  ---  Nb of vertices per triangle needed to select a triangle.

    
    



Instance Methods [hide private]
  onAddCmdToViewer(self)
  handleEditEvent(self, event)
  setupUndoBefore(self, nodes, surfName='all', negate=False, only=False, nbVert=1)
This method builds the self.undoCmds string.
  doit(self, nodes, surfName='all', negate=False, only=False, nbVert=Pmv.numOfSelectedVerticesToSelectTriangle)
virtual method.
  buildFormDescr(self, formName='default')
  getSurfNames(self)
  guiCallback(self)
  __call__(self, nodes, only=False, negate=False, surfName='all', nbVert=1, **kw)
None <--- displayMSMS(nodes, only=False, negate=False, name='all', **kw)...

Inherited from displayCommands.DisplayCommand: __init__, getFormValues, getLastUsedValues, getNodes, handleDisplayValue, handleNegateOnly, 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, checkDependencies, 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]

onAddCmdToViewer(self)

source code 
None
Overrides: displayCommands.DisplayCommand.onAddCmdToViewer

handleEditEvent(self, event)

source code 
None

setupUndoBefore(self, nodes, surfName='all', negate=False, only=False, nbVert=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, surfName='all', negate=False, only=False, nbVert=Pmv.numOfSelectedVerticesToSelectTriangle)

source code 
virtual method. Has to be implemented by the sub classes
Overrides: ViewerFramework.VFCommand.Command.doit
(inherited documentation)

buildFormDescr(self, formName='default')

source code 
None
Overrides: displayCommands.DisplayCommand.buildFormDescr

getSurfNames(self)

source code 
None

guiCallback(self)

source code 
None
Overrides: displayCommands.DisplayCommand.guiCallback

__call__(self, nodes, only=False, negate=False, surfName='all', nbVert=1, **kw)
(Call operator)

source code 
None <--- displayMSMS(nodes, only=False, negate=False, name='all', **kw)

        
Required Arguments:

        nodes  --- TreeNodeSet holding the current selection

        
Optional Arguments:

        only   --- Boolean flag when set to True only the current selection will be displayed (default=False)

        negate --- Boolean flag when set to True undisplay the current selection (default=False)

        surfName   --- name of the selection, default = 'all'

        nbVert --- Nb of vertices per triangle needed to select a triangle

        

Overrides: ViewerFramework.VFCommand.Command.__call__