vtkContextDevice2D implementation for use with vtkSVGExporter. More...

#include <vtkSVGContextDevice2D.h>

Inheritance diagram for vtkSVGContextDevice2D:

Collaboration diagram for vtkSVGContextDevice2D:

Public Types
typedef vtkContextDevice2D	Superclass

Public Types inherited from vtkContextDevice2D
enum	TextureProperty { Nearest = 0x01 , Linear = 0x02 , Stretch = 0x04 , Repeat = 0x08 }

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...

vtkSVGContextDevice2D *	NewInstance () const

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

void	SetSVGContext (vtkXMLDataElement context, vtkXMLDataElement defs)
	The svg container element to draw into, and the global definitions element. More...

void	GenerateDefinitions ()
	Write any definition information (fonts, images, etc) that are accumulated between actors. More...

void	Begin (vtkViewport *) override
	Begin drawing, pass in the viewport to set up the view. More...

void	End () override
	End drawing, clean up the view. More...

void	DrawPoly (float points, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a poly line using the points - fastest code path due to memory layout of the coordinates. More...

void	DrawLines (float f, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2... The lines will be colored by colors array which has nc_comps components (defining a single color). More...

void	DrawPoints (float points, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a series of points - fastest code path due to memory layout of the coordinates. More...

void	DrawPointSprites (vtkImageData sprite, float points, int n, unsigned char *colors=nullptr, int nc_comps=0) override
	Draw a series of point sprites, images centred at the points supplied. More...

void	DrawMarkers (int shape, bool highlight, float points, int n, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a series of markers centered at the points supplied. More...

void	DrawQuad (float *, int) override
	Draw a quad using the specified number of points. More...

void	DrawQuadStrip (float *, int) override
	Draw a quad using the specified number of points. More...

void	DrawPolygon (float *, int) override
	Draw a polygon using the specified number of points. More...

void	DrawColoredPolygon (float points, int numPoints, unsigned char colors=nullptr, int nc_comps=0) override
	Draw a polygon using the specified number of points. More...

void	DrawEllipseWedge (float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle) override
	Draw an elliptic wedge with center at x, y, outer radii outRx, outRy, inner radii inRx, inRy between angles startAngle and stopAngle (expressed in degrees). More...

void	DrawEllipticArc (float x, float y, float rX, float rY, float startAngle, float stopAngle) override
	Draw an elliptic arc with center at x,y with radii rX and rY between angles startAngle and stopAngle (expressed in degrees). More...

void	DrawString (float *point, const vtkStdString &string) override
	Draw some text to the screen. More...

void	ComputeStringBounds (const vtkStdString &string, float bounds[4]) override
	Compute the bounds of the supplied string. More...

void	DrawString (float *point, const vtkUnicodeString &string) override
	Draw some text to the screen. More...

void	ComputeStringBounds (const vtkUnicodeString &string, float bounds[4]) override
	Compute the bounds of the supplied string. More...

void	ComputeJustifiedStringBounds (const char *string, float bounds[4]) override
	Compute the bounds of the supplied string while taking into account the justification of the currently applied text property. More...

void	DrawMathTextString (float *point, const vtkStdString &str) override
	Draw text using MathText markup for mathematical equations. More...

void	DrawImage (float p[2], float scale, vtkImageData *image) override
	Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the image). More...

void	DrawImage (const vtkRectf &pos, vtkImageData *image) override
	Draw the supplied image at the given position. More...

void	SetColor4 (unsigned char color[4]) override
	Set the color for the device using unsigned char of length 4, RGBA. More...

void	SetTexture (vtkImageData *image, int properties) override
	Set the texture for the device, it is used to fill the polygons. More...

void	SetPointSize (float size) override
	Set the point size for glyphs/sprites. More...

void	SetLineWidth (float width) override
	Set the line width. More...

void	SetLineType (int type) override
	Set the line type type (using anonymous enum in vtkPen). More...

void	SetMatrix (vtkMatrix3x3 *m) override
	Set the model view matrix for the display. More...

void	GetMatrix (vtkMatrix3x3 *m) override
	Set the model view matrix for the display. More...

void	MultiplyMatrix (vtkMatrix3x3 *m) override
	Multiply the current model view matrix by the supplied one. More...

void	PushMatrix () override
	Push the current matrix onto the stack. More...

void	PopMatrix () override
	Pop the current matrix off of the stack. More...

void	SetClipping (int *x) override
	Supply an int array of length 4 with x1, y1, width, height specifying clipping region for the device in pixels. More...

void	EnableClipping (bool enable) override
	Enable or disable the clipping of the scene. More...


virtual void	SetEmbedFonts (bool)
	EXPERIMENTAL: If true, the font glyph information will be embedded in the output. More...

virtual bool	GetEmbedFonts ()
	EXPERIMENTAL: If true, the font glyph information will be embedded in the output. More...

virtual void	EmbedFontsOn ()
	EXPERIMENTAL: If true, the font glyph information will be embedded in the output. More...

virtual void	EmbedFontsOff ()
	EXPERIMENTAL: If true, the font glyph information will be embedded in the output. 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	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 vtkContextDevice2D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkContextDevice2D *	NewInstance () const

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

virtual void	DrawPoly (float points, int n, unsigned char colors=nullptr, int nc_comps=0)=0
	Draw a poly line using the points - fastest code path due to memory layout of the coordinates. More...

virtual void	DrawLines (float f, int n, unsigned char colors=nullptr, int nc_comps=0)=0
	Draw lines using the points - memory layout is as follows: l1p1,l1p2,l2p1,l2p2... The lines will be colored by colors array which has nc_comps components (defining a single color). More...

virtual void	DrawPoints (float points, int n, unsigned char colors=nullptr, int nc_comps=0)=0
	Draw a series of points - fastest code path due to memory layout of the coordinates. More...

virtual void	DrawPointSprites (vtkImageData sprite, float points, int n, unsigned char *colors=nullptr, int nc_comps=0)=0
	Draw a series of point sprites, images centred at the points supplied. More...

virtual void	DrawMarkers (int shape, bool highlight, float points, int n, unsigned char colors=nullptr, int nc_comps=0)
	Draw a series of markers centered at the points supplied. More...

virtual void	DrawQuad (float *, int)
	Draw a quad using the specified number of points. More...

virtual void	DrawQuadStrip (float *, int)
	Draw a quad using the specified number of points. More...

virtual void	DrawEllipseWedge (float x, float y, float outRx, float outRy, float inRx, float inRy, float startAngle, float stopAngle)=0
	Draw an elliptic wedge with center at x, y, outer radii outRx, outRy, inner radii inRx, inRy between angles startAngle and stopAngle (expressed in degrees). More...

virtual void	DrawEllipticArc (float x, float y, float rX, float rY, float startAngle, float stopAngle)=0
	Draw an elliptic arc with center at x,y with radii rX and rY between angles startAngle and stopAngle (expressed in degrees). More...

virtual void	DrawString (float *point, const vtkStdString &string)=0
	Draw some text to the screen. More...

virtual void	ComputeStringBounds (const vtkStdString &string, float bounds[4])=0
	Compute the bounds of the supplied string. More...

virtual void	DrawString (float *point, const vtkUnicodeString &string)=0
	Draw some text to the screen. More...

virtual void	ComputeStringBounds (const vtkUnicodeString &string, float bounds[4])=0
	Compute the bounds of the supplied string. More...

virtual void	ComputeJustifiedStringBounds (const char *string, float bounds[4])=0
	Compute the bounds of the supplied string while taking into account the justification of the currently applied text property. More...

virtual void	DrawMathTextString (float *point, const vtkStdString &string)=0
	Draw text using MathText markup for mathematical equations. More...

virtual bool	MathTextIsSupported ()
	Return true if MathText rendering available on this device. More...

virtual void	DrawImage (float p[2], float scale, vtkImageData *image)=0
	Draw the supplied image at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the image). More...

virtual void	DrawImage (const vtkRectf &pos, vtkImageData *image)=0
	Draw the supplied image at the given position. More...

virtual void	DrawPolyData (float p[2], float scale, vtkPolyData polyData, vtkUnsignedCharArray colors, int scalarMode)
	Draw the supplied PolyData at the given x, y (p[0], p[1]) (bottom corner), scaled by scale (1.0 would match the actual dataset). More...

virtual void	ApplyPen (vtkPen *pen)
	Apply the supplied pen which controls the outlines of shapes, as well as lines, points and related primitives. More...

virtual void	ApplyBrush (vtkBrush *brush)
	Apply the supplied brush which controls the outlines of shapes, as well as lines, points and related primitives. More...

virtual void	ApplyTextProp (vtkTextProperty *prop)
	Apply the supplied text property which controls how text is rendered. More...

virtual void	SetColor4 (unsigned char color[4])=0
	Set the color for the device using unsigned char of length 4, RGBA. More...

virtual void	SetTexture (vtkImageData *image, int properties)=0
	Set the texture for the device, it is used to fill the polygons. More...

virtual void	SetPointSize (float size)=0
	Set the point size for glyphs/sprites. More...

virtual void	SetLineWidth (float width)=0
	Set the line width. More...

virtual void	SetLineType (int type)=0
	Set the line type type (using anonymous enum in vtkPen). More...

virtual int	GetWidth ()
	Get the width of the device in pixels. More...

virtual int	GetHeight ()
	Get the width of the device in pixels. More...

virtual void	SetMatrix (vtkMatrix3x3 *m)=0
	Set the model view matrix for the display. More...

virtual void	GetMatrix (vtkMatrix3x3 *m)=0
	Set the model view matrix for the display. More...

virtual void	MultiplyMatrix (vtkMatrix3x3 *m)=0
	Multiply the current model view matrix by the supplied one. More...

virtual void	PushMatrix ()=0
	Push the current matrix onto the stack. More...

virtual void	PopMatrix ()=0
	Pop the current matrix off of the stack. More...

virtual void	SetClipping (int *x)=0
	Supply an int array of length 4 with x1, y1, width, height specifying clipping region for the device in pixels. More...

virtual void	DisableClipping ()
	Disable clipping of the display. More...

virtual void	EnableClipping (bool enable)=0
	Enable or disable the clipping of the scene. More...

virtual void	Begin (vtkViewport *)
	Begin drawing, pass in the viewport to set up the view. More...

virtual void	End ()
	End drawing, clean up the view. More...

virtual bool	GetBufferIdMode () const
	Tell if the device context is in BufferId creation mode. More...

virtual void	BufferIdModeBegin (vtkAbstractContextBufferId *bufferId)
	Start BufferId creation Mode. More...

virtual void	BufferIdModeEnd ()
	Finalize BufferId creation Mode. More...

virtual void	SetViewportSize (const vtkVector2i &size)

virtual vtkVector2i	GetViewportSize ()

virtual void	SetViewportRect (const vtkRecti &rect)

virtual vtkRecti	GetViewportRect ()

virtual vtkPen *	GetPen ()
	Get the pen which controls the outlines of shapes, as well as lines, points and related primitives. More...

virtual vtkBrush *	GetBrush ()
	Get the pen which controls the outlines of shapes as well as lines, points and related primitives. More...

virtual vtkTextProperty *	GetTextProp ()
	Get the text properties object for the vtkContext2D. 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...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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

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. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

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

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

Static Public Member Functions
static vtkSVGContextDevice2D *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSVGContextDevice2D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkContextDevice2D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkContextDevice2D *	SafeDownCast (vtkObjectBase *o)

static vtkContextDevice2D *	New ()

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. 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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSVGContextDevice2D ()

	~vtkSVGContextDevice2D () override

void	SetViewport (vtkViewport *)

void	PushGraphicsState ()

void	PopGraphicsState ()

void	SetupClippingAndTransform ()

void	ApplyPenStateToNode (vtkXMLDataElement *node)

void	ApplyPenColorToNode (vtkXMLDataElement *node)

void	ApplyPenOpacityToNode (vtkXMLDataElement *node)

void	ApplyPenWidthToNode (vtkXMLDataElement *node)

void	ApplyPenStippleToNode (vtkXMLDataElement *node)

void	ApplyPenAsFillColorToNode (vtkXMLDataElement *node)

void	ApplyPenAsFillOpacityToNode (vtkXMLDataElement *node)

void	ApplyBrushStateToNode (vtkXMLDataElement *node)

void	ApplyBrushColorToNode (vtkXMLDataElement *node)

void	ApplyBrushOpacityToNode (vtkXMLDataElement *node)

void	ApplyBrushTextureToNode (vtkXMLDataElement *node)

void	ApplyTextPropertyStateToNode (vtkXMLDataElement *node, float x, float y)

void	ApplyTextPropertyStateToNodeForPath (vtkXMLDataElement *node, float x, float y)

void	ApplyTransform ()

std::string	AddCrossSymbol (bool highlight)

std::string	AddPlusSymbol (bool highlight)

std::string	AddSquareSymbol (bool highlight)

std::string	AddCircleSymbol (bool highlight)

std::string	AddDiamondSymbol (bool highlight)

void	DrawPath (vtkPath *path, std::ostream &out)

void	DrawLineGradient (const vtkVector2f &p1, const vtkColor4ub &c1, const vtkVector2f &p2, const vtkColor4ub &c2, bool useAlpha)

void	DrawTriangleGradient (const vtkVector2f &p1, const vtkColor4ub &c1, const vtkVector2f &p2, const vtkColor4ub &c2, const vtkVector2f &p3, const vtkColor4ub &c3, bool useAlpha)

bool	AreaLessThanTolerance (const vtkVector2f &p1, const vtkVector2f &p2, const vtkVector2f &p3)

bool	LengthLessThanTolerance (const vtkVector2f &p1, const vtkVector2f &p2)

bool	ColorsAreClose (const vtkColor4ub &c1, const vtkColor4ub &c2, bool useAlpha)

bool	ColorsAreClose (const vtkColor4ub &c1, const vtkColor4ub &c2, const vtkColor4ub &c3, bool useAlpha)

void	WriteFonts ()

void	WriteImages ()

void	WritePatterns ()

void	WriteClipRects ()

void	AdjustMatrixForSVG (const double in[9], double out[9])

void	GetSVGMatrix (double svg[9])

float	GetScaledPenWidth ()

void	GetScaledPenWidth (float &x, float &y)

void	TransformSize (float &x, float &y)

vtkImageData *	PreparePointSprite (vtkImageData *in)

Protected Member Functions inherited from vtkContextDevice2D
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkContextDevice2D ()

	~vtkContextDevice2D () 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 ()
	These methods allow a command to exclusively grab all events. More...

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

Static Protected Member Functions
static bool	Transform2DEqual (const double mat3[9], const double mat4[16])

static void	Matrix3ToMatrix4 (const double mat3[9], double mat4[16])

static void	Matrix4ToMatrix3 (const double mat4[16], double mat3[9])

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
Details *	Impl

vtkViewport *	Viewport

vtkXMLDataElement *	ContextNode

vtkXMLDataElement *	ActiveNode

vtkXMLDataElement *	DefinitionNode

vtkNew< vtkTransform >	Matrix

std::array< double, 9 >	ActiveNodeTransform

std::array< int, 4 >	ClipRect

std::array< int, 4 >	ActiveNodeClipRect

float	CanvasHeight

float	SubdivisionThreshold

bool	IsClipping

bool	ActiveNodeIsClipping

bool	EmbedFonts

bool	TextAsPath

Protected Attributes inherited from vtkContextDevice2D
int	Geometry [2]
	Store the width and height of the device in pixels. More...

vtkVector2i	ViewportSize
	Store the size of the total viewport. More...

vtkRecti	ViewportRect
	Store our origin and size in the total viewport. More...

vtkAbstractContextBufferId *	BufferId

vtkPen *	Pen

vtkBrush *	Brush

vtkTextProperty *	TextProp

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

vtkContextDevice2D implementation for use with vtkSVGExporter.

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

Definition at line 56 of file vtkSVGContextDevice2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkContextDevice2D vtkSVGContextDevice2D::Superclass

Definition at line 60 of file vtkSVGContextDevice2D.h.

Constructor & Destructor Documentation

◆ vtkSVGContextDevice2D()

vtkSVGContextDevice2D::vtkSVGContextDevice2D ( )

protected

◆ ~vtkSVGContextDevice2D()

vtkSVGContextDevice2D::~vtkSVGContextDevice2D ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSVGContextDevice2D * vtkSVGContextDevice2D::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSVGContextDevice2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkContextDevice2D.

◆ NewInstance()

vtkSVGContextDevice2D * vtkSVGContextDevice2D::NewInstance ( ) const

◆ PrintSelf()

void vtkSVGContextDevice2D::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 vtkObject.

◆ SetSVGContext()

void vtkSVGContextDevice2D::SetSVGContext	(	vtkXMLDataElement *	context,
		vtkXMLDataElement *	defs
	)

The svg container element to draw into, and the global definitions element.

◆ SetEmbedFonts()

virtual void vtkSVGContextDevice2D::SetEmbedFonts ( bool )

virtual

EXPERIMENTAL: If true, the font glyph information will be embedded in the output.

Default is false.

Note: This feature is experimental and not well tested, as most browsers and SVG viewers do not support rendering embedded fonts. As such, enabling this option typically just increases file size for no real benefit.

◆ GetEmbedFonts()

virtual bool vtkSVGContextDevice2D::GetEmbedFonts ( )

virtual

EXPERIMENTAL: If true, the font glyph information will be embedded in the output.

Default is false.

Note: This feature is experimental and not well tested, as most browsers and SVG viewers do not support rendering embedded fonts. As such, enabling this option typically just increases file size for no real benefit.

◆ EmbedFontsOn()

virtual void vtkSVGContextDevice2D::EmbedFontsOn ( )

virtual

EXPERIMENTAL: If true, the font glyph information will be embedded in the output.

Default is false.

Note: This feature is experimental and not well tested, as most browsers and SVG viewers do not support rendering embedded fonts. As such, enabling this option typically just increases file size for no real benefit.

◆ EmbedFontsOff()

virtual void vtkSVGContextDevice2D::EmbedFontsOff ( )

virtual

EXPERIMENTAL: If true, the font glyph information will be embedded in the output.

Default is false.

Note: This feature is experimental and not well tested, as most browsers and SVG viewers do not support rendering embedded fonts. As such, enabling this option typically just increases file size for no real benefit.

◆ SetTextAsPath()

virtual void vtkSVGContextDevice2D::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 objects inconsistently.

◆ GetTextAsPath()

virtual bool vtkSVGContextDevice2D::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 objects inconsistently.

◆ TextAsPathOn()

virtual void vtkSVGContextDevice2D::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 objects inconsistently.

◆ TextAsPathOff()

virtual void vtkSVGContextDevice2D::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 objects inconsistently.

◆ SetSubdivisionThreshold()

virtual void vtkSVGContextDevice2D::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 vtkSVGContextDevice2D::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.

◆ GenerateDefinitions()

void vtkSVGContextDevice2D::GenerateDefinitions ( )

Write any definition information (fonts, images, etc) that are accumulated between actors.

◆ Begin()

void vtkSVGContextDevice2D::Begin ( vtkViewport * )

overridevirtual

Begin drawing, pass in the viewport to set up the view.

Reimplemented from vtkContextDevice2D.

◆ End()

void vtkSVGContextDevice2D::End ( )

overridevirtual

End drawing, clean up the view.

Reimplemented from vtkContextDevice2D.

◆ DrawPoly()

void vtkSVGContextDevice2D::DrawPoly	(	float *	points,
		int	n,
		unsigned char *	colors = `nullptr`,
		int	nc_comps = `0`
	)

overridevirtual

Draw a poly line using the points - fastest code path due to memory layout of the coordinates.

The line will be colored by the colors array, which must be have nc_comps components (defining a single color).

sprite	the image to draw
points	where to draw the sprites
n	the number of points
colors	is an optional array of colors.
nc_comps	is the number of components for the color.

shape	the shape of the marker
highlight	whether to highlight the marker or not
points	where to draw the sprites
n	the number of points
colors	is an optional array of colors.
nc_comps	is the number of components for the color.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSVGContextDevice2D()

◆ ~vtkSVGContextDevice2D()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetSVGContext()

◆ SetEmbedFonts()

◆ GetEmbedFonts()

◆ EmbedFontsOn()

◆ EmbedFontsOff()

◆ SetTextAsPath()

◆ GetTextAsPath()

◆ TextAsPathOn()

◆ TextAsPathOff()

◆ SetSubdivisionThreshold()

◆ GetSubdivisionThreshold()

◆ GenerateDefinitions()

◆ Begin()

◆ End()

◆ DrawPoly()

◆ DrawLines()

◆ DrawPoints()

◆ DrawPointSprites()

◆ DrawMarkers()

◆ DrawQuad()

◆ DrawQuadStrip()

◆ DrawPolygon()

◆ DrawColoredPolygon()

◆ DrawEllipseWedge()

◆ DrawEllipticArc()

◆ DrawString() [1/2]

◆ ComputeStringBounds() [1/2]

◆ DrawString() [2/2]

◆ ComputeStringBounds() [2/2]

◆ ComputeJustifiedStringBounds()

◆ DrawMathTextString()

◆ DrawImage() [1/2]

◆ DrawImage() [2/2]

◆ SetColor4()

◆ SetTexture()

◆ SetPointSize()

◆ SetLineWidth()

◆ SetLineType()

◆ SetMatrix()

◆ GetMatrix()

◆ MultiplyMatrix()

◆ PushMatrix()

◆ PopMatrix()

◆ SetClipping()

◆ EnableClipping()

◆ SetViewport()

◆ PushGraphicsState()

◆ PopGraphicsState()

◆ SetupClippingAndTransform()

◆ ApplyPenStateToNode()

◆ ApplyPenColorToNode()

◆ ApplyPenOpacityToNode()

◆ ApplyPenWidthToNode()

◆ ApplyPenStippleToNode()

◆ ApplyPenAsFillColorToNode()

◆ ApplyPenAsFillOpacityToNode()

◆ ApplyBrushStateToNode()

◆ ApplyBrushColorToNode()

◆ ApplyBrushOpacityToNode()

◆ ApplyBrushTextureToNode()