vtkOpenGLGL2PSExporter Class Reference

OpenGL2 implementation of GL2PS exporter. More...

#include <vtkOpenGLGL2PSExporter.h>

Inheritance diagram for vtkOpenGLGL2PSExporter:

Collaboration diagram for vtkOpenGLGL2PSExporter:

Public Types
typedef vtkGL2PSExporter	Superclass
Public Types inherited from vtkGL2PSExporter
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 vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOpenGLGL2PSExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
Public Member Functions inherited from vtkGL2PSExporter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkGL2PSExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
	vtkSetFilePathMacro (FilePrefix)
	Specify the prefix of the files to write out.
	vtkGetFilePathMacro (FilePrefix)
	Specify the prefix of the files to write out.
virtual void	SetBufferSize (int)
	The initial size of the GL2PS export buffer in bytes.
virtual int	GetBufferSize ()
	The initial size of the GL2PS export buffer in bytes.
virtual void	SetTitle (const char *)
	Set the title for the output, if supported.
virtual char *	GetTitle ()
	Set the title for the output, if supported.
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.
virtual void	SetFileFormat (int)
	Specify the format of file to write out.
virtual int	GetFileFormat ()
	Specify the format of file to write out.
void	SetFileFormatToPS ()
	Specify the format of file to write out.
void	SetFileFormatToEPS ()
	Specify the format of file to write out.
void	SetFileFormatToPDF ()
	Specify the format of file to write out.
void	SetFileFormatToTeX ()
	Specify the format of file to write out.
void	SetFileFormatToSVG ()
	Specify the format of file to write out.
const char *	GetFileFormatAsString ()
	Specify the format of file to write out.
virtual void	SetSort (int)
	Set the type of sorting algorithm to order primitives from back to front.
virtual int	GetSort ()
	Set the type of sorting algorithm to order primitives from back to front.
void	SetSortToOff ()
	Set the type of sorting algorithm to order primitives from back to front.
void	SetSortToSimple ()
	Set the type of sorting algorithm to order primitives from back to front.
void	SetSortToBSP ()
	Set the type of sorting algorithm to order primitives from back to front.
const char *	GetSortAsString ()
	Set the type of sorting algorithm to order primitives from back to front.
virtual void	SetCompress (vtkTypeBool)
	Turn on/off compression when generating PostScript or PDF output.
virtual vtkTypeBool	GetCompress ()
	Turn on/off compression when generating PostScript or PDF output.
virtual void	CompressOn ()
	Turn on/off compression when generating PostScript or PDF output.
virtual void	CompressOff ()
	Turn on/off compression when generating PostScript or PDF output.
virtual void	SetDrawBackground (vtkTypeBool)
	Turn on/off drawing the background frame.
virtual vtkTypeBool	GetDrawBackground ()
	Turn on/off drawing the background frame.
virtual void	DrawBackgroundOn ()
	Turn on/off drawing the background frame.
virtual void	DrawBackgroundOff ()
	Turn on/off drawing the background frame.
virtual void	SetSimpleLineOffset (vtkTypeBool)
	Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.
virtual vtkTypeBool	GetSimpleLineOffset ()
	Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.
virtual void	SimpleLineOffsetOn ()
	Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.
virtual void	SimpleLineOffsetOff ()
	Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option.
virtual void	SetSilent (vtkTypeBool)
	Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).
virtual vtkTypeBool	GetSilent ()
	Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).
virtual void	SilentOn ()
	Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).
virtual void	SilentOff ()
	Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT).
virtual void	SetBestRoot (vtkTypeBool)
	Turn on/off the GL2PS_BEST_ROOT option.
virtual vtkTypeBool	GetBestRoot ()
	Turn on/off the GL2PS_BEST_ROOT option.
virtual void	BestRootOn ()
	Turn on/off the GL2PS_BEST_ROOT option.
virtual void	BestRootOff ()
	Turn on/off the GL2PS_BEST_ROOT option.
virtual void	SetText (vtkTypeBool)
	Turn on/off drawing the text.
virtual vtkTypeBool	GetText ()
	Turn on/off drawing the text.
virtual void	TextOn ()
	Turn on/off drawing the text.
virtual void	TextOff ()
	Turn on/off drawing the text.
virtual void	SetLandscape (vtkTypeBool)
	Turn on/off landscape orientation.
virtual vtkTypeBool	GetLandscape ()
	Turn on/off landscape orientation.
virtual void	LandscapeOn ()
	Turn on/off landscape orientation.
virtual void	LandscapeOff ()
	Turn on/off landscape orientation.
virtual void	SetPS3Shading (vtkTypeBool)
	Turn on/off the GL2PS_PS3_SHADING option.
virtual vtkTypeBool	GetPS3Shading ()
	Turn on/off the GL2PS_PS3_SHADING option.
virtual void	PS3ShadingOn ()
	Turn on/off the GL2PS_PS3_SHADING option.
virtual void	PS3ShadingOff ()
	Turn on/off the GL2PS_PS3_SHADING option.
virtual void	SetOcclusionCull (vtkTypeBool)
	Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).
virtual vtkTypeBool	GetOcclusionCull ()
	Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).
virtual void	OcclusionCullOn ()
	Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).
virtual void	OcclusionCullOff ()
	Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL).
virtual void	SetWrite3DPropsAsRasterImage (vtkTypeBool)
	Turn on/off writing 3D props as raster images.
virtual vtkTypeBool	GetWrite3DPropsAsRasterImage ()
	Turn on/off writing 3D props as raster images.
virtual void	Write3DPropsAsRasterImageOn ()
	Turn on/off writing 3D props as raster images.
virtual void	Write3DPropsAsRasterImageOff ()
	Turn on/off writing 3D props as raster images.
virtual void	SetTextAsPath (bool)
	Turn on/off exporting text as path information, rather than character data.
virtual bool	GetTextAsPath ()
	Turn on/off exporting text as path information, rather than character data.
virtual void	TextAsPathOn ()
	Turn on/off exporting text as path information, rather than character data.
virtual void	TextAsPathOff ()
	Turn on/off exporting text as path information, rather than character data.
void	SetRasterExclusions (vtkPropCollection *)
	Collection of props to exclude from rasterization.
virtual vtkPropCollection *	GetRasterExclusions ()
	Collection of props to exclude from rasterization.
virtual void	SetPointSizeFactor (float)
	Set the ratio between the OpenGL PointSize and that used by GL2PS to generate PostScript.
virtual float	GetPointSizeFactor ()
	Set the ratio between the OpenGL PointSize and that used by GL2PS to generate PostScript.
virtual void	SetLineWidthFactor (float)
	Set the ratio between the OpenGL LineWidth and that used by GL2PS to generate PostScript.
virtual float	GetLineWidthFactor ()
	Set the ratio between the OpenGL LineWidth and that used by GL2PS to generate PostScript.
Public Member Functions inherited from vtkExporter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Write ()
	Write data to output.
void	Update ()
	Convenient alias for Write() method.
void	SetStartWrite (void(*f)(void *), void *arg)
	Specify a function to be called before data is written.
void	SetEndWrite (void(*f)(void *), void *arg)
	Specify a function to be called after data is written.
void	SetStartWriteArgDelete (void(*f)(void *))
	Set the arg delete method.
void	SetEndWriteArgDelete (void(*f)(void *))
	Set the arg delete method.
vtkMTimeType	GetMTime () override
	Returns the MTime also considering the RenderWindow.
virtual void	SetRenderWindow (vtkRenderWindow *)
	Set/Get the rendering window that contains the scene to be written.
virtual vtkRenderWindow *	GetRenderWindow ()
	Set/Get the rendering window that contains the scene to be written.
virtual void	SetActiveRenderer (vtkRenderer *)
	Set/Get the renderer that contains actors to be written.
virtual vtkRenderer *	GetActiveRenderer ()
	Set/Get the renderer that contains actors to be written.
void	SetInput (vtkRenderWindow *renWin)
	These methods are provided for backward compatibility.
vtkRenderWindow *	GetInput ()
	These methods are provided for backward compatibility.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkOpenGLGL2PSExporter *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLGL2PSExporter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkGL2PSExporter
static vtkGL2PSExporter *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGL2PSExporter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkExporter
static vtkTypeBool	IsTypeOf (const char *type)
static vtkExporter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLGL2PSExporter ()
	~vtkOpenGLGL2PSExporter () override
void	WriteData () override
bool	RasterizeBackground (vtkImageData *image)
bool	CaptureVectorProps ()
Protected Member Functions inherited from vtkGL2PSExporter
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGL2PSExporter ()
	~vtkGL2PSExporter () override
int	GetGL2PSOptions ()
int	GetGL2PSSort ()
int	GetGL2PSFormat ()
const char *	GetFileExtension ()
Protected Member Functions inherited from vtkExporter
virtual vtkObjectBase *	NewInstanceInternal () const
	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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkGL2PSExporter
vtkPropCollection *	RasterExclusions
char *	FilePrefix
char *	Title
int	FileFormat
int	BufferSize
int	Sort
vtkTypeBool	Compress
vtkTypeBool	DrawBackground
vtkTypeBool	SimpleLineOffset
vtkTypeBool	Silent
vtkTypeBool	BestRoot
vtkTypeBool	Text
vtkTypeBool	Landscape
vtkTypeBool	PS3Shading
vtkTypeBool	OcclusionCull
vtkTypeBool	Write3DPropsAsRasterImage
bool	TextAsPath
float	PointSizeFactor
float	LineWidthFactor
Protected Attributes inherited from vtkExporter
vtkRenderWindow *	RenderWindow
vtkRenderer *	ActiveRenderer
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
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

OpenGL2 implementation of GL2PS exporter.

Implementation of vtkGL2PSExporter for the OpenGL2 backend.

Definition at line 32 of file vtkOpenGLGL2PSExporter.h.

Member Typedef Documentation

Superclass

typedef vtkGL2PSExporter vtkOpenGLGL2PSExporter::Superclass

Definition at line 36 of file vtkOpenGLGL2PSExporter.h.

Constructor & Destructor Documentation

vtkOpenGLGL2PSExporter()

vtkOpenGLGL2PSExporter::vtkOpenGLGL2PSExporter ( )

protected

~vtkOpenGLGL2PSExporter()

vtkOpenGLGL2PSExporter::~vtkOpenGLGL2PSExporter ( )

overrideprotected

Member Function Documentation

New()

static vtkOpenGLGL2PSExporter * vtkOpenGLGL2PSExporter::New ( )

static

IsTypeOf()

static vtkTypeBool vtkOpenGLGL2PSExporter::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkOpenGLGL2PSExporter::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 vtkGL2PSExporter.

SafeDownCast()

static vtkOpenGLGL2PSExporter * vtkOpenGLGL2PSExporter::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLGL2PSExporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGL2PSExporter.

NewInstance()

vtkOpenGLGL2PSExporter * vtkOpenGLGL2PSExporter::NewInstance

(

)

const

PrintSelf()

void vtkOpenGLGL2PSExporter::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 vtkGL2PSExporter.

WriteData()

void vtkOpenGLGL2PSExporter::WriteData ( )

overrideprotectedvirtual

Implements vtkExporter.

RasterizeBackground()

bool vtkOpenGLGL2PSExporter::RasterizeBackground ( vtkImageData *  image )

protected

CaptureVectorProps()

bool vtkOpenGLGL2PSExporter::CaptureVectorProps ( )

protected

---

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

• IO/ExportGL2PS/vtkOpenGLGL2PSExporter.h