SVG plotting format. More...

#include <Bpp/Graphics/Svg/SvgGraphicDevice.h>

Inheritance diagram for bpp::SvgGraphicDevice:

Collaboration diagram for bpp::SvgGraphicDevice:

Public Member Functions
	SvgGraphicDevice (std::ostream &out, bool inkscapeEnabled=false)

virtual	~SvgGraphicDevice ()

void	begin ()
	Start the painting. More...

void	end ()
	End the painting. More...

void	drawLine (double x1, double y1, double x2, double y2)
	Draw a line between two points. More...

void	drawRect (double x, double y, double width, double height, short fill=FILL_EMPTY)
	Draw a rectangle. More...

void	drawCircle (double x, double y, double radius, short fill=FILL_EMPTY)
	Draw a circle. More...

void	drawText (double x, double y, const std::string &text, short hpos=TEXT_HORIZONTAL_LEFT, short vpos=TEXT_VERTICAL_BOTTOM, double angle=0)
	Draw some characters. More...

void	comment (const std::string &text)
	Add a comment in the output. More...

void	setXUnit (double xu)

void	setYUnit (double yu)

double	getXUnit () const

double	getYUnit () const

void	setCurrentForegroundColor (const RGBColor &color)

void	setCurrentBackgroundColor (const RGBColor &color)

void	setCurrentFont (const Font &font)

void	setCurrentPointSize (unsigned int size)

void	setCurrentLineType (short type)

void	setCurrentLayer (int layerIndex)

const RGBColor &	getCurrentForegroundColor () const

const RGBColor &	getCurrentBackgroundColor () const

const Font &	getCurrentFont () const

unsigned int	getCurrentPointSize () const

short	getCurrentLineType () const

int	getCurrentLayer () const

Static Public Member Functions
static std::string	colorToText (const RGBColor &color)

Static Public Attributes
static short	TEXT_HORIZONTAL_CENTER = 0

static short	TEXT_HORIZONTAL_LEFT = 1

static short	TEXT_HORIZONTAL_RIGHT = 2

static short	TEXT_VERTICAL_CENTER = 3

static short	TEXT_VERTICAL_BOTTOM = 4

static short	TEXT_VERTICAL_TOP = 5

static short	FILL_EMPTY = 10

static short	FILL_FILLED = 11

static short	FILL_PATTERN = 12

static short	LINE_SOLID = 20

static short	LINE_DASHED = 21

static short	LINE_DOTTED = 22

Protected Member Functions
double	x_ (double x) const

double	y_ (double y) const

double	revx_ (double x) const

double	revy_ (double y) const

Private Attributes
std::ostream &	out_

std::map< int, std::vector< std::string >, std::greater< int > >	layers_

bool	inkscapeEnabled_

double	minx_

double	maxx_

double	miny_

double	maxy_

std::map< short int, std::string >	fontStyles_

std::map< short int, std::string >	fontWeights_

Detailed Description

SVG plotting format.

Definition at line 20 of file SvgGraphicDevice.h.

Constructor & Destructor Documentation

◆ SvgGraphicDevice()

bpp::SvgGraphicDevice::SvgGraphicDevice	(	std::ostream &	out,
		bool	inkscapeEnabled = `false`
	)

inline

Definition at line 32 of file SvgGraphicDevice.h.

References bpp::Font::STYLE_ITALIC, bpp::Font::STYLE_NORMAL, bpp::Font::WEIGHT_BOLD, and bpp::Font::WEIGHT_NORMAL.

◆ ~SvgGraphicDevice()

virtual bpp::SvgGraphicDevice::~SvgGraphicDevice ( )

inlinevirtual

Definition at line 45 of file SvgGraphicDevice.h.

References begin(), drawCircle(), drawLine(), drawRect(), drawText(), end(), bpp::GraphicDevice::FILL_EMPTY, bpp::GraphicDevice::TEXT_HORIZONTAL_LEFT, and bpp::GraphicDevice::TEXT_VERTICAL_BOTTOM.

Member Function Documentation

◆ begin()

void SvgGraphicDevice::begin ( )

virtual

Start the painting.

Implements bpp::GraphicDevice.

Definition at line 10 of file SvgGraphicDevice.cpp.

Referenced by ~SvgGraphicDevice().

◆ colorToText()

static std::string bpp::SvgGraphicDevice::colorToText ( const RGBColor & color )

inlinestatic

Definition at line 61 of file SvgGraphicDevice.h.

References bpp::TextTools::toString().

◆ comment()

void bpp::SvgGraphicDevice::comment ( const std::string & comment )

inlinevirtual

Add a comment in the output.

Parameters

comment Comment text.

Implements bpp::GraphicDevice.

Definition at line 55 of file SvgGraphicDevice.h.

References bpp::AbstractGraphicDevice::getCurrentLayer().

◆ drawCircle()

void SvgGraphicDevice::drawCircle	(	double	x,
		double	y,
		double	radius,
		short	fill = `FILL_EMPTY`
	)

virtual

Draw a circle.

This method uses the current foreground color and the current line type for drawing the stroke of the circle, and the current background color for filling the circle.

Parameters

x	x coordinate of the center
y	y coordinate of the center
radius	The circle radius
fill	Filling type (one of FILL_EMPTY, FILL_FILLED or FILL_PATTERN).

Implements bpp::GraphicDevice.

Definition at line 106 of file SvgGraphicDevice.cpp.

References bpp::TextTools::toString().

Referenced by ~SvgGraphicDevice().

◆ drawLine()

void SvgGraphicDevice::drawLine	(	double	x1,
		double	y1,
		double	x2,
		double	y2
	)

virtual

Draw a line between two points.

This method uses the current foreground color and the current line type.

Parameters

x1	x coordinate 1
y1	y coordinate 1
x2	x coordinate 2
y2	y coordinate 2

Implements bpp::GraphicDevice.

Definition at line 50 of file SvgGraphicDevice.cpp.

References bpp::TextTools::toString().

Referenced by ~SvgGraphicDevice().

◆ drawRect()

void SvgGraphicDevice::drawRect	(	double	x,
		double	y,
		double	width,
		double	height,
		short	fill = `FILL_EMPTY`
	)

virtual

Draw a rectangle.

This method uses the current foreground color and the current line type for drawing the stroke of the rectangle, and the current background color for filling the rectangle.

Parameters

x	x coordinate
y	y coordinate
width	The rectangle width
height	The rectangle height
fill	Filling type (one of FILL_EMPTY, FILL_FILLED or FILL_PATTERN).

Implements bpp::GraphicDevice.

Definition at line 82 of file SvgGraphicDevice.cpp.

References bpp::TextTools::toString().

Referenced by ~SvgGraphicDevice().

◆ drawText()

void SvgGraphicDevice::drawText	(	double	x,
		double	y,
		const std::string &	text,
		short	hpos = `TEXT_HORIZONTAL_LEFT`,
		short	vpos = `TEXT_VERTICAL_BOTTOM`,
		double	angle = `0`
	)

virtual

Draw some characters.

This method uses the current foreground color.

Parameters

x	x coordinate
y	y coordinate
text	The characters to draw
hpos	Horizontal adjustment, one of TEXT_HORIZONTAL_LEFT, TEXT_HORIZONTAL_CENTER or TEXT_HORIZONTAL_RIGHT.
vpos	Vertical adjustment, one of TEXT_VERTICAL_LEFT, TEXT_VERTICAL_CENTER or TEXT_VERTICAL_RIGHT.
angle	Angle i radian to rotate the text.

Implements bpp::GraphicDevice.

Definition at line 121 of file SvgGraphicDevice.cpp.

References bpp::TextTools::toString().

Referenced by ~SvgGraphicDevice().

◆ end()

void SvgGraphicDevice::end ( )

virtual

End the painting.

Depending on the implementation of the device, the call of this method might be required before the plotting commands become visible.

Implements bpp::GraphicDevice.

Definition at line 16 of file SvgGraphicDevice.cpp.

Referenced by ~SvgGraphicDevice().

◆ getCurrentBackgroundColor()

const RGBColor& bpp::AbstractGraphicDevice::getCurrentBackgroundColor ( ) const

inlinevirtualinherited

Implements bpp::GraphicDevice.

Definition at line 58 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::bgColor_.

◆ getCurrentFont()

const Font& bpp::AbstractGraphicDevice::getCurrentFont ( ) const

inlinevirtualinherited

Implements bpp::GraphicDevice.

Definition at line 59 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::font_.

◆ getCurrentForegroundColor()

const RGBColor& bpp::AbstractGraphicDevice::getCurrentForegroundColor ( ) const

inlinevirtualinherited

Implements bpp::GraphicDevice.

Definition at line 57 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::fgColor_.

◆ getCurrentLayer()

int bpp::AbstractGraphicDevice::getCurrentLayer ( ) const

inlinevirtualinherited

Implements bpp::GraphicDevice.

Definition at line 62 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::currentLayer_.

Referenced by comment(), bpp::PgfGraphicDevice::end(), and bpp::PgfGraphicDevice::setCurrentLayer().

◆ getCurrentLineType()

short bpp::AbstractGraphicDevice::getCurrentLineType ( ) const

inlinevirtualinherited

Implements bpp::GraphicDevice.

Definition at line 61 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::lineType_.

◆ getCurrentPointSize()

unsigned int bpp::AbstractGraphicDevice::getCurrentPointSize ( ) const

inlinevirtualinherited

Implements bpp::GraphicDevice.

Definition at line 60 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::pointSize_.

Referenced by bpp::PgfGraphicDevice::setCurrentLineType().

◆ getXUnit()

double bpp::AbstractGraphicDevice::getXUnit ( ) const

inlinevirtualinherited

Returns: The x expansion factor. The actual unit actually depends on the implementation.

Implements bpp::GraphicDevice.

Definition at line 41 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::xUnit_.

Referenced by bpp::PgfGraphicDevice::end().

◆ getYUnit()

double bpp::AbstractGraphicDevice::getYUnit ( ) const

inlinevirtualinherited

Returns: The y expansion factor. The actual unit actually depends on the implementation.

Implements bpp::GraphicDevice.

Definition at line 42 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::yUnit_.

Referenced by bpp::PgfGraphicDevice::end().

◆ revx_()

double bpp::AbstractGraphicDevice::revx_ ( double x ) const

inlineprotectedinherited

Definition at line 68 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::xUnit_.

◆ revy_()

double bpp::AbstractGraphicDevice::revy_ ( double y ) const

inlineprotectedinherited

Definition at line 69 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::yUnit_.

◆ setCurrentBackgroundColor()

void bpp::AbstractGraphicDevice::setCurrentBackgroundColor ( const RGBColor & color )

inlinevirtualinherited

Implements bpp::GraphicDevice.

Reimplemented in bpp::XFigGraphicDevice, and bpp::PgfGraphicDevice.

Definition at line 45 of file AbstractGraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::setCurrentBackgroundColor(), and bpp::XFigGraphicDevice::setCurrentBackgroundColor().

◆ setCurrentFont()

void bpp::AbstractGraphicDevice::setCurrentFont ( const Font & font )

inlinevirtualinherited

Implements bpp::GraphicDevice.

Reimplemented in bpp::XFigGraphicDevice, and bpp::PgfGraphicDevice.

Definition at line 46 of file AbstractGraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::setCurrentFont(), and bpp::XFigGraphicDevice::setCurrentFont().

◆ setCurrentForegroundColor()

void bpp::AbstractGraphicDevice::setCurrentForegroundColor ( const RGBColor & color )

inlinevirtualinherited

Implements bpp::GraphicDevice.

Reimplemented in bpp::XFigGraphicDevice, and bpp::PgfGraphicDevice.

Definition at line 44 of file AbstractGraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::setCurrentForegroundColor(), and bpp::XFigGraphicDevice::setCurrentForegroundColor().

◆ setCurrentLayer()

void bpp::AbstractGraphicDevice::setCurrentLayer ( int layerIndex )

inlinevirtualinherited

Implements bpp::GraphicDevice.

Reimplemented in bpp::PgfGraphicDevice.

Definition at line 55 of file AbstractGraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::setCurrentLayer(), and bpp::XFigGraphicDevice::XFigGraphicDevice().

◆ setCurrentLineType()

void bpp::AbstractGraphicDevice::setCurrentLineType ( short type )

inlinevirtualinherited

Implements bpp::GraphicDevice.

Reimplemented in bpp::XFigGraphicDevice, and bpp::PgfGraphicDevice.

Definition at line 48 of file AbstractGraphicDevice.h.

References bpp::GraphicDevice::LINE_DASHED, bpp::GraphicDevice::LINE_DOTTED, bpp::GraphicDevice::LINE_SOLID, and bpp::TextTools::toString().

Referenced by bpp::PgfGraphicDevice::setCurrentLineType(), and bpp::XFigGraphicDevice::setCurrentLineType().

◆ setCurrentPointSize()

void bpp::AbstractGraphicDevice::setCurrentPointSize ( unsigned int size )

inlinevirtualinherited

Implements bpp::GraphicDevice.

Reimplemented in bpp::PgfGraphicDevice.

Definition at line 47 of file AbstractGraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::setCurrentPointSize().

◆ setXUnit()

void bpp::AbstractGraphicDevice::setXUnit ( double xu )

inlinevirtualinherited

Parameters

xu	The x expansion factor. The actual unit actually depends on the implementation.

Implements bpp::GraphicDevice.

Definition at line 39 of file AbstractGraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::PgfGraphicDevice().

◆ setYUnit()

void bpp::AbstractGraphicDevice::setYUnit ( double yu )

inlinevirtualinherited

Parameters

yu	The y expansion factor. The actual unit actually depends on the implementation.

Implements bpp::GraphicDevice.

Definition at line 40 of file AbstractGraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::PgfGraphicDevice().

◆ x_()

double bpp::AbstractGraphicDevice::x_ ( double x ) const

inlineprotectedinherited

Definition at line 65 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::xUnit_.

Referenced by bpp::PgfGraphicDevice::setCurrentLineType(), and bpp::PgfGraphicDevice::setCurrentPointSize().

◆ y_()

double bpp::AbstractGraphicDevice::y_ ( double y ) const

inlineprotectedinherited

Definition at line 66 of file AbstractGraphicDevice.h.

References bpp::AbstractGraphicDevice::yUnit_.

Member Data Documentation

◆ FILL_EMPTY

short GraphicDevice::FILL_EMPTY = 10

staticinherited

Definition at line 150 of file GraphicDevice.h.

Referenced by bpp::XFigGraphicDevice::setCurrentLineType(), bpp::PgfGraphicDevice::~PgfGraphicDevice(), and ~SvgGraphicDevice().

◆ FILL_FILLED

short GraphicDevice::FILL_FILLED = 11

staticinherited

Definition at line 151 of file GraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::drawCircle(), and bpp::PgfGraphicDevice::drawRect().

◆ FILL_PATTERN

short GraphicDevice::FILL_PATTERN = 12

staticinherited

Definition at line 152 of file GraphicDevice.h.

◆ fontStyles_

std::map<short int, std::string> bpp::SvgGraphicDevice::fontStyles_

private

Definition at line 28 of file SvgGraphicDevice.h.

◆ fontWeights_

std::map<short int, std::string> bpp::SvgGraphicDevice::fontWeights_

private

Definition at line 29 of file SvgGraphicDevice.h.

◆ inkscapeEnabled_

bool bpp::SvgGraphicDevice::inkscapeEnabled_

private

Definition at line 26 of file SvgGraphicDevice.h.

◆ layers_

std::map<int, std::vector<std::string>, std::greater<int> > bpp::SvgGraphicDevice::layers_

private

Definition at line 25 of file SvgGraphicDevice.h.

◆ LINE_DASHED

short GraphicDevice::LINE_DASHED = 21

staticinherited

Definition at line 155 of file GraphicDevice.h.

Referenced by bpp::AbstractGraphicDevice::setCurrentLineType(), bpp::PgfGraphicDevice::setCurrentLineType(), and bpp::XFigGraphicDevice::setCurrentLineType().

◆ LINE_DOTTED

short GraphicDevice::LINE_DOTTED = 22

staticinherited

Definition at line 156 of file GraphicDevice.h.

Referenced by bpp::AbstractGraphicDevice::setCurrentLineType(), bpp::PgfGraphicDevice::setCurrentLineType(), and bpp::XFigGraphicDevice::setCurrentLineType().

◆ LINE_SOLID

short GraphicDevice::LINE_SOLID = 20

staticinherited

Definition at line 154 of file GraphicDevice.h.

Referenced by bpp::AbstractGraphicDevice::setCurrentLineType(), bpp::PgfGraphicDevice::setCurrentLineType(), and bpp::XFigGraphicDevice::setCurrentLineType().

◆ maxx_

double bpp::SvgGraphicDevice::maxx_

private

Definition at line 27 of file SvgGraphicDevice.h.

◆ maxy_

double bpp::SvgGraphicDevice::maxy_

private

Definition at line 27 of file SvgGraphicDevice.h.

◆ minx_

double bpp::SvgGraphicDevice::minx_

private

Definition at line 27 of file SvgGraphicDevice.h.

◆ miny_

double bpp::SvgGraphicDevice::miny_

private

Definition at line 27 of file SvgGraphicDevice.h.

◆ out_

std::ostream& bpp::SvgGraphicDevice::out_

private

Definition at line 24 of file SvgGraphicDevice.h.

◆ TEXT_HORIZONTAL_CENTER

short GraphicDevice::TEXT_HORIZONTAL_CENTER = 0

staticinherited

Definition at line 143 of file GraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::drawText().

◆ TEXT_HORIZONTAL_LEFT

short GraphicDevice::TEXT_HORIZONTAL_LEFT = 1

staticinherited

Definition at line 144 of file GraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::drawText(), bpp::XFigGraphicDevice::setCurrentLineType(), bpp::PgfGraphicDevice::~PgfGraphicDevice(), and ~SvgGraphicDevice().

◆ TEXT_HORIZONTAL_RIGHT

short GraphicDevice::TEXT_HORIZONTAL_RIGHT = 2

staticinherited

Definition at line 145 of file GraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::drawText().

◆ TEXT_VERTICAL_BOTTOM

short GraphicDevice::TEXT_VERTICAL_BOTTOM = 4

staticinherited

Definition at line 147 of file GraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::drawText(), bpp::XFigGraphicDevice::setCurrentLineType(), bpp::PgfGraphicDevice::~PgfGraphicDevice(), and ~SvgGraphicDevice().

◆ TEXT_VERTICAL_CENTER

short GraphicDevice::TEXT_VERTICAL_CENTER = 3

staticinherited

Definition at line 146 of file GraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::drawText().

◆ TEXT_VERTICAL_TOP

short GraphicDevice::TEXT_VERTICAL_TOP = 5

staticinherited

Definition at line 148 of file GraphicDevice.h.

Referenced by bpp::PgfGraphicDevice::drawText().

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

Bpp/Graphics/Svg/SvgGraphicDevice.h
Bpp/Graphics/Svg/SvgGraphicDevice.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SvgGraphicDevice()

◆ ~SvgGraphicDevice()

Member Function Documentation

◆ begin()

◆ colorToText()

◆ comment()

◆ drawCircle()

◆ drawLine()

◆ drawRect()

◆ drawText()

◆ end()

◆ getCurrentBackgroundColor()

◆ getCurrentFont()

◆ getCurrentForegroundColor()

◆ getCurrentLayer()

◆ getCurrentLineType()

◆ getCurrentPointSize()

◆ getXUnit()

◆ getYUnit()

◆ revx_()

◆ revy_()

◆ setCurrentBackgroundColor()

◆ setCurrentFont()

◆ setCurrentForegroundColor()

◆ setCurrentLayer()

◆ setCurrentLineType()

◆ setCurrentPointSize()

◆ setXUnit()

◆ setYUnit()

◆ x_()

◆ y_()

Member Data Documentation

◆ FILL_EMPTY

◆ FILL_FILLED

◆ FILL_PATTERN

◆ fontStyles_

◆ fontWeights_

◆ inkscapeEnabled_

◆ layers_

◆ LINE_DASHED

◆ LINE_DOTTED

◆ LINE_SOLID

◆ maxx_

◆ maxy_

◆ minx_

◆ miny_

◆ out_

◆ TEXT_HORIZONTAL_CENTER

◆ TEXT_HORIZONTAL_LEFT

◆ TEXT_HORIZONTAL_RIGHT

◆ TEXT_VERTICAL_BOTTOM

◆ TEXT_VERTICAL_CENTER

◆ TEXT_VERTICAL_TOP