bpp::AbstractGraphicDevice Class Reference

Partial implementation of the GraphicDevice interface. More...

#include <Bpp/Graphics/AbstractGraphicDevice.h>

Inheritance diagram for bpp::AbstractGraphicDevice:

Collaboration diagram for bpp::AbstractGraphicDevice:

Public Member Functions
	AbstractGraphicDevice ()
virtual	~AbstractGraphicDevice ()
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
virtual void	begin ()=0
	Start the painting. More...
virtual void	end ()=0
	End the painting. More...
virtual void	drawLine (double x1, double y1, double x2, double y2)=0
	Draw a line between two points. More...
virtual void	drawRect (double x, double y, double width, double height, short fill=FILL_EMPTY)=0
	Draw a rectangle. More...
virtual void	drawCircle (double x, double y, double radius, short fill=FILL_EMPTY)=0
	Draw a circle. More...
virtual void	drawText (double x, double y, const std::string &text, short hpos=TEXT_HORIZONTAL_LEFT, short vpos=TEXT_VERTICAL_BOTTOM, double angle=0)=0
	Draw some characters. More...
virtual void	comment (const std::string &comment)=0
	Add a comment in the output. More...

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
double	xUnit_
double	yUnit_
RGBColor	fgColor_
RGBColor	bgColor_
Font	font_
unsigned int	pointSize_
short	lineType_
int	currentLayer_

Detailed Description

Partial implementation of the GraphicDevice interface.

Implement this interface to support new formats.

Definition at line 54 of file AbstractGraphicDevice.h.

Constructor & Destructor Documentation

AbstractGraphicDevice()

bpp::AbstractGraphicDevice::AbstractGraphicDevice ( )

inline

Definition at line 68 of file AbstractGraphicDevice.h.

~AbstractGraphicDevice()

virtual bpp::AbstractGraphicDevice::~AbstractGraphicDevice ( )

inlinevirtual

Definition at line 72 of file AbstractGraphicDevice.h.

Member Function Documentation

begin()

virtual void bpp::GraphicDevice::begin ( )

pure virtualinherited

Start the painting.

Implemented in bpp::SvgGraphicDevice, bpp::PgfGraphicDevice, and bpp::XFigGraphicDevice.

comment()

virtual void bpp::GraphicDevice::comment ( const std::string &  comment )

pure virtualinherited

Add a comment in the output.

Parameters

comment

Comment text.

Implemented in bpp::SvgGraphicDevice, bpp::PgfGraphicDevice, and bpp::XFigGraphicDevice.

drawCircle()

virtual void bpp::GraphicDevice::drawCircle ( double  x, double  y, double  radius, short  fill = FILL_EMPTY  )

pure virtualinherited

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

Implemented in bpp::SvgGraphicDevice, bpp::PgfGraphicDevice, and bpp::XFigGraphicDevice.

drawLine()

virtual void bpp::GraphicDevice::drawLine ( double  x1, double  y1, double  x2, double  y2  )

pure virtualinherited

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

Implemented in bpp::SvgGraphicDevice, bpp::PgfGraphicDevice, and bpp::XFigGraphicDevice.

drawRect()

virtual void bpp::GraphicDevice::drawRect ( double  x, double  y, double  width, double  height, short  fill = FILL_EMPTY  )

pure virtualinherited

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

Implemented in bpp::SvgGraphicDevice, bpp::PgfGraphicDevice, and bpp::XFigGraphicDevice.

drawText()

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

pure virtualinherited

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.

Implemented in bpp::SvgGraphicDevice, bpp::PgfGraphicDevice, and bpp::XFigGraphicDevice.

end()

virtual void bpp::GraphicDevice::end ( )

pure virtualinherited

End the painting.

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

Implemented in bpp::SvgGraphicDevice, bpp::PgfGraphicDevice, and bpp::XFigGraphicDevice.

getCurrentBackgroundColor()

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

inlinevirtual

Implements bpp::GraphicDevice.

Definition at line 94 of file AbstractGraphicDevice.h.

References bgColor_.

getCurrentFont()

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

inlinevirtual

Implements bpp::GraphicDevice.

Definition at line 95 of file AbstractGraphicDevice.h.

References font_.

getCurrentForegroundColor()

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

inlinevirtual

Implements bpp::GraphicDevice.

Definition at line 93 of file AbstractGraphicDevice.h.

References fgColor_.

getCurrentLayer()

int bpp::AbstractGraphicDevice::getCurrentLayer ( ) const

inlinevirtual

Implements bpp::GraphicDevice.

Definition at line 98 of file AbstractGraphicDevice.h.

References currentLayer_.

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

getCurrentLineType()

short bpp::AbstractGraphicDevice::getCurrentLineType ( ) const

inlinevirtual

Implements bpp::GraphicDevice.

Definition at line 97 of file AbstractGraphicDevice.h.

References lineType_.

getCurrentPointSize()

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

inlinevirtual

Implements bpp::GraphicDevice.

Definition at line 96 of file AbstractGraphicDevice.h.

References pointSize_.

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

getXUnit()

double bpp::AbstractGraphicDevice::getXUnit ( ) const

inlinevirtual

Returns

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

Implements bpp::GraphicDevice.

Definition at line 77 of file AbstractGraphicDevice.h.

References xUnit_.

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

getYUnit()

double bpp::AbstractGraphicDevice::getYUnit ( ) const

inlinevirtual

Returns

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

Implements bpp::GraphicDevice.

Definition at line 78 of file AbstractGraphicDevice.h.

References yUnit_.

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

revx_()

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

inlineprotected

Definition at line 104 of file AbstractGraphicDevice.h.

References xUnit_.

revy_()

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

inlineprotected

Definition at line 105 of file AbstractGraphicDevice.h.

References yUnit_.

setCurrentBackgroundColor()

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

inlinevirtual

Implements bpp::GraphicDevice.

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

Definition at line 81 of file AbstractGraphicDevice.h.

References bgColor_.

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

setCurrentFont()

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

inlinevirtual

Implements bpp::GraphicDevice.

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

Definition at line 82 of file AbstractGraphicDevice.h.

References font_.

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

setCurrentForegroundColor()

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

inlinevirtual

Implements bpp::GraphicDevice.

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

Definition at line 80 of file AbstractGraphicDevice.h.

References fgColor_.

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

setCurrentLayer()

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

inlinevirtual

Implements bpp::GraphicDevice.

Reimplemented in bpp::PgfGraphicDevice.

Definition at line 91 of file AbstractGraphicDevice.h.

References currentLayer_.

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

setCurrentLineType()

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

inlinevirtual

Implements bpp::GraphicDevice.

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

Definition at line 84 of file AbstractGraphicDevice.h.

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

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

setCurrentPointSize()

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

inlinevirtual

Implements bpp::GraphicDevice.

Reimplemented in bpp::PgfGraphicDevice.

Definition at line 83 of file AbstractGraphicDevice.h.

References pointSize_.

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

setXUnit()

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

inlinevirtual

Parameters

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

Implements bpp::GraphicDevice.

Definition at line 75 of file AbstractGraphicDevice.h.

References xUnit_.

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

setYUnit()

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

inlinevirtual

Parameters

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

Implements bpp::GraphicDevice.

Definition at line 76 of file AbstractGraphicDevice.h.

References yUnit_.

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

x_()

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

inlineprotected

Definition at line 101 of file AbstractGraphicDevice.h.

References xUnit_.

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

y_()

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

inlineprotected

Definition at line 102 of file AbstractGraphicDevice.h.

References yUnit_.

Member Data Documentation

bgColor_

RGBColor bpp::AbstractGraphicDevice::bgColor_

private

Definition at line 61 of file AbstractGraphicDevice.h.

Referenced by getCurrentBackgroundColor(), and setCurrentBackgroundColor().

currentLayer_

int bpp::AbstractGraphicDevice::currentLayer_

private

Definition at line 65 of file AbstractGraphicDevice.h.

Referenced by getCurrentLayer(), and setCurrentLayer().

fgColor_

RGBColor bpp::AbstractGraphicDevice::fgColor_

private

Definition at line 60 of file AbstractGraphicDevice.h.

Referenced by getCurrentForegroundColor(), and setCurrentForegroundColor().

FILL_EMPTY

short GraphicDevice::FILL_EMPTY = 10

staticinherited

Definition at line 186 of file GraphicDevice.h.

FILL_FILLED

short GraphicDevice::FILL_FILLED = 11

staticinherited

Definition at line 187 of file GraphicDevice.h.

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

FILL_PATTERN

short GraphicDevice::FILL_PATTERN = 12

staticinherited

Definition at line 188 of file GraphicDevice.h.

font_

Font bpp::AbstractGraphicDevice::font_

private

Definition at line 62 of file AbstractGraphicDevice.h.

Referenced by getCurrentFont(), and setCurrentFont().

LINE_DASHED

short GraphicDevice::LINE_DASHED = 21

staticinherited

Definition at line 191 of file GraphicDevice.h.

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

LINE_DOTTED

short GraphicDevice::LINE_DOTTED = 22

staticinherited

Definition at line 192 of file GraphicDevice.h.

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

LINE_SOLID

short GraphicDevice::LINE_SOLID = 20

staticinherited

Definition at line 190 of file GraphicDevice.h.

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

lineType_

short bpp::AbstractGraphicDevice::lineType_

private

Definition at line 64 of file AbstractGraphicDevice.h.

Referenced by getCurrentLineType(), and setCurrentLineType().

pointSize_

unsigned int bpp::AbstractGraphicDevice::pointSize_

private

Definition at line 63 of file AbstractGraphicDevice.h.

Referenced by getCurrentPointSize(), and setCurrentPointSize().

TEXT_HORIZONTAL_CENTER

short GraphicDevice::TEXT_HORIZONTAL_CENTER = 0

staticinherited

Definition at line 179 of file GraphicDevice.h.

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

TEXT_HORIZONTAL_LEFT

short GraphicDevice::TEXT_HORIZONTAL_LEFT = 1

staticinherited

Definition at line 180 of file GraphicDevice.h.

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

TEXT_HORIZONTAL_RIGHT

short GraphicDevice::TEXT_HORIZONTAL_RIGHT = 2

staticinherited

Definition at line 181 of file GraphicDevice.h.

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

TEXT_VERTICAL_BOTTOM

short GraphicDevice::TEXT_VERTICAL_BOTTOM = 4

staticinherited

Definition at line 183 of file GraphicDevice.h.

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

TEXT_VERTICAL_CENTER

short GraphicDevice::TEXT_VERTICAL_CENTER = 3

staticinherited

Definition at line 182 of file GraphicDevice.h.

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

TEXT_VERTICAL_TOP

short GraphicDevice::TEXT_VERTICAL_TOP = 5

staticinherited

Definition at line 184 of file GraphicDevice.h.

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

xUnit_

double bpp::AbstractGraphicDevice::xUnit_

private

Definition at line 58 of file AbstractGraphicDevice.h.

Referenced by getXUnit(), revx_(), setXUnit(), and x_().

yUnit_

double bpp::AbstractGraphicDevice::yUnit_

private

Definition at line 59 of file AbstractGraphicDevice.h.

Referenced by getYUnit(), revy_(), setYUnit(), and y_().

---

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

• Bpp/Graphics/AbstractGraphicDevice.h