Exports vtkContext2D scenes to SVG. More...

#include <vtkSVGExporter.h>

Inheritance diagram for vtkSVGExporter:

Collaboration diagram for vtkSVGExporter:

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.

vtkSVGExporter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.


virtual void	SetTitle (const char *)
	The title of the exported document.

virtual char *	GetTitle ()
	The title of the exported document.


virtual void	SetDescription (const char *)
	A description of the exported document.

virtual char *	GetDescription ()
	A description of the exported document.


	vtkSetFilePathMacro (FileName)
	The name of the exported file.

	vtkGetFilePathMacro (FileName)
	The name of the exported file.


virtual void	SetTextAsPath (bool)
	If true, draw all text as path objects rather than text objects.

virtual bool	GetTextAsPath ()
	If true, draw all text as path objects rather than text objects.

virtual void	TextAsPathOn ()
	If true, draw all text as path objects rather than text objects.

virtual void	TextAsPathOff ()
	If true, draw all text as path objects rather than text objects.


virtual void	SetDrawBackground (bool)
	If true, the background will be drawn into the output document.

virtual bool	GetDrawBackground ()
	If true, the background will be drawn into the output document.

virtual void	DrawBackgroundOn ()
	If true, the background will be drawn into the output document.

virtual void	DrawBackgroundOff ()
	If true, the background will be drawn into the output document.


virtual void	SetSubdivisionThreshold (float)
	Set the threshold for subdividing gradient-shaded polygons/line.

virtual float	GetSubdivisionThreshold ()
	Set the threshold for subdividing gradient-shaded polygons/line.

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 vtkSVGExporter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSVGExporter *	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

	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
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 &)

Protected Attributes
char *	Title

char *	Description

char *	FileName

vtkSVGContextDevice2D *	Device

vtkXMLDataElement *	RootNode

vtkXMLDataElement *	PageNode

vtkXMLDataElement *	DefinitionNode

float	SubdivisionThreshold

bool	DrawBackground

bool	TextAsPath

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Exports vtkContext2D scenes to SVG.

This exporter draws context2D scenes into a SVG file.

Limitations:

The Nearest/Linear texture properties are ignored, since SVG doesn't provide any reliable control over interpolation.
Embedded fonts are experimental and poorly tested. Viewer support is lacking at the time of writing, hence the feature is largely useless. By default, fonts are not embedded since they're basically useless bloat. (this option is not exposed in vtkSVGExporter).
TextAsPath is enabled by default, since viewers differ wildly in how they handle text objects (eg. Inkscape renders at expected size, but webkit is way too big).
Pattern fills and markers are not shown on some viewers, e.g. KDE's okular (Webkit seems to work, though).
Clipping seems to be broken in most viewers. Webkit is buggy and forces the clip coordinates to objectBoundingBox, even when explicitly set to userSpaceOnUse.
Many viewers anti-alias the output, leaving thin outlines around the triangles that make up larger polygons. This is a viewer issue and there not much we can do about it from the VTK side of things (and most viewers don't seem to have an antialiasing toggle, either...).

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

Online Examples:

ImportToExport

Definition at line 75 of file vtkSVGExporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkExporter vtkSVGExporter::Superclass

Definition at line 79 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.

◆ vtkSetFilePathMacro()

vtkSVGExporter::vtkSetFilePathMacro ( FileName )

The name of the exported file.

◆ vtkGetFilePathMacro()

vtkSVGExporter::vtkGetFilePathMacro ( FileName )

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 158 of file vtkSVGExporter.h.

◆ Description

char* vtkSVGExporter::Description

protected

Definition at line 159 of file vtkSVGExporter.h.

◆ FileName

char* vtkSVGExporter::FileName

protected

Definition at line 160 of file vtkSVGExporter.h.

◆ Device

vtkSVGContextDevice2D* vtkSVGExporter::Device

protected

Definition at line 162 of file vtkSVGExporter.h.

◆ RootNode

vtkXMLDataElement* vtkSVGExporter::RootNode

protected

Definition at line 163 of file vtkSVGExporter.h.

◆ PageNode

vtkXMLDataElement* vtkSVGExporter::PageNode

protected

Definition at line 164 of file vtkSVGExporter.h.

◆ DefinitionNode

vtkXMLDataElement* vtkSVGExporter::DefinitionNode

protected

Definition at line 165 of file vtkSVGExporter.h.

◆ SubdivisionThreshold

float vtkSVGExporter::SubdivisionThreshold

protected

Definition at line 167 of file vtkSVGExporter.h.

◆ DrawBackground

bool vtkSVGExporter::DrawBackground

protected

Definition at line 168 of file vtkSVGExporter.h.

◆ TextAsPath

bool vtkSVGExporter::TextAsPath

protected

Definition at line 169 of file vtkSVGExporter.h.

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

IO/Export/vtkSVGExporter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSVGExporter()

◆ ~vtkSVGExporter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetTitle()

◆ GetTitle()

◆ SetDescription()

◆ GetDescription()

◆ vtkSetFilePathMacro()

◆ vtkGetFilePathMacro()

◆ SetTextAsPath()

◆ GetTextAsPath()

◆ TextAsPathOn()

◆ TextAsPathOff()

◆ SetDrawBackground()

◆ GetDrawBackground()

◆ DrawBackgroundOn()

◆ DrawBackgroundOff()

◆ SetSubdivisionThreshold()

◆ GetSubdivisionThreshold()

◆ WriteData()

◆ WriteSVG()

◆ PrepareDocument()

◆ RenderContextActors()

◆ RenderBackground()

◆ RenderContextActor()

Member Data Documentation

◆ Title

◆ Description

◆ FileName

◆ Device

◆ RootNode

◆ PageNode

◆ DefinitionNode

◆ SubdivisionThreshold

◆ DrawBackground

◆ TextAsPath