Package Pmv :: Module bondsCommands :: Class AddBondsGUICommand
[hide private]
[frames] | no frames]

Class AddBondsGUICommand

source code

 ViewerFramework.VFCommand.Command --+    
                                     |    
                   mvCommand.MVCommand --+
                                         |
ViewerFramework.VFCommand.ICOM --+       |
                                 |       |
                  mvCommand.MVICOM --+   |
                                     |   |
                  mvCommand.MVAtomICOM --+
                                         |
                                        AddBondsGUICommand


    The AddBondGUICommand provides an interactive way of creating bonds between two given atoms by picking on them. To use this command you need first to load it into PMV. Then you can find the entry 'addBonds' under the Edit menu. To add bonds  you just need to pick on the 2 atoms you want to bind. If you drag select  a bunch of atoms, the command will buildBondsByDistance between them.This command is undoable.
   
Package : Pmv
   
Module  : bondsCommands
   
Class   : AddBondsGUICommand
   
Command : addBondsGC
   
Synopsis:

        None<-addBondsGC(atoms)

    
Required Arguments:
    
        atoms  : atom(s)

    



Instance Methods [hide private]
  __init__(self, func=None)
  onRemoveObjectFromViewer(self, obj)
  onAddCmdToViewer(self)
method called when an instance of this command is added to the viewer.
  __call__(self, atoms, **kw)
None<-addBondsGC(atoms)
  doit(self, ats)
virtual method.
  applyTransformation(self, pt, mat)
  getTransformedCoords(self, atom)
  update(self, event=None)
  guiCallback(self, event=None)
  setupUndoAfter(self, ats, **kw)
A chance to modify self.undoCmds after the command was carried out
  startICOM(self)
gets called every time this command is about to be run becuase of a picking event.
  stopICOM(self)
gets called when this command stops being bound to picking here one should withdraw forms mainly

Inherited from mvCommand.MVCommand: strArg

Inherited from mvCommand.MVCommand (private): _strArg

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

Inherited from mvCommand.MVAtomICOM: getObjects

Inherited from ViewerFramework.VFCommand.ICOM: initICOM


Class Variables [hide private]

Inherited from ViewerFramework.VFCommand.Command: negateKw, objArgOnly


Method Details [hide private]

__init__(self, func=None)
(Constructor)

source code 
None
Overrides: mvCommand.MVCommand.__init__

onRemoveObjectFromViewer(self, obj)

source code 
None

onAddCmdToViewer(self)

source code 
method called when an instance of this command is added to the viewer. This enable viewer-addition time initializations
Overrides: ViewerFramework.VFCommand.Command.onAddCmdToViewer
(inherited documentation)

__call__(self, atoms, **kw)
(Call operator)

source code 

None<-addBondsGC(atoms)

atoms : atom(s)
Overrides: ViewerFramework.VFCommand.Command.__call__

doit(self, ats)

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

applyTransformation(self, pt, mat)

source code 
None

getTransformedCoords(self, atom)

source code 
None

update(self, event=None)

source code 
None

guiCallback(self, event=None)

source code 
None
Overrides: mvCommand.MVCommand.guiCallback

setupUndoAfter(self, ats, **kw)

source code 
A chance to modify self.undoCmds after the command was carried out
Overrides: ViewerFramework.VFCommand.Command.setupUndoAfter
(inherited documentation)

startICOM(self)

source code 
gets called every time this command is about to be run becuase of a picking event. It is called just before the Pick is converted into objects.
Overrides: ViewerFramework.VFCommand.ICOM.startICOM
(inherited documentation)

stopICOM(self)

source code 
gets called when this command stops being bound to picking here one should withdraw forms mainly
Overrides: ViewerFramework.VFCommand.ICOM.stopICOM
(inherited documentation)