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

OpenGL2 implementation of GL2PS exporter. More...

#include <vtkOpenGLGL2PSExporter.h>

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

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. More...
 
vtkOpenGLGL2PSExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkGL2PSExporter
vtkGL2PSExporterNewInstance () const
 
virtual void SetFilePrefix (const char *)
 Specify the prefix of the files to write out. More...
 
virtual char * GetFilePrefix ()
 
virtual void SetBufferSize (int)
 The initial size of the GL2PS export buffer in bytes. More...
 
virtual int GetBufferSize ()
 
virtual void SetTitle (const char *)
 Set the title for the output, if supported. More...
 
virtual char * GetTitle ()
 
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 ()
 
void SetFileFormatToPS ()
 
void SetFileFormatToEPS ()
 
void SetFileFormatToPDF ()
 
void SetFileFormatToTeX ()
 
void SetFileFormatToSVG ()
 
const char * GetFileFormatAsString ()
 
virtual void SetSort (int)
 Set the type of sorting algorithm to order primitives from back to front. More...
 
virtual int GetSort ()
 
void SetSortToOff ()
 
void SetSortToSimple ()
 
void SetSortToBSP ()
 
const char * GetSortAsString ()
 
virtual void SetCompress (vtkTypeBool)
 Turn on/off compression when generating PostScript or PDF output. More...
 
virtual vtkTypeBool GetCompress ()
 
virtual void CompressOn ()
 
virtual void CompressOff ()
 
virtual void SetDrawBackground (vtkTypeBool)
 Turn on/off drawing the background frame. More...
 
virtual vtkTypeBool GetDrawBackground ()
 
virtual void DrawBackgroundOn ()
 
virtual void DrawBackgroundOff ()
 
virtual void SetSimpleLineOffset (vtkTypeBool)
 Turn on/off the GL2PS_SIMPLE_LINE_OFFSET option. More...
 
virtual vtkTypeBool GetSimpleLineOffset ()
 
virtual void SimpleLineOffsetOn ()
 
virtual void SimpleLineOffsetOff ()
 
virtual void SetSilent (vtkTypeBool)
 Turn on/off GL2PS messages sent to stderr (GL2PS_SILENT). More...
 
virtual vtkTypeBool GetSilent ()
 
virtual void SilentOn ()
 
virtual void SilentOff ()
 
virtual void SetBestRoot (vtkTypeBool)
 Turn on/off the GL2PS_BEST_ROOT option. More...
 
virtual vtkTypeBool GetBestRoot ()
 
virtual void BestRootOn ()
 
virtual void BestRootOff ()
 
virtual void SetText (vtkTypeBool)
 Turn on/off drawing the text. More...
 
virtual vtkTypeBool GetText ()
 
virtual void TextOn ()
 
virtual void TextOff ()
 
virtual void SetLandscape (vtkTypeBool)
 Turn on/off landscape orientation. More...
 
virtual vtkTypeBool GetLandscape ()
 
virtual void LandscapeOn ()
 
virtual void LandscapeOff ()
 
virtual void SetPS3Shading (vtkTypeBool)
 Turn on/off the GL2PS_PS3_SHADING option. More...
 
virtual vtkTypeBool GetPS3Shading ()
 
virtual void PS3ShadingOn ()
 
virtual void PS3ShadingOff ()
 
virtual void SetOcclusionCull (vtkTypeBool)
 Turn on/off culling of occluded polygons (GL2PS_OCCLUSION_CULL). More...
 
virtual vtkTypeBool GetOcclusionCull ()
 
virtual void OcclusionCullOn ()
 
virtual void OcclusionCullOff ()
 
virtual void SetWrite3DPropsAsRasterImage (vtkTypeBool)
 Turn on/off writing 3D props as raster images. More...
 
virtual vtkTypeBool GetWrite3DPropsAsRasterImage ()
 
virtual void Write3DPropsAsRasterImageOn ()
 
virtual void Write3DPropsAsRasterImageOff ()
 
virtual void SetTextAsPath (bool)
 Turn on/off exporting text as path information, rather than character data. More...
 
virtual bool GetTextAsPath ()
 
virtual void TextAsPathOn ()
 
virtual void TextAsPathOff ()
 
void SetRasterExclusions (vtkPropCollection *)
 Collection of props to exclude from rasterization. More...
 
virtual vtkPropCollectionGetRasterExclusions ()
 
virtual void SetPointSizeFactor (float)
 Set the ratio between the OpenGL PointSize and that used by GL2PS to generate PostScript. More...
 
virtual float GetPointSizeFactor ()
 
virtual void SetLineWidthFactor (float)
 Set the ratio between the OpenGL LineWidth and that used by GL2PS to generate PostScript. More...
 
virtual float GetLineWidthFactor ()
 
- Public Member Functions inherited from vtkExporter
vtkExporterNewInstance () const
 
virtual void Write ()
 Write data to output. More...
 
void Update ()
 Convenient alias for Write() method. More...
 
virtual void SetRenderWindow (vtkRenderWindow *)
 Set/Get the rendering window that contains the scene to be written. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 
virtual void SetActiveRenderer (vtkRenderer *)
 Set/Get the renderer that contains actors to be written. More...
 
virtual vtkRendererGetActiveRenderer ()
 
void SetInput (vtkRenderWindow *renWin)
 These methods are provided for backward compatibility. More...
 
vtkRenderWindowGetInput ()
 
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...
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkOpenGLGL2PSExporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLGL2PSExporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGL2PSExporter
static vtkGL2PSExporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGL2PSExporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkExporter
static vtkTypeBool 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkOpenGLGL2PSExporter ()
 
 ~vtkOpenGLGL2PSExporter () override
 
void WriteData () override
 
bool RasterizeBackground (vtkImageData *image)
 
bool CaptureVectorProps ()
 
- Protected Member Functions inherited from vtkGL2PSExporter
 vtkGL2PSExporter ()
 
 ~vtkGL2PSExporter () override
 
int GetGL2PSOptions ()
 
int GetGL2PSSort ()
 
int GetGL2PSFormat ()
 
const char * GetFileExtension ()
 
- Protected Member Functions inherited from vtkExporter
 vtkExporter ()
 
 ~vtkExporter () override
 
- 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. More...
 
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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkGL2PSExporter
vtkPropCollectionRasterExclusions
 
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
vtkRenderWindowRenderWindow
 
vtkRendererActiveRenderer
 
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

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: