vtkGL2PSExporter Class Reference

#include <vtkGL2PSExporter.h>

Inheritance diagram for vtkGL2PSExporter:

[legend]

Collaboration diagram for vtkGL2PSExporter:

[legend]

List of all members.

Detailed Description

export a scene as a PostScript file using GL2PS.

vtkGL2PSExporter is a concrete subclass of vtkExporter that writes high quality vector PostScript (PS/EPS), PDF or SVG files by using GL2PS. GL2PS can be obtained at: http://www.geuz.org/gl2ps/. This can be very useful when one requires publication quality pictures. This class works best with simple 3D scenes and most 2D plots. Please note that GL2PS has its limitations since PostScript is not an ideal language to represent complex 3D scenes. However, this class does allow one to write mixed vector/raster files by using the Write3DPropsAsRasterImage ivar. Please do read the caveats section of this documentation.

By default vtkGL2PSExporter generates Encapsulated PostScript (EPS) output along with the text in portrait orientation with the background color of the window being drawn. The generated output is also compressed using zlib. The various other options are set to sensible defaults.

The output file format (FileFormat) can be either PostScript (PS), Encapsulated PostScript (EPS), PDF, SVG or TeX. The file extension is generated automatically depending on the FileFormat. The default is EPS. When TeX output is chosen, only the text strings in the plot are generated and put into a picture environment. One can turn on and off the text when generating PS/EPS/PDF/SVG files by using the Text boolean variable. By default the text is drawn. The background color of the renderwindow is drawn by default. To make the background white instead use the DrawBackgroundOff function. Landscape figures can be generated by using the LandscapeOn function. Portrait orientation is used by default. Several of the GL2PS options can be set. The names of the ivars for these options are similar to the ones that GL2PS provides. Compress, SimpleLineOffset, Silent, BestRoot, PS3Shading and OcclusionCull are similar to the options provided by GL2PS. Please read the function documentation or the GL2PS documentation for more details. The ivar Write3DPropsAsRasterImage allows one to generate mixed vector/raster images. All the 3D props in the scene will be written as a raster image and all 2D actors will be written as vector graphic primitives. This makes it possible to handle transparency and complex 3D scenes. This ivar is set to Off by default. When drawing lines and points the OpenGL point size and line width are multiplied by a factor in order to generate PostScript lines and points of the right size. The Get/SetGlobalPointSizeFactor and Get/SetGlobalLineWidthFactor let one customize this ratio. The default value is such that the PostScript output looks close to what is seen on screen.

To use this class you need to turn on VTK_USE_GL2PS when configuring VTK.

Warning:: By default (with Write3DPropsAsRasterImage set to Off) exporting complex 3D scenes can take a long while and result in huge output files. Generating correct vector graphics output for scenes with transparency is almost impossible. However, one can set Write3DPropsAsRasterImageOn and generate mixed vector/raster files. This should work fine with complex scenes along with transparent actors.

See also:: vtkExporter

Thanks:: Thanks to Goodwin Lawlor and Prabhu Ramachandran for this class.

Tests:: vtkGL2PSExporter (Tests)

Definition at line 90 of file vtkGL2PSExporter.h.


Public Types
enum	OutputFormat { PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE, SVG_FILE }
enum	SortScheme { NO_SORT = 0, SIMPLE_SORT = 1, BSP_SORT = 2 }
typedef vtkExporter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetFilePrefix (const char *)
virtual char *	GetFilePrefix ()

virtual void	SetFileFormat (int)
virtual int	GetFileFormat ()
void	SetFileFormatToPS ()
void	SetFileFormatToEPS ()
void	SetFileFormatToPDF ()
void	SetFileFormatToTeX ()
void	SetFileFormatToSVG ()
const char *	GetFileFormatAsString ()

virtual void	SetSort (int)
virtual int	GetSort ()
void	SetSortToOff ()
void	SetSortToSimple ()
void	SetSortToBSP ()
const char *	GetSortAsString ()

virtual void	SetCompress (int)
virtual int	GetCompress ()
virtual void	CompressOn ()
virtual void	CompressOff ()

virtual void	SetDrawBackground (int)
virtual int	GetDrawBackground ()
virtual void	DrawBackgroundOn ()
virtual void	DrawBackgroundOff ()

virtual void	SetSimpleLineOffset (int)
virtual int	GetSimpleLineOffset ()
virtual void	SimpleLineOffsetOn ()
virtual void	SimpleLineOffsetOff ()

virtual void	SetSilent (int)
virtual int	GetSilent ()
virtual void	SilentOn ()
virtual void	SilentOff ()

virtual void	SetBestRoot (int)
virtual int	GetBestRoot ()
virtual void	BestRootOn ()
virtual void	BestRootOff ()

virtual void	SetText (int)
virtual int	GetText ()
virtual void	TextOn ()
virtual void	TextOff ()

virtual void	SetLandscape (int)
virtual int	GetLandscape ()
virtual void	LandscapeOn ()
virtual void	LandscapeOff ()

virtual void	SetPS3Shading (int)
virtual int	GetPS3Shading ()
virtual void	PS3ShadingOn ()
virtual void	PS3ShadingOff ()

virtual void	SetOcclusionCull (int)
virtual int	GetOcclusionCull ()
virtual void	OcclusionCullOn ()
virtual void	OcclusionCullOff ()

virtual void	SetWrite3DPropsAsRasterImage (int)
virtual int	GetWrite3DPropsAsRasterImage ()
virtual void	Write3DPropsAsRasterImageOn ()
virtual void	Write3DPropsAsRasterImageOff ()
Static Public Member Functions
static vtkGL2PSExporter *	New ()
static int	IsTypeOf (const char *type)
static vtkGL2PSExporter *	SafeDownCast (vtkObject *o)

static void	SetGlobalPointSizeFactor (float val)
static float	GetGlobalPointSizeFactor ()

static void	SetGlobalLineWidthFactor (float val)
static float	GetGlobalLineWidthFactor ()
Protected Member Functions
	vtkGL2PSExporter ()
	~vtkGL2PSExporter ()
void	WriteData ()
Protected Attributes
char *	FilePrefix
int	FileFormat
int	Sort
int	Compress
int	DrawBackground
int	SimpleLineOffset
int	Silent
int	BestRoot
int	Text
int	Landscape
int	PS3Shading
int	OcclusionCull
int	Write3DPropsAsRasterImage

Member Typedef Documentation

typedef vtkExporter vtkGL2PSExporter::Superclass

Reimplemented from vtkExporter.

Definition at line 94 of file vtkGL2PSExporter.h.

Member Enumeration Documentation

enum vtkGL2PSExporter::OutputFormat

Enumerator:

PS_FILE
EPS_FILE
PDF_FILE
TEX_FILE
SVG_FILE

Definition at line 106 of file vtkGL2PSExporter.h.

enum vtkGL2PSExporter::SortScheme

Enumerator:

NO_SORT
SIMPLE_SORT
BSP_SORT

Definition at line 137 of file vtkGL2PSExporter.h.

Constructor & Destructor Documentation

vtkGL2PSExporter::vtkGL2PSExporter ( ) [protected]

vtkGL2PSExporter::~vtkGL2PSExporter ( ) [protected]

Member Function Documentation

static vtkGL2PSExporter* vtkGL2PSExporter::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkGL2PSExporter::GetClassName ( ) [virtual]

Reimplemented from vtkExporter.

static int vtkGL2PSExporter::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkExporter.

virtual int vtkGL2PSExporter::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkExporter.

static vtkGL2PSExporter* vtkGL2PSExporter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkExporter.

void vtkGL2PSExporter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkExporter.

virtual void vtkGL2PSExporter::SetFilePrefix ( const char * ) [virtual]

Specify the prefix of the files to write out. The resulting filenames will have .ps or .eps or .tex appended to them depending on the other options chosen.

virtual char* vtkGL2PSExporter::GetFilePrefix ( ) [virtual]

Specify the prefix of the files to write out. The resulting filenames will have .ps or .eps or .tex appended to them depending on the other options chosen.

virtual void vtkGL2PSExporter::SetFileFormat ( int ) [virtual]