processing.dxf
Class RawDXF

java.lang.Object
  processing.core.PImage
      processing.core.PGraphics
          processing.core.PGraphics3D
              processing.dxf.RawDXF

All Implemented Interfaces:

java.lang.Cloneable, PConstants

public class RawDXF
extends PGraphics3D

A simple library to write DXF files with Processing. Because this is used with beginRaw() and endRaw(), only individual triangles and (discontinuous) line segments will be written to the file.

Use something like a keyPressed() in PApplet to trigger it, to avoid writing a bazillion .dxf files.

Usually, the file will be saved to the sketch's folder. Use Sketch → Show Sketch Folder to see it from the PDE.

A simple example of how to use:

 import processing.dxf.*;

 boolean record;

 void setup() {
   size(500, 500, P3D);
 }

 void keyPressed() {
   // use a key press so that it doesn't make a million files
   if (key == 'r') record = true;
 }

 void draw() {
   if (record) {
     beginRaw(DXF, "output.dxf");
   }

   // do all your drawing here

   if (record) {
     endRaw();
     record = false;
   }
 }
 

 import processing.dxf.*;

 boolean record;
 RawDXF dxf;

 void setup() {
   size(500, 500, P3D);
 }

 void keyPressed() {
   // use a key press so that it doesn't make a million files
   if (key == 'r') record = true;
 }

 void draw() {
   if (record) {
     dxf = (RawDXF) createGraphics(width, height, DXF, "output.dxf");
     beginRaw(dxf);
   }

   // do all your drawing here, and to set the layer, call:
   // if (record) {
   //   dxf.setLayer(num);
   // }
   // where 'num' is an integer.
   // the default is zero, or you can set it to whatever.

   if (record) {
     endRaw();
     record = false;
     dxf = null;
   }
 }
 

Based on the original DXF writer from Simon Greenwold, February 2004. Updated for Processing 0070 by Ben Fry in September 2004, and again for Processing beta in April 2005. Rewritten to support beginRaw/endRaw by Ben Fry in February 2006. Updated again for inclusion as a core library in March 2006. Constructor modifications in September 2008 as we approach 1.0.

RawDXF

public RawDXF()

setPath

public void setPath(java.lang.String path)

Overrides:

setPath in class PGraphics

dispose

public void dispose()

Description copied from class: PGraphics

Handle any takedown for this graphics context.

This is called when a sketch is shut down and this renderer was specified using the size() command, or inside endRecord() and endRaw(), in order to shut things off.

Overrides:

dispose in class PGraphics

displayable

public boolean displayable()

Description copied from class: PGraphics

Return true if this renderer should be drawn to the screen. Defaults to returning true, since nearly all renderers are on-screen beasts. But can be overridden for subclasses like PDF so that a window doesn't open up.

A better name? showFrame, displayable, isVisible, visible, shouldDisplay, what to call this?

Overrides:

displayable in class PGraphics

beginDraw

public void beginDraw()

Description copied from class: PGraphics

Prepares the PGraphics for drawing.

When creating your own PGraphics, you should call this before drawing anything.

Overrides:

beginDraw in class PGraphics3D

endDraw

public void endDraw()

Description copied from class: PGraphics3D

See notes in PGraphics. If z-sorting has been turned on, then the triangles will all be quicksorted here (to make alpha work more properly) and then blit to the screen.

Overrides:

endDraw in class PGraphics3D

setLayer

public void setLayer(int layer)

Set the current layer being used in the DXF file. The default is zero.

write

public void write(java.lang.String cmd,
                  float val)

Write a command on one line (as a String), then start a new line and write out a formatted float. Available for anyone who wants to insert additional commands into the DXF stream.

println

public void println(java.lang.String what)

Write a line to the dxf file. Available for anyone who wants to insert additional commands into the DXF stream.

beginShape

public void beginShape(int kind)

Description copied from class: PGraphics

Start a new shape.

Differences between beginShape() and line() and point() methods.

beginShape() is intended to be more flexible at the expense of being a little more complicated to use. it handles more complicated shapes that can consist of many connected lines (so you get joins) or lines mixed with curves.

The line() and point() command are for the far more common cases (particularly for our audience) that simply need to draw a line or a point on the screen.

From the code side of things, line() may or may not call beginShape() to do the drawing. In the beta code, they do, but in the alpha code, they did not. they might be implemented one way or the other depending on tradeoffs of runtime efficiency vs. implementation efficiency &mdash meaning the speed that things run at vs. the speed it takes me to write the code and maintain it. for beta, the latter is most important so that's how things are implemented.

Overrides:

beginShape in class PGraphics3D

vertex

public void vertex(float x,
                   float y)

Overrides:

vertex in class PGraphics3D

vertex

public void vertex(float x,
                   float y,
                   float z)

Overrides:

vertex in class PGraphics

endShape

public void endShape(int mode)

Overrides:

endShape in class PGraphics3D