# Python: module skeinforge_application.skeinforge_plugins.analyze_plugins.vectorwrite

skeinforge_application.skeinforge_plugins.analyze_plugins.vectorwrite ($Date: 2008/21/04 $) | index /home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/skeinforge_application/skeinforge_plugins/analyze_plugins/vectorwrite.py

Previous / Next / Contents

`
Vectorwrite is a script to write Scalable Vector Graphics for a gcode file.
The vectorwrite manual page is at:
http://www.bitsfrombytes.com/wiki/index.php?title=Skeinforge_Vectorwrite
Vectorwrite generates a Scalable Vector Graphics file which can be opened by an SVG viewer or an SVG capable browser like Mozilla:
http://www.mozilla.com/firefox/
Operation
Settings
Layers
Layers From
Layers To
SVG Viewer
Examples
`

## Operation

The default 'Activate Vectorwrite' checkbox is on. When it is on, the functions described below will work when called from the skeinforge toolchain, when it is off, the functions will not be called from the toolchain. The functions will still be called, whether or not the 'Activate Vectorwrite' checkbox is on, when vectorwrite is run directly.

## Settings

### Layers

#### Layers From

Default is zero.
The "Layers From" is the index of the bottom layer that will be displayed. If the layer from is the default zero, the display will start from the lowest layer. If the the layer from index is negative, then the display will start from the layer from index below the top layer.

#### Layers To

Default is a huge number, which will be limited to the highest index layer.
The "Layers To" is the index of the top layer that will be displayed. If the layer to index is a huge number like the default, the display will go to the top of the model, at least until we model habitats:) If the layer to index is negative, then the display will go to the layer to index below the top layer. The layer from until layer to index is a python slice.

### SVG Viewer

Default is webbrowser.
If the 'SVG Viewer' is set to the default 'webbrowser', the scalable vector graphics file will be sent to the default browser to be opened. If the 'SVG Viewer' is set to a program name, the scalable vector graphics file will be sent to that program to be opened.

## Examples

Below are examples of vectorwrite being used. These examples are run in a terminal in the folder which contains Screw Holder_penultimate.gcode and vectorwrite.py.
> python vectorwrite.py
This brings up the vectorwrite dialog.
> python vectorwrite.py Screw Holder_penultimate.gcode
The vectorwrite file is saved as Screw_Holder_penultimate_vectorwrite.svg
> python
Python 2.5.1 (r251:54863, Sep 22 2007, 01:43:31)
[GCC 4.2.1 (SUSE Linux)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import vectorwrite
>>> vectorwrite.main()
This brings up the vectorwrite dialog.
>>> vectorwrite.getWindowAnalyzeFile('Screw Holder_penultimate.gcode')
The vectorwrite file is saved as Screw_Holder_penultimate_vectorwrite.svg

Previous / Next / Contents

Modules

``

__init__ cStringIO fabmetheus_utilities.euclidean | fabmetheus_utilities.gcodec os fabmetheus_utilities.settings | skeinforge_application.skeinforge_utilities.skeinforge_polyfile skeinforge_application.skeinforge_utilities.skeinforge_profile fabmetheus_utilities.svg_writer | sys time

Classes

``

fabmetheus_utilities.svg_writer.SVGWriter
  SVGWriterVectorwrite
ThreadLayer
VectorwriteRepository
VectorwriteSkein

class SVGWriterVectorwrite(fabmetheus_utilities.svg_writer.SVGWriter)
`` | `A class to vectorwrite a carving.`

Methods defined here:

addPaths(self, colorName, paths, transformString)
  `Add paths to the output.`

addRotatedLoopLayerToOutput(self, layerIndex, rotatedBoundaryLayer)
  `Add rotated boundary layer to the output.`

Methods inherited from fabmetheus_utilities.svg_writer.SVGWriter:

__init__(self, addLayerTemplateToSVG, carving, decimalPlacesCarried, perimeterWidth=None)

addLayerBegin(self, layerIndex, rotatedBoundaryLayer)
  `Add the start lines for the layer.`

addRotatedLoopLayersToOutput(self, rotatedBoundaryLayers)
  `Add rotated boundary layers to the output.`

getReplacedSVGTemplate(self, fileName, procedureName, rotatedBoundaryLayers, xmlElement)
  `Get the lines of text from the layer_template.svg file.`

getRounded(self, number)
  `Get number rounded to the number of carried decimal places as a string.`

getRoundedComplexString(self, point)
  `Get the rounded complex string.`

getSVGStringForLoop(self, loop)
  `Get the svg loop string.`

getSVGStringForLoops(self, loops)
  `Get the svg loops string.`

getSVGStringForPath(self, path)
  `Get the svg path string.`

getTransformString(self)
  `Get the svg transform string.`

setMetadataNoscriptElement(self, prefix, value)
  `Set the metadata value and the NoJavascript text.`

class ThreadLayer
`` | `Threads with a z.`

Methods defined here:

__init__(self, z)

__repr__(self)
  `Get the string representation of this loop layer.`

class VectorwriteRepository
`` | `A class to handle the vectorwrite settings.`

Methods defined here:

__init__(self)
  `Set the default settings, execute title & settings fileName.`

execute(self)
  `Write button has been clicked.`

class VectorwriteSkein
`` | `A class to vectorwrite a carving.`

Methods defined here:

addRotatedLoopLayer(self, z)
  `Add rotated loop layer.`

addToLoops(self)
  `Add the thread to the loops.`

addToPerimeters(self)
  `Add the thread to the perimeters.`

getCarveCornerMaximum(self)
  `Get the corner maximum of the vertexes.`

getCarveCornerMinimum(self)
  `Get the corner minimum of the vertexes.`

getCarveLayerThickness(self)
  `Get the layer thickness.`

getCarvedSVG(self, fileName, gcodeText, repository)
  `Parse gnu triangulated surface text and store the vectorwrite gcode.`

linearMove(self, splitLine)
  `Get statistics for a linear move.`

parseInitialization(self)
  `Parse gcode initialization and store the parameters.`

parseLine(self, line)
  `Parse a gcode line and add it to the outset skein.`

Functions

``

getNewRepository()
  `Get the repository constructor.`

getWindowAnalyzeFile(fileName)
  `Write scalable vector graphics for a gcode file.`

getWindowAnalyzeFileGivenText(fileName, gcodeText, repository=None)
  `Write scalable vector graphics for a gcode file given the settings.`

main()
  `Display the vectorwrite dialog.`

writeOutput(fileName, fileNameSuffix, gcodeText='')
  `Write scalable vector graphics for a skeinforge gcode file, if activate vectorwrite is selected.`

Data
`` |  | __author__ = 'Enrique Perez (perez_enrique@yahoo.com)' __credits__ = 'Nophead <http://hydraraptor.blogspot.com/>' __date__ = '$Date: 2008/21/04 $' __license__ = 'GPL 3.0' absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)

Author
`` |  | Enrique Perez (perez_enrique@yahoo.com)

Credits
`` |  | Nophead <http://hydraraptor.blogspot.com/>