processing.pdf

Class PGraphicsPDF

Object

PImage

PGraphics

PGraphicsJava2D

PGraphicsPDF

All Implemented Interfaces:

Cloneable, PConstants

public class PGraphicsPDF
extends PGraphicsJava2D

Thin wrapper for the iText PDF library that handles writing PDF files. The majority of the work in this library is done by iText.

This is currently using iText 2.1.7.

The issue is that versions from the 5.x series were slow to handle lots of fonts with the DefaultFontMapper. 2.x seemed a little slower than 1.x, but 5.x took up to 10 times the time to load, meaning a lag of several seconds when starting sketches on a machine that had a good handful of fonts installed. (Like, say, anyone in our target audience. Or me.)

Field Summary

Fields inherited from class PGraphicsJava2D

fillGradient, fillGradientObject, g2, strokeGradient, strokeGradientObject

Fields inherited from class PGraphics

A, AB, AG, ambientB, ambientColor, ambientG, ambientR, AR, B, backgroundColor, BEEN_LIT, bezierDetail, colorMode, colorModeA, colorModeX, colorModeY, colorModeZ, curveDetail, curveTightness, DA, DB, DEFAULT_VERTICES, DG, DR, EB, edge, EDGE, EG, ellipseMode, emissiveB, emissiveColor, emissiveG, emissiveR, ER, fill, fillColor, G, HAS_NORMAL, image, imageMode, normalX, normalY, normalZ, NX, NY, NZ, pixelCount, R, rectMode, SA, SB, setAmbient, SG, shapeMode, SHINE, shininess, smooth, SPB, specularB, specularColor, specularG, specularR, SPG, sphereDetailU, sphereDetailV, SPR, SR, stroke, strokeCap, strokeColor, strokeJoin, strokeWeight, SW, textAlign, textAlignY, textFont, textLeading, textMode, textSize, textureImage, textureMode, textureU, textureV, tint, tintColor, TX, TY, TZ, U, V, VERTEX_FIELD_COUNT, VW, VX, VY, VZ

Fields inherited from class PImage

ALPHA_MASK, BLUE_MASK, format, GREEN_MASK, height, loaded, parent, pixelDensity, pixelHeight, pixels, pixelWidth, RED_MASK, width

Fields inherited from interface PConstants

ADD, ALPHA, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CHORD, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ASYNC_SAVEFRAME, DISABLE_BUFFER_READING, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_KEY_REPEAT, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_OPTIMIZED_STROKE, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_MIPMAPS, DODGE, DOWN, DXF, ELLIPSE, ENABLE_ASYNC_SAVEFRAME, ENABLE_BUFFER_READING, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_KEY_REPEAT, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_OPTIMIZED_STROKE, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_MIPMAPS, ENTER, EPSILON, ERODE, ESC, EXCLUSION, FX2D, GIF, GRAY, GROUP, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LANDSCAPE, LEFT, LIGHTEST, LINE, LINE_LOOP, LINE_STRIP, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MODELVIEW, MOVE, MULTIPLY, NORMAL, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, PIE, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADRATIC_VERTEX, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPAN, SPHERE, SPOT, SQUARE, SUBTRACT, SVG, TAB, TARGA, TAU, TEXT, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, UP, VERTEX, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Constructor Summary

Constructors

Constructor and Description
PGraphicsPDF()

Method Summary

Modifier and Type	Method and Description
void	addFonts(String directory) Add a directory that should be searched for font data.
void	beginDraw()
void	blend(int sx, int sy, int dx, int dy, int mode)
void	blend(int sx1, int sy1, int sx2, int sy2, int dx1, int dy1, int dx2, int dy2, int mode)
void	blend(PImage src, int sx, int sy, int dx, int dy, int mode)
void	blend(PImage src, int sx1, int sy1, int sx2, int sy2, int dx1, int dy1, int dx2, int dy2, int mode)
void	copy(int sx1, int sy1, int sx2, int sy2, int dx1, int dy1, int dx2, int dy2)
void	copy(PImage src, int sx1, int sy1, int sx2, int sy2, int dx1, int dy1, int dx2, int dy2)
PSurface	createSurface()
boolean	displayable() Don't open a window for this renderer, it won't be used.
void	dispose()
void	endDraw()
void	filter(int kind)
void	filter(int kind, float param)
PImage	get()
int	get(int x, int y)
PImage	get(int x, int y, int c, int d)
static String[]	listFonts() List the fonts known to the PDF renderer.
void	loadPixels()
void	mask(int[] alpha)
void	mask(PImage alpha)
void	nextPage() Call to explicitly go to the next page from within a single draw().
boolean	save(String filename)
void	set(int x, int y, int argb)
void	set(int x, int y, PImage image)
void	setOutput(OutputStream output) Set the library to write to an output stream instead of a file.
void	setPath(String path)
void	textFont(PFont which)
void	textMode(int mode) Change the textMode() to either SHAPE or MODEL.
void	updatePixels()
void	updatePixels(int x, int y, int c, int d)

Methods inherited from class PGraphicsJava2D

applyMatrix, applyMatrix, backgroundImpl, beginContour, beginRaw, beginShape, bezierDetail, bezierVertex, bezierVertex, box, checkImage, curveDetail, curveVertex, endContour, endRaw, endShape, getImage, getMatrix, getMatrix, getMatrix, getNative, hint, line, loadShape, noClip, point, popMatrix, printMatrix, pushMatrix, quad, quadraticVertex, quadraticVertex, resetMatrix, rotate, rotate, rotateX, rotateY, rotateZ, scale, scale, scale, screenX, screenX, screenY, screenY, screenZ, setMatrix, setMatrix, shearX, shearY, sphere, strokeCap, strokeJoin, strokeWeight, textAscent, textDescent, texture, translate, triangle, vertex, vertex, vertex, vertex, vertex

Methods inherited from class PGraphics

alpha, ambient, ambient, ambient, ambientLight, ambientLight, applyMatrix, applyMatrix, applyMatrix, arc, arc, attrib, attrib, attrib, attribColor, attribNormal, attribPosition, background, background, background, background, background, background, background, beginCamera, beginPGL, beginShape, bezier, bezier, bezierPoint, bezierTangent, blendMode, blue, box, brightness, camera, camera, circle, clear, clip, color, color, color, color, color, color, color, color, color, colorMode, colorMode, colorMode, colorMode, createShape, createShape, createShape, curve, curve, curvePoint, curveTangent, curveTightness, curveVertex, directionalLight, edge, ellipse, ellipseMode, emissive, emissive, emissive, endCamera, endPGL, endShape, fill, fill, fill, fill, fill, fill, filter, flush, frustum, getCache, getRaw, getStyle, getStyle, green, haveRaw, hue, image, image, image, imageMode, is2D, is2X, is3D, isGL, lerpColor, lerpColor, lightFalloff, lights, lightSpecular, line, loadShader, loadShader, loadShape, modelX, modelY, modelZ, noFill, noLights, normal, noSmooth, noStroke, noTexture, noTint, ortho, ortho, ortho, perspective, perspective, point, pointLight, pop, popStyle, printCamera, printProjection, push, pushStyle, rect, rect, rect, rectMode, red, removeCache, resetShader, resetShader, saturation, setCache, setMatrix, setParent, setPrimary, setSize, shader, shader, shape, shape, shape, shapeMode, shininess, showDepthWarning, showDepthWarningXYZ, showException, showMethodWarning, showMissingWarning, showVariationWarning, showWarning, showWarning, smooth, smooth, specular, specular, specular, sphereDetail, sphereDetail, spotLight, square, stroke, stroke, stroke, stroke, stroke, stroke, style, text, text, text, text, text, text, text, text, text, text, text, textAlign, textAlign, textFont, textLeading, textSize, textureMode, textureWrap, textWidth, textWidth, textWidth, tint, tint, tint, tint, tint, tint, translate

Methods inherited from class PImage

blendColor, clone, copy, getModifiedX1, getModifiedX2, getModifiedY1, getModifiedY2, init, init, isLoaded, isModified, resize, setLoaded, setLoaded, setModified, setModified

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PGraphicsPDF

public PGraphicsPDF()

Method Detail

setPath

public void setPath(String path)

Overrides:

setPath in class PGraphics

setOutput

public void setOutput(OutputStream output)

Set the library to write to an output stream instead of a file.

createSurface

public PSurface createSurface()

Overrides:

createSurface in class PGraphicsJava2D

beginDraw

public void beginDraw()

Overrides:

beginDraw in class PGraphicsJava2D

endDraw

public void endDraw()

Overrides:

endDraw in class PGraphicsJava2D

nextPage

public void nextPage()

Call to explicitly go to the next page from within a single draw().

dispose

public void dispose()

Overrides:

dispose in class PGraphics

displayable

public boolean displayable()

Don't open a window for this renderer, it won't be used.

Overrides:

displayable in class PGraphics

textFont

public void textFont(PFont which)

Overrides:

textFont in class PGraphics

textMode

public void textMode(int mode)

Change the textMode() to either SHAPE or MODEL.
This resets all renderer settings, and therefore must be called before any other commands that set the fill() or the textFont() or anything. Unlike other renderers, use textMode() directly after the size() command.

Overrides:

textMode in class PGraphics

loadPixels

public void loadPixels()

Overrides:

loadPixels in class PGraphicsJava2D

updatePixels

public void updatePixels()

Overrides:

updatePixels in class PImage

updatePixels

public void updatePixels(int x,
                         int y,
                         int c,
                         int d)

Overrides:

updatePixels in class PGraphicsJava2D

get

public int get(int x,
               int y)

Overrides:

get in class PGraphicsJava2D

get

public PImage get(int x,
                  int y,
                  int c,
                  int d)

Overrides:

get in class PImage

get

public PImage get()

Overrides:

get in class PImage

set

public void set(int x,
                int y,
                int argb)

Overrides:

set in class PGraphicsJava2D

set

public void set(int x,
                int y,
                PImage image)

Overrides:

set in class PImage

mask

public void mask(int[] alpha)

Overrides:

mask in class PGraphicsJava2D

mask

public void mask(PImage alpha)

Overrides:

mask in class PGraphicsJava2D

filter

public void filter(int kind)

Overrides:

filter in class PImage

filter

public void filter(int kind,
                   float param)

Overrides:

filter in class PImage

copy

public void copy(int sx1,
                 int sy1,
                 int sx2,
                 int sy2,
                 int dx1,
                 int dy1,
                 int dx2,
                 int dy2)

Overrides:

copy in class PGraphicsJava2D

copy

public void copy(PImage src,
                 int sx1,
                 int sy1,
                 int sx2,
                 int sy2,
                 int dx1,
                 int dy1,
                 int dx2,
                 int dy2)

Overrides:

copy in class PGraphicsJava2D

blend

public void blend(int sx,
                  int sy,
                  int dx,
                  int dy,
                  int mode)

blend

public void blend(PImage src,
                  int sx,
                  int sy,
                  int dx,
                  int dy,
                  int mode)

blend

public void blend(int sx1,
                  int sy1,
                  int sx2,
                  int sy2,
                  int dx1,
                  int dy1,
                  int dx2,
                  int dy2,
                  int mode)

Overrides:

blend in class PImage

blend

public void blend(PImage src,
                  int sx1,
                  int sy1,
                  int sx2,
                  int sy2,
                  int dx1,
                  int dy1,
                  int dx2,
                  int dy2,
                  int mode)

Overrides:

blend in class PImage

save

public boolean save(String filename)

Overrides:

save in class PGraphics

addFonts

public void addFonts(String directory)

Add a directory that should be searched for font data.
On Mac OS X, the following directories are added by default:

• /System/Library/Fonts
• /Library/Fonts
• ~/Library/Fonts

On Windows, all drive letters are searched for WINDOWS\Fonts or WINNT\Fonts, any that exists is added.

On Linux or any other platform, you'll need to add the directories by hand. (If there are actual standards here that we can use as a starting point, please file a bug to make a note of it)

listFonts

public static String[] listFonts()

List the fonts known to the PDF renderer. This is like PFont.list(), however not all those fonts are available by default.