Package Pmv :: Module splineCommands :: Class DisplaySplineAsLineCommand
[hide private]
[frames] | no frames]

Class DisplaySplineAsLineCommand

source code

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

DisplaySplineAsLineCommand implements a set of method to display/
    undisplay part of the spline when represented as line.
    
Package : Pmv
    
Module  : splineCommands
    
Class   : DisplaySplineAsLineCommand
    
Command : displaySplineAsLine
    
Synopsis:
None<- displaySplineAsLine(nodes, lineWidth=3, only=0, negate=0,**kw)
    
Required Arguments:

        nodes --- TreeNodeSet holding the current selection. Can also be a string representing the current selection.
    
Optional Arguments:

        only  --- Boolean flag when set to True only the current selection will be displayed
        
negate --- Boolean flag when set to True undisplay the current selection lineWidth: width of the line representing the spline.
    



Instance Methods [hide private]
  onRemoveObjectFromViewer(self, obj)
  createGeometries(self, obj)
Methdo creating the lineSpline geometry.
  pickedVerticesToAtoms(self, geom, vertInd)
Function called to convert a picked vertex into an atom
  atomPropToVertices(self, geom, atoms, propName, propIndex=None)
Function called to compute the array of colors
  setupUndoBefore(self, nodes, lineWidth=3, only=False, negate=False)
This method builds the self.undoCmds string.
  guiCallback(self)
  __call__(self, nodes, lineWidth=3, only=False, negate=False, **kw)
None<- displaySplineAsLine(nodes,lineWidth=3,only=0,negate=0,**kw) Required Arguments: nodes --- TreeNodeSet holding the current selection.
  doit(self, nodes, lineWidth=3, only=False, negate=False)
virtual method.

Inherited from displayCommands.DisplayCommand: __init__, 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, 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]

onRemoveObjectFromViewer(self, obj)

source code 
None

createGeometries(self, obj)

source code 
Methdo creating the lineSpline geometry.

pickedVerticesToAtoms(self, geom, vertInd)

source code 
Function called to convert a picked vertex into an atom

atomPropToVertices(self, geom, atoms, propName, propIndex=None)

source code 
Function called to compute the array of colors

setupUndoBefore(self, nodes, lineWidth=3, only=False, negate=False)

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)

guiCallback(self)

source code 
None
Overrides: displayCommands.DisplayCommand.guiCallback

__call__(self, nodes, lineWidth=3, only=False, negate=False, **kw)
(Call operator)

source code 
None<- displaySplineAsLine(nodes,lineWidth=3,only=0,negate=0,**kw)
        
Required Arguments:

        nodes --- TreeNodeSet holding the current selection. Can also be a string representing the current selection.
        
Optional Arguments:

        only  --- Boolean flag when set to True only the current selection will be displayed
        
negate --- Boolean flag when set to True undisplay the current selection 
        
lineWidth --- width of the line representing the spline.
        

Overrides: ViewerFramework.VFCommand.Command.__call__

doit(self, nodes, lineWidth=3, only=False, negate=False)

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