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

Class ExtrudeSplineCommand

source code

ViewerFramework.VFCommand.Command --+    
                                    |    
                  mvCommand.MVCommand --+
                                        |
                                       ExtrudeSplineCommand


    The extrudeSplineCommand implements a set of method to create the
    extrude Geometries DejaVu.GleExtrude resulting of the extrusion of a
    shape2D along a path3D computed by the DejaVu.SplineObject using the GLE
    library.
    
Package : Pmv
    
Module  : splineCommands
    
Class   : ExtrudeSplineCommand
    
Command : extrudeSpline
    
keywords: extrude spline
    
Synopsis:
None <- extrudeSpline(nodes, shape2D=None, display=True, **kw)
    
Required Arguments:

        nodes --- treeNodeSet holding the current selection, or string
                 representing a treeNodeSet.
    
Optional Arguments:

        shape2D --- instance of a DejaVu.Shapes class (Triangle2DDup, Circle2D...)the default shape is a circle2D
        
capsFlag --- Boolean flag to add caps at the end of the spline (default=False)
        
display --- Boolean flag to call or not the displayExtrudedSpline command default value is True.
    



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.
  createGeometries(self, chain)
Method to create the extrude geometry
  pickedVerticesToAtoms(self, geom, vertInd)
Function called to convert a picked vertex into an atom
  atomPropToVertices(self, geom, atoms, propName, propIndex=None)
  __call__(self, nodes, shape2D=None, capsFlag=False, display=True, **kw)
None <- extrudeSpline(nodes, shape2D=None, display=True, **kw) Required Arguments: nodes --- treeNodeSet holding the current selection, or string representing a treeNodeSet.
  doit(self, nodes, shape2D=None, capsFlag=False, display=True)
virtual method.
  buildFormDescr(self, formName)
descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command.
  guiCallback(self)
Default callback function called by the gui

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, getLastUsedValues, getLogArgs, getValNamedArgs, log, logString, onAddNewCmd, onCmdRun, setLastUsedValues, setupUndoAfter, setupUndoBefore, showForm, tkCb, updateGeom, warningMsg


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)

createGeometries(self, chain)

source code 
Method to create the extrude 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 
None

__call__(self, nodes, shape2D=None, capsFlag=False, display=True, **kw)
(Call operator)

source code 
None <- extrudeSpline(nodes, shape2D=None, display=True, **kw)
        
Required Arguments:

        nodes --- treeNodeSet holding the current selection, or string
                 representing a treeNodeSet.
        
Optional Arguments:

        shape2D --- instance of a DejaVu.Shapes class (Triangle2DDup, Circle2D...)the default shape is a circle2D
        
capsFlag --- Boolean flag to add caps at the end of the spline (default=False)
        
display --- Boolean flag to call or not the displayExtrudedSpline command default value is True.
        

Overrides: ViewerFramework.VFCommand.Command.__call__

doit(self, nodes, shape2D=None, capsFlag=False, display=True)

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

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: ViewerFramework.VFCommand.Command.buildFormDescr
(inherited documentation)

guiCallback(self)

source code 
Default callback function called by the gui
Overrides: mvCommand.MVCommand.guiCallback