VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGL2PSExporter Class Reference

export a scene as a PostScript file using GL2PS. More...

#include <vtkGL2PSExporter.h>

Inheritance diagram for vtkGL2PSExporter:
[legend]
Collaboration diagram for vtkGL2PSExporter:
[legend]

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 Types inherited from vtkExporter
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkGL2PSExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFilePrefix (const char *)
 Specify the prefix of the files to write out. More...
 
virtual char * GetFilePrefix ()
 Specify the prefix of the files to write out. More...
 
virtual void SetBufferSize (int)
 The initial size of the GL2PS export buffer in bytes. More...
 
virtual int GetBufferSize ()
 The initial size of the GL2PS export buffer in bytes. More...
 
virtual void SetTitle (const char *)
 Set the title for the output, if supported. More...
 
virtual char * GetTitle ()
 Set the title for the output, if supported. More...
 
void UsePainterSettings ()
 Configure the exporter to expect a painter-ordered 2D rendering, that is, a rendering at a fixed depth where primitives are drawn from the bottom up. More...
 
virtual void SetFileFormat (int)
 Specify the format of file to write out. More...
 
virtual int GetFileFormat ()
 Specify the format of file to write out. More...
 
void SetFileFormatToPS ()
 Specify the format of file to write out. More...
 
void SetFileFormatToEPS ()
 Specify the format of file to write out. More...
 
void SetFileFormatToPDF ()
 Specify the format of file to write out. More...
 
void SetFileFormatToTeX ()
 Specify the format of file to write out. More...
 
void SetFileFormatToSVG ()
 Specify the format of file to write out. More...
 
const char * GetFileFormatAsString ()
 Specify the format of file to write out. More...
 
virtual void SetSort (int)
 Set the the type of sorting algorithm to order primitives from back to front. More...
 
virtual int GetSort ()
 Set the the type of sorting algorithm to order primitives from back to front. More...
 
void SetSortToOff ()
 Set the the type of sorting algorithm to order primitives from back to front. More...
 
void SetSortToSimple ()
 Set the the type of sorting algorithm to order primitives from back to front. More...
 
void SetSortToBSP ()
 Set the the type of sorting algorithm to order primitives from back to front. More...
 
const char * GetSortAsString ()
 Set the the type of sorting algorithm to order primitives from back to front. More...
 
virtual void SetCompress (int)
 Turn on/off compression when generating PostScript or PDF output. More...
 
virtual int GetCompress ()
 Turn on/off compression when generating PostScript or PDF output. More...
 
virtual void CompressOn ()
 Turn on/off compression when generating PostScript or PDF output. More...
 
virtual void CompressOff ()
 Turn on/off compression when generating PostScript or PDF output. More...
 
virtual void SetDrawBackground (int)
 Turn on/off drawing the background frame. More...
 
virtual int GetDrawBackground ()
 Turn on/off drawing the background frame. More...
 
virtual void DrawBackgroundOn ()
 Turn on/off drawing the background frame. More...
 
virtual void DrawBackgroundOff ()
 Turn on/off drawing the background frame. More...
 
virtual void SetSimpleLineOffset (int)
 Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option. More...
 
virtual int GetSimpleLineOffset ()
 Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option. More...
 
virtual void SimpleLineOffsetOn ()
 Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option. More...
 
virtual void SimpleLineOffsetOff ()
 Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option. More...
 
virtual void SetSilent (int)
 Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT). More...
 
virtual int GetSilent ()
 Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT). More...
 
virtual void SilentOn ()
 Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT). More...
 
virtual void SilentOff ()
 Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT). More...
 
virtual void SetBestRoot (int)
 Turn on/off the GL2PS_BEST_ROOT option. More...
 
virtual int GetBestRoot ()
 Turn on/off the GL2PS_BEST_ROOT option. More...
 
virtual void BestRootOn ()
 Turn on/off the GL2PS_BEST_ROOT option. More...
 
virtual void BestRootOff ()
 Turn on/off the GL2PS_BEST_ROOT option. More...
 
virtual void SetText (int)
 Turn on/off drawing the text. More...
 
virtual int GetText ()
 Turn on/off drawing the text. More...
 
virtual void TextOn ()
 Turn on/off drawing the text. More...
 
virtual void TextOff ()
 Turn on/off drawing the text. More...
 
virtual void SetLandscape (int)
 Turn on/off landscape orientation. More...
 
virtual int GetLandscape ()
 Turn on/off landscape orientation. More...
 
virtual void LandscapeOn ()
 Turn on/off landscape orientation. More...
 
virtual void LandscapeOff ()
 Turn on/off landscape orientation. More...
 
virtual void SetPS3Shading (int)
 Turn on/off the GL2PS_PS3_SHADING option. More...
 
virtual int GetPS3Shading ()
 Turn on/off the GL2PS_PS3_SHADING option. More...
 
virtual void PS3ShadingOn ()
 Turn on/off the GL2PS_PS3_SHADING option. More...
 
virtual void PS3ShadingOff ()
 Turn on/off the GL2PS_PS3_SHADING option. More...
 
virtual void SetOcclusionCull (int)
 Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL). More...
 
virtual int GetOcclusionCull ()
 Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL). More...
 
virtual void OcclusionCullOn ()
 Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL). More...
 
virtual void OcclusionCullOff ()
 Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL). More...
 
virtual void SetWrite3DPropsAsRasterImage (int)
 Turn on/off writing 3D props as raster images. More...
 
virtual int GetWrite3DPropsAsRasterImage ()
 Turn on/off writing 3D props as raster images. More...
 
virtual void Write3DPropsAsRasterImageOn ()
 Turn on/off writing 3D props as raster images. More...
 
virtual void Write3DPropsAsRasterImageOff ()
 Turn on/off writing 3D props as raster images. More...
 
virtual void SetTextAsPath (bool)
 Turn on/off exporting text as path information, rather than character data. More...
 
virtual bool GetTextAsPath ()
 Turn on/off exporting text as path information, rather than character data. More...
 
virtual void TextAsPathOn ()
 Turn on/off exporting text as path information, rather than character data. More...
 
virtual void TextAsPathOff ()
 Turn on/off exporting text as path information, rather than character data. More...
 
void SetRasterExclusions (vtkPropCollection *)
 Collection of props to exclude from rasterization. More...
 
virtual vtkPropCollectionGetRasterExclusions ()
 Collection of props to exclude from rasterization. More...
 
virtual void SetPointSizeFactor (float)
 Set the ratio between the OpenGL PointSize and that used by GL2PS to generate PostScript. More...
 
virtual float GetPointSizeFactor ()
 Set the ratio between the OpenGL PointSize and that used by GL2PS to generate PostScript. More...
 
virtual void SetLineWidthFactor (float)
 Set the ratio between the OpenGL LineWidth and that used by GL2PS to generate PostScript. More...
 
virtual float GetLineWidthFactor ()
 Set the ratio between the OpenGL LineWidth and that used by GL2PS to generate PostScript. More...
 
- Public Member Functions inherited from vtkExporter
vtkExporterNewInstance () const
 
virtual void Write ()
 Write data to output. More...
 
void Update ()
 Convenient alias for Write() method. More...
 
void SetStartWrite (void(*f)(void *), void *arg)
 Specify a function to be called before data is written. More...
 
void SetEndWrite (void(*f)(void *), void *arg)
 Specify a function to be called after data is written. More...
 
void SetStartWriteArgDelete (void(*f)(void *))
 Set the arg delete method. More...
 
void SetEndWriteArgDelete (void(*f)(void *))
 Set the arg delete method. More...
 
vtkMTimeType GetMTime () override
 Returns the MTime also considering the RenderWindow. More...
 
virtual void SetRenderWindow (vtkRenderWindow *)
 Set/Get the rendering window that contains the scene to be written. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 Set/Get the rendering window that contains the scene to be written. More...
 
void SetInput (vtkRenderWindow *renWin)
 These methods are provided for backward compatibility. More...
 
vtkRenderWindowGetInput ()
 These methods are provided for backward compatibility. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkGL2PSExporterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGL2PSExporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkExporter
static int IsTypeOf (const char *type)
 
static vtkExporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGL2PSExporter ()
 
 ~vtkGL2PSExporter () override
 
int GetGL2PSOptions ()
 
int GetGL2PSSort ()
 
int GetGL2PSFormat ()
 
const char * GetFileExtension ()
 
- Protected Member Functions inherited from vtkExporter
 vtkExporter ()
 
 ~vtkExporter () override
 
virtual void WriteData ()=0
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPropCollectionRasterExclusions
 
char * FilePrefix
 
char * Title
 
int FileFormat
 
int BufferSize
 
int Sort
 
int Compress
 
int DrawBackground
 
int SimpleLineOffset
 
int Silent
 
int BestRoot
 
int Text
 
int Landscape
 
int PS3Shading
 
int OcclusionCull
 
int Write3DPropsAsRasterImage
 
bool TextAsPath
 
float PointSizeFactor
 
float LineWidthFactor
 
- Protected Attributes inherited from vtkExporter
vtkRenderWindowRenderWindow
 
void(* StartWrite )(void *)
 
void(* StartWriteArgDelete )(void *)
 
void * StartWriteArg
 
void(* EndWrite )(void *)
 
void(* EndWriteArgDelete )(void *)
 
void * EndWriteArg
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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. Specific 3D props can be excluded from the rasterization process by adding them to the RasterExclusions ivar. Props in this collection will be rendered as 2D vector primitives instead.

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)

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. Specific 3D props can be excluded from the rasterization process by adding them to the RasterExclusions ivar. Props in this collection will be rendered as 2D vector primitives instead.

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.

Definition at line 90 of file vtkGL2PSExporter.h.

Member Typedef Documentation

Definition at line 94 of file vtkGL2PSExporter.h.

Member Enumeration Documentation

Enumerator
PS_FILE 
EPS_FILE 
PDF_FILE 
TEX_FILE 
SVG_FILE 

Definition at line 129 of file vtkGL2PSExporter.h.

Enumerator
NO_SORT 
SIMPLE_SORT 
BSP_SORT 

Definition at line 175 of file vtkGL2PSExporter.h.

Constructor & Destructor Documentation

vtkGL2PSExporter::vtkGL2PSExporter ( )
protected
vtkGL2PSExporter::~vtkGL2PSExporter ( )
overrideprotected

Member Function Documentation

static vtkGL2PSExporter* vtkGL2PSExporter::New ( )
static
static int vtkGL2PSExporter::IsTypeOf ( const char *  type)
static
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkExporter.

Reimplemented in vtkOpenGLGL2PSExporter, and vtkOpenGLGL2PSExporter.

static vtkGL2PSExporter* vtkGL2PSExporter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkGL2PSExporter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkExporter.

Reimplemented in vtkOpenGLGL2PSExporter, and vtkOpenGLGL2PSExporter.

vtkGL2PSExporter* vtkGL2PSExporter::NewInstance ( ) const
void vtkGL2PSExporter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

Reimplemented in vtkOpenGLGL2PSExporter, and vtkOpenGLGL2PSExporter.

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::SetBufferSize ( int  )
virtual

The initial size of the GL2PS export buffer in bytes.

The buffer is used to store the exported image prior to writing to file. If the buffer is too small, the exporter will enlarge the buffer and rerender until the export is successful. Setting a larger value here can reduce the time needed to export a complex scene by reducing the number of iterations required. The default initial size is 4 MB.

virtual int vtkGL2PSExporter::GetBufferSize ( )
virtual

The initial size of the GL2PS export buffer in bytes.

The buffer is used to store the exported image prior to writing to file. If the buffer is too small, the exporter will enlarge the buffer and rerender until the export is successful. Setting a larger value here can reduce the time needed to export a complex scene by reducing the number of iterations required. The default initial size is 4 MB.

virtual void vtkGL2PSExporter::SetTitle ( const char *  )
virtual

Set the title for the output, if supported.

If NULL, "VTK GL2PS Export" is used.

virtual char* vtkGL2PSExporter::GetTitle ( )
virtual

Set the title for the output, if supported.

If NULL, "VTK GL2PS Export" is used.

void vtkGL2PSExporter::UsePainterSettings ( )
inline

Configure the exporter to expect a painter-ordered 2D rendering, that is, a rendering at a fixed depth where primitives are drawn from the bottom up.

This disables sorting, which will break the painter ordering, and turns off the simple line offset, which can cause line primitives to be drawn on top of all other geometry.

Definition at line 146 of file vtkGL2PSExporter.h.

virtual void vtkGL2PSExporter::SetFileFormat ( int  )
virtual

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

virtual int vtkGL2PSExporter::GetFileFormat ( )
virtual

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

void vtkGL2PSExporter::SetFileFormatToPS ( )
inline

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

Definition at line 162 of file vtkGL2PSExporter.h.

void vtkGL2PSExporter::SetFileFormatToEPS ( )
inline

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

Definition at line 164 of file vtkGL2PSExporter.h.

void vtkGL2PSExporter::SetFileFormatToPDF ( )
inline

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

Definition at line 166 of file vtkGL2PSExporter.h.

void vtkGL2PSExporter::SetFileFormatToTeX ( )
inline

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

Definition at line 168 of file vtkGL2PSExporter.h.

void vtkGL2PSExporter::SetFileFormatToSVG ( )
inline

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

Definition at line 170 of file vtkGL2PSExporter.h.

const char * vtkGL2PSExporter::GetFileFormatAsString ( void  )
inline

Specify the format of file to write out.

This can be one of: PS_FILE, EPS_FILE, PDF_FILE, TEX_FILE. Defaults to EPS_FILE. Depending on the option chosen it generates the appropriate file (with correct extension) when the Write function is called.

Definition at line 403 of file vtkGL2PSExporter.h.

virtual void vtkGL2PSExporter::SetSort ( int  )
virtual

Set the the type of sorting algorithm to order primitives from back to front.

Successive algorithms are more memory intensive. Simple is the default but BSP is perhaps the best.

virtual int vtkGL2PSExporter::GetSort ( )
virtual

Set the the type of sorting algorithm to order primitives from back to front.

Successive algorithms are more memory intensive. Simple is the default but BSP is perhaps the best.

void vtkGL2PSExporter::SetSortToOff ( )
inline

Set the the type of sorting algorithm to order primitives from back to front.

Successive algorithms are more memory intensive. Simple is the default but BSP is perhaps the best.

Definition at line 190 of file vtkGL2PSExporter.h.

void vtkGL2PSExporter::SetSortToSimple ( )
inline

Set the the type of sorting algorithm to order primitives from back to front.

Successive algorithms are more memory intensive. Simple is the default but BSP is perhaps the best.

Definition at line 192 of file vtkGL2PSExporter.h.

void vtkGL2PSExporter::SetSortToBSP ( )
inline

Set the the type of sorting algorithm to order primitives from back to front.

Successive algorithms are more memory intensive. Simple is the default but BSP is perhaps the best.

Definition at line 194 of file vtkGL2PSExporter.h.

const char * vtkGL2PSExporter::GetSortAsString ( void  )
inline

Set the the type of sorting algorithm to order primitives from back to front.

Successive algorithms are more memory intensive. Simple is the default but BSP is perhaps the best.

Definition at line 387 of file vtkGL2PSExporter.h.

virtual void vtkGL2PSExporter::SetCompress ( int  )
virtual

Turn on/off compression when generating PostScript or PDF output.

By default compression is on.

virtual int vtkGL2PSExporter::GetCompress ( )
virtual

Turn on/off compression when generating PostScript or PDF output.

By default compression is on.

virtual void vtkGL2PSExporter::CompressOn ( )
virtual

Turn on/off compression when generating PostScript or PDF output.

By default compression is on.

virtual void vtkGL2PSExporter::CompressOff ( )
virtual

Turn on/off compression when generating PostScript or PDF output.

By default compression is on.

virtual void vtkGL2PSExporter::SetDrawBackground ( int  )
virtual

Turn on/off drawing the background frame.

If off the background is treated as white. By default the background is drawn. On the OpenGL2 backend, the background is always drawn.

virtual int vtkGL2PSExporter::GetDrawBackground ( )
virtual

Turn on/off drawing the background frame.

If off the background is treated as white. By default the background is drawn. On the OpenGL2 backend, the background is always drawn.

virtual void vtkGL2PSExporter::DrawBackgroundOn ( )
virtual

Turn on/off drawing the background frame.

If off the background is treated as white. By default the background is drawn. On the OpenGL2 backend, the background is always drawn.

virtual void vtkGL2PSExporter::DrawBackgroundOff ( )
virtual

Turn on/off drawing the background frame.

If off the background is treated as white. By default the background is drawn. On the OpenGL2 backend, the background is always drawn.

virtual void vtkGL2PSExporter::SetSimpleLineOffset ( int  )
virtual

Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.

When enabled a small offset is added in the z-buffer to all the lines in the plot. This results in an anti-aliasing like solution. Defaults to on.

virtual int vtkGL2PSExporter::GetSimpleLineOffset ( )
virtual

Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.

When enabled a small offset is added in the z-buffer to all the lines in the plot. This results in an anti-aliasing like solution. Defaults to on.

virtual void vtkGL2PSExporter::SimpleLineOffsetOn ( )
virtual

Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.

When enabled a small offset is added in the z-buffer to all the lines in the plot. This results in an anti-aliasing like solution. Defaults to on.

virtual void vtkGL2PSExporter::SimpleLineOffsetOff ( )
virtual

Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.

When enabled a small offset is added in the z-buffer to all the lines in the plot. This results in an anti-aliasing like solution. Defaults to on.

virtual void vtkGL2PSExporter::SetSilent ( int  )
virtual

Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).

When enabled GL2PS messages are suppressed. Defaults to off.

virtual int vtkGL2PSExporter::GetSilent ( )
virtual

Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).

When enabled GL2PS messages are suppressed. Defaults to off.

virtual void vtkGL2PSExporter::SilentOn ( )
virtual

Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).

When enabled GL2PS messages are suppressed. Defaults to off.

virtual void vtkGL2PSExporter::SilentOff ( )
virtual

Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).

When enabled GL2PS messages are suppressed. Defaults to off.

virtual void vtkGL2PSExporter::SetBestRoot ( int  )
virtual

Turn on/off the GL2PS_BEST_ROOT option.

When enabled the construction of the BSP tree is optimized by choosing the root primitives leading to the minimum number of splits. Defaults to on.

virtual int vtkGL2PSExporter::GetBestRoot ( )
virtual

Turn on/off the GL2PS_BEST_ROOT option.

When enabled the construction of the BSP tree is optimized by choosing the root primitives leading to the minimum number of splits. Defaults to on.

virtual void vtkGL2PSExporter::BestRootOn ( )
virtual

Turn on/off the GL2PS_BEST_ROOT option.

When enabled the construction of the BSP tree is optimized by choosing the root primitives leading to the minimum number of splits. Defaults to on.

virtual void vtkGL2PSExporter::BestRootOff ( )
virtual

Turn on/off the GL2PS_BEST_ROOT option.

When enabled the construction of the BSP tree is optimized by choosing the root primitives leading to the minimum number of splits. Defaults to on.

virtual void vtkGL2PSExporter::SetText ( int  )
virtual

Turn on/off drawing the text.

If on (default) the text is drawn. If the FileFormat is set to TeX output then a LaTeX picture is generated with the text strings. If off text output is suppressed.

virtual int vtkGL2PSExporter::GetText ( )
virtual

Turn on/off drawing the text.

If on (default) the text is drawn. If the FileFormat is set to TeX output then a LaTeX picture is generated with the text strings. If off text output is suppressed.

virtual void vtkGL2PSExporter::TextOn ( )
virtual

Turn on/off drawing the text.

If on (default) the text is drawn. If the FileFormat is set to TeX output then a LaTeX picture is generated with the text strings. If off text output is suppressed.

virtual void vtkGL2PSExporter::TextOff ( )
virtual

Turn on/off drawing the text.

If on (default) the text is drawn. If the FileFormat is set to TeX output then a LaTeX picture is generated with the text strings. If off text output is suppressed.

virtual void vtkGL2PSExporter::SetLandscape ( int  )
virtual

Turn on/off landscape orientation.

If off (default) the orientation is set to portrait.

virtual int vtkGL2PSExporter::GetLandscape ( )
virtual

Turn on/off landscape orientation.

If off (default) the orientation is set to portrait.

virtual void vtkGL2PSExporter::LandscapeOn ( )
virtual

Turn on/off landscape orientation.

If off (default) the orientation is set to portrait.

virtual void vtkGL2PSExporter::LandscapeOff ( )
virtual

Turn on/off landscape orientation.

If off (default) the orientation is set to portrait.

virtual void vtkGL2PSExporter::SetPS3Shading ( int  )
virtual

Turn on/off the GL2PS_PS3_SHADING option.

When enabled the shfill PostScript level 3 operator is used. Read the GL2PS documentation for more details. Defaults to on.

virtual int vtkGL2PSExporter::GetPS3Shading ( )
virtual

Turn on/off the GL2PS_PS3_SHADING option.

When enabled the shfill PostScript level 3 operator is used. Read the GL2PS documentation for more details. Defaults to on.

virtual void vtkGL2PSExporter::PS3ShadingOn ( )
virtual

Turn on/off the GL2PS_PS3_SHADING option.

When enabled the shfill PostScript level 3 operator is used. Read the GL2PS documentation for more details. Defaults to on.

virtual void vtkGL2PSExporter::PS3ShadingOff ( )
virtual

Turn on/off the GL2PS_PS3_SHADING option.

When enabled the shfill PostScript level 3 operator is used. Read the GL2PS documentation for more details. Defaults to on.

virtual void vtkGL2PSExporter::SetOcclusionCull ( int  )
virtual

Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).

When enabled hidden polygons are removed. This reduces file size considerably. Defaults to on.

virtual int vtkGL2PSExporter::GetOcclusionCull ( )
virtual

Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).

When enabled hidden polygons are removed. This reduces file size considerably. Defaults to on.

virtual void vtkGL2PSExporter::OcclusionCullOn ( )
virtual

Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).

When enabled hidden polygons are removed. This reduces file size considerably. Defaults to on.

virtual void vtkGL2PSExporter::OcclusionCullOff ( )
virtual

Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).

When enabled hidden polygons are removed. This reduces file size considerably. Defaults to on.

virtual void vtkGL2PSExporter::SetWrite3DPropsAsRasterImage ( int  )
virtual

Turn on/off writing 3D props as raster images.

2D props are rendered using vector graphics primitives. If you have hi-res actors and are using transparency you probably need to turn this on. Defaults to Off. This option has no effect when the OpenGL2 backend is in use, as all 3D props (excluding vtkTextActor3D) are rasterized into the background.

virtual int vtkGL2PSExporter::GetWrite3DPropsAsRasterImage ( )
virtual

Turn on/off writing 3D props as raster images.

2D props are rendered using vector graphics primitives. If you have hi-res actors and are using transparency you probably need to turn this on. Defaults to Off. This option has no effect when the OpenGL2 backend is in use, as all 3D props (excluding vtkTextActor3D) are rasterized into the background.

virtual void vtkGL2PSExporter::Write3DPropsAsRasterImageOn ( )
virtual

Turn on/off writing 3D props as raster images.

2D props are rendered using vector graphics primitives. If you have hi-res actors and are using transparency you probably need to turn this on. Defaults to Off. This option has no effect when the OpenGL2 backend is in use, as all 3D props (excluding vtkTextActor3D) are rasterized into the background.

virtual void vtkGL2PSExporter::Write3DPropsAsRasterImageOff ( )
virtual

Turn on/off writing 3D props as raster images.

2D props are rendered using vector graphics primitives. If you have hi-res actors and are using transparency you probably need to turn this on. Defaults to Off. This option has no effect when the OpenGL2 backend is in use, as all 3D props (excluding vtkTextActor3D) are rasterized into the background.

virtual void vtkGL2PSExporter::SetTextAsPath ( bool  )
virtual

Turn on/off exporting text as path information, rather than character data.

This is useful for the PDF backend, which does not properly support aligned text otherwise. Defaults to Off.

virtual bool vtkGL2PSExporter::GetTextAsPath ( )
virtual

Turn on/off exporting text as path information, rather than character data.

This is useful for the PDF backend, which does not properly support aligned text otherwise. Defaults to Off.

virtual void vtkGL2PSExporter::TextAsPathOn ( )
virtual

Turn on/off exporting text as path information, rather than character data.

This is useful for the PDF backend, which does not properly support aligned text otherwise. Defaults to Off.

virtual void vtkGL2PSExporter::TextAsPathOff ( )
virtual

Turn on/off exporting text as path information, rather than character data.

This is useful for the PDF backend, which does not properly support aligned text otherwise. Defaults to Off.

void vtkGL2PSExporter::SetRasterExclusions ( vtkPropCollection )

Collection of props to exclude from rasterization.

These will be rendered as 2D vector primitives in the output. This setting is ignored if Write3DPropsAsRasterImage is false. Behind the scenes, these props are treated as 2D props during the vector output generation.

virtual vtkPropCollection* vtkGL2PSExporter::GetRasterExclusions ( )
virtual

Collection of props to exclude from rasterization.

These will be rendered as 2D vector primitives in the output. This setting is ignored if Write3DPropsAsRasterImage is false. Behind the scenes, these props are treated as 2D props during the vector output generation.

virtual void vtkGL2PSExporter::SetPointSizeFactor ( float  )
virtual

Set the ratio between the OpenGL PointSize and that used by GL2PS to generate PostScript.

Defaults to a ratio of 5/7.

virtual float vtkGL2PSExporter::GetPointSizeFactor ( )
virtual

Set the ratio between the OpenGL PointSize and that used by GL2PS to generate PostScript.

Defaults to a ratio of 5/7.

virtual void vtkGL2PSExporter::SetLineWidthFactor ( float  )
virtual

Set the ratio between the OpenGL LineWidth and that used by GL2PS to generate PostScript.

Defaults to a ratio of 5/7.

virtual float vtkGL2PSExporter::GetLineWidthFactor ( )
virtual

Set the ratio between the OpenGL LineWidth and that used by GL2PS to generate PostScript.

Defaults to a ratio of 5/7.

int vtkGL2PSExporter::GetGL2PSOptions ( )
protected
int vtkGL2PSExporter::GetGL2PSSort ( )
protected
int vtkGL2PSExporter::GetGL2PSFormat ( )
protected
const char* vtkGL2PSExporter::GetFileExtension ( )
protected

Member Data Documentation

vtkPropCollection* vtkGL2PSExporter::RasterExclusions
protected

Definition at line 361 of file vtkGL2PSExporter.h.

char* vtkGL2PSExporter::FilePrefix
protected

Definition at line 363 of file vtkGL2PSExporter.h.

char* vtkGL2PSExporter::Title
protected

Definition at line 364 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::FileFormat
protected

Definition at line 365 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::BufferSize
protected

Definition at line 366 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Sort
protected

Definition at line 367 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Compress
protected

Definition at line 368 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::DrawBackground
protected

Definition at line 369 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::SimpleLineOffset
protected

Definition at line 370 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Silent
protected

Definition at line 371 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::BestRoot
protected

Definition at line 372 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Text
protected

Definition at line 373 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Landscape
protected

Definition at line 374 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::PS3Shading
protected

Definition at line 375 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::OcclusionCull
protected

Definition at line 376 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Write3DPropsAsRasterImage
protected

Definition at line 377 of file vtkGL2PSExporter.h.

bool vtkGL2PSExporter::TextAsPath
protected

Definition at line 378 of file vtkGL2PSExporter.h.

float vtkGL2PSExporter::PointSizeFactor
protected

Definition at line 379 of file vtkGL2PSExporter.h.

float vtkGL2PSExporter::LineWidthFactor
protected

Definition at line 380 of file vtkGL2PSExporter.h.


The documentation for this class was generated from the following file: