boxPath¶

  LEFT TOP RIGHT BOTTOM boxPath

Given the coordinates of the sides of a box, this creates a new, closed path starting at the bottom right corner, across to the bottom left, up to the top left, over to the top right, and then back to the bottom right.

clipBox¶

   LEFT TOP RIGHT BOTTOM clipBox

This clips to the box defined by the coordinates.

drawBox¶

   LEFT TOP RIGHT BOTTOM drawBox

This calls boxPath to and then strokes the path using the current pen.

fillBox¶

  LEFT TOP RIGHT BOTTOM COLOR fillBox

This fills the path created by boxPath with "COLOR", which can be anything accepted by setColor.

hLine¶

  WIDTH X Y hline

Stroke a horizontal line with the current pen with the left endpoint at position "X, Y", extending "WIDTH" points rightwards.

setColor¶

  RGB-ARRAY|BW-NUMBER setColor

This combines "setgray" and "setrgbcolor" into a single function. You can provide either an array of 3 numbers for "setrgbcolor", or a single number for "setgray". The "str" in PostScript::File function was designed to format the parameter to this function.

showCenter¶

  X Y STRING showCenter

This prints "STRING" centered horizontally at position X using baseline Y and the current font.

showLeft¶

  X Y STRING showLeft

This prints "STRING" left justified at position X using baseline Y and the current font.

showLines¶

  X Y LINES SPACING FUNC showLines

This calls "FUNC" for each element of "LINES", which should be an array of strings. "FUNC" is called with "X Y STRING" on the stack, and it must pop those off. "SPACING" is subtracted from "Y" after every line. "FUNC" will normally be "showCenter", "showLeft", or "showRight".

showRight¶

  X Y STRING showRight

This prints "STRING" right justified at position X using baseline Y and the current font.

vLine¶

  HEIGHT X Y vline

Stroke a vertical line with the current pen with the bottom endpoint at position "X, Y", extending "HEIGHT" points upwards.

new¶

  $funcs = PostScript::File::Functions->new;

The constructor takes no parameters.

add¶

  $funcs->add('functionRequested', ...);

Add one or more functions to the procset to be generated. All dependencies of the requested functions are added automatically. See "POSTSCRIPT FUNCTIONS" for the list of available functions.

add_to_file¶

  $funcs->add_to_file($ps, $basename);

This is short for

  $ps->add_procset( $funcs->generate_procset($basename) );

$ps should normally be a PostScript::File object. See "add_procset" in PostScript::File.

generate_procset¶

  ($name, $code, $version) = $funcs->generate_procset($basename);

This collects the requested functions into a block of PostScript code.

$name is a suitable name for the procset, created by appending the ids of the requested functions to $basename. If $basename is omitted, it defaults to the class name with "::" replaced by "_".

$code is a block of PostScript code that defines the functions. It contains no comments or excess whitespace.

$version is the version number of the procset.

In scalar context, returns $code.