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

Exports vtkContext2D scenes to SVG. More...

#include <vtkSVGExporter.h>

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

Public Types

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...
 
vtkSVGExporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetTitle (const char *)
 The title of the exported document. More...
 
virtual char * GetTitle ()
 The title of the exported document. More...
 
virtual void SetDescription (const char *)
 A description of the exported document. More...
 
virtual char * GetDescription ()
 A description of the exported document. More...
 
virtual void SetFileName (const char *)
 The name of the exported file. More...
 
virtual char * GetFileName ()
 The name of the exported file. More...
 
virtual void SetTextAsPath (bool)
 If true, draw all text as path objects rather than text objects. More...
 
virtual bool GetTextAsPath ()
 If true, draw all text as path objects rather than text objects. More...
 
virtual void TextAsPathOn ()
 If true, draw all text as path objects rather than text objects. More...
 
virtual void TextAsPathOff ()
 If true, draw all text as path objects rather than text objects. More...
 
virtual void SetDrawBackground (bool)
 If true, the background will be drawn into the output document. More...
 
virtual bool GetDrawBackground ()
 If true, the background will be drawn into the output document. More...
 
virtual void DrawBackgroundOn ()
 If true, the background will be drawn into the output document. More...
 
virtual void DrawBackgroundOff ()
 If true, the background will be drawn into the output document. More...
 
virtual void SetSubdivisionThreshold (float)
 Set the threshold for subdividing gradient-shaded polygons/line. More...
 
virtual float GetSubdivisionThreshold ()
 Set the threshold for subdividing gradient-shaded polygons/line. 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...
 
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 vtkSVGExporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSVGExporterSafeDownCast (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
 
 vtkSVGExporter ()
 
 ~vtkSVGExporter () override
 
void WriteData () override
 
void WriteSVG ()
 
void PrepareDocument ()
 
void RenderContextActors ()
 
void RenderBackground (vtkRenderer *ren)
 
void RenderContextActor (vtkContextActor *actor, vtkRenderer *renderer)
 
- 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 &)
 

Protected Attributes

char * Title
 
char * Description
 
char * FileName
 
vtkSVGContextDevice2DDevice
 
vtkXMLDataElementRootNode
 
vtkXMLDataElementPageNode
 
vtkXMLDataElementDefinitionNode
 
float SubdivisionThreshold
 
bool DrawBackground
 
bool TextAsPath
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Exports vtkContext2D scenes to SVG.

This exporter draws context2D scenes into a SVG file.

Limitations:

If ActiveRenderer is specified then it exports contents of ActiveRenderer. Otherwise it exports contents of all renderers.

Definition at line 56 of file vtkSVGExporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkSVGExporter.h.

Constructor & Destructor Documentation

◆ vtkSVGExporter()

vtkSVGExporter::vtkSVGExporter ( )
protected

◆ ~vtkSVGExporter()

vtkSVGExporter::~vtkSVGExporter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSVGExporter* vtkSVGExporter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSVGExporter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkExporter.

◆ NewInstance()

vtkSVGExporter* vtkSVGExporter::NewInstance ( ) const

◆ PrintSelf()

void vtkSVGExporter::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.

◆ SetTitle()

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

The title of the exported document.

◆ GetTitle()

virtual char* vtkSVGExporter::GetTitle ( )
virtual

The title of the exported document.

◆ SetDescription()

virtual void vtkSVGExporter::SetDescription ( const char *  )
virtual

A description of the exported document.

◆ GetDescription()

virtual char* vtkSVGExporter::GetDescription ( )
virtual

A description of the exported document.

◆ SetFileName()

virtual void vtkSVGExporter::SetFileName ( const char *  )
virtual

The name of the exported file.

◆ GetFileName()

virtual char* vtkSVGExporter::GetFileName ( )
virtual

The name of the exported file.

◆ SetTextAsPath()

virtual void vtkSVGExporter::SetTextAsPath ( bool  )
virtual

If true, draw all text as path objects rather than text objects.

Enabling this option will:

  • Improve portability (text will look exactly the same everywhere).
  • Increase file size (text objects are much more compact than paths).
  • Prevent text from being easily edited (text metadata is lost).

Note that some text (e.g. MathText) is always rendered as a path.

The default is true, as many browsers and SVG viewers render text inconsistently.

◆ GetTextAsPath()

virtual bool vtkSVGExporter::GetTextAsPath ( )
virtual

If true, draw all text as path objects rather than text objects.

Enabling this option will:

  • Improve portability (text will look exactly the same everywhere).
  • Increase file size (text objects are much more compact than paths).
  • Prevent text from being easily edited (text metadata is lost).

Note that some text (e.g. MathText) is always rendered as a path.

The default is true, as many browsers and SVG viewers render text inconsistently.

◆ TextAsPathOn()

virtual void vtkSVGExporter::TextAsPathOn ( )
virtual

If true, draw all text as path objects rather than text objects.

Enabling this option will:

  • Improve portability (text will look exactly the same everywhere).
  • Increase file size (text objects are much more compact than paths).
  • Prevent text from being easily edited (text metadata is lost).

Note that some text (e.g. MathText) is always rendered as a path.

The default is true, as many browsers and SVG viewers render text inconsistently.

◆ TextAsPathOff()

virtual void vtkSVGExporter::TextAsPathOff ( )
virtual

If true, draw all text as path objects rather than text objects.

Enabling this option will:

  • Improve portability (text will look exactly the same everywhere).
  • Increase file size (text objects are much more compact than paths).
  • Prevent text from being easily edited (text metadata is lost).

Note that some text (e.g. MathText) is always rendered as a path.

The default is true, as many browsers and SVG viewers render text inconsistently.

◆ SetDrawBackground()

virtual void vtkSVGExporter::SetDrawBackground ( bool  )
virtual

If true, the background will be drawn into the output document.

Default is true.

◆ GetDrawBackground()

virtual bool vtkSVGExporter::GetDrawBackground ( )
virtual

If true, the background will be drawn into the output document.

Default is true.

◆ DrawBackgroundOn()

virtual void vtkSVGExporter::DrawBackgroundOn ( )
virtual

If true, the background will be drawn into the output document.

Default is true.

◆ DrawBackgroundOff()

virtual void vtkSVGExporter::DrawBackgroundOff ( )
virtual

If true, the background will be drawn into the output document.

Default is true.

◆ SetSubdivisionThreshold()

virtual void vtkSVGExporter::SetSubdivisionThreshold ( float  )
virtual

Set the threshold for subdividing gradient-shaded polygons/line.

Default value is 1, and lower values yield higher quality and larger files. Larger values will reduce the number of primitives, but will decrease quality.

A triangle / line will not be subdivided further if all of it's vertices satisfy the equation:

|v1 - v2|^2 < thresh

e.g. the squared norm of the vector between any verts must be greater than the threshold for subdivision to occur.

◆ GetSubdivisionThreshold()

virtual float vtkSVGExporter::GetSubdivisionThreshold ( )
virtual

Set the threshold for subdividing gradient-shaded polygons/line.

Default value is 1, and lower values yield higher quality and larger files. Larger values will reduce the number of primitives, but will decrease quality.

A triangle / line will not be subdivided further if all of it's vertices satisfy the equation:

|v1 - v2|^2 < thresh

e.g. the squared norm of the vector between any verts must be greater than the threshold for subdivision to occur.

◆ WriteData()

void vtkSVGExporter::WriteData ( )
overrideprotectedvirtual

Implements vtkExporter.

◆ WriteSVG()

void vtkSVGExporter::WriteSVG ( )
protected

◆ PrepareDocument()

void vtkSVGExporter::PrepareDocument ( )
protected

◆ RenderContextActors()

void vtkSVGExporter::RenderContextActors ( )
protected

◆ RenderBackground()

void vtkSVGExporter::RenderBackground ( vtkRenderer ren)
protected

◆ RenderContextActor()

void vtkSVGExporter::RenderContextActor ( vtkContextActor actor,
vtkRenderer renderer 
)
protected

Member Data Documentation

◆ Title

char* vtkSVGExporter::Title
protected

Definition at line 140 of file vtkSVGExporter.h.

◆ Description

char* vtkSVGExporter::Description
protected

Definition at line 141 of file vtkSVGExporter.h.

◆ FileName

char* vtkSVGExporter::FileName
protected

Definition at line 142 of file vtkSVGExporter.h.

◆ Device

vtkSVGContextDevice2D* vtkSVGExporter::Device
protected

Definition at line 144 of file vtkSVGExporter.h.

◆ RootNode

vtkXMLDataElement* vtkSVGExporter::RootNode
protected

Definition at line 145 of file vtkSVGExporter.h.

◆ PageNode

vtkXMLDataElement* vtkSVGExporter::PageNode
protected

Definition at line 146 of file vtkSVGExporter.h.

◆ DefinitionNode

vtkXMLDataElement* vtkSVGExporter::DefinitionNode
protected

Definition at line 147 of file vtkSVGExporter.h.

◆ SubdivisionThreshold

float vtkSVGExporter::SubdivisionThreshold
protected

Definition at line 149 of file vtkSVGExporter.h.

◆ DrawBackground

bool vtkSVGExporter::DrawBackground
protected

Definition at line 150 of file vtkSVGExporter.h.

◆ TextAsPath

bool vtkSVGExporter::TextAsPath
protected

Definition at line 151 of file vtkSVGExporter.h.


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