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

Public Member Functions

virtual int IsA (const char *type)
 
vtkGL2PSExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetFilePrefix (const char *)
 
virtual char * GetFilePrefix ()
 
virtual void SetBufferSize (int)
 
virtual int GetBufferSize ()
 
virtual void SetTitle (const char *)
 
virtual char * GetTitle ()
 
void UsePainterSettings ()
 
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 ()
 
virtual void SetTextAsPath (bool)
 
virtual bool GetTextAsPath ()
 
virtual void TextAsPathOn ()
 
virtual void TextAsPathOff ()
 
void SetRasterExclusions (vtkPropCollection *)
 
virtual vtkPropCollectionGetRasterExclusions ()
 
virtual void SetPointSizeFactor (float)
 
virtual float GetPointSizeFactor ()
 
virtual void SetLineWidthFactor (float)
 
virtual float GetLineWidthFactor ()
 
- Public Member Functions inherited from vtkExporter
vtkExporterNewInstance () const
 
virtual void Write ()
 
void Update ()
 
void SetStartWrite (void(*f)(void *), void *arg)
 
void SetEndWrite (void(*f)(void *), void *arg)
 
void SetStartWriteArgDelete (void(*f)(void *))
 
void SetEndWriteArgDelete (void(*f)(void *))
 
unsigned long GetMTime ()
 
virtual void SetRenderWindow (vtkRenderWindow *)
 
virtual vtkRenderWindowGetRenderWindow ()
 
void SetInput (vtkRenderWindow *renWin)
 
vtkRenderWindowGetInput ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

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 int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGL2PSExporter ()
 
 ~vtkGL2PSExporter ()
 
void WriteData ()
 
int GetGL2PSOptions ()
 
int GetGL2PSSort ()
 
int GetGL2PSFormat ()
 
const char * GetFileExtension ()
 
void SavePropVisibility (vtkRendererCollection *renCol, vtkIntArray *volVis, vtkIntArray *actVis, vtkIntArray *act2dVis)
 
void RestorePropVisibility (vtkRendererCollection *renCol, vtkIntArray *volVis, vtkIntArray *actVis, vtkIntArray *act2dVis)
 
void Turn3DPropsOff (vtkRendererCollection *renCol)
 
void Turn2DPropsOff (vtkRendererCollection *renCol)
 
void GetVisibleContextActors (vtkPropCollection *contextActors, vtkRendererCollection *renCol)
 
void SetPropVisibilities (vtkPropCollection *col, int vis)
 
void DrawSpecialProps (vtkCollection *propCol, vtkRendererCollection *renCol)
 
void CopyPixels (int copyRect[4], vtkRenderer *ren)
 
void DrawContextActors (vtkPropCollection *contextActs, vtkRendererCollection *renCol)
 
virtual void HandleSpecialProp (vtkProp *prop, vtkRenderer *ren)
 
void DrawTextActor (vtkTextActor *textAct, vtkRenderer *ren)
 
void DrawTextActor3D (vtkTextActor3D *textAct, vtkRenderer *ren)
 
void DrawTextMapper (vtkTextMapper *textMap, vtkActor2D *textAct, vtkRenderer *ren)
 
void DrawLabeledDataMapper (vtkLabeledDataMapper *mapper, vtkRenderer *ren)
 
void DrawLabeledContourMapper (vtkActor *act, vtkLabeledContourMapper *mapper, vtkRenderer *ren)
 
void DrawScalarBarActor (vtkScalarBarActor *bar, vtkRenderer *ren)
 
void DrawViewportTextOverlay (const char *string, vtkTextProperty *tprop, vtkCoordinate *coord, vtkRenderer *ren)
 
- Protected Member Functions inherited from vtkExporter
 vtkExporter ()
 
 ~vtkExporter ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- 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
 
vtkNew< vtkImageDataPixelData
 
- 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)

Definition at line 108 of file vtkGL2PSExporter.h.

Member Typedef Documentation

Definition at line 112 of file vtkGL2PSExporter.h.

Member Enumeration Documentation

Enumerator
PS_FILE 
EPS_FILE 
PDF_FILE 
TEX_FILE 
SVG_FILE 

Definition at line 142 of file vtkGL2PSExporter.h.

Enumerator
NO_SORT 
SIMPLE_SORT 
BSP_SORT 

Definition at line 186 of file vtkGL2PSExporter.h.

Constructor & Destructor Documentation

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

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.

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

Reimplemented from vtkExporter.

vtkGL2PSExporter* vtkGL2PSExporter::NewInstance ( ) const
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::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 158 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 172 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 174 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 176 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 178 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 180 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 422 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 200 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 202 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 204 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 406 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.

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.

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.

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.

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.

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.

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.

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.

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.

void vtkGL2PSExporter::WriteData ( )
protectedvirtual

Implements vtkExporter.

int vtkGL2PSExporter::GetGL2PSOptions ( )
protected
int vtkGL2PSExporter::GetGL2PSSort ( )
protected
int vtkGL2PSExporter::GetGL2PSFormat ( )
protected
const char* vtkGL2PSExporter::GetFileExtension ( )
protected
void vtkGL2PSExporter::SavePropVisibility ( vtkRendererCollection renCol,
vtkIntArray volVis,
vtkIntArray actVis,
vtkIntArray act2dVis 
)
protected
void vtkGL2PSExporter::RestorePropVisibility ( vtkRendererCollection renCol,
vtkIntArray volVis,
vtkIntArray actVis,
vtkIntArray act2dVis 
)
protected
void vtkGL2PSExporter::Turn3DPropsOff ( vtkRendererCollection renCol)
protected
void vtkGL2PSExporter::Turn2DPropsOff ( vtkRendererCollection renCol)
protected
void vtkGL2PSExporter::GetVisibleContextActors ( vtkPropCollection contextActors,
vtkRendererCollection renCol 
)
protected
void vtkGL2PSExporter::SetPropVisibilities ( vtkPropCollection col,
int  vis 
)
protected
void vtkGL2PSExporter::DrawSpecialProps ( vtkCollection propCol,
vtkRendererCollection renCol 
)
protected
virtual void vtkGL2PSExporter::HandleSpecialProp ( vtkProp prop,
vtkRenderer ren 
)
protectedvirtual

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::DrawTextActor ( vtkTextActor textAct,
vtkRenderer ren 
)
protected

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::DrawTextActor3D ( vtkTextActor3D textAct,
vtkRenderer ren 
)
protected

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::DrawTextMapper ( vtkTextMapper textMap,
vtkActor2D textAct,
vtkRenderer ren 
)
protected

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::DrawLabeledDataMapper ( vtkLabeledDataMapper mapper,
vtkRenderer ren 
)
protected

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::DrawLabeledContourMapper ( vtkActor act,
vtkLabeledContourMapper mapper,
vtkRenderer ren 
)
protected

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::DrawScalarBarActor ( vtkScalarBarActor bar,
vtkRenderer ren 
)
protected

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::DrawViewportTextOverlay ( const char *  string,
vtkTextProperty tprop,
vtkCoordinate coord,
vtkRenderer ren 
)
protected

Reimplement this to handle your own special props. Must call this function at the end of the override for default handling.

void vtkGL2PSExporter::CopyPixels ( int  copyRect[4],
vtkRenderer ren 
)
protected

Copy the region copyRect from the framebuffer into the gl2ps document. copyRect is in viewport coordinates [xmin, ymin, width, height].

void vtkGL2PSExporter::DrawContextActors ( vtkPropCollection contextActs,
vtkRendererCollection renCol 
)
protected

Member Data Documentation

vtkPropCollection* vtkGL2PSExporter::RasterExclusions
protected

Definition at line 378 of file vtkGL2PSExporter.h.

char* vtkGL2PSExporter::FilePrefix
protected

Definition at line 380 of file vtkGL2PSExporter.h.

char* vtkGL2PSExporter::Title
protected

Definition at line 381 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::FileFormat
protected

Definition at line 382 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::BufferSize
protected

Definition at line 383 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Sort
protected

Definition at line 384 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Compress
protected

Definition at line 385 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::DrawBackground
protected

Definition at line 386 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::SimpleLineOffset
protected

Definition at line 387 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Silent
protected

Definition at line 388 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::BestRoot
protected

Definition at line 389 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Text
protected

Definition at line 390 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Landscape
protected

Definition at line 391 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::PS3Shading
protected

Definition at line 392 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::OcclusionCull
protected

Definition at line 393 of file vtkGL2PSExporter.h.

int vtkGL2PSExporter::Write3DPropsAsRasterImage
protected

Definition at line 394 of file vtkGL2PSExporter.h.

bool vtkGL2PSExporter::TextAsPath
protected

Definition at line 395 of file vtkGL2PSExporter.h.

float vtkGL2PSExporter::PointSizeFactor
protected

Definition at line 396 of file vtkGL2PSExporter.h.

float vtkGL2PSExporter::LineWidthFactor
protected

Definition at line 397 of file vtkGL2PSExporter.h.

vtkNew<vtkImageData> vtkGL2PSExporter::PixelData
protected

Definition at line 399 of file vtkGL2PSExporter.h.


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